Skip to content

CreateStreamInput

Source code in docs_src/capo_dsql/types/create_stream_input.py
class CreateStreamInput(TypedDict, closed=True):
    cluster_identifier: "capo_dsql.types.cluster_id.ClusterId"
    """<p>The ID of the cluster for which to create the stream.</p>"""
    target_definition: "capo_dsql.types.target_definition.TargetDefinition"
    """<p>The target destination configuration for the stream. Contains Kinesis stream configuration including stream ARN and IAM role ARN.</p>"""
    ordering: "capo_dsql.types.stream_ordering.StreamOrdering"
    """<p>The ordering mode for the stream. Determines how change events are ordered when delivered to the target.</p>"""
    format: "capo_dsql.types.stream_format.StreamFormat"
    """<p>The format of the stream records.</p>"""
    tags: NotRequired["capo_dsql.types.tag_map.TagMap"]
    """<p>A map of key and value pairs to use to tag your stream.</p>"""
    client_token: NotRequired["capo_dsql.types.client_token.ClientToken"]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect.</p> <p>If you don't specify a client token, the Amazon Web Services SDK automatically generates one.</p>"""

client_token instance-attribute

client_token: NotRequired[ClientToken]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

If you don't specify a client token, the Amazon Web Services SDK automatically generates one.

cluster_identifier instance-attribute

cluster_identifier: ClusterId

The ID of the cluster for which to create the stream.

format instance-attribute

format: StreamFormat

The format of the stream records.

ordering instance-attribute

ordering: StreamOrdering

The ordering mode for the stream. Determines how change events are ordered when delivered to the target.

tags instance-attribute

tags: NotRequired[TagMap]

A map of key and value pairs to use to tag your stream.

target_definition instance-attribute

target_definition: TargetDefinition

The target destination configuration for the stream. Contains Kinesis stream configuration including stream ARN and IAM role ARN.