StreamGrantsProps

class aws_cdk.aws_dynamodb.StreamGrantsProps(*, table, table_stream_arn, encryption_key=None)

Bases: object

Construction properties for StreamGrants.

Parameters:

table (ITableRef) – The table this stream is for.
table_stream_arn (str) – The ARN of the Stream.
encryption_key (Optional[IKey]) – The encryption key of the table. Required permissions will be added to the key as well. Default: - No key

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 import aws_dynamodb as dynamodb
from aws_cdk import aws_kms as kms
from aws_cdk.interfaces import aws_dynamodb as interfaces_aws_dynamodb

# key: kms.Key
# table_ref: interfaces_aws_dynamodb.ITableRef

stream_grants_props = dynamodb.StreamGrantsProps(
    table=table_ref,
    table_stream_arn="tableStreamArn",

    # the properties below are optional
    encryption_key=key
)

Attributes

encryption_key

The encryption key of the table.

Required permissions will be added to the key as well.

Default:

No key

table: The table this stream is for.

table_stream_arn: The ARN of the Stream.