CfnStreamPropsMixin

class aws_cdk.mixins_preview.aws_qldb.mixins.CfnStreamPropsMixin(props, *, strategy=None)

Bases: Mixin

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-qldb-stream.html
CloudformationResource:: AWS::QLDB::Stream
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_qldb import mixins as qldb_mixins

cfn_stream_props_mixin = qldb_mixins.CfnStreamPropsMixin(qldb_mixins.CfnStreamMixinProps(
    exclusive_end_time="exclusiveEndTime",
    inclusive_start_time="inclusiveStartTime",
    kinesis_configuration=qldb_mixins.CfnStreamPropsMixin.KinesisConfigurationProperty(
        aggregation_enabled=False,
        stream_arn="streamArn"
    ),
    ledger_name="ledgerName",
    role_arn="roleArn",
    stream_name="streamName",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::QLDB::Stream.

Parameters:

props (Union[CfnStreamMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['exclusiveEndTime', 'inclusiveStartTime', 'kinesisConfiguration', 'ledgerName', 'roleArn', 'streamName', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

KinesisConfigurationProperty

class CfnStreamPropsMixin.KinesisConfigurationProperty(*, aggregation_enabled=None, stream_arn=None)

Bases: object

The configuration settings of the Amazon Kinesis Data Streams destination for an Amazon QLDB journal stream.

Parameters:

aggregation_enabled (Union[bool, IResolvable, None]) – Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call. Default: True .. epigraph:: Record aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see KPL Key Concepts and Consumer De-aggregation in the Amazon Kinesis Data Streams Developer Guide .
stream_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qldb-stream-kinesisconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_qldb import mixins as qldb_mixins

kinesis_configuration_property = qldb_mixins.CfnStreamPropsMixin.KinesisConfigurationProperty(
    aggregation_enabled=False,
    stream_arn="streamArn"
)

Attributes

aggregation_enabled

Enables QLDB to publish multiple data records in a single Kinesis Data Streams record, increasing the number of records sent per API call.

Default: True .. epigraph:

Record aggregation has important implications for processing records and requires de-aggregation in your stream consumer. To learn more, see `KPL Key Concepts <https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-concepts.html>`_ and `Consumer De-aggregation <https://docs.aws.amazon.com/streams/latest/dev/kinesis-kpl-consumer-deaggregation.html>`_ in the *Amazon Kinesis Data Streams Developer Guide* .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qldb-stream-kinesisconfiguration.html#cfn-qldb-stream-kinesisconfiguration-aggregationenabled

stream_arn

The Amazon Resource Name (ARN) of the Kinesis Data Streams resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qldb-stream-kinesisconfiguration.html#cfn-qldb-stream-kinesisconfiguration-streamarn