CfnChannel

class aws_cdk.aws_msk.CfnChannel(scope, id, *, 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: CfnResource

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

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 = msk.CfnChannel(self, "MyCfnChannel",
    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"
    }
)

Create a new AWS::MSK::Channel.

Parameters:

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_dependency(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

Parameters:

target (CfnResource)

Deprecated:

Use addResourceDependency instead.

Stability:

deprecated

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

Parameters:

target (CfnResource)

Deprecated:

Use addResourceDependency instead.

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str)

  • value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

add_resource_dependency(target, reason=None)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

Parameters:
Return type:

None

apply_cross_stack_reference_strength(strength)

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack’s context.

Parameters:

strength (ReferenceStrength) –

  • The reference strength to use for this resource.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

  • policy (Optional[RemovalPolicy])

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

cfn_property_name(cdk_property_name)
Parameters:

cdk_property_name (str)

Return type:

Optional[str]

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

  • attribute_name (str) – The name of the attribute.

  • type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str)

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) – tree inspector to collect and process attributes.

Return type:

None

obtain_dependencies()

Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

Return type:

List[Union[Stack, CfnResource]]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

remove_dependency(target)

(deprecated) Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Deprecated:

Use removeResourceDependency instead

Stability:

deprecated

Return type:

None

remove_resource_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource)

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:
Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

with_(*mixins)

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

mixins (IMixin)

Return type:

IConstruct

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::MSK::Channel'
attr_channel_arn

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

CloudformationAttribute:

ChannelArn

attr_state_info

Includes information about the channel state.

CloudformationAttribute:

StateInfo

attr_status

Status of a channel resource.

CloudformationAttribute:

Status

cdk_tag_manager

Tag Manager which manages the tags for this resource.

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

channel_name

Name of the channel.

channel_ref

A reference to a Channel resource.

cluster_arn

The Amazon Resource Name (ARN) of the cluster.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

encryption_configuration

Encryption configuration.

env
iceberg_destination_configuration

Iceberg destination configuration.

logging_info

Log configuration details for Channel.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

s3_destination_configuration

S3 destination configuration.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags

Tags attached to the channel.

topic_configuration_list

Topic configuration.

Static Methods

classmethod arn_for_channel(resource)
Parameters:

resource (IChannelRef)

Return type:

str

classmethod is_cfn_channel(x)

Checks whether the given object is a CfnChannel.

Parameters:

x (Any)

Return type:

bool

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any)

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any)

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

CatalogProperty

class CfnChannel.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 import aws_msk as msk

catalog_property = msk.CfnChannel.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 CfnChannel.ChannelLoggingInfoProperty(*, cloud_watch_logs=None, firehose=None, s3=None)

Bases: object

Log configuration details for Channel.

Parameters:
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 import aws_msk as msk

channel_logging_info_property = 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"
    )
)

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 CfnChannel.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 import aws_msk as msk

channel_state_info_property = msk.CfnChannel.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 CfnChannel.CloudWatchLogsLogDestinationProperty(*, enabled, log_group=None)

Bases: object

CloudWatch Logs log destination details.

Parameters:

  • enabled (Union[bool, IResolvable]) – 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 import aws_msk as msk

cloud_watch_logs_log_destination_property = msk.CfnChannel.CloudWatchLogsLogDestinationProperty(
    enabled=False,

    # the properties below are optional
    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 CfnChannel.DeadLetterQueueS3Property(*, bucket_arn, error_output_prefix, expected_bucket_owner=None)

Bases: object

Dead letter queue S3 configuration of the destination.

Parameters:

  • bucket_arn (str) – The ARN of the S3 bucket.

  • error_output_prefix (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 import aws_msk as msk

dead_letter_queue_s3_property = msk.CfnChannel.DeadLetterQueueS3Property(
    bucket_arn="bucketArn",
    error_output_prefix="errorOutputPrefix",

    # the properties below are optional
    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 CfnChannel.DestinationTableProperty(*, destination_database_name, destination_table_name, partition_spec=None)

Bases: object

Destination table configuration.

Parameters:

  • destination_database_name (str) – The destination database name.

  • destination_table_name (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 import aws_msk as msk

destination_table_property = 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"
        )]
    )
)

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 CfnChannel.EncryptionConfigurationProperty(*, kms_key_arn)

Bases: object

Encryption configuration.

Parameters:

