Package software.amazon.awscdk.cfnpropertymixins.services.kinesis

Interface CfnStreamConsumerMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStreamConsumerMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:00.671Z")
@Stability(Stable)
public interface CfnStreamConsumerMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnStreamConsumerPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.kinesis.*;
 CfnStreamConsumerMixinProps cfnStreamConsumerMixinProps = CfnStreamConsumerMixinProps.builder()
         .consumerName("consumerName")
         .streamArn("streamArn")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnStreamConsumerMixinProps.Builder	A builder for CfnStreamConsumerMixinProps
static final class	CfnStreamConsumerMixinProps.Jsii$Proxy	An implementation for CfnStreamConsumerMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnStreamConsumerMixinProps.Builder	builder()
default String	getConsumerName()	The name of the consumer is something you choose when you register the consumer.
default String	getStreamArn()	The ARN of the stream with which you registered the consumer.
default List<CfnTag>	getTags()	An array of tags to be added to a specified Kinesis resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConsumerName

@Stability(Stable)
@Nullable
default String getConsumerName()

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

See Also:

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

getStreamArn

@Stability(Stable)
@Nullable
default String getStreamArn()

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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 Also:

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

builder

@Stability(Stable)
static CfnStreamConsumerMixinProps.Builder builder()

Returns:

a CfnStreamConsumerMixinProps.Builder of CfnStreamConsumerMixinProps