interface CfnChannelMixinProps

Language	Type name
.NET	`Amazon.CDK.CfnPropertyMixins.AWS.Kinesis.CfnChannelMixinProps`
Go	`github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awskinesis#CfnChannelMixinProps`
Java	`software.amazon.awscdk.cfnpropertymixins.services.kinesis.CfnChannelMixinProps`
Python	`aws_cdk.cfn_property_mixins.aws_kinesis.CfnChannelMixinProps`
TypeScript	`@aws-cdk/cfn-property-mixins` » `aws_kinesis` » `CfnChannelMixinProps`

Properties for CfnChannelPropsMixin.

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/cfn-property-mixins';
const cfnChannelMixinProps: kinesis.CfnChannelMixinProps = {
  channelName: 'channelName',
  encryptionConfiguration: {
    encryptionType: 'encryptionType',
    keyId: 'keyId',
  },
  loggingConfiguration: {
    cloudWatchLogs: {
      enabled: false,
      logGroupName: 'logGroupName',
      logStreamName: 'logStreamName',
    },
  },
  s3DestinationConfiguration: {
    dataFreshnessInSeconds: 123,
    deadLetterQueueS3Configuration: {
      bucketArn: 'bucketArn',
      errorOutputPrefix: 'errorOutputPrefix',
      expectedBucketOwner: 'expectedBucketOwner',
    },
    storageConfiguration: {
      bucketArn: 'bucketArn',
      compressionType: 'compressionType',
      expectedBucketOwner: 'expectedBucketOwner',
      outputKeyTemplate: 'outputKeyTemplate',
      storageClass: 'storageClass',
    },
  },
  s3TablesDestinationConfiguration: {
    dataFreshnessInSeconds: 123,
    deadLetterQueueS3Configuration: {
      bucketArn: 'bucketArn',
      errorOutputPrefix: 'errorOutputPrefix',
      expectedBucketOwner: 'expectedBucketOwner',
    },
    s3TablesConfigurationList: [{
      compressionType: 'compressionType',
      namespace: 'namespace',
      partitionSpec: {
        partitionFields: [{
          sourceName: 'sourceName',
          transform: 'transform',
        }],
      },
      tableBucketArn: 'tableBucketArn',
      tableName: 'tableName',
    }],
  },
  serviceExecutionRoleArn: 'serviceExecutionRoleArn',
  streamConfigurationList: [{
    recordConfiguration: {
      gsrSchemaArn: 'gsrSchemaArn',
      recordFormatType: 'recordFormatType',
    },
    streamArn: 'streamArn',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
channelName?	`string`	The name of 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.
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.
tags?	`CfnTag[]`	An arbitrary set of tags (key-value pairs) to associate with the Kinesis channel.

channelName?

Type: string (optional)

The name of the channel.

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

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.

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

serviceExecutionRoleArn?

Type: string (optional)

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)[] (optional)

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.

tags?

Type: CfnTag[] (optional)

An arbitrary set of tags (key-value pairs) to associate with the Kinesis channel.

AWS CDK

2.272.0