Package software.amazon.awscdk.services.kinesis

Class CfnChannel

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.kinesis.CfnChannel
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IChannelRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-09-30T11:04:54.358Z") @Stability(Stable) public class CfnChannel extends CfnResource implements IInspectable, IChannelRef, ITaggableV2
Resource Type definition for AWS::Kinesis::Channel.

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.*;
 CfnChannel cfnChannel = CfnChannel.Builder.create(this, "MyCfnChannel")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnChannel

      protected CfnChannel(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnChannel

      protected CfnChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnChannel

      @Stability(Stable) public CfnChannel(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnChannelProps props)
      Create a new AWS::Kinesis::Channel.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForChannel

      @Stability(Stable) @NotNull public static String arnForChannel(@NotNull IChannelRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnChannel

      @Stability(Stable) @NotNull public static Boolean isCfnChannel(@NotNull Object x)
      Checks whether the given object is a CfnChannel.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrChannelArn

      @Stability(Stable) @NotNull public String getAttrChannelArn()
      The ARN of the channel.

    • getAttrChannelCreationTimestamp

      @Stability(Stable) @NotNull public String getAttrChannelCreationTimestamp()
      Timestamp of when the channel was created.

    • getAttrChannelId

      @Stability(Stable) @NotNull public String getAttrChannelId()
      The service-generated unique identifier for the channel.

    • getAttrChannelStatus

      @Stability(Stable) @NotNull public String getAttrChannelStatus()
      The status of the channel.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getChannelRef

      @Stability(Stable) @NotNull public ChannelReference getChannelRef()
      A reference to a Channel resource.
      Specified by:
      getChannelRef in interface IChannelRef

    • getChannelName

      @Stability(Stable) @NotNull public String getChannelName()
      The name of the channel.

    • setChannelName

      @Stability(Stable) public void setChannelName(@NotNull String value)
      The name of the channel.

    • getServiceExecutionRoleArn

      @Stability(Stable) @NotNull public 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.

    • setServiceExecutionRoleArn

      @Stability(Stable) public void setServiceExecutionRoleArn(@NotNull String value)
      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.

    • getStreamConfigurationList

      @Stability(Stable) @NotNull public Object getStreamConfigurationList()
      List of stream configurations associated with the channel.

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

    • setStreamConfigurationList

      @Stability(Stable) public void setStreamConfigurationList(@NotNull IResolvable value)
      List of stream configurations associated with the channel.

    • setStreamConfigurationList

      @Stability(Stable) public void setStreamConfigurationList(@NotNull List<Object> value)
      List of stream configurations associated with the channel.

    • getEncryptionConfiguration

      @Stability(Stable) @Nullable public Object getEncryptionConfiguration()
      Server-side encryption configuration for data at rest in the destination.

      Returns union: either IResolvable or CfnChannel.EncryptionConfigurationProperty

    • setEncryptionConfiguration

      @Stability(Stable) public void setEncryptionConfiguration(@Nullable IResolvable value)
      Server-side encryption configuration for data at rest in the destination.

    • setEncryptionConfiguration

      @Stability(Stable) public void setEncryptionConfiguration(@Nullable CfnChannel.EncryptionConfigurationProperty value)
      Server-side encryption configuration for data at rest in the destination.

    • getLoggingConfiguration

      @Stability(Stable) @Nullable public Object getLoggingConfiguration()
      Configuration for delivering channel operational logs.

      Returns union: either IResolvable or CfnChannel.LoggingConfigurationProperty

    • setLoggingConfiguration

      @Stability(Stable) public void setLoggingConfiguration(@Nullable IResolvable value)
      Configuration for delivering channel operational logs.

    • setLoggingConfiguration

      @Stability(Stable) public void setLoggingConfiguration(@Nullable CfnChannel.LoggingConfigurationProperty value)
      Configuration for delivering channel operational logs.

    • getS3DestinationConfiguration

      @Stability(Stable) @Nullable public Object getS3DestinationConfiguration()
      Configuration for delivery to a vanilla S3 bucket destination.

      Returns union: either IResolvable or CfnChannel.S3DestinationConfigurationProperty

    • setS3DestinationConfiguration

      @Stability(Stable) public void setS3DestinationConfiguration(@Nullable IResolvable value)
      Configuration for delivery to a vanilla S3 bucket destination.

    • setS3DestinationConfiguration

      @Stability(Stable) public void setS3DestinationConfiguration(@Nullable CfnChannel.S3DestinationConfigurationProperty value)
      Configuration for delivery to a vanilla S3 bucket destination.

    • getS3TablesDestinationConfiguration

      @Stability(Stable) @Nullable public Object getS3TablesDestinationConfiguration()
      Configuration for delivery to S3 Tables destinations.

      Returns union: either IResolvable or CfnChannel.S3TablesDestinationConfigurationProperty

    • setS3TablesDestinationConfiguration

      @Stability(Stable) public void setS3TablesDestinationConfiguration(@Nullable IResolvable value)
      Configuration for delivery to S3 Tables destinations.

    • setS3TablesDestinationConfiguration

      @Stability(Stable) public void setS3TablesDestinationConfiguration(@Nullable CfnChannel.S3TablesDestinationConfigurationProperty value)
      Configuration for delivery to S3 Tables destinations.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An arbitrary set of tags (key-value pairs) to associate with the Kinesis channel.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An arbitrary set of tags (key-value pairs) to associate with the Kinesis channel.