CfnChannelProps

class aws_cdk.aws_kinesis.CfnChannelProps(*, channel_name, service_execution_role_arn, stream_configuration_list, encryption_configuration=None, logging_configuration=None, s3_destination_configuration=None, s3_tables_destination_configuration=None, tags=None)

Bases: object

Properties for defining a CfnChannel.

Parameters:

• channel_name (str) – The name of the channel. The name’s uniqueness is scoped per AWS account and region.

• service_execution_role_arn (str) – The ARN of the IAM role that the channel assumes to read from the source stream, deliver records to the destination, and (when enabled) write CloudWatch Logs.

• stream_configuration_list (Union[IResolvable, Sequence[Union[IResolvable, StreamConfigurationProperty, Dict[str, Any]]]]) – List of stream configurations associated with the channel. v1 supports a single element; the list shape allows future extensibility to fan in from multiple streams.

• encryption_configuration (Union[IResolvable, EncryptionConfigurationProperty, Dict[str, Any], None]) – Server-side encryption configuration for data at rest in the destination. Data delivered to S3 / S3 Tables is encrypted with the same key.

• logging_configuration (Union[IResolvable, LoggingConfigurationProperty, Dict[str, Any], None]) – Configuration for delivering channel operational logs.

• s3_destination_configuration (Union[IResolvable, S3DestinationConfigurationProperty, Dict[str, Any], None]) – Configuration for delivery to a vanilla S3 bucket destination. Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified on the channel.

• s3_tables_destination_configuration (Union[IResolvable, S3TablesDestinationConfigurationProperty, Dict[str, Any], None]) – Configuration for delivery to S3 Tables destinations. Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified on the channel.

• tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An arbitrary set of tags (key-value pairs) to associate with the Kinesis channel.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

cfn_channel_props = kinesis.CfnChannelProps(
    channel_name="channelName",
    service_execution_role_arn="serviceExecutionRoleArn",
    stream_configuration_list=[kinesis.CfnChannel.StreamConfigurationProperty(
        record_configuration=kinesis.CfnChannel.RecordConfigurationProperty(
            record_format_type="recordFormatType",

            # the properties below are optional
            gsr_schema_arn="gsrSchemaArn"
        ),
        stream_arn="streamArn"
    )],

    # the properties below are optional
    encryption_configuration=kinesis.CfnChannel.EncryptionConfigurationProperty(
        encryption_type="encryptionType",
        key_id="keyId"
    ),
    logging_configuration=kinesis.CfnChannel.LoggingConfigurationProperty(
        cloud_watch_logs=kinesis.CfnChannel.CloudWatchLogsConfigurationProperty(
            enabled=False,

            # the properties below are optional
            log_group_name="logGroupName",
            log_stream_name="logStreamName"
        )
    ),
    s3_destination_configuration=kinesis.CfnChannel.S3DestinationConfigurationProperty(
        storage_configuration=kinesis.CfnChannel.S3StorageConfigurationProperty(
            bucket_arn="bucketArn",
            compression_type="compressionType",
            expected_bucket_owner="expectedBucketOwner",

            # the properties below are optional
            output_key_template="outputKeyTemplate",
            storage_class="storageClass"
        ),

        # the properties below are optional
        data_freshness_in_seconds=123,
        dead_letter_queue_s3_configuration=kinesis.CfnChannel.DeadLetterQueueS3ConfigurationProperty(
            bucket_arn="bucketArn",
            expected_bucket_owner="expectedBucketOwner",

            # the properties below are optional
            error_output_prefix="errorOutputPrefix"
        )
    ),
    s3_tables_destination_configuration=kinesis.CfnChannel.S3TablesDestinationConfigurationProperty(
        dead_letter_queue_s3_configuration=kinesis.CfnChannel.DeadLetterQueueS3ConfigurationProperty(
            bucket_arn="bucketArn",
            expected_bucket_owner="expectedBucketOwner",

            # the properties below are optional
            error_output_prefix="errorOutputPrefix"
        ),
        s3_tables_configuration_list=[kinesis.CfnChannel.S3TableConfigurationProperty(
            compression_type="compressionType",
            namespace="namespace",
            table_bucket_arn="tableBucketArn",
            table_name="tableName",

            # the properties below are optional
            partition_spec=kinesis.CfnChannel.PartitionSpecProperty(
                partition_fields=[kinesis.CfnChannel.PartitionFieldProperty(
                    source_name="sourceName",
                    transform="transform"
                )]
            )
        )],

        # the properties below are optional
        data_freshness_in_seconds=123
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

channel_name

The name of the channel.

The name’s uniqueness is scoped per AWS account and region.

See:

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

encryption_configuration

Server-side encryption configuration for data at rest in the destination.

Data delivered to S3 / S3 Tables is encrypted with the same key.

See:

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

logging_configuration

Configuration for delivering channel operational logs.

See:

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

s3_destination_configuration

Configuration for delivery to a vanilla S3 bucket destination.

Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified on the channel.

See:

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

s3_tables_destination_configuration

Configuration for delivery to S3 Tables destinations.

Exactly one of S3DestinationConfiguration and S3TablesDestinationConfiguration must be specified on the channel.

See:

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

service_execution_role_arn

The ARN of the IAM role that the channel assumes to read from the source stream, deliver records to the destination, and (when enabled) write CloudWatch Logs.

See:

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

stream_configuration_list

List of stream configurations associated with the channel.

v1 supports a single element; the list shape allows future extensibility to fan in from multiple streams.

See:

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

tags

An arbitrary set of tags (key-value pairs) to associate with the Kinesis channel.

See:

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