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:

  • Field Details

    • AWS_ACCESS_KEY_ID

      public static final String AWS_ACCESS_KEY_ID
      Property name for specifying the Amazon AWS Access Key
      See Also:

    • AWS_SECRET_ACCESS_KEY

      public static final String AWS_SECRET_ACCESS_KEY
      Property name for specifying the Amazon AWS Secret Access Key
      See Also:

    • AWS_SESSION_TOKEN

      public static final String AWS_SESSION_TOKEN
      Property name for specifying the Amazon AWS Session Token
      See Also:

    • AWS_ACCOUNT_ID

      public static final String AWS_ACCOUNT_ID
      Property name for specifying the Amazon AWS Account ID associated with credentials
      See Also:

    • ROLE_ARN

      public static final String ROLE_ARN
      Property name for specifying the IAM role to assume
      See Also:

    • ROLE_SESSION_NAME

      public static final String ROLE_SESSION_NAME
      Property name for specifying the IAM role session name
      See Also:

    • DURATION_SECONDS

      public static final String DURATION_SECONDS
      Property name for specifying how long in seconds to assume the role
      See Also:

    • EXTERNAL_ID

      public static final String EXTERNAL_ID
      Property name for specifying the IAM role external id
      See Also:

    • SOURCE_PROFILE

      public static final String SOURCE_PROFILE
      Property name for specifying the profile credentials to use when assuming a role
      See Also:

    • CREDENTIAL_SOURCE

      public static final String CREDENTIAL_SOURCE
      Property name for specifying the credential source to use when assuming a role
      See Also:

    • REGION

      public static final String REGION
      AWS Region to use when creating clients.
      See Also:

    • MFA_SERIAL

      public static final String MFA_SERIAL
      Property name for specifying the identification number of the MFA device
      See Also:

    • ENDPOINT_DISCOVERY_ENABLED

      public static final String ENDPOINT_DISCOVERY_ENABLED
      Property name for specifying whether or not endpoint discovery is enabled.
      See Also:

    • CREDENTIAL_PROCESS

      public static final String CREDENTIAL_PROCESS
      An external process that should be invoked to load credentials.
      See Also:

    • WEB_IDENTITY_TOKEN_FILE

      public static final String WEB_IDENTITY_TOKEN_FILE
      See Also:

    • 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:

    • DISABLE_S3_EXPRESS_AUTH

      public static final String DISABLE_S3_EXPRESS_AUTH
      See Also:

    • 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:

    • DEFAULTS_MODE

      public static final String DEFAULTS_MODE
      The "defaults mode" to be used for clients created using the currently-configured profile. Defaults mode determins how SDK default configuration should be resolved. See the DefaultsMode class JavaDoc for more information.
      See Also:

    • ACCOUNT_ID_ENDPOINT_MODE

      public static final String ACCOUNT_ID_ENDPOINT_MODE
      The "account id endpoint mode" to be used for clients created using the currently-configured profile. This setting can only be used by services that route user requests to account specific endpoints, and determines how endpoints should be resolved depending on the availability of an accountId for a request. See the AccountIdEndpointMode class javadoc for more information.
      See Also:

    • 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:

    • 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:

    • SSO_ACCOUNT_ID

      public static final String SSO_ACCOUNT_ID
      AWS account ID that temporary AWS credentials will be resolved for.
      See Also:

    • 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:

    • USE_DUALSTACK_ENDPOINT

      public static final String USE_DUALSTACK_ENDPOINT
      See Also:

    • AUTH_SCHEME_PREFERENCE

      public static final String AUTH_SCHEME_PREFERENCE
      See Also:

    • USE_FIPS_ENDPOINT

      public static final String USE_FIPS_ENDPOINT
      See Also:

    • EC2_METADATA_SERVICE_ENDPOINT_MODE

      public static final String EC2_METADATA_SERVICE_ENDPOINT_MODE
      See Also:

    • EC2_METADATA_SERVICE_ENDPOINT

      public static final String EC2_METADATA_SERVICE_ENDPOINT
      See Also:

    • EC2_METADATA_V1_DISABLED

      public static final String EC2_METADATA_V1_DISABLED
      See Also:

    • METADATA_SERVICE_TIMEOUT

      public static final String METADATA_SERVICE_TIMEOUT
      See Also:

    • DISABLE_REQUEST_COMPRESSION

      public static final String DISABLE_REQUEST_COMPRESSION
      Whether request compression is disabled for operations marked with the RequestCompression trait. The default value is false, i.e., request compression is enabled.
      See Also:

    • REQUEST_MIN_COMPRESSION_SIZE_BYTES

      public static final String REQUEST_MIN_COMPRESSION_SIZE_BYTES
      The minimum compression size in bytes, inclusive, for a request to be compressed. The default value is 10_240. The value must be non-negative and no greater than 10_485_760.
      See Also:

    • ENDPOINT_URL

      public static final String ENDPOINT_URL
      The endpoint override to use. This may also be specified under a service-specific parent property to override the endpoint just for that one service.
      See Also:

    • REQUEST_CHECKSUM_CALCULATION

      public static final String REQUEST_CHECKSUM_CALCULATION
      The request checksum calculation setting. The default value is WHEN_SUPPORTED.
      See Also:

    • RESPONSE_CHECKSUM_VALIDATION

      public static final String RESPONSE_CHECKSUM_VALIDATION
      The response checksum validation setting. The default value is WHEN_SUPPORTED.
      See Also:

    • SDK_UA_APP_ID

      public static final String SDK_UA_APP_ID
      See Also:

    • SIGV4A_SIGNING_REGION_SET

      public static final String SIGV4A_SIGNING_REGION_SET
      Property name for specifying the SIGV4A signing region set configuration. This optional property is a non-empty, comma-delimited list of non-empty strings, which can be configured via the environment variable AWS_SIGV4A_SIGNING_REGION_SET, or the configuration file property sigv4a_signing_region_set, following standard precedence rules.
      See Also: