interface CfnChannelProps

Language	Type name
.NET	`Amazon.CDK.AWS.Kinesis.CfnChannelProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awskinesis#CfnChannelProps`
Java	`software.amazon.awscdk.services.kinesis.CfnChannelProps`
Python	`aws_cdk.aws_kinesis.CfnChannelProps`
TypeScript	`aws-cdk-lib` » `aws_kinesis` » `CfnChannelProps`

Properties for defining a CfnChannel.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kinesis as kinesis } from 'aws-cdk-lib';
const cfnChannelProps: kinesis.CfnChannelProps = {
  channelName: 'channelName',
  serviceExecutionRoleArn: 'serviceExecutionRoleArn',
  streamConfigurationList: [{
    recordConfiguration: {
      recordFormatType: 'recordFormatType',

      // the properties below are optional
      gsrSchemaArn: 'gsrSchemaArn',
    },
    streamArn: 'streamArn',
  }],

  // the properties below are optional
  encryptionConfiguration: {
    encryptionType: 'encryptionType',
    keyId: 'keyId',
  },
  loggingConfiguration: {
    cloudWatchLogs: {
      enabled: false,

      // the properties below are optional
      logGroupName: 'logGroupName',
      logStreamName: 'logStreamName',
    },
  },
  s3DestinationConfiguration: {
    storageConfiguration: {
      bucketArn: 'bucketArn',
      compressionType: 'compressionType',
      expectedBucketOwner: 'expectedBucketOwner',

      // the properties below are optional
      outputKeyTemplate: 'outputKeyTemplate',
      storageClass: 'storageClass',
    },

    // the properties below are optional
    dataFreshnessInSeconds: 123,
    deadLetterQueueS3Configuration: {
      bucketArn: 'bucketArn',
      expectedBucketOwner: 'expectedBucketOwner',

      // the properties below are optional
      errorOutputPrefix: 'errorOutputPrefix',
    },
  },
  s3TablesDestinationConfiguration: {
    deadLetterQueueS3Configuration: {
      bucketArn: 'bucketArn',
      expectedBucketOwner: 'expectedBucketOwner',

      // the properties below are optional
      errorOutputPrefix: 'errorOutputPrefix',
    },
    s3TablesConfigurationList: [{
      compressionType: 'compressionType',
      namespace: 'namespace',
      tableBucketArn: 'tableBucketArn',
      tableName: 'tableName',

      // the properties below are optional
      partitionSpec: {
        partitionFields: [{
          sourceName: 'sourceName',
          transform: 'transform',
        }],
      },
    }],

    // the properties below are optional
    dataFreshnessInSeconds: 123,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
channelName	`string`	The name of the channel.
serviceExecutionRoleArn	`string`	The ARN of the IAM role that the channel assumes to read from the source stream, deliver records to the destination, and (when enabled) write CloudWatch Logs.
streamConfigurationList	`IResolvable` `\| (IResolvable` `\|` `StreamConfigurationProperty)[]`	List of stream configurations associated with the channel.
encryptionConfiguration?	`IResolvable` `\|` `EncryptionConfigurationProperty`	Server-side encryption configuration for data at rest in the destination.
loggingConfiguration?	`IResolvable` `\|` `LoggingConfigurationProperty`	Configuration for delivering channel operational logs.
s3DestinationConfiguration?	`IResolvable` `\|` `S3DestinationConfigurationProperty`	Configuration for delivery to a vanilla S3 bucket destination.
s3TablesDestinationConfiguration?	`IResolvable` `\|` `S3TablesDestinationConfigurationProperty`	Configuration for delivery to S3 Tables destinations.
tags?	`CfnTag[]`	An arbitrary set of tags (key-value pairs) to associate with the Kinesis channel.

channelName

Type: string

The name of the channel.

The name's uniqueness is scoped per AWS account and region.

serviceExecutionRoleArn

Type: string

The ARN of the IAM role that the channel assumes to read from the source stream, deliver records to the destination, and (when enabled) write CloudWatch Logs.

streamConfigurationList

Type: IResolvable | (IResolvable | StreamConfigurationProperty)[]

List of stream configurations associated with the channel.

v1 supports a single element; the list shape allows future extensibility to fan in from multiple streams.

encryptionConfiguration?

Type: IResolvable | EncryptionConfigurationProperty (optional)

Server-side encryption configuration for data at rest in the destination.

Data delivered to S3 / S3 Tables is encrypted with the same key.

loggingConfiguration?

Type: IResolvable | LoggingConfigurationProperty (optional)

Configuration for delivering channel operational logs.

s3DestinationConfiguration?

Type: IResolvable | S3DestinationConfigurationProperty (optional)

Configuration for delivery to a vanilla S3 bucket destination.

Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified on the channel.

s3TablesDestinationConfiguration?

Type: IResolvable | S3TablesDestinationConfigurationProperty (optional)

Configuration for delivery to S3 Tables destinations.