CfnChannelProps

class aws_cdk.aws_msk.CfnChannelProps(*, channel_name, topic_configuration_list, cluster_arn=None, encryption_configuration=None, iceberg_destination_configuration=None, logging_info=None, s3_destination_configuration=None, tags=None)

Bases: object

Properties for defining a CfnChannel.

Parameters:
See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_msk as msk

cfn_channel_props = msk.CfnChannelProps(
    channel_name="channelName",
    topic_configuration_list=[msk.CfnChannel.TopicConfigurationProperty(
        record_converter=msk.CfnChannel.RecordConverterProperty(
            value_converter="valueConverter"
        ),
        topic_arn="topicArn",

        # the properties below are optional
        record_schema=msk.CfnChannel.RecordSchemaProperty(
            gsr_arn="gsrArn"
        )
    )],

    # the properties below are optional
    cluster_arn="clusterArn",
    encryption_configuration=msk.CfnChannel.EncryptionConfigurationProperty(
        kms_key_arn="kmsKeyArn"
    ),
    iceberg_destination_configuration=msk.CfnChannel.IcebergDestinationConfigurationProperty(
        append_only=False,
        dead_letter_queue_s3=msk.CfnChannel.DeadLetterQueueS3Property(
            bucket_arn="bucketArn",
            error_output_prefix="errorOutputPrefix",

            # the properties below are optional
            expected_bucket_owner="expectedBucketOwner"
        ),
        destination_table_list=[msk.CfnChannel.DestinationTableProperty(
            destination_database_name="destinationDatabaseName",
            destination_table_name="destinationTableName",

            # the properties below are optional
            partition_spec=msk.CfnChannel.PartitionSpecProperty(
                partition_strategy="partitionStrategy",

                # the properties below are optional
                source_list=[msk.CfnChannel.PartitionSourceProperty(
                    source_name="sourceName"
                )]
            )
        )],
        schema_evolution=msk.CfnChannel.SchemaEvolutionProperty(
            enable_schema_evolution=False
        ),
        service_execution_role_arn="serviceExecutionRoleArn",
        table_creation=msk.CfnChannel.TableCreationProperty(
            enable_table_creation=False
        ),

        # the properties below are optional
        catalog=msk.CfnChannel.CatalogProperty(
            catalog_arn="catalogArn",
            warehouse_location="warehouseLocation"
        ),
        compression_type="compressionType",
        data_freshness_in_seconds=123
    ),
    logging_info=msk.CfnChannel.ChannelLoggingInfoProperty(
        cloud_watch_logs=msk.CfnChannel.CloudWatchLogsLogDestinationProperty(
            enabled=False,

            # the properties below are optional
            log_group="logGroup"
        ),
        firehose=msk.CfnChannel.FirehoseLogDestinationProperty(
            enabled=False,

            # the properties below are optional
            delivery_stream="deliveryStream"
        ),
        s3=msk.CfnChannel.S3LogDestinationProperty(
            enabled=False,

            # the properties below are optional
            bucket="bucket",
            prefix="prefix"
        )
    ),
    s3_destination_configuration=msk.CfnChannel.S3DestinationConfigurationProperty(
        dead_letter_queue_s3=msk.CfnChannel.DeadLetterQueueS3Property(
            bucket_arn="bucketArn",
            error_output_prefix="errorOutputPrefix",

            # the properties below are optional
            expected_bucket_owner="expectedBucketOwner"
        ),
        service_execution_role_arn="serviceExecutionRoleArn",
        storage=msk.CfnChannel.S3StorageProperty(
            bucket_arn="bucketArn",
            compression_type="compressionType",
            storage_class="storageClass",

            # the properties below are optional
            expected_bucket_owner="expectedBucketOwner",
            output_key_template="outputKeyTemplate",
            output_prefix="outputPrefix"
        ),

        # the properties below are optional
        data_freshness_in_seconds=123
    ),
    tags={
        "tags_key": "tags"
    }
)

Attributes

channel_name

Name of the channel.

See:

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

cluster_arn

The Amazon Resource Name (ARN) of the cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html#cfn-msk-channel-clusterarn

encryption_configuration

Encryption configuration.

See:

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

iceberg_destination_configuration

Iceberg destination configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html#cfn-msk-channel-icebergdestinationconfiguration

logging_info

Log configuration details for Channel.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html#cfn-msk-channel-logginginfo

s3_destination_configuration

S3 destination configuration.

See:

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

tags

Tags attached to the channel.

See:

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

topic_configuration_list

Topic configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html#cfn-msk-channel-topicconfigurationlist