software.amazon.awscdk.services.qldb

Interface CfnStreamProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStreamProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.273Z")
 @Stability(value=Stable)
public interface CfnStreamProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnStream`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.qldb.*;
 CfnStreamProps cfnStreamProps = CfnStreamProps.builder()
         .inclusiveStartTime("inclusiveStartTime")
         .kinesisConfiguration(KinesisConfigurationProperty.builder()
                 .aggregationEnabled(false)
                 .streamArn("streamArn")
                 .build())
         .ledgerName("ledgerName")
         .roleArn("roleArn")
         .streamName("streamName")
         // the properties below are optional
         .exclusiveEndTime("exclusiveEndTime")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnStreamProps.Builder A builder for CfnStreamProps
static class	CfnStreamProps.Jsii$Proxy An implementation for CfnStreamProps

Method Summary

Modifier and Type	Method and Description
static CfnStreamProps.Builder	builder()
default String	getExclusiveEndTime() The exclusive date and time that specifies when the stream ends.
String	getInclusiveStartTime() The inclusive start date and time from which to start streaming journal data.
Object	getKinesisConfiguration() The configuration settings of the Kinesis Data Streams destination for your stream request.
String	getLedgerName() The name of the ledger.
String	getRoleArn() 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.
String	getStreamName() The name that you want to assign to the QLDB journal stream.
default List<CfnTag>	getTags() An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getInclusiveStartTime

@Stability(value=Stable)
 @NotNull
String getInclusiveStartTime()

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 .

getKinesisConfiguration

@Stability(value=Stable)
 @NotNull
Object getKinesisConfiguration()

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

getLedgerName

@Stability(value=Stable)
 @NotNull
String getLedgerName()

The name of the ledger.

getRoleArn

@Stability(value=Stable)
 @NotNull
String getRoleArn()

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.

getStreamName

@Stability(value=Stable)
 @NotNull
String getStreamName()

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 .

getExclusiveEndTime

@Stability(value=Stable)
 @Nullable
default String getExclusiveEndTime()

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 .

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

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

For more information, see Tag .

builder

@Stability(value=Stable)
static CfnStreamProps.Builder builder()

Returns:

a CfnStreamProps.Builder of CfnStreamProps