streams

Creates, updates, deletes or gets a stream resource or lists streams in a region

Overview

Name	streams
Type	Resource
Description	Resource Type definition for AWS::Kinesis::Stream
Id	awscc.kinesis.streams

Fields

Name	Datatype	Description
arn	string	The Amazon resource name (ARN) of the Kinesis stream
name	string	The name of the Kinesis stream.
desired_shard_level_metrics	array	The final list of shard-level metrics
retention_period_hours	integer	The number of hours for the data records that are stored in shards to remain accessible.
shard_count	integer	The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.
▶stream_mode_details	object	The mode in which the stream is running.
▶stream_encryption	object	When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
▶tags	array	An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.
region	string	AWS region.

For more information, see AWS::Kinesis::Stream.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual stream.

SELECT
region,
arn,
name,
desired_shard_level_metrics,
retention_period_hours,
shard_count,
stream_mode_details,
stream_encryption,
tags
FROM awscc.kinesis.streams
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

Use the following StackQL query and manifest file to create a new stream resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.kinesis.streams (
 Name,
 DesiredShardLevelMetrics,
 RetentionPeriodHours,
 ShardCount,
 StreamModeDetails,
 StreamEncryption,
 Tags,
 region
)
SELECT 
'{{ Name }}',
 '{{ DesiredShardLevelMetrics }}',
 '{{ RetentionPeriodHours }}',
 '{{ ShardCount }}',
 '{{ StreamModeDetails }}',
 '{{ StreamEncryption }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.kinesis.streams (
 Name,
 DesiredShardLevelMetrics,
 RetentionPeriodHours,
 ShardCount,
 StreamModeDetails,
 StreamEncryption,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ DesiredShardLevelMetrics }}',
 '{{ RetentionPeriodHours }}',
 '{{ ShardCount }}',
 '{{ StreamModeDetails }}',
 '{{ StreamEncryption }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: stream
    props:
      - name: Name
        value: '{{ Name }}'
      - name: DesiredShardLevelMetrics
        value:
          - '{{ DesiredShardLevelMetrics[0] }}'
      - name: RetentionPeriodHours
        value: '{{ RetentionPeriodHours }}'
      - name: ShardCount
        value: '{{ ShardCount }}'
      - name: StreamModeDetails
        value:
          StreamMode: '{{ StreamMode }}'
      - name: StreamEncryption
        value:
          EncryptionType: '{{ EncryptionType }}'
          KeyId: '{{ KeyId }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'

DELETE example

/*+ delete */
DELETE FROM awscc.kinesis.streams
WHERE data__Identifier = '<Name>'
AND region = 'us-east-1';

Permissions

To operate on the streams resource, the following permissions are required:

Create

kinesis:EnableEnhancedMonitoring,
kinesis:DescribeStreamSummary,
kinesis:CreateStream,
kinesis:IncreaseStreamRetentionPeriod,
kinesis:StartStreamEncryption,
kinesis:AddTagsToStream,
kinesis:ListTagsForStream,
kinesis:ListTagsForResource

Read

kinesis:DescribeStreamSummary,
kinesis:ListTagsForStream,
kinesis:ListTagsForResource

Update

kinesis:EnableEnhancedMonitoring,
kinesis:DisableEnhancedMonitoring,
kinesis:DescribeStreamSummary,
kinesis:UpdateShardCount,
kinesis:UpdateStreamMode,
kinesis:IncreaseStreamRetentionPeriod,
kinesis:DecreaseStreamRetentionPeriod,
kinesis:StartStreamEncryption,
kinesis:StopStreamEncryption,
kinesis:AddTagsToStream,
kinesis:TagResource,
kinesis:RemoveTagsFromStream,
kinesis:UntagResource,
kinesis:ListTagsForStream,
kinesis:ListTagsForResource

Delete

kinesis:DescribeStreamSummary,
kinesis:DeleteStream,
kinesis:RemoveTagsFromStream,
kinesis:UntagResource

List

kinesis:ListStreams