org.apache.flink.streaming.connectors.kinesis.config

Class AWSConfigConstants

java.lang.Object

org.apache.flink.streaming.connectors.kinesis.config.AWSConfigConstants

Direct Known Subclasses:

ConsumerConfigConstants, ProducerConfigConstants

@PublicEvolving
public class AWSConfigConstants
extends Object

Configuration keys for AWS service usage.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AWSConfigConstants.CredentialProvider Possible configuration values for the type of credential provider to use when accessing AWS Kinesis.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AWS_ACCESS_KEY_ID The AWS access key ID to use when setting credentials provider type to BASIC.
static String	AWS_CREDENTIALS_PROVIDER The credential provider type to use when AWS credentials are required (BASIC is used if not set).
static String	AWS_ENDPOINT The AWS endpoint for Kinesis (derived from the AWS region setting if not set).
static String	AWS_PROFILE_NAME Optional configuration for profile name if credential provider type is set to be PROFILE.
static String	AWS_PROFILE_PATH Optional configuration for profile path if credential provider type is set to be PROFILE.
static String	AWS_REGION The AWS region of the Kinesis streams to be pulled ("us-east-1" is used if not set).
static String	AWS_ROLE_ARN The role ARN to use when credential provider type is set to ASSUME_ROLE or WEB_IDENTITY_TOKEN.
static String	AWS_ROLE_CREDENTIALS_PROVIDER The credentials provider that provides credentials for assuming the role when credential provider type is set to ASSUME_ROLE.
static String	AWS_ROLE_EXTERNAL_ID The external ID to use when credential provider type is set to ASSUME_ROLE.
static String	AWS_ROLE_SESSION_NAME The role session name to use when credential provider type is set to ASSUME_ROLE or WEB_IDENTITY_TOKEN.
static String	AWS_SECRET_ACCESS_KEY The AWS secret key to use when setting credentials provider type to BASIC.
static 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.

Constructor Summary

Constructors

Constructor and Description
AWSConfigConstants()

Method Summary

Modifier and Type	Method and Description
static String	accessKeyId(String prefix)
static String	externalId(String prefix)
static String	profileName(String prefix)
static String	profilePath(String prefix)
static String	roleArn(String prefix)
static String	roleCredentialsProvider(String prefix)
static String	roleSessionName(String prefix)
static String	secretKey(String prefix)
static String	webIdentityTokenFile(String prefix)

Methods inherited from class java.lang.Object

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

Field Detail

AWS_REGION

public static final String AWS_REGION

The AWS region of the Kinesis streams to be pulled ("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_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 Kinesis (derived from the AWS region setting if not set).

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)

roleArn

public static String roleArn(String prefix)

roleSessionName

public static String roleSessionName(String prefix)

externalId

public static String externalId(String prefix)

roleCredentialsProvider

public static String roleCredentialsProvider(String prefix)

webIdentityTokenFile

public static String webIdentityTokenFile(String prefix)