com.amazonaws.services.dynamodbv2.streamsadapter

Class AmazonDynamoDBStreamsAdapterClient

java.lang.Object

com.amazonaws.services.kinesis.AbstractAmazonKinesis

com.amazonaws.services.dynamodbv2.streamsadapter.AmazonDynamoDBStreamsAdapterClient

All Implemented Interfaces:

AmazonKinesis

public class AmazonDynamoDBStreamsAdapterClient
extends AbstractAmazonKinesis

Client for accessing DynamoDB Streams using the Amazon Kinesis interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AmazonDynamoDBStreamsAdapterClient.SkipRecordsBehavior Enum values decides the behavior of application when customer loses some records when KCL lags behind

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	GET_RECORDS_LIMIT

Fields inherited from interface com.amazonaws.services.kinesis.AmazonKinesis

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AmazonDynamoDBStreamsAdapterClient() Constructs a new client to invoke service methods on DynamoDB Streams.
AmazonDynamoDBStreamsAdapterClient(AmazonDynamoDBStreams amazonDynamoDBStreams) Recommended constructor for AmazonDynamoDBStreamsAdapterClient which takes in an AmazonDynamoDBStreams interface.
AmazonDynamoDBStreamsAdapterClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on DynamoDB Streams.
AmazonDynamoDBStreamsAdapterClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on DynamoDB Streams.
AmazonDynamoDBStreamsAdapterClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on DynamoDB Streams.
AmazonDynamoDBStreamsAdapterClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on DynamoDB Streams.
AmazonDynamoDBStreamsAdapterClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on DynamoDB Streams.
AmazonDynamoDBStreamsAdapterClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on DynamoDB Streams.

Method Summary

Methods

Modifier and Type	Method and Description
AddTagsToStreamResult	addTagsToStream(AddTagsToStreamRequest addTagsToStreamRequest)
CreateStreamResult	createStream(CreateStreamRequest createStreamRequest)
CreateStreamResult	createStream(java.lang.String streamName, java.lang.Integer shardCount)
DecreaseStreamRetentionPeriodResult	decreaseStreamRetentionPeriod(DecreaseStreamRetentionPeriodRequest decreaseStreamRetentionPeriodRequest)
DeleteStreamResult	deleteStream(DeleteStreamRequest deleteStreamRequest)
DeleteStreamResult	deleteStream(java.lang.String streamName)
DescribeStreamResult	describeStream(DescribeStreamRequest describeStreamRequest)
DescribeStreamResult	describeStream(java.lang.String streamName)
DescribeStreamResult	describeStream(java.lang.String streamName, java.lang.Integer limit, java.lang.String exclusiveStartShardId)
DescribeStreamResult	describeStream(java.lang.String streamName, java.lang.String exclusiveStartShardId)
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request)
GetRecordsResult	getRecords(GetRecordsRequest getRecordsRequest)
GetShardIteratorResult	getShardIterator(GetShardIteratorRequest getShardIteratorRequest)
GetShardIteratorResult	getShardIterator(java.lang.String streamName, java.lang.String shardId, java.lang.String shardIteratorType)
GetShardIteratorResult	getShardIterator(java.lang.String streamName, java.lang.String shardId, java.lang.String shardIteratorType, java.lang.String startingSequenceNumber)
AmazonDynamoDBStreamsAdapterClient.SkipRecordsBehavior	getSkipRecordsBehavior() Gets the value of AmazonDynamoDBStreamsAdapterClient.SkipRecordsBehavior.
IncreaseStreamRetentionPeriodResult	increaseStreamRetentionPeriod(IncreaseStreamRetentionPeriodRequest increaseStreamRetentionPeriodRequest)
ListStreamsResult	listStreams()
ListStreamsResult	listStreams(java.lang.Integer limit, java.lang.String exclusiveStartStreamName)
ListStreamsResult	listStreams(ListStreamsRequest listStreamsRequest)
ListStreamsResult	listStreams(java.lang.String exclusiveStartStreamName)
ListTagsForStreamResult	listTagsForStream(ListTagsForStreamRequest listTagsForStreamRequest)
MergeShardsResult	mergeShards(MergeShardsRequest mergeShardsRequest)
MergeShardsResult	mergeShards(java.lang.String streamName, java.lang.String shardToMerge, java.lang.String adjacentShardToMerge)
PutRecordResult	putRecord(PutRecordRequest putRecordRequest)
PutRecordResult	putRecord(java.lang.String streamName, java.nio.ByteBuffer data, java.lang.String partitionKey)
PutRecordResult	putRecord(java.lang.String streamName, java.nio.ByteBuffer data, java.lang.String partitionKey, java.lang.String sequenceNumberForOrdering)
PutRecordsResult	putRecords(PutRecordsRequest putRecordsRequest)
RemoveTagsFromStreamResult	removeTagsFromStream(RemoveTagsFromStreamRequest removeTagsFromStreamRequest)
void	setEndpoint(java.lang.String endpoint) Overrides the default endpoint for this client.
void	setGenerateRecordBytes(boolean generateRecordBytes) Determines RecordAdapter behavior when RecordAdapter::getData() is called.
void	setRegion(Region region) Sets the regional endpoint for this client's service calls.
void	setSkipRecordsBehavior(AmazonDynamoDBStreamsAdapterClient.SkipRecordsBehavior skipRecordsBehavior) Sets a value of AmazonDynamoDBStreamsAdapterClient.SkipRecordsBehavior to decide how the application handles the case when records are lost.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
SplitShardResult	splitShard(SplitShardRequest splitShardRequest)
SplitShardResult	splitShard(java.lang.String streamName, java.lang.String shardToSplit, java.lang.String newStartingHashKey)

Methods inherited from class com.amazonaws.services.kinesis.AbstractAmazonKinesis

describeLimits, disableEnhancedMonitoring, enableEnhancedMonitoring, updateShardCount, waiters

Methods inherited from class java.lang.Object

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

Field Detail

GET_RECORDS_LIMIT

public static final java.lang.Integer GET_RECORDS_LIMIT

Constructor Detail

AmazonDynamoDBStreamsAdapterClient

public AmazonDynamoDBStreamsAdapterClient()

Constructs a new client to invoke service methods on DynamoDB Streams.

AmazonDynamoDBStreamsAdapterClient

public AmazonDynamoDBStreamsAdapterClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on DynamoDB Streams.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to DynamoDB Streams (ex: proxy settings, retry counts, etc.).

AmazonDynamoDBStreamsAdapterClient

public AmazonDynamoDBStreamsAdapterClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on DynamoDB Streams.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonDynamoDBStreamsAdapterClient

public AmazonDynamoDBStreamsAdapterClient(AWSCredentials awsCredentials,
                                  ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on DynamoDB Streams.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to DynamoDB Streams (ex: proxy settings, retry counts, etc.).

AmazonDynamoDBStreamsAdapterClient

public AmazonDynamoDBStreamsAdapterClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on DynamoDB Streams.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonDynamoDBStreamsAdapterClient

public AmazonDynamoDBStreamsAdapterClient(AWSCredentialsProvider awsCredentialsProvider,
                                  ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on DynamoDB Streams.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to DynamoDB Streams (ex: proxy settings, retry counts, etc.).

AmazonDynamoDBStreamsAdapterClient

public AmazonDynamoDBStreamsAdapterClient(AWSCredentialsProvider awsCredentialsProvider,
                                  ClientConfiguration clientConfiguration,
                                  RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on DynamoDB Streams.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to DynamoDB Streams (ex: proxy settings, retry counts, etc.).

requestMetricCollector - Optional request metric collector

AmazonDynamoDBStreamsAdapterClient

public AmazonDynamoDBStreamsAdapterClient(AmazonDynamoDBStreams amazonDynamoDBStreams)

Recommended constructor for AmazonDynamoDBStreamsAdapterClient which takes in an AmazonDynamoDBStreams interface. If you need to execute setEndpoint(String,String,String) or setServiceNameIntern() methods, you should do that on AmazonDynamoDBStreamsClient implementation before passing it in this constructor.

Parameters:

amazonDynamoDBStreams - The DynamoDB Streams to be used internally

Method Detail

setEndpoint

public void setEndpoint(java.lang.String endpoint)

Overrides the default endpoint for this client. Callers can use this method to control which AWS region they want to work with.

Specified by:

setEndpoint in interface AmazonKinesis

Overrides:

setEndpoint in class AbstractAmazonKinesis

Parameters:

endpoint - The region specific AWS endpoint this client will communicate with.

setRegion

public void setRegion(Region region)

Sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

Specified by:

setRegion in interface AmazonKinesis

Overrides:

setRegion in class AbstractAmazonKinesis

setGenerateRecordBytes

public void setGenerateRecordBytes(boolean generateRecordBytes)

Determines RecordAdapter behavior when RecordAdapter::getData() is called. This method should usually be called immediately after instantiating this client. If this method is called from one thread while a GetRecords call is in progress on another thread then the behavior will be non-deterministic.

Parameters:

generateRecordBytes - Whether or not to generate the ByteBuffer returned by RecordAdapter::getData(). KCL uses the bytes returned by getData to generate throughput metrics. If these metrics are not needed then choosing to not generate this data results in memory and CPU savings. If this value is true then the data will be generated and KCL will generate a correct throughput metric. If this is false, getData() will return an empty ByteBuffer and the KCL metric will always be zero.

describeStream

public DescribeStreamResult describeStream(DescribeStreamRequest describeStreamRequest)

Specified by:

describeStream in interface AmazonKinesis

Overrides:

describeStream in class AbstractAmazonKinesis

Parameters:

describeStreamRequest - Container for the necessary parameters to execute the DescribeStream service method on DynamoDB Streams.

Returns:

The response from the DescribeStream service method, adapted for use with the AmazonKinesis model.

describeStream

public DescribeStreamResult describeStream(java.lang.String streamName)

Specified by:

describeStream in interface AmazonKinesis

Overrides:

describeStream in class AbstractAmazonKinesis

Parameters:

streamName - The ID of the stream to describe.

Returns:

The response from the DescribeStream service method, adapted for use with the AmazonKinesis model.

describeStream

public DescribeStreamResult describeStream(java.lang.String streamName,
                                  java.lang.String exclusiveStartShardId)

Specified by:

describeStream in interface AmazonKinesis

Overrides:

describeStream in class AbstractAmazonKinesis

Parameters:

streamName - The ID of the stream to describe.

exclusiveStartShardId - The shard ID of the shard to start with for the stream description.

Returns:

The response from the DescribeStream service method, adapted for use with the AmazonKinesis model.

describeStream

public DescribeStreamResult describeStream(java.lang.String streamName,
                                  java.lang.Integer limit,
                                  java.lang.String exclusiveStartShardId)

Specified by:

describeStream in interface AmazonKinesis

Overrides:

describeStream in class AbstractAmazonKinesis

Parameters:

streamName - The ID of the stream to describe.

limit - The maximum number of shards to return.

exclusiveStartShardId - The shard ID of the shard to start with for the stream description.

Returns:

The response from the DescribeStream service method, adapted for use with the AmazonKinesis model.

getShardIterator

public GetShardIteratorResult getShardIterator(GetShardIteratorRequest getShardIteratorRequest)

Specified by:

getShardIterator in interface AmazonKinesis

Overrides:

getShardIterator in class AbstractAmazonKinesis

Parameters:

getShardIteratorRequest - Container for the necessary parameters to execute the GetShardIterator service method on DynamoDB Streams.

Returns:

The response from the GetShardIterator service method, adapted for use with the AmazonKinesis model.

getShardIterator

public GetShardIteratorResult getShardIterator(java.lang.String streamName,
                                      java.lang.String shardId,
                                      java.lang.String shardIteratorType)

Specified by:

getShardIterator in interface AmazonKinesis

Overrides:

getShardIterator in class AbstractAmazonKinesis

Parameters:

streamName - The ID of the stream.

shardId - The shard ID of the shard to get the iterator for

shardIteratorType - Determines how the shard iterator is used to start reading data records from the shard.

Returns:

The response from the GetShardIterator service method, adapted for use with the AmazonKinesis model.

getShardIterator

public GetShardIteratorResult getShardIterator(java.lang.String streamName,
                                      java.lang.String shardId,
                                      java.lang.String shardIteratorType,
                                      java.lang.String startingSequenceNumber)

Specified by:

getShardIterator in interface AmazonKinesis

Overrides:

getShardIterator in class AbstractAmazonKinesis

Parameters:

streamName - The ID of the stream.

shardId - The shard ID of the shard to get the iterator for

shardIteratorType - Determines how the shard iterator is used to start reading data records from the shard.

startingSequenceNumber - The sequence number of the data record in the shard from which to start reading from.

Returns:

The response from the GetShardIterator service method, adapted for use with the AmazonKinesis model.

putRecord

public PutRecordResult putRecord(PutRecordRequest putRecordRequest)

Specified by:

putRecord in interface AmazonKinesis

Overrides:

putRecord in class AbstractAmazonKinesis

putRecord

public PutRecordResult putRecord(java.lang.String streamName,
                        java.nio.ByteBuffer data,
                        java.lang.String partitionKey)

Specified by:

putRecord in interface AmazonKinesis

Overrides:

putRecord in class AbstractAmazonKinesis

putRecord

public PutRecordResult putRecord(java.lang.String streamName,
                        java.nio.ByteBuffer data,
                        java.lang.String partitionKey,
                        java.lang.String sequenceNumberForOrdering)

Specified by:

putRecord in interface AmazonKinesis

Overrides:

putRecord in class AbstractAmazonKinesis

putRecords

public PutRecordsResult putRecords(PutRecordsRequest putRecordsRequest)

Specified by:

putRecords in interface AmazonKinesis

Overrides:

putRecords in class AbstractAmazonKinesis

getRecords

public GetRecordsResult getRecords(GetRecordsRequest getRecordsRequest)

Specified by:

getRecords in interface AmazonKinesis

Overrides:

getRecords in class AbstractAmazonKinesis

Parameters:

getRecordsRequest - Container for the necessary parameters to execute the GetRecords service method on DynamoDB Streams.

Returns:

The response from the GetRecords service method, adapted for use with the AmazonKinesis model.

splitShard

public SplitShardResult splitShard(SplitShardRequest splitShardRequest)

Specified by:

splitShard in interface AmazonKinesis

Overrides:

splitShard in class AbstractAmazonKinesis

splitShard

public SplitShardResult splitShard(java.lang.String streamName,
                          java.lang.String shardToSplit,
                          java.lang.String newStartingHashKey)

Specified by:

splitShard in interface AmazonKinesis

Overrides:

splitShard in class AbstractAmazonKinesis

createStream

public CreateStreamResult createStream(CreateStreamRequest createStreamRequest)

Specified by:

createStream in interface AmazonKinesis

Overrides:

createStream in class AbstractAmazonKinesis

createStream

public CreateStreamResult createStream(java.lang.String streamName,
                              java.lang.Integer shardCount)

Specified by:

createStream in interface AmazonKinesis

Overrides:

createStream in class AbstractAmazonKinesis

deleteStream

public DeleteStreamResult deleteStream(DeleteStreamRequest deleteStreamRequest)

Specified by:

deleteStream in interface AmazonKinesis

Overrides:

deleteStream in class AbstractAmazonKinesis

deleteStream

public DeleteStreamResult deleteStream(java.lang.String streamName)

Specified by:

deleteStream in interface AmazonKinesis

Overrides:

deleteStream in class AbstractAmazonKinesis

listStreams

public ListStreamsResult listStreams(ListStreamsRequest listStreamsRequest)

Specified by:

listStreams in interface AmazonKinesis

Overrides:

listStreams in class AbstractAmazonKinesis

Parameters:

listStreamsRequest - Container for the necessary parameters to execute the ListStreams service method on DynamoDB Streams.

Returns:

The response from the ListStreams service method, adapted for use with the AmazonKinesis model.

listStreams

public ListStreamsResult listStreams()

Specified by:

listStreams in interface AmazonKinesis

Overrides:

listStreams in class AbstractAmazonKinesis

Returns:

The response from the ListStreams service method, adapted for use with the AmazonKinesis model.

listStreams

public ListStreamsResult listStreams(java.lang.String exclusiveStartStreamName)

Specified by:

listStreams in interface AmazonKinesis

Overrides:

listStreams in class AbstractAmazonKinesis

Parameters:

exclusiveStartStreamName - The name of the stream to start the list with.

Returns:

The response from the ListStreams service method, adapted for use with the AmazonKinesis model.

listStreams

public ListStreamsResult listStreams(java.lang.Integer limit,
                            java.lang.String exclusiveStartStreamName)

Specified by:

listStreams in interface AmazonKinesis

Overrides:

listStreams in class AbstractAmazonKinesis

Parameters:

limit - The maximum number of streams to list.

exclusiveStartStreamName - The name of the stream to start the list with.

Returns:

The response from the ListStreams service method, adapted for use with the AmazonKinesis model.

mergeShards

public MergeShardsResult mergeShards(MergeShardsRequest mergeShardsRequest)

Specified by:

mergeShards in interface AmazonKinesis

Overrides:

mergeShards in class AbstractAmazonKinesis

mergeShards

public MergeShardsResult mergeShards(java.lang.String streamName,
                            java.lang.String shardToMerge,
                            java.lang.String adjacentShardToMerge)

Specified by:

mergeShards in interface AmazonKinesis

Overrides:

mergeShards in class AbstractAmazonKinesis

addTagsToStream

public AddTagsToStreamResult addTagsToStream(AddTagsToStreamRequest addTagsToStreamRequest)

Specified by:

addTagsToStream in interface AmazonKinesis

Overrides:

addTagsToStream in class AbstractAmazonKinesis

listTagsForStream

public ListTagsForStreamResult listTagsForStream(ListTagsForStreamRequest listTagsForStreamRequest)

Specified by:

listTagsForStream in interface AmazonKinesis

Overrides:

listTagsForStream in class AbstractAmazonKinesis

removeTagsFromStream

public RemoveTagsFromStreamResult removeTagsFromStream(RemoveTagsFromStreamRequest removeTagsFromStreamRequest)

Specified by:

removeTagsFromStream in interface AmazonKinesis

Overrides:

removeTagsFromStream in class AbstractAmazonKinesis

shutdown

public void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonKinesis

Overrides:

shutdown in class AbstractAmazonKinesis

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Specified by:

getCachedResponseMetadata in interface AmazonKinesis

Overrides:

getCachedResponseMetadata in class AbstractAmazonKinesis

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.

getSkipRecordsBehavior

public AmazonDynamoDBStreamsAdapterClient.SkipRecordsBehavior getSkipRecordsBehavior()

Gets the value of AmazonDynamoDBStreamsAdapterClient.SkipRecordsBehavior.

Returns:

The value of AmazonDynamoDBStreamsAdapterClient.SkipRecordsBehavior

setSkipRecordsBehavior

public void setSkipRecordsBehavior(AmazonDynamoDBStreamsAdapterClient.SkipRecordsBehavior skipRecordsBehavior)

Sets a value of AmazonDynamoDBStreamsAdapterClient.SkipRecordsBehavior to decide how the application handles the case when records are lost. Default = AmazonDynamoDBStreamsAdapterClient.SkipRecordsBehavior.SKIP_RECORDS_TO_TRIM_HORIZON

Parameters:

skipRecordsBehavior - A AmazonDynamoDBStreamsAdapterClient.SkipRecordsBehavior for the adapter

decreaseStreamRetentionPeriod

public DecreaseStreamRetentionPeriodResult decreaseStreamRetentionPeriod(DecreaseStreamRetentionPeriodRequest decreaseStreamRetentionPeriodRequest)

Specified by:

decreaseStreamRetentionPeriod in interface AmazonKinesis

Overrides:

decreaseStreamRetentionPeriod in class AbstractAmazonKinesis

increaseStreamRetentionPeriod

public IncreaseStreamRetentionPeriodResult increaseStreamRetentionPeriod(IncreaseStreamRetentionPeriodRequest increaseStreamRetentionPeriodRequest)

Specified by:

increaseStreamRetentionPeriod in interface AmazonKinesis

Overrides:

increaseStreamRetentionPeriod in class AbstractAmazonKinesis