kms_key_arn (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 import aws_msk as msk

encryption_configuration_property = msk.CfnChannel.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 CfnChannel.FirehoseLogDestinationProperty(*, enabled, delivery_stream=None)

Bases: object

Firehose log destination details.

Parameters:

  • enabled (Union[bool, IResolvable]) – Whether Firehose logging is enabled.

  • delivery_stream (Optional[str]) – The Firehose delivery stream for log delivery.

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 import aws_msk as msk

firehose_log_destination_property = msk.CfnChannel.FirehoseLogDestinationProperty(
    enabled=False,

    # the properties below are optional
    delivery_stream="deliveryStream"
)

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 CfnChannel.IcebergDestinationConfigurationProperty(*, append_only, dead_letter_queue_s3, destination_table_list, schema_evolution, service_execution_role_arn, table_creation, catalog=None, compression_type=None, data_freshness_in_seconds=None)

Bases: object

Iceberg destination configuration.

Parameters:

  • append_only (Union[bool, IResolvable]) – Append only mode. Default: - true

  • dead_letter_queue_s3 (Union[IResolvable, DeadLetterQueueS3Property, Dict[str, Any]]) – Dead letter queue S3 configuration of the destination.

  • destination_table_list (Union[IResolvable, Sequence[Union[IResolvable, DestinationTableProperty, Dict[str, Any]]]]) – List of destination tables.

  • schema_evolution (Union[IResolvable, SchemaEvolutionProperty, Dict[str, Any]]) – Schema evolution configuration of the destination.

  • service_execution_role_arn (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]]) – Table creation configuration of the destination.

  • 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.

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 import aws_msk as msk

iceberg_destination_configuration_property = 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
)

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 CfnChannel.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 import aws_msk as msk

partition_source_property = msk.CfnChannel.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 CfnChannel.PartitionSpecProperty(*, partition_strategy, source_list=None)

Bases: object

Partition specification.

Parameters:
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 import aws_msk as msk

partition_spec_property = msk.CfnChannel.PartitionSpecProperty(
    partition_strategy="partitionStrategy",

    # the properties below are optional
    source_list=[msk.CfnChannel.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 CfnChannel.RecordConverterProperty(*, value_converter)

Bases: object

Record converter configuration for a topic.

Parameters:

value_converter (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 import aws_msk as msk

record_converter_property = msk.CfnChannel.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 CfnChannel.RecordSchemaProperty(*, gsr_arn)

Bases: object

Record schema configuration for a topic.

Parameters:

gsr_arn (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 import aws_msk as msk

record_schema_property = msk.CfnChannel.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 CfnChannel.S3DestinationConfigurationProperty(*, dead_letter_queue_s3, service_execution_role_arn, storage, data_freshness_in_seconds=None)

Bases: object

S3 destination configuration.

Parameters:

  • dead_letter_queue_s3 (Union[IResolvable, DeadLetterQueueS3Property, Dict[str, Any]]) – Dead letter queue S3 configuration of the destination.

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

  • storage (Union[IResolvable, S3StorageProperty, Dict[str, Any]]) – S3 storage configuration.

  • data_freshness_in_seconds (Union[int, float, None]) – Data freshness in seconds.

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 import aws_msk as msk

s3_destination_configuration_property = 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
)

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 CfnChannel.S3LogDestinationProperty(*, enabled, bucket=None, prefix=None)

Bases: object

S3 log destination details.

Parameters:

  • enabled (Union[bool, IResolvable]) – Whether S3 logging is enabled.

  • bucket (Optional[str]) – The name of the S3 bucket for log delivery.

  • 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 import aws_msk as msk

s3_log_destination_property = msk.CfnChannel.S3LogDestinationProperty(
    enabled=False,

    # the properties below are optional
    bucket="bucket",
    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 CfnChannel.S3StorageProperty(*, bucket_arn, compression_type, storage_class, expected_bucket_owner=None, output_key_template=None, output_prefix=None)

Bases: object

S3 storage configuration.

Parameters:

  • bucket_arn (str) – ARN of the S3 bucket.

  • compression_type (str) – S3 compression type.

  • storage_class (str) – S3 storage class.

  • 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.

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 import aws_msk as msk

s3_storage_property = 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"
)

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 CfnChannel.SchemaEvolutionProperty(*, enable_schema_evolution)

Bases: object

Schema evolution configuration of the destination.

Parameters:

enable_schema_evolution (Union[bool, IResolvable]) – 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 import aws_msk as msk

schema_evolution_property = msk.CfnChannel.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 CfnChannel.TableCreationProperty(*, enable_table_creation)

Bases: object

Table creation configuration of the destination.

Parameters:

enable_table_creation (Union[bool, IResolvable]) – 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 import aws_msk as msk

table_creation_property = msk.CfnChannel.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 CfnChannel.TopicConfigurationProperty(*, record_converter, topic_arn, record_schema=None)

Bases: object

Configuration of topic in a channel.

Parameters:

  • record_converter (Union[IResolvable, RecordConverterProperty, Dict[str, Any]]) – Record converter configuration for a topic.

  • topic_arn (str) – The Amazon Resource Name (ARN) that uniquely identifies the topic.

  • record_schema (Union[IResolvable, RecordSchemaProperty, Dict[str, Any], None]) – Record schema configuration for a 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 import aws_msk as msk

topic_configuration_property = 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"
    )
)

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