Interface CfnChannelProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnChannelProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
date="2026-09-02T11:03:14.184Z")
@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.msk.*;
CfnChannelProps cfnChannelProps = CfnChannelProps.builder()
.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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnChannelPropsstatic final classAn implementation forCfnChannelProps -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnChannelProps.Builderbuilder()Name of the channel.default StringThe Amazon Resource Name (ARN) of the cluster.default ObjectEncryption configuration.default ObjectIceberg destination configuration.default ObjectLog configuration details for Channel.default ObjectS3 destination configuration.getTags()Tags attached to the channel.Topic configuration.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getChannelName
Name of the channel.- See Also:
-
getTopicConfigurationList
Topic configuration.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnChannel.TopicConfigurationProperty>- See Also:
-
getClusterArn
The Amazon Resource Name (ARN) of the cluster.- See Also:
-
getEncryptionConfiguration
Encryption configuration.Returns union: either
IResolvableorCfnChannel.EncryptionConfigurationProperty- See Also:
-
getIcebergDestinationConfiguration
Iceberg destination configuration.Returns union: either
IResolvableorCfnChannel.IcebergDestinationConfigurationProperty- See Also:
-
getLoggingInfo
Log configuration details for Channel.Returns union: either
IResolvableorCfnChannel.ChannelLoggingInfoProperty- See Also:
-
getS3DestinationConfiguration
S3 destination configuration.Returns union: either
IResolvableorCfnChannel.S3DestinationConfigurationProperty- See Also:
-
getTags
Tags attached to the channel.- See Also:
-
builder
- Returns:
- a
CfnChannelProps.BuilderofCfnChannelProps
-