software.amazon.kinesis.connectors.flink.util

Class AWSUtil

java.lang.Object

software.amazon.kinesis.connectors.flink.util.AWSUtil

@Internal
public class AWSUtil
extends Object

Some utilities specific to Amazon Web Service.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AWS_CLIENT_CONFIG_PREFIX The prefix used for properties that should be applied to ClientConfiguration.

Constructor Summary

Constructors

Constructor and Description
AWSUtil()

Method Summary

Modifier and Type	Method and Description
static com.amazonaws.services.kinesis.AmazonKinesis	createKinesisClient(Properties configProps) Creates an AmazonKinesis client.
static com.amazonaws.services.kinesis.AmazonKinesis	createKinesisClient(Properties configProps, com.amazonaws.ClientConfiguration awsClientConfig) Creates an Amazon Kinesis Client.
static String	formatFlinkUserAgentPrefix() Creates a user agent prefix for Flink.
static com.amazonaws.auth.AWSCredentialsProvider	getCredentialsProvider(Properties configProps) Return a AWSCredentialsProvider instance corresponding to the configuration properties.
static StartingPosition	getStartingPosition(SequenceNumber sequenceNumber, Properties configProps) Creates a StartingPosition from the given SequenceNumber and Properties.
static boolean	isValidRegion(String region) Checks whether or not a region ID is valid.
static void	setAwsClientConfigProperties(com.amazonaws.ClientConfiguration config, Properties configProps) Set all prefixed properties on ClientConfiguration.

Methods inherited from class java.lang.Object

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

Field Detail

AWS_CLIENT_CONFIG_PREFIX

public static final String AWS_CLIENT_CONFIG_PREFIX

The prefix used for properties that should be applied to ClientConfiguration.

See Also:

Constant Field Values

Constructor Detail

AWSUtil

public AWSUtil()

Method Detail

createKinesisClient

public static com.amazonaws.services.kinesis.AmazonKinesis createKinesisClient(Properties configProps)

Creates an AmazonKinesis client.

Parameters:

configProps - configuration properties containing the access key, secret key, and region

Returns:

a new AmazonKinesis client

createKinesisClient

public static com.amazonaws.services.kinesis.AmazonKinesis createKinesisClient(Properties configProps,
                                                                               com.amazonaws.ClientConfiguration awsClientConfig)

Creates an Amazon Kinesis Client.

Parameters:

configProps - configuration properties containing the access key, secret key, and region

awsClientConfig - preconfigured AWS SDK client configuration

Returns:

a new Amazon Kinesis Client

formatFlinkUserAgentPrefix

public static String formatFlinkUserAgentPrefix()

Creates a user agent prefix for Flink. This can be used by HTTP Clients.

Returns:

a user agent prefix for Flink

getCredentialsProvider

public static com.amazonaws.auth.AWSCredentialsProvider getCredentialsProvider(Properties configProps)

Return a AWSCredentialsProvider instance corresponding to the configuration properties.

Parameters:

configProps - the configuration properties

Returns:

The corresponding AWS Credentials Provider instance

isValidRegion

public static boolean isValidRegion(String region)

Checks whether or not a region ID is valid.

Parameters:

region - The AWS region ID to check

Returns:

true if the supplied region ID is valid, false otherwise

setAwsClientConfigProperties

public static void setAwsClientConfigProperties(com.amazonaws.ClientConfiguration config,
                                                Properties configProps)

Set all prefixed properties on ClientConfiguration.

Parameters:

config -

configProps -

getStartingPosition

public static StartingPosition getStartingPosition(SequenceNumber sequenceNumber,
                                                   Properties configProps)

Creates a StartingPosition from the given SequenceNumber and Properties. In the case we are restating from a SentinelSequenceNumber.SENTINEL_AT_TIMESTAMP_SEQUENCE_NUM, the date is parsed from the properties.

Parameters:

sequenceNumber - the sequence number to resume from

configProps - the properties to parse date from

Returns:

the starting position