kinesis_streaming_destinations

Creates, updates, deletes, gets or lists a kinesis_streaming_destinations resource.

Overview

Name	kinesis_streaming_destinations
Type	Resource
Id	aws.dynamodb.kinesis_streaming_destinations

Fields

The following fields are returned by SELECT queries:

describe_kinesis_streaming_destination

Name	Datatype	Description
kinesis_data_stream_destinations	array	The list of replica structures for the table being described.
table_name	string	The name of the table being described. (pattern: <code>[a-zA-Z0-9_.-]+</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_kinesis_streaming_destination	select	region		Returns information about the status of Kinesis streaming.
update_kinesis_streaming_destination	update	region, TableName, StreamArn		The command to update the Kinesis stream destination.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_kinesis_streaming_destination

Returns information about the status of Kinesis streaming.

SELECT
kinesis_data_stream_destinations,
table_name
FROM aws.dynamodb.kinesis_streaming_destinations
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_kinesis_streaming_destination

The command to update the Kinesis stream destination.

UPDATE aws.dynamodb.kinesis_streaming_destinations
SET 
TableName = '{{ TableName }}',
StreamArn = '{{ StreamArn }}',
UpdateKinesisStreamingConfiguration = '{{ UpdateKinesisStreamingConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND TableName = '{{ TableName }}' --required
AND StreamArn = '{{ StreamArn }}' --required
RETURNING
destination_status,
stream_arn,
table_name,
update_kinesis_streaming_configuration;