interface CfnChannelProps

Language	Type name
.NET	Amazon.CDK.AWS.MSK.CfnChannelProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsmsk#CfnChannelProps
Java	software.amazon.awscdk.services.msk.CfnChannelProps
Python	aws_cdk.aws_msk.CfnChannelProps
TypeScript	aws-cdk-lib » aws_msk » CfnChannelProps

Properties for defining a CfnChannel.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html

Example

// 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	Type	Description
channelName	string	Name of the channel.
topicConfigurationList	IResolvable | (IResolvable | TopicConfigurationProperty)[]	Topic configuration.
clusterArn?	string	The Amazon Resource Name (ARN) of the cluster.
encryptionConfiguration?	IResolvable | EncryptionConfigurationProperty	Encryption configuration.
icebergDestinationConfiguration?	IResolvable | IcebergDestinationConfigurationProperty	Iceberg destination configuration.
loggingInfo?	IResolvable | ChannelLoggingInfoProperty	Log configuration details for Channel.
s3DestinationConfiguration?	IResolvable | S3DestinationConfigurationProperty	S3 destination configuration.
tags?	{ [string]: string }	Tags attached to the channel.

---

channelName

Type: string

Name of the channel.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html#cfn-msk-channel-channelname

---

topicConfigurationList

Type: IResolvable | (IResolvable | TopicConfigurationProperty)[]

Topic configuration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html#cfn-msk-channel-topicconfigurationlist

---

clusterArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the cluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html#cfn-msk-channel-clusterarn

---

encryptionConfiguration?

Type: IResolvable | EncryptionConfigurationProperty (optional)

Encryption configuration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html#cfn-msk-channel-encryptionconfiguration

---

icebergDestinationConfiguration?

Type: IResolvable | IcebergDestinationConfigurationProperty (optional)

Iceberg destination configuration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html#cfn-msk-channel-icebergdestinationconfiguration

---

loggingInfo?

Type: IResolvable | ChannelLoggingInfoProperty (optional)

Log configuration details for Channel.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html#cfn-msk-channel-logginginfo

---

s3DestinationConfiguration?

Type: IResolvable | S3DestinationConfigurationProperty (optional)

S3 destination configuration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html#cfn-msk-channel-s3destinationconfiguration

---

tags?

Type: { [string]: string } (optional)

Tags attached to the channel.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html#cfn-msk-channel-tags