Package software.amazon.awscdk.services.kinesis

Interface CfnStreamConsumerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStreamConsumerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-09-02T11:25:33.573Z")
@Stability(Stable)
public interface CfnStreamConsumerProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnStreamConsumer.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kinesis.*;
 CfnStreamConsumerProps cfnStreamConsumerProps = CfnStreamConsumerProps.builder()
         .consumerName("consumerName")
         .streamArn("streamArn")
         // the properties below are optional
         .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	CfnStreamConsumerProps.Builder	A builder for CfnStreamConsumerProps
static final class	CfnStreamConsumerProps.Jsii$Proxy	An implementation for CfnStreamConsumerProps

Method Summary

Modifier and Type	Method	Description
static CfnStreamConsumerProps.Builder	builder()
String	getConsumerName()	The name of the consumer is something you choose when you register the consumer.
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)
@NotNull
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)
@NotNull
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 CfnStreamConsumerProps.Builder builder()

Returns:

a CfnStreamConsumerProps.Builder of CfnStreamConsumerProps