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

Class CfnStreamMixinProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnStreamMixinProps>

Enclosing interface:

CfnStreamMixinProps

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

A builder for CfnStreamMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnStreamMixinProps	build()	Builds the configured instance.
CfnStreamMixinProps.Builder	desiredShardLevelMetrics(List<String> desiredShardLevelMetrics)	Sets the value of CfnStreamMixinProps.getDesiredShardLevelMetrics()
CfnStreamMixinProps.Builder	maxRecordSizeInKiB(Number maxRecordSizeInKiB)	Sets the value of CfnStreamMixinProps.getMaxRecordSizeInKiB()
CfnStreamMixinProps.Builder	name(String name)	Sets the value of CfnStreamMixinProps.getName()
CfnStreamMixinProps.Builder	retentionPeriodHours(Number retentionPeriodHours)	Sets the value of CfnStreamMixinProps.getRetentionPeriodHours()
CfnStreamMixinProps.Builder	shardCount(Number shardCount)	Sets the value of CfnStreamMixinProps.getShardCount()
CfnStreamMixinProps.Builder	streamEncryption(CfnStreamPropsMixin.StreamEncryptionProperty streamEncryption)	Sets the value of CfnStreamMixinProps.getStreamEncryption()
CfnStreamMixinProps.Builder	streamEncryption(IResolvable streamEncryption)	Sets the value of CfnStreamMixinProps.getStreamEncryption()
CfnStreamMixinProps.Builder	streamModeDetails(CfnStreamPropsMixin.StreamModeDetailsProperty streamModeDetails)	Sets the value of CfnStreamMixinProps.getStreamModeDetails()
CfnStreamMixinProps.Builder	streamModeDetails(IResolvable streamModeDetails)	Sets the value of CfnStreamMixinProps.getStreamModeDetails()
CfnStreamMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnStreamMixinProps.getTags()
CfnStreamMixinProps.Builder	warmThroughputMiBps(Number warmThroughputMiBps)	Sets the value of CfnStreamMixinProps.getWarmThroughputMiBps()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

desiredShardLevelMetrics

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

Sets the value of CfnStreamMixinProps.getDesiredShardLevelMetrics()

Parameters:

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

Returns:

this

maxRecordSizeInKiB

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

Sets the value of CfnStreamMixinProps.getMaxRecordSizeInKiB()

Parameters:

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

Returns:

this

name

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

Sets the value of CfnStreamMixinProps.getName()

Parameters:

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.

Returns:

this

retentionPeriodHours

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

Sets the value of CfnStreamMixinProps.getRetentionPeriodHours()

Parameters:

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.

Returns:

this

shardCount

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

Sets the value of CfnStreamMixinProps.getShardCount()

Parameters:

shardCount - The number of shards that the stream uses. For greater provisioned throughput, increase the number of shards.

Returns:

this

streamEncryption

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

Sets the value of CfnStreamMixinProps.getStreamEncryption()

Parameters:

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.

Returns:

this

streamEncryption

@Stability(Stable)
public CfnStreamMixinProps.Builder streamEncryption(CfnStreamPropsMixin.StreamEncryptionProperty streamEncryption)

Sets the value of CfnStreamMixinProps.getStreamEncryption()

Parameters:

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.

Returns:

this

streamModeDetails

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

Sets the value of CfnStreamMixinProps.getStreamModeDetails()

Parameters:

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.

Returns:

this

streamModeDetails

@Stability(Stable)
public CfnStreamMixinProps.Builder streamModeDetails(CfnStreamPropsMixin.StreamModeDetailsProperty streamModeDetails)

Sets the value of CfnStreamMixinProps.getStreamModeDetails()

Parameters:

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.

Returns:

this

tags

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

Sets the value of CfnStreamMixinProps.getTags()

Parameters:

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 .

Returns:

this

warmThroughputMiBps

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

Sets the value of CfnStreamMixinProps.getWarmThroughputMiBps()

Parameters:

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.

Returns:

this

build

@Stability(Stable)
public CfnStreamMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnStreamMixinProps

Throws:

NullPointerException - if any required attribute was not provided