Package software.amazon.awscdk.services.kinesis

Interface CfnChannelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnChannelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-09-30T11:04:54.380Z")
@Stability(Stable)
public interface CfnChannelProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.kinesis.*;
 CfnChannelProps cfnChannelProps = CfnChannelProps.builder()
         .channelName("channelName")
         .serviceExecutionRoleArn("serviceExecutionRoleArn")
         .streamConfigurationList(List.of(StreamConfigurationProperty.builder()
                 .recordConfiguration(RecordConfigurationProperty.builder()
                         .recordFormatType("recordFormatType")
                         // the properties below are optional
                         .gsrSchemaArn("gsrSchemaArn")
                         .build())
                 .streamArn("streamArn")
                 .build()))
         // the properties below are optional
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .encryptionType("encryptionType")
                 .keyId("keyId")
                 .build())
         .loggingConfiguration(LoggingConfigurationProperty.builder()
                 .cloudWatchLogs(CloudWatchLogsConfigurationProperty.builder()
                         .enabled(false)
                         // the properties below are optional
                         .logGroupName("logGroupName")
                         .logStreamName("logStreamName")
                         .build())
                 .build())
         .s3DestinationConfiguration(S3DestinationConfigurationProperty.builder()
                 .storageConfiguration(S3StorageConfigurationProperty.builder()
                         .bucketArn("bucketArn")
                         .compressionType("compressionType")
                         .expectedBucketOwner("expectedBucketOwner")
                         // the properties below are optional
                         .outputKeyTemplate("outputKeyTemplate")
                         .storageClass("storageClass")
                         .build())
                 // the properties below are optional
                 .dataFreshnessInSeconds(123)
                 .deadLetterQueueS3Configuration(DeadLetterQueueS3ConfigurationProperty.builder()
                         .bucketArn("bucketArn")
                         .expectedBucketOwner("expectedBucketOwner")
                         // the properties below are optional
                         .errorOutputPrefix("errorOutputPrefix")
                         .build())
                 .build())
         .s3TablesDestinationConfiguration(S3TablesDestinationConfigurationProperty.builder()
                 .deadLetterQueueS3Configuration(DeadLetterQueueS3ConfigurationProperty.builder()
                         .bucketArn("bucketArn")
                         .expectedBucketOwner("expectedBucketOwner")
                         // the properties below are optional
                         .errorOutputPrefix("errorOutputPrefix")
                         .build())
                 .s3TablesConfigurationList(List.of(S3TableConfigurationProperty.builder()
                         .compressionType("compressionType")
                         .namespace("namespace")
                         .tableBucketArn("tableBucketArn")
                         .tableName("tableName")
                         // the properties below are optional
                         .partitionSpec(PartitionSpecProperty.builder()
                                 .partitionFields(List.of(PartitionFieldProperty.builder()
                                         .sourceName("sourceName")
                                         .transform("transform")
                                         .build()))
                                 .build())
                         .build()))
                 // the properties below are optional
                 .dataFreshnessInSeconds(123)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-channel.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnChannelProps.Builder	A builder for CfnChannelProps
static final class	CfnChannelProps.Jsii$Proxy	An implementation for CfnChannelProps

Method Summary

Modifier and Type	Method	Description
static CfnChannelProps.Builder	builder()
String	getChannelName()	The name of the channel.
default Object	getEncryptionConfiguration()	Server-side encryption configuration for data at rest in the destination.
default Object	getLoggingConfiguration()	Configuration for delivering channel operational logs.
default Object	getS3DestinationConfiguration()	Configuration for delivery to a vanilla S3 bucket destination.
default Object	getS3TablesDestinationConfiguration()	Configuration for delivery to S3 Tables destinations.
String	getServiceExecutionRoleArn()	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.
Object	getStreamConfigurationList()	List of stream configurations associated with the channel.
default List<CfnTag>	getTags()	An arbitrary set of tags (key-value pairs) to associate with the Kinesis channel.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getChannelName

@Stability(Stable)
@NotNull
String getChannelName()

The name of the channel.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-channel.html#cfn-kinesis-channel-channelname

getServiceExecutionRoleArn

@Stability(Stable)
@NotNull
String getServiceExecutionRoleArn()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-channel.html#cfn-kinesis-channel-serviceexecutionrolearn

getStreamConfigurationList

@Stability(Stable)
@NotNull
Object getStreamConfigurationList()

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnChannel.StreamConfigurationProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-channel.html#cfn-kinesis-channel-streamconfigurationlist

getEncryptionConfiguration

@Stability(Stable)
@Nullable
default Object getEncryptionConfiguration()

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

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

Returns union: either IResolvable or CfnChannel.EncryptionConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-channel.html#cfn-kinesis-channel-encryptionconfiguration

getLoggingConfiguration

@Stability(Stable)
@Nullable
default Object getLoggingConfiguration()

Configuration for delivering channel operational logs.

Returns union: either IResolvable or CfnChannel.LoggingConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-channel.html#cfn-kinesis-channel-loggingconfiguration

getS3DestinationConfiguration

@Stability(Stable)
@Nullable
default Object getS3DestinationConfiguration()

Configuration for delivery to a vanilla S3 bucket destination.

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

Returns union: either IResolvable or CfnChannel.S3DestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-channel.html#cfn-kinesis-channel-s3destinationconfiguration

getS3TablesDestinationConfiguration

@Stability(Stable)
@Nullable
default Object getS3TablesDestinationConfiguration()

Configuration for delivery to S3 Tables destinations.

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

Returns union: either IResolvable or CfnChannel.S3TablesDestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-channel.html#cfn-kinesis-channel-s3tablesdestinationconfiguration

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-channel.html#cfn-kinesis-channel-tags

builder

@Stability(Stable)
static CfnChannelProps.Builder builder()

Returns:

a CfnChannelProps.Builder of CfnChannelProps