CfnChannelProps Struct
Properties for defining a CfnChannel.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_msk as msk } from 'aws-cdk-lib';
const cfnChannelProps: msk.CfnChannelProps = {
channelName: 'channelName',
topicConfigurationList: [{
recordConverter: {
valueConverter: 'valueConverter',
},
topicArn: 'topicArn',
// the properties below are optional
recordSchema: {
gsrArn: 'gsrArn',
},
}],
// the properties below are optional
clusterArn: 'clusterArn',
encryptionConfiguration: {
kmsKeyArn: 'kmsKeyArn',
},
icebergDestinationConfiguration: {
appendOnly: false,
deadLetterQueueS3: {
bucketArn: 'bucketArn',
errorOutputPrefix: 'errorOutputPrefix',
// the properties below are optional
expectedBucketOwner: 'expectedBucketOwner',
},
destinationTableList: [{
destinationDatabaseName: 'destinationDatabaseName',
destinationTableName: 'destinationTableName',
// the properties below are optional
partitionSpec: {
partitionStrategy: 'partitionStrategy',
// the properties below are optional
sourceList: [{
sourceName: 'sourceName',
}],
},
}],
schemaEvolution: {
enableSchemaEvolution: false,
},
serviceExecutionRoleArn: 'serviceExecutionRoleArn',
tableCreation: {
enableTableCreation: false,
},
// the properties below are optional
catalog: {
catalogArn: 'catalogArn',
warehouseLocation: 'warehouseLocation',
},
compressionType: 'compressionType',
dataFreshnessInSeconds: 123,
},
loggingInfo: {
cloudWatchLogs: {
enabled: false,
// the properties below are optional
logGroup: 'logGroup',
},
firehose: {
enabled: false,
// the properties below are optional
deliveryStream: 'deliveryStream',
},
s3: {
enabled: false,
// the properties below are optional
bucket: 'bucket',
prefix: 'prefix',
},
},
s3DestinationConfiguration: {
deadLetterQueueS3: {
bucketArn: 'bucketArn',
errorOutputPrefix: 'errorOutputPrefix',
// the properties below are optional
expectedBucketOwner: 'expectedBucketOwner',
},
serviceExecutionRoleArn: 'serviceExecutionRoleArn',
storage: {
bucketArn: 'bucketArn',
compressionType: 'compressionType',
storageClass: 'storageClass',
// the properties below are optional
expectedBucketOwner: 'expectedBucketOwner',
outputKeyTemplate: 'outputKeyTemplate',
outputPrefix: 'outputPrefix',
},
// the properties below are optional
dataFreshnessInSeconds: 123,
},
tags: {
tagsKey: 'tags',
},
};
Properties
Name of the channel.
clusterArnoptionalstringcluster_arnoptionalstrclusterArnoptionalStringClusterArnoptionalstringClusterArnoptional*string#The Amazon Resource Name (ARN) of the cluster.
encryptionConfigurationoptionalIResolvable | CfnChannel.EncryptionConfigurationPropertyencryption_configurationoptionaltyping.Union[IResolvable, EncryptionConfigurationProperty]encryptionConfigurationoptionalIResolvableEncryptionConfigurationoptionalIResolvableEncryptionConfigurationoptionalinterface{}#Encryption configuration.
icebergDestinationConfigurationoptionalIResolvable | CfnChannel.IcebergDestinationConfigurationPropertyiceberg_destination_configurationoptionaltyping.Union[IResolvable, IcebergDestinationConfigurationProperty]icebergDestinationConfigurationoptionalIResolvableIcebergDestinationConfigurationoptionalIResolvableIcebergDestinationConfigurationoptionalinterface{}#Iceberg destination configuration.
loggingInfooptionalIResolvable | CfnChannel.ChannelLoggingInfoPropertylogging_infooptionaltyping.Union[IResolvable, ChannelLoggingInfoProperty]loggingInfooptionalIResolvableLoggingInfooptionalIResolvableLoggingInfooptionalinterface{}#Log configuration details for Channel.
s3DestinationConfigurationoptionalIResolvable | CfnChannel.S3DestinationConfigurationPropertys3_destination_configurationoptionaltyping.Union[IResolvable, S3DestinationConfigurationProperty]s3DestinationConfigurationoptionalIResolvableS3DestinationConfigurationoptionalIResolvableS3DestinationConfigurationoptionalinterface{}#S3 destination configuration.
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#Tags attached to the channel.
topicConfigurationListIResolvable | IResolvable | CfnChannel.TopicConfigurationProperty[]topic_configuration_listtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TopicConfigurationProperty]]]topicConfigurationListIResolvableTopicConfigurationListIResolvableTopicConfigurationListinterface{}required#Topic configuration.