CfnChannelPropsMixin

class aws_cdk.cfn_property_mixins.aws_msk.CfnChannelPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::MSK::Channel.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-channel.html
CloudformationResource:: AWS::MSK::Channel
Mixin:: true
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.cfn_property_mixins import aws_msk as msk
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_channel_props_mixin = msk.CfnChannelPropsMixin(msk.CfnChannelMixinProps(
    channel_name="channelName",
    cluster_arn="clusterArn",
    encryption_configuration=msk.CfnChannelPropsMixin.EncryptionConfigurationProperty(
        kms_key_arn="kmsKeyArn"
    ),
    iceberg_destination_configuration=msk.CfnChannelPropsMixin.IcebergDestinationConfigurationProperty(
        append_only=False,
        catalog=msk.CfnChannelPropsMixin.CatalogProperty(
            catalog_arn="catalogArn",
            warehouse_location="warehouseLocation"
        ),
        compression_type="compressionType",
        data_freshness_in_seconds=123,
        dead_letter_queue_s3=msk.CfnChannelPropsMixin.DeadLetterQueueS3Property(
            bucket_arn="bucketArn",
            error_output_prefix="errorOutputPrefix",
            expected_bucket_owner="expectedBucketOwner"
        ),
        destination_table_list=[msk.CfnChannelPropsMixin.DestinationTableProperty(
            destination_database_name="destinationDatabaseName",
            destination_table_name="destinationTableName",
            partition_spec=msk.CfnChannelPropsMixin.PartitionSpecProperty(
                partition_strategy="partitionStrategy",
                source_list=[msk.CfnChannelPropsMixin.PartitionSourceProperty(
                    source_name="sourceName"
                )]
            )
        )],
        schema_evolution=msk.CfnChannelPropsMixin.SchemaEvolutionProperty(
            enable_schema_evolution=False
        ),
        service_execution_role_arn="serviceExecutionRoleArn",
        table_creation=msk.CfnChannelPropsMixin.TableCreationProperty(
            enable_table_creation=False
        )
    ),
    logging_info=msk.CfnChannelPropsMixin.ChannelLoggingInfoProperty(
        cloud_watch_logs=msk.CfnChannelPropsMixin.CloudWatchLogsLogDestinationProperty(
            enabled=False,
            log_group="logGroup"
        ),
        firehose=msk.CfnChannelPropsMixin.FirehoseLogDestinationProperty(
            delivery_stream="deliveryStream",
            enabled=False
        ),
        s3=msk.CfnChannelPropsMixin.S3LogDestinationProperty(
            bucket="bucket",
            enabled=False,
            prefix="prefix"
        )
    ),
    s3_destination_configuration=msk.CfnChannelPropsMixin.S3DestinationConfigurationProperty(
        data_freshness_in_seconds=123,
        dead_letter_queue_s3=msk.CfnChannelPropsMixin.DeadLetterQueueS3Property(
            bucket_arn="bucketArn",
            error_output_prefix="errorOutputPrefix",
            expected_bucket_owner="expectedBucketOwner"
        ),
        service_execution_role_arn="serviceExecutionRoleArn",
        storage=msk.CfnChannelPropsMixin.S3StorageProperty(
            bucket_arn="bucketArn",
            compression_type="compressionType",
            expected_bucket_owner="expectedBucketOwner",
            output_key_template="outputKeyTemplate",
            output_prefix="outputPrefix",
            storage_class="storageClass"
        )
    ),
    tags={
        "tags_key": "tags"
    },
    topic_configuration_list=[msk.CfnChannelPropsMixin.TopicConfigurationProperty(
        record_converter=msk.CfnChannelPropsMixin.RecordConverterProperty(
            value_converter="valueConverter"
        ),
        record_schema=msk.CfnChannelPropsMixin.RecordSchemaProperty(
            gsr_arn="gsrArn"
        ),
        topic_arn="topicArn"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::MSK::Channel.

Parameters:

props (Union[CfnChannelMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['channelName', 'clusterArn', 'encryptionConfiguration', 'icebergDestinationConfiguration', 'loggingInfo', 's3DestinationConfiguration', 'tags', 'topicConfigurationList']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

CatalogProperty

class CfnChannelPropsMixin.CatalogProperty(*, catalog_arn=None, warehouse_location=None)

Bases: object

Catalog configuration of the destination.

Parameters:

catalog_arn (Optional[str]) – The ARN of the catalog.
warehouse_location (Optional[str]) – The warehouse location.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-catalog.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.cfn_property_mixins import aws_msk as msk

catalog_property = msk.CfnChannelPropsMixin.CatalogProperty(
    catalog_arn="catalogArn",
    warehouse_location="warehouseLocation"
)

Attributes

catalog_arn

The ARN of the catalog.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-catalog.html#cfn-msk-channel-catalog-catalogarn

warehouse_location

The warehouse location.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-catalog.html#cfn-msk-channel-catalog-warehouselocation

ChannelLoggingInfoProperty

class CfnChannelPropsMixin.ChannelLoggingInfoProperty(*, cloud_watch_logs=None, firehose=None, s3=None)

Bases: object

Log configuration details for Channel.

Parameters:

cloud_watch_logs (Union[IResolvable, CloudWatchLogsLogDestinationProperty, Dict[str, Any], None]) – CloudWatch Logs log destination details.
firehose (Union[IResolvable, FirehoseLogDestinationProperty, Dict[str, Any], None]) – Firehose log destination details.
s3 (Union[IResolvable, S3LogDestinationProperty, Dict[str, Any], None]) – S3 log destination details.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-channellogginginfo.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.cfn_property_mixins import aws_msk as msk

channel_logging_info_property = msk.CfnChannelPropsMixin.ChannelLoggingInfoProperty(
    cloud_watch_logs=msk.CfnChannelPropsMixin.CloudWatchLogsLogDestinationProperty(
        enabled=False,
        log_group="logGroup"
    ),
    firehose=msk.CfnChannelPropsMixin.FirehoseLogDestinationProperty(
        delivery_stream="deliveryStream",
        enabled=False
    ),
    s3=msk.CfnChannelPropsMixin.S3LogDestinationProperty(
        bucket="bucket",
        enabled=False,
        prefix="prefix"
    )
)

Attributes

cloud_watch_logs

CloudWatch Logs log destination details.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-channellogginginfo.html#cfn-msk-channel-channellogginginfo-cloudwatchlogs

firehose

Firehose log destination details.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-channellogginginfo.html#cfn-msk-channel-channellogginginfo-firehose

s3

S3 log destination details.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-channellogginginfo.html#cfn-msk-channel-channellogginginfo-s3

ChannelStateInfoProperty

class CfnChannelPropsMixin.ChannelStateInfoProperty(*, code=None, message=None)

Bases: object

Includes information about the channel state.

Parameters:

code (Optional[str]) – Code for channel state.
message (Optional[str]) – Message for channel state.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-channelstateinfo.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.cfn_property_mixins import aws_msk as msk

channel_state_info_property = msk.CfnChannelPropsMixin.ChannelStateInfoProperty(
    code="code",
    message="message"
)

Attributes

code

Code for channel state.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-channelstateinfo.html#cfn-msk-channel-channelstateinfo-code

message

Message for channel state.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-channelstateinfo.html#cfn-msk-channel-channelstateinfo-message

CloudWatchLogsLogDestinationProperty

class CfnChannelPropsMixin.CloudWatchLogsLogDestinationProperty(*, enabled=None, log_group=None)

Bases: object

CloudWatch Logs log destination details.

Parameters:

enabled (Union[bool, IResolvable, None]) – Whether CloudWatch Logs logging is enabled.
log_group (Optional[str]) – The CloudWatch log group for log delivery.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-cloudwatchlogslogdestination.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.cfn_property_mixins import aws_msk as msk

cloud_watch_logs_log_destination_property = msk.CfnChannelPropsMixin.CloudWatchLogsLogDestinationProperty(
    enabled=False,
    log_group="logGroup"
)

Attributes

enabled

Whether CloudWatch Logs logging is enabled.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-cloudwatchlogslogdestination.html#cfn-msk-channel-cloudwatchlogslogdestination-enabled

log_group

The CloudWatch log group for log delivery.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-cloudwatchlogslogdestination.html#cfn-msk-channel-cloudwatchlogslogdestination-loggroup

DeadLetterQueueS3Property

class CfnChannelPropsMixin.DeadLetterQueueS3Property(*, bucket_arn=None, error_output_prefix=None, expected_bucket_owner=None)

Bases: object

Dead letter queue S3 configuration of the destination.

Parameters:

bucket_arn (Optional[str]) – The ARN of the S3 bucket.
error_output_prefix (Optional[str]) – The error output prefix.
expected_bucket_owner (Optional[str]) – Optional 12-digit AWS account ID expected to own the dead-letter S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-deadletterqueues3.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.cfn_property_mixins import aws_msk as msk

dead_letter_queue_s3_property = msk.CfnChannelPropsMixin.DeadLetterQueueS3Property(
    bucket_arn="bucketArn",
    error_output_prefix="errorOutputPrefix",
    expected_bucket_owner="expectedBucketOwner"
)

Attributes

bucket_arn

The ARN of the S3 bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-deadletterqueues3.html#cfn-msk-channel-deadletterqueues3-bucketarn

error_output_prefix

The error output prefix.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-deadletterqueues3.html#cfn-msk-channel-deadletterqueues3-erroroutputprefix

expected_bucket_owner

Optional 12-digit AWS account ID expected to own the dead-letter S3 bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-deadletterqueues3.html#cfn-msk-channel-deadletterqueues3-expectedbucketowner

DestinationTableProperty

class CfnChannelPropsMixin.DestinationTableProperty(*, destination_database_name=None, destination_table_name=None, partition_spec=None)

Bases: object

Destination table configuration.

Parameters:

destination_database_name (Optional[str]) – The destination database name.
destination_table_name (Optional[str]) – The destination table name.
partition_spec (Union[IResolvable, PartitionSpecProperty, Dict[str, Any], None]) – Partition specification.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-destinationtable.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.cfn_property_mixins import aws_msk as msk

destination_table_property = msk.CfnChannelPropsMixin.DestinationTableProperty(
    destination_database_name="destinationDatabaseName",
    destination_table_name="destinationTableName",
    partition_spec=msk.CfnChannelPropsMixin.PartitionSpecProperty(
        partition_strategy="partitionStrategy",
        source_list=[msk.CfnChannelPropsMixin.PartitionSourceProperty(
            source_name="sourceName"
        )]
    )
)

Attributes

destination_database_name

The destination database name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-destinationtable.html#cfn-msk-channel-destinationtable-destinationdatabasename

destination_table_name

The destination table name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-destinationtable.html#cfn-msk-channel-destinationtable-destinationtablename

partition_spec

Partition specification.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-destinationtable.html#cfn-msk-channel-destinationtable-partitionspec

EncryptionConfigurationProperty

class CfnChannelPropsMixin.EncryptionConfigurationProperty(*, kms_key_arn=None)

Bases: object

Encryption configuration.

Parameters:: kms_key_arn (Optional[str]) – The ARN of the KMS key for encryption.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-encryptionconfiguration.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.cfn_property_mixins import aws_msk as msk

encryption_configuration_property = msk.CfnChannelPropsMixin.EncryptionConfigurationProperty(
    kms_key_arn="kmsKeyArn"
)

Attributes

kms_key_arn

The ARN of the KMS key for encryption.

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

FirehoseLogDestinationProperty

class CfnChannelPropsMixin.FirehoseLogDestinationProperty(*, delivery_stream=None, enabled=None)

Bases: object

Firehose log destination details.

Parameters:

delivery_stream (Optional[str]) – The Firehose delivery stream for log delivery.
enabled (Union[bool, IResolvable, None]) – Whether Firehose logging is enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-firehoselogdestination.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.cfn_property_mixins import aws_msk as msk

firehose_log_destination_property = msk.CfnChannelPropsMixin.FirehoseLogDestinationProperty(
    delivery_stream="deliveryStream",
    enabled=False
)

Attributes

delivery_stream

The Firehose delivery stream for log delivery.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-firehoselogdestination.html#cfn-msk-channel-firehoselogdestination-deliverystream

enabled

Whether Firehose logging is enabled.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-firehoselogdestination.html#cfn-msk-channel-firehoselogdestination-enabled

IcebergDestinationConfigurationProperty

class CfnChannelPropsMixin.IcebergDestinationConfigurationProperty(*, append_only=None, catalog=None, compression_type=None, data_freshness_in_seconds=None, dead_letter_queue_s3=None, destination_table_list=None, schema_evolution=None, service_execution_role_arn=None, table_creation=None)

Bases: object

Iceberg destination configuration.

Parameters:

append_only (Union[bool, IResolvable, None]) – Append only mode. Default: - true
catalog (Union[IResolvable, CatalogProperty, Dict[str, Any], None]) – Catalog configuration of the destination.
compression_type (Optional[str]) – Compression codec for Iceberg table data files. Defaults to ZSTD.
data_freshness_in_seconds (Union[int, float, None]) – Data freshness in seconds.
dead_letter_queue_s3 (Union[IResolvable, DeadLetterQueueS3Property, Dict[str, Any], None]) – Dead letter queue S3 configuration of the destination.
destination_table_list (Union[IResolvable, Sequence[Union[IResolvable, DestinationTableProperty, Dict[str, Any]]], None]) – List of destination tables.
schema_evolution (Union[IResolvable, SchemaEvolutionProperty, Dict[str, Any], None]) – Schema evolution configuration of the destination.
service_execution_role_arn (Optional[str]) – The Amazon Resource Name (ARN) of an IAM role used by MSK to access the table.
table_creation (Union[IResolvable, TableCreationProperty, Dict[str, Any], None]) – Table creation configuration of the destination.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-icebergdestinationconfiguration.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.cfn_property_mixins import aws_msk as msk

iceberg_destination_configuration_property = msk.CfnChannelPropsMixin.IcebergDestinationConfigurationProperty(
    append_only=False,
    catalog=msk.CfnChannelPropsMixin.CatalogProperty(
        catalog_arn="catalogArn",
        warehouse_location="warehouseLocation"
    ),
    compression_type="compressionType",
    data_freshness_in_seconds=123,
    dead_letter_queue_s3=msk.CfnChannelPropsMixin.DeadLetterQueueS3Property(
        bucket_arn="bucketArn",
        error_output_prefix="errorOutputPrefix",
        expected_bucket_owner="expectedBucketOwner"
    ),
    destination_table_list=[msk.CfnChannelPropsMixin.DestinationTableProperty(
        destination_database_name="destinationDatabaseName",
        destination_table_name="destinationTableName",
        partition_spec=msk.CfnChannelPropsMixin.PartitionSpecProperty(
            partition_strategy="partitionStrategy",
            source_list=[msk.CfnChannelPropsMixin.PartitionSourceProperty(
                source_name="sourceName"
            )]
        )
    )],
    schema_evolution=msk.CfnChannelPropsMixin.SchemaEvolutionProperty(
        enable_schema_evolution=False
    ),
    service_execution_role_arn="serviceExecutionRoleArn",
    table_creation=msk.CfnChannelPropsMixin.TableCreationProperty(
        enable_table_creation=False
    )
)

Attributes

append_only

Append only mode.

Default:

true

See:

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

catalog

Catalog configuration of the destination.

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

compression_type

Compression codec for Iceberg table data files.

Defaults to ZSTD.

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

data_freshness_in_seconds

Data freshness in seconds.

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

dead_letter_queue_s3

Dead letter queue S3 configuration of the destination.

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

destination_table_list

List of destination tables.

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

schema_evolution

Schema evolution configuration of the destination.

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

service_execution_role_arn

The Amazon Resource Name (ARN) of an IAM role used by MSK to access the table.

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

table_creation

Table creation configuration of the destination.

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

PartitionSourceProperty

class CfnChannelPropsMixin.PartitionSourceProperty(*, source_name=None)

Bases: object

Partition source configuration.

Parameters:: source_name (Optional[str]) – Source name.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-partitionsource.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.cfn_property_mixins import aws_msk as msk

partition_source_property = msk.CfnChannelPropsMixin.PartitionSourceProperty(
    source_name="sourceName"
)

Attributes

source_name

Source name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-partitionsource.html#cfn-msk-channel-partitionsource-sourcename

PartitionSpecProperty

class CfnChannelPropsMixin.PartitionSpecProperty(*, partition_strategy=None, source_list=None)

Bases: object

Partition specification.

Parameters:

partition_strategy (Optional[str]) – Partition strategy for MSK channel.
source_list (Union[IResolvable, Sequence[Union[IResolvable, PartitionSourceProperty, Dict[str, Any]]], None]) – Source list.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-partitionspec.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.cfn_property_mixins import aws_msk as msk

partition_spec_property = msk.CfnChannelPropsMixin.PartitionSpecProperty(
    partition_strategy="partitionStrategy",
    source_list=[msk.CfnChannelPropsMixin.PartitionSourceProperty(
        source_name="sourceName"
    )]
)

Attributes

partition_strategy

Partition strategy for MSK channel.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-partitionspec.html#cfn-msk-channel-partitionspec-partitionstrategy

source_list

Source list.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-partitionspec.html#cfn-msk-channel-partitionspec-sourcelist

RecordConverterProperty

class CfnChannelPropsMixin.RecordConverterProperty(*, value_converter=None)

Bases: object

Record converter configuration for a topic.

Parameters:: value_converter (Optional[str]) – Value converter for topic data.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-recordconverter.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.cfn_property_mixins import aws_msk as msk

record_converter_property = msk.CfnChannelPropsMixin.RecordConverterProperty(
    value_converter="valueConverter"
)

Attributes

value_converter

Value converter for topic data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-recordconverter.html#cfn-msk-channel-recordconverter-valueconverter

RecordSchemaProperty

class CfnChannelPropsMixin.RecordSchemaProperty(*, gsr_arn=None)

Bases: object

Record schema configuration for a topic.

Parameters:: gsr_arn (Optional[str]) – ARN of Glue Schema Registry resource used for table schema.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-recordschema.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.cfn_property_mixins import aws_msk as msk

record_schema_property = msk.CfnChannelPropsMixin.RecordSchemaProperty(
    gsr_arn="gsrArn"
)

Attributes

gsr_arn

ARN of Glue Schema Registry resource used for table schema.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-recordschema.html#cfn-msk-channel-recordschema-gsrarn

S3DestinationConfigurationProperty

class CfnChannelPropsMixin.S3DestinationConfigurationProperty(*, data_freshness_in_seconds=None, dead_letter_queue_s3=None, service_execution_role_arn=None, storage=None)

Bases: object

S3 destination configuration.

Parameters:

data_freshness_in_seconds (Union[int, float, None]) – Data freshness in seconds.
dead_letter_queue_s3 (Union[IResolvable, DeadLetterQueueS3Property, Dict[str, Any], None]) – Dead letter queue S3 configuration of the destination.
service_execution_role_arn (Optional[str]) – The Amazon Resource Name (ARN) of an IAM role used by MSK to access S3.
storage (Union[IResolvable, S3StorageProperty, Dict[str, Any], None]) – S3 storage configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-s3destinationconfiguration.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.cfn_property_mixins import aws_msk as msk

s3_destination_configuration_property = msk.CfnChannelPropsMixin.S3DestinationConfigurationProperty(
    data_freshness_in_seconds=123,
    dead_letter_queue_s3=msk.CfnChannelPropsMixin.DeadLetterQueueS3Property(
        bucket_arn="bucketArn",
        error_output_prefix="errorOutputPrefix",
        expected_bucket_owner="expectedBucketOwner"
    ),
    service_execution_role_arn="serviceExecutionRoleArn",
    storage=msk.CfnChannelPropsMixin.S3StorageProperty(
        bucket_arn="bucketArn",
        compression_type="compressionType",
        expected_bucket_owner="expectedBucketOwner",
        output_key_template="outputKeyTemplate",
        output_prefix="outputPrefix",
        storage_class="storageClass"
    )
)

Attributes

data_freshness_in_seconds

Data freshness in seconds.

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

dead_letter_queue_s3

Dead letter queue S3 configuration of the destination.

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

service_execution_role_arn

The Amazon Resource Name (ARN) of an IAM role used by MSK to access S3.

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

storage

S3 storage configuration.

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

S3LogDestinationProperty

class CfnChannelPropsMixin.S3LogDestinationProperty(*, bucket=None, enabled=None, prefix=None)

Bases: object

S3 log destination details.

Parameters:

bucket (Optional[str]) – The name of the S3 bucket for log delivery.
enabled (Union[bool, IResolvable, None]) – Whether S3 logging is enabled.
prefix (Optional[str]) – The S3 prefix for log delivery.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-s3logdestination.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.cfn_property_mixins import aws_msk as msk

s3_log_destination_property = msk.CfnChannelPropsMixin.S3LogDestinationProperty(
    bucket="bucket",
    enabled=False,
    prefix="prefix"
)

Attributes

bucket

The name of the S3 bucket for log delivery.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-s3logdestination.html#cfn-msk-channel-s3logdestination-bucket

enabled

Whether S3 logging is enabled.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-s3logdestination.html#cfn-msk-channel-s3logdestination-enabled

prefix

The S3 prefix for log delivery.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-s3logdestination.html#cfn-msk-channel-s3logdestination-prefix

S3StorageProperty

class CfnChannelPropsMixin.S3StorageProperty(*, bucket_arn=None, compression_type=None, expected_bucket_owner=None, output_key_template=None, output_prefix=None, storage_class=None)

Bases: object

S3 storage configuration.

Parameters:

bucket_arn (Optional[str]) – ARN of the S3 bucket.
compression_type (Optional[str]) – S3 compression type.
expected_bucket_owner (Optional[str]) – Optional 12-digit AWS account ID expected to own the S3 bucket.
output_key_template (Optional[str]) – Template for S3 key for output objects, used for partitioning.
output_prefix (Optional[str]) – Optional prefix for output objects.
storage_class (Optional[str]) – S3 storage class.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-s3storage.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.cfn_property_mixins import aws_msk as msk

s3_storage_property = msk.CfnChannelPropsMixin.S3StorageProperty(
    bucket_arn="bucketArn",
    compression_type="compressionType",
    expected_bucket_owner="expectedBucketOwner",
    output_key_template="outputKeyTemplate",
    output_prefix="outputPrefix",
    storage_class="storageClass"
)

Attributes

bucket_arn

ARN of the S3 bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-s3storage.html#cfn-msk-channel-s3storage-bucketarn

compression_type

S3 compression type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-s3storage.html#cfn-msk-channel-s3storage-compressiontype

expected_bucket_owner

Optional 12-digit AWS account ID expected to own the S3 bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-s3storage.html#cfn-msk-channel-s3storage-expectedbucketowner

output_key_template

Template for S3 key for output objects, used for partitioning.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-s3storage.html#cfn-msk-channel-s3storage-outputkeytemplate

output_prefix

Optional prefix for output objects.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-s3storage.html#cfn-msk-channel-s3storage-outputprefix

storage_class

S3 storage class.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-s3storage.html#cfn-msk-channel-s3storage-storageclass

SchemaEvolutionProperty

class CfnChannelPropsMixin.SchemaEvolutionProperty(*, enable_schema_evolution=None)

Bases: object

Schema evolution configuration of the destination.

Parameters:: enable_schema_evolution (Union[bool, IResolvable, None]) – Whether schema evolution is enabled. Default: - false
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-schemaevolution.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.cfn_property_mixins import aws_msk as msk

schema_evolution_property = msk.CfnChannelPropsMixin.SchemaEvolutionProperty(
    enable_schema_evolution=False
)

Attributes

enable_schema_evolution

Whether schema evolution is enabled.

Default:

false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-schemaevolution.html#cfn-msk-channel-schemaevolution-enableschemaevolution

TableCreationProperty

class CfnChannelPropsMixin.TableCreationProperty(*, enable_table_creation=None)

Bases: object

Table creation configuration of the destination.

Parameters:: enable_table_creation (Union[bool, IResolvable, None]) – Whether table creation is enabled. Default: - true
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-tablecreation.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.cfn_property_mixins import aws_msk as msk

table_creation_property = msk.CfnChannelPropsMixin.TableCreationProperty(
    enable_table_creation=False
)

Attributes

enable_table_creation

Whether table creation is enabled.

Default:

true

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-tablecreation.html#cfn-msk-channel-tablecreation-enabletablecreation

TopicConfigurationProperty

class CfnChannelPropsMixin.TopicConfigurationProperty(*, record_converter=None, record_schema=None, topic_arn=None)

Bases: object

Configuration of topic in a channel.

Parameters:

record_converter (Union[IResolvable, RecordConverterProperty, Dict[str, Any], None]) – Record converter configuration for a topic.
record_schema (Union[IResolvable, RecordSchemaProperty, Dict[str, Any], None]) – Record schema configuration for a topic.
topic_arn (Optional[str]) – The Amazon Resource Name (ARN) that uniquely identifies the topic.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-topicconfiguration.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.cfn_property_mixins import aws_msk as msk

topic_configuration_property = msk.CfnChannelPropsMixin.TopicConfigurationProperty(
    record_converter=msk.CfnChannelPropsMixin.RecordConverterProperty(
        value_converter="valueConverter"
    ),
    record_schema=msk.CfnChannelPropsMixin.RecordSchemaProperty(
        gsr_arn="gsrArn"
    ),
    topic_arn="topicArn"
)

Attributes

record_converter

Record converter configuration for a topic.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-topicconfiguration.html#cfn-msk-channel-topicconfiguration-recordconverter

record_schema

Record schema configuration for a topic.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-topicconfiguration.html#cfn-msk-channel-topicconfiguration-recordschema

topic_arn

The Amazon Resource Name (ARN) that uniquely identifies the topic.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-channel-topicconfiguration.html#cfn-msk-channel-topicconfiguration-topicarn