software.amazon.awssdk.profiles

Class ProfileProperty

java.lang.Object

software.amazon.awssdk.profiles.ProfileProperty

public final class ProfileProperty
extends Object

The properties used by the Java SDK from the credentials and config files.

See Also:

ProfileFile

Field Summary

Fields

Modifier and Type	Field and Description
static String	AWS_ACCESS_KEY_ID Property name for specifying the Amazon AWS Access Key
static String	AWS_SECRET_ACCESS_KEY Property name for specifying the Amazon AWS Secret Access Key
static String	AWS_SESSION_TOKEN Property name for specifying the Amazon AWS Session Token
static String	CREDENTIAL_PROCESS An external process that should be invoked to load credentials.
static String	CREDENTIAL_SOURCE Property name for specifying the credential source to use when assuming a role
static String	ENDPOINT_DISCOVERY_ENABLED Property name for specifying whether or not endpoint discovery is enabled.
static String	EXTERNAL_ID Property name for specifying the IAM role external id
static String	MFA_SERIAL Property name for specifying the identification number of the MFA device
static String	REGION AWS Region to use when creating clients.
static String	RETRY_MODE The "retry mode" to be used for clients created using the currently-configured profile.
static String	ROLE_ARN Property name for specifying the IAM role to assume
static String	ROLE_SESSION_NAME Property name for specifying the IAM role session name
static String	S3_US_EAST_1_REGIONAL_ENDPOINT The S3 regional endpoint setting for the us-east-1 region.
static String	SOURCE_PROFILE Property name for specifying the profile credentials to use when assuming a role
static String	SSO_ACCOUNT_ID AWS account ID that temporary AWS credentials will be resolved for.
static String	SSO_REGION Aws region where the SSO directory for the given 'sso_start_url' is hosted.
static String	SSO_ROLE_NAME The corresponding IAM role in the AWS account that temporary AWS credentials will be resolved for.
static String	SSO_START_URL Start url provided by the SSO service via the console.
static String	WEB_IDENTITY_TOKEN_FILE

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

AWS_ACCESS_KEY_ID

public static final String AWS_ACCESS_KEY_ID

Property name for specifying the Amazon AWS Access Key

See Also:

Constant Field Values

AWS_SECRET_ACCESS_KEY

public static final String AWS_SECRET_ACCESS_KEY

Property name for specifying the Amazon AWS Secret Access Key

See Also:

Constant Field Values

AWS_SESSION_TOKEN

public static final String AWS_SESSION_TOKEN

Property name for specifying the Amazon AWS Session Token

See Also:

Constant Field Values

ROLE_ARN

public static final String ROLE_ARN

Property name for specifying the IAM role to assume

See Also:

Constant Field Values

ROLE_SESSION_NAME

public static final String ROLE_SESSION_NAME

Property name for specifying the IAM role session name

See Also:

Constant Field Values

EXTERNAL_ID

public static final String EXTERNAL_ID

Property name for specifying the IAM role external id

See Also:

Constant Field Values

SOURCE_PROFILE

public static final String SOURCE_PROFILE

Property name for specifying the profile credentials to use when assuming a role

See Also:

Constant Field Values

CREDENTIAL_SOURCE

public static final String CREDENTIAL_SOURCE

Property name for specifying the credential source to use when assuming a role

See Also:

Constant Field Values

REGION

public static final String REGION

AWS Region to use when creating clients.

See Also:

Constant Field Values

MFA_SERIAL

public static final String MFA_SERIAL

Property name for specifying the identification number of the MFA device

See Also:

Constant Field Values

ENDPOINT_DISCOVERY_ENABLED

public static final String ENDPOINT_DISCOVERY_ENABLED

Property name for specifying whether or not endpoint discovery is enabled.

See Also:

Constant Field Values

CREDENTIAL_PROCESS

public static final String CREDENTIAL_PROCESS

An external process that should be invoked to load credentials.

See Also:

Constant Field Values

WEB_IDENTITY_TOKEN_FILE

public static final String WEB_IDENTITY_TOKEN_FILE

See Also:

Constant Field Values

S3_US_EAST_1_REGIONAL_ENDPOINT

public static final String S3_US_EAST_1_REGIONAL_ENDPOINT

The S3 regional endpoint setting for the us-east-1 region. Setting the value to regional causes the SDK to use the s3.us-east-1.amazonaws.com endpoint when using the US_EAST_1 region instead of the global s3.amazonaws.com. Using the regional endpoint is disabled by default.

See Also:

Constant Field Values

RETRY_MODE

public static final String RETRY_MODE

The "retry mode" to be used for clients created using the currently-configured profile. Values supported by all SDKs are "legacy" and "standard". See the RetryMode class JavaDoc for more information.

See Also:

Constant Field Values

SSO_REGION

public static final String SSO_REGION

Aws region where the SSO directory for the given 'sso_start_url' is hosted. This is independent of the general 'region'.

See Also:

Constant Field Values

SSO_ROLE_NAME

public static final String SSO_ROLE_NAME

The corresponding IAM role in the AWS account that temporary AWS credentials will be resolved for.

See Also:

Constant Field Values

SSO_ACCOUNT_ID

public static final String SSO_ACCOUNT_ID

AWS account ID that temporary AWS credentials will be resolved for.

See Also:

Constant Field Values

SSO_START_URL

public static final String SSO_START_URL

Start url provided by the SSO service via the console. It's the main URL used for login to the SSO directory. This is also referred to as the "User Portal URL" and can also be used to login to the SSO web interface for AWS console access.

See Also:

Constant Field Values