AWS::Kinesis::ChannelResource Type definition for AWS::Kinesis::Channel
8 configurable properties. 3 required. Click a row to see details.
| Property | Type | Flags |
|---|---|---|
ChannelName | string | RequiredCreate-only |
ServiceExecutionRoleARN | string | RequiredCreate-only |
StreamConfigurationList | Array<StreamConfiguration> | RequiredCreate-only |
EncryptionConfiguration | EncryptionConfiguration | Create-only |
LoggingConfiguration | LoggingConfiguration | |
S3DestinationConfiguration | S3DestinationConfiguration | |
S3TablesDestinationConfiguration | S3TablesDestinationConfiguration | |
Tags | Array<Tag> |
Values returned after the resource is created. Access these with Fn::GetAtt.
| Attribute | Type | Description |
|---|---|---|
ChannelARN | string | The ARN of the channel. |
ChannelCreationTimestamp | string | Timestamp of when the channel was created. |
ChannelId | string | The service-generated unique identifier for the channel. |
ChannelStatus | string | The status of the channel. |
A minimal template with required properties and common optional ones.
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Kinesis::Channel
Resources:
MyResource:
Type: AWS::Kinesis::Channel
Properties:
ChannelName: "my-channelname"
ServiceExecutionRoleARN: "arn:aws:service:region:account:resource"
StreamConfigurationList: []
Tags:
- Key: Environment
Value: ProductionPermissions CloudFormation needs in your IAM role to manage this resource.
kinesis:DescribeChannelkinesis:ListTagsForResourcekinesis:CreateChannelkinesis:DescribeChannelkinesis:AssociateStreamsWithChannelkinesis:TagResourcekinesis:ListTagsForResourceiam:PassRolekinesis:UpdateChannelkinesis:DescribeChannelkinesis:TagResourcekinesis:UntagResourcekinesis:ListTagsForResourcekinesis:ListChannelskinesis:DeleteChannelkinesis:DescribeChannelOur bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterChannelARNThese properties cannot be changed after the resource is created. Updating them triggers a replacement.
ChannelNameServiceExecutionRoleARNStreamConfigurationListEncryptionConfigurationS3DestinationConfiguration/StorageConfigurationS3DestinationConfiguration/DeadLetterQueueS3ConfigurationS3TablesDestinationConfiguration/S3TablesConfigurationListS3TablesDestinationConfiguration/DeadLetterQueueS3Configuration