Skip to content

CreateChannelInput

Source code in docs_src/capo_kinesis/types/create_channel_input.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
class CreateChannelInput(TypedDict, closed=True):
    channel_name: "capo_kinesis.types.channel_name.ChannelName"
    """<p>The name of the channel. The name is unique within your Amazon Web Services account and Amazon Web Services Region.</p>"""
    service_execution_role_arn: "capo_kinesis.types.role_arn.RoleARN"
    """<p>The Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Data Streams assumes to write records to the destination.</p>"""
    stream_configuration_list: "capo_kinesis.types.channel_stream_configuration_list.ChannelStreamConfigurationList"
    """<p>The source stream configuration for the channel. Currently, one stream is supported per channel.</p>"""
    s3_destination_configuration: NotRequired[
        "capo_kinesis.types.s3_destination_configuration.S3DestinationConfiguration"
    ]
    """<p>The configuration for delivery to a general purpose Amazon S3 bucket. Specify this parameter when <code>S3TablesDestinationConfiguration</code> is not specified.</p>"""
    s3_tables_destination_configuration: NotRequired[
        "capo_kinesis.types.s3_tables_destination_configuration.S3TablesDestinationConfiguration"
    ]
    """<p>The configuration for delivery to streaming tables on Apache Iceberg in Amazon S3 Tables. Specify this parameter when <code>S3DestinationConfiguration</code> is not specified.</p>"""
    encryption_configuration: NotRequired[
        "capo_kinesis.types.channel_encryption_configuration.ChannelEncryptionConfiguration"
    ]
    """<p>The server-side encryption configuration that uses an Amazon Web Services KMS key to encrypt data delivered to the destination.</p>"""
    tags: NotRequired["capo_kinesis.types.tag_map.TagMap"]
    """<p>A set of key-value pairs to assign to the channel. A tag consists of a required key and an optional value.</p>"""
    logging_configuration: NotRequired[
        "capo_kinesis.types.channel_logging_configuration.ChannelLoggingConfiguration"
    ]
    """<p>The Amazon CloudWatch Logs configuration for the channel.</p>"""

channel_name instance-attribute 

channel_name: ChannelName

The name of the channel. The name is unique within your Amazon Web Services account and Amazon Web Services Region.

encryption_configuration instance-attribute 

encryption_configuration: NotRequired[ChannelEncryptionConfiguration]

The server-side encryption configuration that uses an Amazon Web Services KMS key to encrypt data delivered to the destination.

logging_configuration instance-attribute 

logging_configuration: NotRequired[ChannelLoggingConfiguration]

The Amazon CloudWatch Logs configuration for the channel.

s3_destination_configuration instance-attribute 

s3_destination_configuration: NotRequired[S3DestinationConfiguration]

The configuration for delivery to a general purpose Amazon S3 bucket. Specify this parameter when S3TablesDestinationConfiguration is not specified.

s3_tables_destination_configuration instance-attribute 

s3_tables_destination_configuration: NotRequired[S3TablesDestinationConfiguration]

The configuration for delivery to streaming tables on Apache Iceberg in Amazon S3 Tables. Specify this parameter when S3DestinationConfiguration is not specified.

service_execution_role_arn instance-attribute 

service_execution_role_arn: RoleARN

The Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Data Streams assumes to write records to the destination.

stream_configuration_list instance-attribute 

stream_configuration_list: ChannelStreamConfigurationList

The source stream configuration for the channel. Currently, one stream is supported per channel.

tags instance-attribute 

tags: NotRequired[TagMap]

A set of key-value pairs to assign to the channel. A tag consists of a required key and an optional value.