software.amazon.awscdk.services.qldb

Class CfnStream.Builder

java.lang.Object

software.amazon.awscdk.services.qldb.CfnStream.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnStream>

Enclosing class:

CfnStream

@Stability(value=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 and Description
CfnStream	build()
static CfnStream.Builder	create(software.constructs.Construct scope, String id)
CfnStream.Builder	exclusiveEndTime(String exclusiveEndTime) The exclusive date and time that specifies when the stream ends.
CfnStream.Builder	inclusiveStartTime(String inclusiveStartTime) The inclusive start date and time from which to start streaming journal data.
CfnStream.Builder	kinesisConfiguration(CfnStream.KinesisConfigurationProperty kinesisConfiguration) The configuration settings of the Kinesis Data Streams destination for your stream request.
CfnStream.Builder	kinesisConfiguration(IResolvable kinesisConfiguration) The configuration settings of the Kinesis Data Streams destination for your stream request.
CfnStream.Builder	ledgerName(String ledgerName) The name of the ledger.
CfnStream.Builder	roleArn(String 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.
CfnStream.Builder	streamName(String streamName) The name that you want to assign to the QLDB journal stream.
CfnStream.Builder	tags(List<? extends CfnTag> tags) An array of key-value pairs to apply to this resource.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=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 - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnStream.KinesisConfigurationProperty.Builder.

inclusiveStartTime

@Stability(value=Stable)
public CfnStream.Builder inclusiveStartTime(String inclusiveStartTime)

The inclusive start date and time from which to start streaming journal data.

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 .

Parameters:

inclusiveStartTime - The inclusive start date and time from which to start streaming journal data. This parameter is required.

Returns:

this

kinesisConfiguration

@Stability(value=Stable)
public CfnStream.Builder kinesisConfiguration(CfnStream.KinesisConfigurationProperty kinesisConfiguration)

The configuration settings of the Kinesis Data Streams destination for your stream request.

Parameters:

kinesisConfiguration - The configuration settings of the Kinesis Data Streams destination for your stream request. This parameter is required.

Returns:

this

kinesisConfiguration

@Stability(value=Stable)
public CfnStream.Builder kinesisConfiguration(IResolvable kinesisConfiguration)

The configuration settings of the Kinesis Data Streams destination for your stream request.

Parameters:

kinesisConfiguration - The configuration settings of the Kinesis Data Streams destination for your stream request. This parameter is required.

Returns:

this

ledgerName

@Stability(value=Stable)
public CfnStream.Builder ledgerName(String ledgerName)

The name of the ledger.

Parameters:

ledgerName - The name of the ledger. This parameter is required.

Returns:

this

roleArn

@Stability(value=Stable)
public CfnStream.Builder roleArn(String 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.

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.

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.

Returns:

this

streamName

@Stability(value=Stable)
public CfnStream.Builder streamName(String streamName)

The name that you want to assign to the QLDB journal stream.

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 .

Parameters:

streamName - The name that you want to assign to the QLDB journal stream. This parameter is required.

Returns:

this

exclusiveEndTime

@Stability(value=Stable)
public CfnStream.Builder exclusiveEndTime(String 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 .

Parameters:

exclusiveEndTime - The exclusive date and time that specifies when the stream ends. This parameter is required.

Returns:

this

tags

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

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnStream build()

Specified by:

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