software.amazon.awscdk.services.qldb

Class CfnStream

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.qldb.CfnStream

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:18.526Z")
public class CfnStream
extends CfnResource
implements IInspectable

A CloudFormation `AWS::QLDB::Stream`.

The AWS::QLDB::Stream resource specifies a journal stream for a given Amazon Quantum Ledger Database (Amazon QLDB) ledger. The stream captures every document revision that is committed to the ledger's journal and delivers the data to a specified Amazon Kinesis Data Streams resource.

For more information, see StreamJournalToKinesis in the Amazon QLDB API Reference .

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.*;
 CfnStream cfnStream = CfnStream.Builder.create(this, "MyCfnStream")
         .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	Class and Description
static class	CfnStream.Builder A fluent builder for CfnStream.
static interface	CfnStream.KinesisConfigurationProperty The configuration settings of the Amazon Kinesis Data Streams destination for an Amazon QLDB journal stream.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnStream(Construct scope, java.lang.String id, CfnStreamProps props) Create a new `AWS::QLDB::Stream`.
protected	CfnStream(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStream(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() The Amazon Resource Name (ARN) of the QLDB journal stream.
java.lang.String	getAttrId() The unique ID that QLDB assigns to each QLDB journal stream.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getExclusiveEndTime() The exclusive date and time that specifies when the stream ends.
java.lang.String	getInclusiveStartTime() The inclusive start date and time from which to start streaming journal data.
java.lang.Object	getKinesisConfiguration() The configuration settings of the Kinesis Data Streams destination for your stream request.
java.lang.String	getLedgerName() The name of the ledger.
java.lang.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.
java.lang.String	getStreamName() The name that you want to assign to the QLDB journal stream.
TagManager	getTags() An array of key-value pairs to apply to this resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setExclusiveEndTime(java.lang.String value) The exclusive date and time that specifies when the stream ends.
void	setInclusiveStartTime(java.lang.String value) The inclusive start date and time from which to start streaming journal data.
void	setKinesisConfiguration(CfnStream.KinesisConfigurationProperty value) The configuration settings of the Kinesis Data Streams destination for your stream request.
void	setKinesisConfiguration(IResolvable value) The configuration settings of the Kinesis Data Streams destination for your stream request.
void	setLedgerName(java.lang.String value) The name of the ledger.
void	setRoleArn(java.lang.String value) 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.
void	setStreamName(java.lang.String value) The name that you want to assign to the QLDB journal stream.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnStream

protected CfnStream(software.amazon.jsii.JsiiObjectRef objRef)

CfnStream

protected CfnStream(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnStream

public CfnStream(Construct scope,
                 java.lang.String id,
                 CfnStreamProps props)

Create a new `AWS::QLDB::Stream`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The Amazon Resource Name (ARN) of the QLDB journal stream.

For example: arn:aws:qldb:us-east-1:123456789012:stream/exampleLedger/IiPT4brpZCqCq3f4MTHbYy .

getAttrId

public java.lang.String getAttrId()

The unique ID that QLDB assigns to each QLDB journal stream.

For example: IiPT4brpZCqCq3f4MTHbYy .

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

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

For more information, see Tag .

getInclusiveStartTime

public java.lang.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 .

setInclusiveStartTime

public void setInclusiveStartTime(java.lang.String value)

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

public java.lang.Object getKinesisConfiguration()

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

setKinesisConfiguration

public void setKinesisConfiguration(IResolvable value)

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

setKinesisConfiguration

public void setKinesisConfiguration(CfnStream.KinesisConfigurationProperty value)

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

getLedgerName

public java.lang.String getLedgerName()

The name of the ledger.

setLedgerName

public void setLedgerName(java.lang.String value)

The name of the ledger.

getRoleArn

public java.lang.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.

setRoleArn

public void setRoleArn(java.lang.String value)

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

public java.lang.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 .

setStreamName

public void setStreamName(java.lang.String value)

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

public java.lang.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 .

setExclusiveEndTime

public void setExclusiveEndTime(java.lang.String value)

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 .