Package software.amazon.awscdk.services.kinesis

Class CfnStreamProps.Builder

java.lang.Object
software.amazon.awscdk.services.kinesis.CfnStreamProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnStreamProps>
Enclosing interface:
CfnStreamProps
@Stability(Stable) public static final class CfnStreamProps.Builder extends Object implements software.amazon.jsii.Builder<CfnStreamProps>
A builder for CfnStreamProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • name

      @Stability(Stable) public CfnStreamProps.Builder name(String name)
      Sets the value of CfnStreamProps.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 CfnStreamProps.Builder retentionPeriodHours(Number retentionPeriodHours)
      Sets the value of CfnStreamProps.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 CfnStreamProps.Builder shardCount(Number shardCount)
      Sets the value of CfnStreamProps.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 CfnStreamProps.Builder streamEncryption(IResolvable streamEncryption)
      Sets the value of CfnStreamProps.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 CfnStreamProps.Builder streamEncryption(CfnStream.StreamEncryptionProperty streamEncryption)
      Sets the value of CfnStreamProps.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 CfnStreamProps.Builder streamModeDetails(IResolvable streamModeDetails)
      Sets the value of CfnStreamProps.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 CfnStreamProps.Builder streamModeDetails(CfnStream.StreamModeDetailsProperty streamModeDetails)
      Sets the value of CfnStreamProps.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 CfnStreamProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnStreamProps.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

    • build

      @Stability(Stable) public CfnStreamProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnStreamProps>
      Returns:
      a new instance of CfnStreamProps
      Throws:
      NullPointerException - if any required attribute was not provided