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

Class CfnStreamPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.kinesis.CfnStreamPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnStreamPropsMixin>

Enclosing class:

CfnStreamPropsMixin

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

A fluent builder for CfnStreamPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnStreamPropsMixin	build()
static CfnStreamPropsMixin.Builder	create()
static CfnStreamPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnStreamPropsMixin.Builder	desiredShardLevelMetrics(List<String> desiredShardLevelMetrics)	A list of shard-level metrics in properties to enable enhanced monitoring mode.
CfnStreamPropsMixin.Builder	maxRecordSizeInKiB(Number maxRecordSizeInKiB)	The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.
CfnStreamPropsMixin.Builder	name(String name)	The name of the Kinesis stream.
CfnStreamPropsMixin.Builder	retentionPeriodHours(Number retentionPeriodHours)	The number of hours for the data records that are stored in shards to remain accessible.
CfnStreamPropsMixin.Builder	shardCount(Number shardCount)	The number of shards that the stream uses.
CfnStreamPropsMixin.Builder	streamEncryption(CfnStreamPropsMixin.StreamEncryptionProperty streamEncryption)	When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
CfnStreamPropsMixin.Builder	streamEncryption(IResolvable streamEncryption)	When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
CfnStreamPropsMixin.Builder	streamModeDetails(CfnStreamPropsMixin.StreamModeDetailsProperty streamModeDetails)	Specifies the capacity mode to which you want to set your data stream.
CfnStreamPropsMixin.Builder	streamModeDetails(IResolvable streamModeDetails)	Specifies the capacity mode to which you want to set your data stream.
CfnStreamPropsMixin.Builder	tags(List<? extends CfnTag> tags)	An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.
CfnStreamPropsMixin.Builder	warmThroughputMiBps(Number warmThroughputMiBps)	The target warm throughput in MB/s that the stream should be scaled to handle.

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 CfnStreamPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnStreamPropsMixin.Builder.

create

@Stability(Stable)
public static CfnStreamPropsMixin.Builder create()

Returns:

a new instance of CfnStreamPropsMixin.Builder.

desiredShardLevelMetrics

@Stability(Stable)
public CfnStreamPropsMixin.Builder desiredShardLevelMetrics(List<String> desiredShardLevelMetrics)

A list of shard-level metrics in properties to enable enhanced monitoring mode.

Parameters:

desiredShardLevelMetrics - A list of shard-level metrics in properties to enable enhanced monitoring mode. This parameter is required.

Returns:

this

See Also:

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

maxRecordSizeInKiB

@Stability(Stable)
public CfnStreamPropsMixin.Builder maxRecordSizeInKiB(Number maxRecordSizeInKiB)

The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a stream.

Parameters:

maxRecordSizeInKiB - The maximum record size of a single record in kibibyte (KiB) that you can write to, and read from a 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-maxrecordsizeinkib

name

@Stability(Stable)
public CfnStreamPropsMixin.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 CfnStreamPropsMixin.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 CfnStreamPropsMixin.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 CfnStreamPropsMixin.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 CfnStreamPropsMixin.Builder streamEncryption(CfnStreamPropsMixin.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 CfnStreamPropsMixin.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 CfnStreamPropsMixin.Builder streamModeDetails(CfnStreamPropsMixin.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 CfnStreamPropsMixin.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

warmThroughputMiBps

@Stability(Stable)
public CfnStreamPropsMixin.Builder warmThroughputMiBps(Number warmThroughputMiBps)

The target warm throughput in MB/s that the stream should be scaled to handle.

This represents the throughput capacity that will be immediately available for write operations.

Parameters:

warmThroughputMiBps - The target warm throughput in MB/s that the stream should be scaled to handle. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnStreamPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnStreamPropsMixin.