StreamGrantsProps

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

Bases: object

Construction properties for StreamGrants.

Parameters:

  • 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

  • table (Optional[ITableRef]) – (deprecated) The table this stream is for. Default: - None, no longer required

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_dynamodb

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

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

    # the properties below are optional
    encryption_key=key,
    table=table_ref
)

Attributes

encryption_key

The encryption key of the table.

Required permissions will be added to the key as well.

Default:

  • No key

table

(deprecated) The table this stream is for.

Default:

  • None, no longer required

Deprecated:

This property is not used anymore

Stability:

deprecated

table_stream_arn

The ARN of the Stream.