@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:41.271Z") @Stability(value=Stable) public class CfnStream extends CfnResource implements IInspectable
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();
| 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.
|
software.amazon.jsii.JsiiObject.InitializationModeIInspectable.Jsii$Default, IInspectable.Jsii$Proxy| Modifier and Type | Field and Description |
|---|---|
static String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnStream(software.constructs.Construct scope,
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) |
| Modifier and Type | Method and Description |
|---|---|
String |
getAttrArn()
The Amazon Resource Name (ARN) of the QLDB journal stream.
|
String |
getAttrId()
The unique ID that QLDB assigns to each QLDB journal stream.
|
protected Map<String,Object> |
getCfnProperties() |
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.
|
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 Map<String,Object> |
renderProperties(Map<String,Object> props) |
void |
setExclusiveEndTime(String value)
The exclusive date and time that specifies when the stream ends.
|
void |
setInclusiveStartTime(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(String value)
The name of the ledger.
|
void |
setRoleArn(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(String value)
The name that you want to assign to the QLDB journal stream.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdjsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet@Stability(value=Stable) public static final String CFN_RESOURCE_TYPE_NAME
protected CfnStream(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnStream(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
@Stability(value=Stable)
public CfnStream(@NotNull
software.constructs.Construct scope,
@NotNull
String id,
@NotNull
CfnStreamProps props)
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.@Stability(value=Stable)
public void inspect(@NotNull
TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.@Stability(value=Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
renderProperties in class CfnResourceprops - This parameter is required.@Stability(value=Stable) @NotNull public String getAttrArn()
For example: arn:aws:qldb:us-east-1:123456789012:stream/exampleLedger/IiPT4brpZCqCq3f4MTHbYy .
@Stability(value=Stable) @NotNull public String getAttrId()
For example: IiPT4brpZCqCq3f4MTHbYy .
@Stability(value=Stable) @NotNull protected Map<String,Object> getCfnProperties()
getCfnProperties in class CfnResource@Stability(value=Stable) @NotNull public TagManager getTags()
For more information, see Tag .
@Stability(value=Stable) @NotNull public String getInclusiveStartTime()
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 .
@Stability(value=Stable)
public void setInclusiveStartTime(@NotNull
String value)
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 .
@Stability(value=Stable) @NotNull public Object getKinesisConfiguration()
@Stability(value=Stable)
public void setKinesisConfiguration(@NotNull
CfnStream.KinesisConfigurationProperty value)
@Stability(value=Stable)
public void setKinesisConfiguration(@NotNull
IResolvable value)
@Stability(value=Stable) @NotNull public String getLedgerName()
@Stability(value=Stable)
public void setLedgerName(@NotNull
String value)
@Stability(value=Stable) @NotNull public String getRoleArn()
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.
@Stability(value=Stable)
public void setRoleArn(@NotNull
String value)
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.
@Stability(value=Stable) @NotNull public String getStreamName()
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 .
@Stability(value=Stable)
public void setStreamName(@NotNull
String value)
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 .
@Stability(value=Stable) @Nullable public String getExclusiveEndTime()
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 .
@Stability(value=Stable)
public void setExclusiveEndTime(@Nullable
String value)
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 .
Copyright © 2022. All rights reserved.