Package software.amazon.awscdk.services.kinesis

Class CfnStreamConsumer.Builder

java.lang.Object

software.amazon.awscdk.services.kinesis.CfnStreamConsumer.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnStreamConsumer>

Enclosing class:

CfnStreamConsumer

@Stability(Stable)
public static final class CfnStreamConsumer.Builder
extends Object
implements software.amazon.jsii.Builder<CfnStreamConsumer>

A fluent builder for CfnStreamConsumer.

Method Summary

Modifier and Type	Method	Description
CfnStreamConsumer	build()
CfnStreamConsumer.Builder	consumerName(String consumerName)	The name of the consumer is something you choose when you register the consumer.
static CfnStreamConsumer.Builder	create(software.constructs.Construct scope, String id)
CfnStreamConsumer.Builder	streamArn(String streamArn)	The ARN of the stream with which you registered the consumer.
CfnStreamConsumer.Builder	tags(List<? extends CfnTag> tags)	An array of tags to be added to a specified Kinesis resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnStreamConsumer.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnStreamConsumer.Builder.

consumerName

@Stability(Stable)
public CfnStreamConsumer.Builder consumerName(String consumerName)

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

Parameters:

consumerName - The name of the consumer is something you choose when you register the consumer. This parameter is required.

Returns:

this

See Also:

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

streamArn

@Stability(Stable)
public CfnStreamConsumer.Builder streamArn(String streamArn)

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

Parameters:

streamArn - The ARN of the stream with which you registered the consumer. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnStreamConsumer.Builder tags(List<? extends CfnTag> 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.

Parameters:

tags - An array of tags to be added to a specified Kinesis resource. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnStreamConsumer build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnStreamConsumer>

Returns:

a newly built instance of CfnStreamConsumer.