AWS::MSK::Channel

MSK Channel

Resource Type definition for AWS::MSK::Channel

Properties

8 configurable properties. 2 required. Click a row to see details.

Filter:
PropertyTypeFlags
ChannelName
string
RequiredCreate-only
TopicConfigurationList
Array<TopicConfiguration>
RequiredCreate-only
ClusterArn
string
Create-onlyWrite-only
EncryptionConfiguration
EncryptionConfiguration
Create-only
IcebergDestinationConfiguration
IcebergDestinationConfiguration
LoggingInfo
ChannelLoggingInfo
Create-only
S3DestinationConfiguration
S3DestinationConfiguration
Tags
Tags

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
ChannelArnstringThe Amazon Resource Name (ARN) that uniquely identifies the channel
StateInfoChannelStateInfo-
Statusstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::MSK::Channel

Resources:
  MyResource:
    Type: AWS::MSK::Channel
    Properties:
      ChannelName: "my-channelname"
      TopicConfigurationList: []
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

kafka:CreateChannelkafka:DescribeChannelkafka:TagResourcedynamodb:DescribeTabledynamodb:PutItemdynamodb:TagResourcestepfunctions:DescribeStateMachinestepfunctions:StartExecutionstepfunctions:TagResourceiam:PassRolekms:DescribeKeyglue:CreateTableglue:GetTableglue:GetDatabases3:GetBucketLocations3:GetBucketPolicys3:PutBucketPolicys3:ListBuckets3:PutObjects3:GetObjectlogs:CreateLogGrouplogs:CreateLogStreamlogs:PutLogEventslogs:DescribeLogGroupslogs:CreateLogDeliverylogs:GetLogDeliverylogs:UpdateLogDeliverylogs:ListLogDeliverieslogs:PutResourcePolicylogs:DescribeResourcePoliciesfirehose:DescribeDeliveryStreamfirehose:PutRecordfirehose:PutRecordBatchfirehose:TagDeliveryStreamiam:CreateServiceLinkedRoleiam:GetRoleiam:AttachRolePolicyiam:PutRolePolicy

read

kafka:DescribeChannelkafka:ListTagsForResourcekms:DescribeKey

update

kafka:UpdateChannelkafka:DescribeChannelkafka:TagResourcekafka:UntagResourcekms:DescribeKey

delete

kafka:DeleteChannelkafka:DescribeChanneldynamodb:DescribeTablestepfunctions:DescribeStateMachinestepfunctions:StopExecutionlogs:ListLogDeliverieslogs:DeleteLogDeliverykms:DescribeKey

list

kafka:ListChannelskms:DescribeKey

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceMSK
Properties11
Required2
TaggingSupported
Primary IDChannelArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

ChannelNameClusterArnTopicConfigurationListEncryptionConfigurationLoggingInfoIcebergDestinationConfiguration/ServiceExecutionRoleArnIcebergDestinationConfiguration/CatalogIcebergDestinationConfiguration/Catalog/CatalogArnIcebergDestinationConfiguration/Catalog/WarehouseLocationIcebergDestinationConfiguration/DeadLetterQueueS3IcebergDestinationConfiguration/DeadLetterQueueS3/BucketArnIcebergDestinationConfiguration/DeadLetterQueueS3/ErrorOutputPrefixIcebergDestinationConfiguration/DeadLetterQueueS3/ExpectedBucketOwnerIcebergDestinationConfiguration/AppendOnlyIcebergDestinationConfiguration/SchemaEvolutionIcebergDestinationConfiguration/SchemaEvolution/EnableSchemaEvolutionIcebergDestinationConfiguration/TableCreationIcebergDestinationConfiguration/TableCreation/EnableTableCreationIcebergDestinationConfiguration/DestinationTableListIcebergDestinationConfiguration/DestinationTableList/*/DestinationDatabaseNameIcebergDestinationConfiguration/DestinationTableList/*/DestinationTableNameIcebergDestinationConfiguration/DestinationTableList/*/PartitionSpecIcebergDestinationConfiguration/DestinationTableList/*/PartitionSpec/PartitionStrategyIcebergDestinationConfiguration/DestinationTableList/*/PartitionSpec/SourceListIcebergDestinationConfiguration/DestinationTableList/*/PartitionSpec/SourceList/*/SourceNameIcebergDestinationConfiguration/CompressionTypeS3DestinationConfiguration/ServiceExecutionRoleArnS3DestinationConfiguration/DeadLetterQueueS3S3DestinationConfiguration/DeadLetterQueueS3/BucketArnS3DestinationConfiguration/DeadLetterQueueS3/ErrorOutputPrefixS3DestinationConfiguration/DeadLetterQueueS3/ExpectedBucketOwnerS3DestinationConfiguration/StorageS3DestinationConfiguration/Storage/BucketArnS3DestinationConfiguration/Storage/OutputPrefixS3DestinationConfiguration/Storage/OutputKeyTemplateS3DestinationConfiguration/Storage/StorageClassS3DestinationConfiguration/Storage/CompressionTypeS3DestinationConfiguration/Storage/ExpectedBucketOwner

Related Resources

External Links