CfnStreamConsumerProps

class aws_cdk.aws_kinesis.CfnStreamConsumerProps(*, consumer_name, stream_arn, tags=None)

Bases: object

Properties for defining a CfnStreamConsumer.

Parameters:

  • consumer_name (str) – The name of the consumer is something you choose when you register the consumer.

  • stream_arn (str) – The ARN of the stream with which you registered the consumer.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of tags to be added to a specified Kinesis resource. A tag consists of a required key and an optional value. You can specify up to 50 tag key-value pairs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesis-streamconsumer.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_kinesis as kinesis

cfn_stream_consumer_props = kinesis.CfnStreamConsumerProps(
    consumer_name="consumerName",
    stream_arn="streamArn",

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

Attributes

consumer_name

The name of the consumer is something you choose when you register the consumer.

See:

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

stream_arn

The ARN of the stream with which you registered the consumer.

See:

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

tags

An array of tags to be added to a specified Kinesis resource.

A tag consists of a required key and an optional value. You can specify up to 50 tag key-value pairs.

See:

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