Package org.apache.flink.connector.aws.config

Class AWSConfigConstants

  • @PublicEvolving
public class AWSConfigConstants
extends Object
    Configuration keys for AWS service usage.

    • Field Detail

      • AWS_REGION

        public static final String AWS_REGION
        The AWS region of the service ("us-east-1" is used if not set).
        See Also:
        Constant Field Values

      • AWS_CREDENTIALS_PROVIDER

        public static final String AWS_CREDENTIALS_PROVIDER
        The credential provider type to use when AWS credentials are required (BASIC is used if not set).
        See Also:
        Constant Field Values

      • AWS_ACCESS_KEY_ID

        public static final String AWS_ACCESS_KEY_ID
        The AWS access key ID to use when setting credentials provider type to BASIC.

      • AWS_SECRET_ACCESS_KEY

        public static final String AWS_SECRET_ACCESS_KEY
        The AWS secret key to use when setting credentials provider type to BASIC.

      • AWS_PROFILE_PATH

        public static final String AWS_PROFILE_PATH
        Optional configuration for profile path if credential provider type is set to be PROFILE.

      • AWS_PROFILE_NAME

        public static final String AWS_PROFILE_NAME
        Optional configuration for profile name if credential provider type is set to be PROFILE.

      • AWS_ROLE_STS_ENDPOINT

        public static final String AWS_ROLE_STS_ENDPOINT
        The AWS endpoint for the STS (derived from the AWS region setting if not set) to use if credential provider type is set to be ASSUME_ROLE.

      • CUSTOM_CREDENTIALS_PROVIDER_CLASS

        public static final String CUSTOM_CREDENTIALS_PROVIDER_CLASS
        The full path (e.g. org.user_company.auth.CustomAwsCredentialsProvider) to the user provided class to use if credential provider type is set to be CUSTOM.

      • AWS_ROLE_ARN

        public static final String AWS_ROLE_ARN
        The role ARN to use when credential provider type is set to ASSUME_ROLE or WEB_IDENTITY_TOKEN.

      • AWS_ROLE_SESSION_NAME

        public static final String AWS_ROLE_SESSION_NAME
        The role session name to use when credential provider type is set to ASSUME_ROLE or WEB_IDENTITY_TOKEN.

      • AWS_ROLE_EXTERNAL_ID

        public static final String AWS_ROLE_EXTERNAL_ID
        The external ID to use when credential provider type is set to ASSUME_ROLE.

      • AWS_WEB_IDENTITY_TOKEN_FILE

        public static final String AWS_WEB_IDENTITY_TOKEN_FILE
        The absolute path to the web identity token file that should be used if provider type is set to WEB_IDENTITY_TOKEN.

      • AWS_ROLE_CREDENTIALS_PROVIDER

        public static final String AWS_ROLE_CREDENTIALS_PROVIDER
        The credentials provider that provides credentials for assuming the role when credential provider type is set to ASSUME_ROLE. Roles can be nested, so AWS_ROLE_CREDENTIALS_PROVIDER can again be set to "ASSUME_ROLE"

      • AWS_ENDPOINT

        public static final String AWS_ENDPOINT
        The AWS endpoint for the service (derived from the AWS region setting if not set).
        See Also:
        Constant Field Values

      • TRUST_ALL_CERTIFICATES

        public static final String TRUST_ALL_CERTIFICATES
        Whether to trust all SSL certificates.
        See Also:
        Constant Field Values

      • HTTP_PROTOCOL_VERSION

        public static final String HTTP_PROTOCOL_VERSION
        The HTTP protocol version to use.
        See Also:
        Constant Field Values

      • HTTP_CLIENT_MAX_CONCURRENCY

        public static final String HTTP_CLIENT_MAX_CONCURRENCY
        Maximum request concurrency for SdkAsyncHttpClient.
        See Also:
        Constant Field Values

      • HTTP_CLIENT_READ_TIMEOUT_MILLIS

        public static final String HTTP_CLIENT_READ_TIMEOUT_MILLIS
        Read Request timeout for SdkAsyncHttpClient.
        See Also:
        Constant Field Values

    • Constructor Detail

      • AWSConfigConstants

        public AWSConfigConstants()

    • Method Detail

      • accessKeyId

        public static String accessKeyId​(String prefix)

      • secretKey

        public static String secretKey​(String prefix)

      • profilePath

        public static String profilePath​(String prefix)

      • profileName

        public static String profileName​(String prefix)

      • roleSessionName

        public static String roleSessionName​(String prefix)

      • externalId

        public static String externalId​(String prefix)

      • roleCredentialsProvider

        public static String roleCredentialsProvider​(String prefix)

      • roleStsEndpoint

        public static String roleStsEndpoint​(String prefix)

      • customCredentialsProviderClass

        public static String customCredentialsProviderClass​(String prefix)

      • webIdentityTokenFile

        public static String webIdentityTokenFile​(String prefix)