Package software.amazon.awscdk.services.qldb

Class CfnStreamProps.Builder

java.lang.Object
software.amazon.awscdk.services.qldb.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

    • inclusiveStartTime

      @Stability(Stable) public CfnStreamProps.Builder inclusiveStartTime(String inclusiveStartTime)
      Sets the value of CfnStreamProps.getInclusiveStartTime()
      Parameters:
      inclusiveStartTime - The inclusive start date and time from which to start streaming journal data. This parameter is required. This parameter must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z .

      The InclusiveStartTime cannot be in the future and must be before ExclusiveEndTime .

      If you provide an InclusiveStartTime that is before the ledger's CreationDateTime , QLDB effectively defaults it to the ledger's CreationDateTime .

      Returns:
      this

    • kinesisConfiguration

      @Stability(Stable) public CfnStreamProps.Builder kinesisConfiguration(IResolvable kinesisConfiguration)
      Sets the value of CfnStreamProps.getKinesisConfiguration()
      Parameters:
      kinesisConfiguration - The configuration settings of the Kinesis Data Streams destination for your stream request. This parameter is required.
      Returns:
      this

    • kinesisConfiguration

      @Stability(Stable) public CfnStreamProps.Builder kinesisConfiguration(CfnStream.KinesisConfigurationProperty kinesisConfiguration)
      Sets the value of CfnStreamProps.getKinesisConfiguration()
      Parameters:
      kinesisConfiguration - The configuration settings of the Kinesis Data Streams destination for your stream request. This parameter is required.
      Returns:
      this

    • ledgerName

      @Stability(Stable) public CfnStreamProps.Builder ledgerName(String ledgerName)
      Sets the value of CfnStreamProps.getLedgerName()
      Parameters:
      ledgerName - The name of the ledger. This parameter is required.
      Returns:
      this

    • roleArn

      @Stability(Stable) public CfnStreamProps.Builder roleArn(String roleArn)
      Sets the value of CfnStreamProps.getRoleArn()
      Parameters:
      roleArn - The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a journal stream to write data records to a Kinesis Data Streams resource. This parameter is required. To pass a role to QLDB when requesting a journal stream, you must have permissions to perform the iam:PassRole action on the IAM role resource. This is required for all journal stream requests.
      Returns:
      this

    • streamName

      @Stability(Stable) public CfnStreamProps.Builder streamName(String streamName)
      Sets the value of CfnStreamProps.getStreamName()
      Parameters:
      streamName - The name that you want to assign to the QLDB journal stream. This parameter is required. User-defined names can help identify and indicate the purpose of a stream.

      Your stream name must be unique among other active streams for a given ledger. Stream names have the same naming constraints as ledger names, as defined in Quotas in Amazon QLDB in the Amazon QLDB Developer Guide .

      Returns:
      this

    • exclusiveEndTime

      @Stability(Stable) public CfnStreamProps.Builder exclusiveEndTime(String exclusiveEndTime)
      Sets the value of CfnStreamProps.getExclusiveEndTime()
      Parameters:
      exclusiveEndTime - The exclusive date and time that specifies when the stream ends. If you don't define this parameter, the stream runs indefinitely until you cancel it.

      The ExclusiveEndTime must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: 2019-06-13T21:36:34Z .

      Returns:
      this

    • tags

      @Stability(Stable) public CfnStreamProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnStreamProps.getTags()
      Parameters:
      tags - An array of key-value pairs to apply to this resource. For more information, see Tag .
      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