Package software.amazon.awscdk.services.msk

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.msk.CfnChannel
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IChannelRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:14.175Z") @Stability(Stable) public class CfnChannel extends CfnResource implements IInspectable, IChannelRef, ITaggableV2
Resource Type definition for AWS::MSK::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.msk.*;
 CfnChannel cfnChannel = CfnChannel.Builder.create(this, "MyCfnChannel")
         .channelName("channelName")
         .topicConfigurationList(List.of(TopicConfigurationProperty.builder()
                 .recordConverter(RecordConverterProperty.builder()
                         .valueConverter("valueConverter")
                         .build())
                 .topicArn("topicArn")
                 // the properties below are optional
                 .recordSchema(RecordSchemaProperty.builder()
                         .gsrArn("gsrArn")
                         .build())
                 .build()))
         // the properties below are optional
         .clusterArn("clusterArn")
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .kmsKeyArn("kmsKeyArn")
                 .build())
         .icebergDestinationConfiguration(IcebergDestinationConfigurationProperty.builder()
                 .appendOnly(false)
                 .deadLetterQueueS3(DeadLetterQueueS3Property.builder()
                         .bucketArn("bucketArn")
                         .errorOutputPrefix("errorOutputPrefix")
                         // the properties below are optional
                         .expectedBucketOwner("expectedBucketOwner")
                         .build())
                 .destinationTableList(List.of(DestinationTableProperty.builder()
                         .destinationDatabaseName("destinationDatabaseName")
                         .destinationTableName("destinationTableName")
                         // the properties below are optional
                         .partitionSpec(PartitionSpecProperty.builder()
                                 .partitionStrategy("partitionStrategy")
                                 // the properties below are optional
                                 .sourceList(List.of(PartitionSourceProperty.builder()
                                         .sourceName("sourceName")
                                         .build()))
                                 .build())
                         .build()))
                 .schemaEvolution(SchemaEvolutionProperty.builder()
                         .enableSchemaEvolution(false)
                         .build())
                 .serviceExecutionRoleArn("serviceExecutionRoleArn")
                 .tableCreation(TableCreationProperty.builder()
                         .enableTableCreation(false)
                         .build())
                 // the properties below are optional
                 .catalog(CatalogProperty.builder()
                         .catalogArn("catalogArn")
                         .warehouseLocation("warehouseLocation")
                         .build())
                 .compressionType("compressionType")
                 .dataFreshnessInSeconds(123)
                 .build())
         .loggingInfo(ChannelLoggingInfoProperty.builder()
                 .cloudWatchLogs(CloudWatchLogsLogDestinationProperty.builder()
                         .enabled(false)
                         // the properties below are optional
                         .logGroup("logGroup")
                         .build())
                 .firehose(FirehoseLogDestinationProperty.builder()
                         .enabled(false)
                         // the properties below are optional
                         .deliveryStream("deliveryStream")
                         .build())
                 .s3(S3LogDestinationProperty.builder()
                         .enabled(false)
                         // the properties below are optional
                         .bucket("bucket")
                         .prefix("prefix")
                         .build())
                 .build())
         .s3DestinationConfiguration(S3DestinationConfigurationProperty.builder()
                 .deadLetterQueueS3(DeadLetterQueueS3Property.builder()
                         .bucketArn("bucketArn")
                         .errorOutputPrefix("errorOutputPrefix")
                         // the properties below are optional
                         .expectedBucketOwner("expectedBucketOwner")
                         .build())
                 .serviceExecutionRoleArn("serviceExecutionRoleArn")
                 .storage(S3StorageProperty.builder()
                         .bucketArn("bucketArn")
                         .compressionType("compressionType")
                         .storageClass("storageClass")
                         // the properties below are optional
                         .expectedBucketOwner("expectedBucketOwner")
                         .outputKeyTemplate("outputKeyTemplate")
                         .outputPrefix("outputPrefix")
                         .build())
                 // the properties below are optional
                 .dataFreshnessInSeconds(123)
                 .build())
         .tags(Map.of(
                 "tagsKey", "tags"))
         .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::MSK::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 Amazon Resource Name (ARN) that uniquely identifies the channel.

    • getAttrStateInfo

      @Stability(Stable) @NotNull public IResolvable getAttrStateInfo()
      Includes information about the channel state.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      Status of a channel resource.

    • 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()
      Name of the channel.

    • setChannelName

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

    • getTopicConfigurationList

      @Stability(Stable) @NotNull public Object getTopicConfigurationList()
      Topic configuration.

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

    • setTopicConfigurationList

      @Stability(Stable) public void setTopicConfigurationList(@NotNull IResolvable value)
      Topic configuration.

    • setTopicConfigurationList

      @Stability(Stable) public void setTopicConfigurationList(@NotNull List<Object> value)
      Topic configuration.

    • getClusterArn

      @Stability(Stable) @Nullable public String getClusterArn()
      The Amazon Resource Name (ARN) of the cluster.

    • setClusterArn

      @Stability(Stable) public void setClusterArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the cluster.

    • getEncryptionConfiguration

      @Stability(Stable) @Nullable public Object getEncryptionConfiguration()
      Encryption configuration.

      Returns union: either IResolvable or CfnChannel.EncryptionConfigurationProperty

    • setEncryptionConfiguration

      @Stability(Stable) public void setEncryptionConfiguration(@Nullable IResolvable value)
      Encryption configuration.

    • setEncryptionConfiguration

      @Stability(Stable) public void setEncryptionConfiguration(@Nullable CfnChannel.EncryptionConfigurationProperty value)
      Encryption configuration.

    • getIcebergDestinationConfiguration

      @Stability(Stable) @Nullable public Object getIcebergDestinationConfiguration()
      Iceberg destination configuration.

      Returns union: either IResolvable or CfnChannel.IcebergDestinationConfigurationProperty

    • setIcebergDestinationConfiguration

      @Stability(Stable) public void setIcebergDestinationConfiguration(@Nullable IResolvable value)
      Iceberg destination configuration.

    • setIcebergDestinationConfiguration

      @Stability(Stable) public void setIcebergDestinationConfiguration(@Nullable CfnChannel.IcebergDestinationConfigurationProperty value)
      Iceberg destination configuration.

    • getLoggingInfo

      @Stability(Stable) @Nullable public Object getLoggingInfo()
      Log configuration details for Channel.

      Returns union: either IResolvable or CfnChannel.ChannelLoggingInfoProperty

    • setLoggingInfo

      @Stability(Stable) public void setLoggingInfo(@Nullable IResolvable value)
      Log configuration details for Channel.

    • setLoggingInfo

      @Stability(Stable) public void setLoggingInfo(@Nullable CfnChannel.ChannelLoggingInfoProperty value)
      Log configuration details for Channel.

    • getS3DestinationConfiguration

      @Stability(Stable) @Nullable public Object getS3DestinationConfiguration()
      S3 destination configuration.

      Returns union: either IResolvable or CfnChannel.S3DestinationConfigurationProperty

    • setS3DestinationConfiguration

      @Stability(Stable) public void setS3DestinationConfiguration(@Nullable IResolvable value)
      S3 destination configuration.

    • setS3DestinationConfiguration

      @Stability(Stable) public void setS3DestinationConfiguration(@Nullable CfnChannel.S3DestinationConfigurationProperty value)
      S3 destination configuration.

    • getTags

      @Stability(Stable) @Nullable public Map<String,String> getTags()
      Tags attached to the channel.

    • setTags

      @Stability(Stable) public void setTags(@Nullable Map<String,String> value)
      Tags attached to the channel.