Package software.amazon.awscdk.services.kinesis

Class CfnStream.Builder

java.lang.Object

software.amazon.awscdk.services.kinesis.CfnStream.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnStream>

Enclosing class:

CfnStream

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

A fluent builder for CfnStream.

Method Summary

Modifier and Type	Method	Description
CfnStream	build()
static CfnStream.Builder	create(software.constructs.Construct scope, String id)
CfnStream.Builder	name(String name)	The name of the Kinesis stream.
CfnStream.Builder	retentionPeriodHours(Number retentionPeriodHours)	The number of hours for the data records that are stored in shards to remain accessible.
CfnStream.Builder	shardCount(Number shardCount)	The number of shards that the stream uses.
CfnStream.Builder	streamEncryption(IResolvable streamEncryption)	When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
CfnStream.Builder	streamEncryption(CfnStream.StreamEncryptionProperty streamEncryption)	When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
CfnStream.Builder	streamModeDetails(IResolvable streamModeDetails)	Specifies the capacity mode to which you want to set your data stream.
CfnStream.Builder	streamModeDetails(CfnStream.StreamModeDetailsProperty streamModeDetails)	Specifies the capacity mode to which you want to set your data stream.
CfnStream.Builder	tags(List<? extends CfnTag> tags)	An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.

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 CfnStream.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 CfnStream.Builder.

name

@Stability(Stable)
public CfnStream.Builder name(String name)

The name of the Kinesis stream.

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the stream name. For more information, see Name Type .

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

Parameters:

name - The name of the Kinesis stream. This parameter is required.

Returns:

this

See Also:

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

retentionPeriodHours

@Stability(Stable)
public CfnStream.Builder retentionPeriodHours(Number retentionPeriodHours)

The number of hours for the data records that are stored in shards to remain accessible.

The default value is 24. For more information about the stream retention period, see Changing the Data Retention Period in the Amazon Kinesis Developer Guide.

Parameters:

retentionPeriodHours - The number of hours for the data records that are stored in shards to remain accessible. This parameter is required.

Returns:

this

See Also:

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

shardCount

@Stability(Stable)
public CfnStream.Builder shardCount(Number shardCount)

The number of shards that the stream uses.

For greater provisioned throughput, increase the number of shards.

Parameters:

shardCount - The number of shards that the stream uses. This parameter is required.

Returns:

this

See Also:

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

streamEncryption

@Stability(Stable)
public CfnStream.Builder streamEncryption(IResolvable streamEncryption)

When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.

Removing this property from your stack template and updating your stack disables encryption.

Parameters:

streamEncryption - When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream. This parameter is required.

Returns:

this

See Also:

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

streamEncryption

@Stability(Stable)
public CfnStream.Builder streamEncryption(CfnStream.StreamEncryptionProperty streamEncryption)

When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.

Removing this property from your stack template and updating your stack disables encryption.

Parameters:

streamEncryption - When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream. This parameter is required.

Returns:

this

See Also:

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

streamModeDetails

@Stability(Stable)
public CfnStream.Builder streamModeDetails(IResolvable streamModeDetails)

Specifies the capacity mode to which you want to set your data stream.

Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

Parameters:

streamModeDetails - Specifies the capacity mode to which you want to set your data stream. This parameter is required.

Returns:

this

See Also:

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

streamModeDetails

@Stability(Stable)
public CfnStream.Builder streamModeDetails(CfnStream.StreamModeDetailsProperty streamModeDetails)

Specifies the capacity mode to which you want to set your data stream.

Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

Parameters:

streamModeDetails - Specifies the capacity mode to which you want to set your data stream. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnStream.Builder tags(List<? extends CfnTag> tags)

An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.

For information about constraints for this property, see Tag Restrictions in the Amazon Kinesis Developer Guide .

Parameters:

tags - An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnStream build()

Specified by:

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

Returns:

a newly built instance of CfnStream.