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

Enum AWSConfigConstants.CredentialProvider

java.lang.Object

java.lang.Enum<AWSConfigConstants.CredentialProvider>

org.apache.flink.connector.aws.config.AWSConfigConstants.CredentialProvider

All Implemented Interfaces:

Serializable, Comparable<AWSConfigConstants.CredentialProvider>

Enclosing class:

AWSConfigConstants

public static enum AWSConfigConstants.CredentialProvider
extends Enum<AWSConfigConstants.CredentialProvider>

Possible configuration values for the type of credential provider to use when accessing AWS. Internally, a corresponding implementation of AwsCredentialsProvider will be used.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASSUME_ROLE	Create AWS credentials by assuming a role.
AUTO	A credentials provider chain will be used that searches for credentials in this order: ENV_VARS, SYS_PROPS, WEB_IDENTITY_TOKEN, PROFILE in the AWS instance metadata.
BASIC	Simply create AWS credentials by supplying the AWS access key ID and AWS secret key in the configuration properties.
CUSTOM	Use a custom class specified by the user in connector config.
ENV_VAR	Look for the environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY to create AWS credentials.
PROFILE	Use a AWS credentials profile file to create the AWS credentials.
SYS_PROP	Look for Java system properties aws.accessKeyId and aws.secretKey to create AWS credentials.
WEB_IDENTITY_TOKEN	Use AWS WebIdentityToken in order to assume a role.

Method Summary

Modifier and Type	Method	Description
static AWSConfigConstants.CredentialProvider	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AWSConfigConstants.CredentialProvider[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ENV_VAR

public static final AWSConfigConstants.CredentialProvider ENV_VAR

Look for the environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY to create AWS credentials.

SYS_PROP

public static final AWSConfigConstants.CredentialProvider SYS_PROP

Look for Java system properties aws.accessKeyId and aws.secretKey to create AWS credentials.

PROFILE

public static final AWSConfigConstants.CredentialProvider PROFILE

Use a AWS credentials profile file to create the AWS credentials.

BASIC

public static final AWSConfigConstants.CredentialProvider BASIC

Simply create AWS credentials by supplying the AWS access key ID and AWS secret key in the configuration properties.

ASSUME_ROLE

public static final AWSConfigConstants.CredentialProvider ASSUME_ROLE

Create AWS credentials by assuming a role. The credentials for assuming the role must be supplied. *

WEB_IDENTITY_TOKEN

public static final AWSConfigConstants.CredentialProvider WEB_IDENTITY_TOKEN

Use AWS WebIdentityToken in order to assume a role. A token file and role details can be supplied as configuration or environment variables. *

CUSTOM

public static final AWSConfigConstants.CredentialProvider CUSTOM

Use a custom class specified by the user in connector config.

AUTO

public static final AWSConfigConstants.CredentialProvider AUTO

A credentials provider chain will be used that searches for credentials in this order: ENV_VARS, SYS_PROPS, WEB_IDENTITY_TOKEN, PROFILE in the AWS instance metadata. *

Method Detail

values

public static AWSConfigConstants.CredentialProvider[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AWSConfigConstants.CredentialProvider c : AWSConfigConstants.CredentialProvider.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AWSConfigConstants.CredentialProvider valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null