CfnTable

class aws_cdk.aws_dynamodb.CfnTable(scope, id, *, key_schema, attribute_definitions=None, billing_mode=None, global_secondary_indexes=None, local_secondary_indexes=None, point_in_time_recovery_specification=None, provisioned_throughput=None, sse_specification=None, stream_specification=None, table_name=None, tags=None, time_to_live_specification=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::DynamoDB::Table.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html

CloudformationResource

AWS::DynamoDB::Table

Create a new AWS::DynamoDB::Table.

Parameters

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

(experimental) Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Stability

experimental

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::DynamoDB::Table'
attr_arn

Arn

Type

cloudformationAttribute

Return type

str

attr_stream_arn

StreamArn

Type

cloudformationAttribute

Return type

str

attribute_definitions

AWS::DynamoDB::Table.AttributeDefinitions.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-attributedef

Return type

Union[IResolvable, List[Union[IResolvable, AttributeDefinitionProperty]], None]

billing_mode

AWS::DynamoDB::Table.BillingMode.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-billingmode

Return type

Optional[str]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

global_secondary_indexes

AWS::DynamoDB::Table.GlobalSecondaryIndexes.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-gsi

Return type

Union[IResolvable, List[Union[IResolvable, GlobalSecondaryIndexProperty]], None]

key_schema

AWS::DynamoDB::Table.KeySchema.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-keyschema

Return type

Union[IResolvable, List[Union[KeySchemaProperty, IResolvable]]]

local_secondary_indexes

AWS::DynamoDB::Table.LocalSecondaryIndexes.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-lsi

Return type

Union[IResolvable, List[Union[IResolvable, LocalSecondaryIndexProperty]], None]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

point_in_time_recovery_specification

AWS::DynamoDB::Table.PointInTimeRecoverySpecification.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-pointintimerecoveryspecification

Return type

Union[IResolvable, PointInTimeRecoverySpecificationProperty, None]

provisioned_throughput

AWS::DynamoDB::Table.ProvisionedThroughput.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-provisionedthroughput

Return type

Union[IResolvable, ProvisionedThroughputProperty, None]

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

sse_specification

AWS::DynamoDB::Table.SSESpecification.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-ssespecification

Return type

Union[IResolvable, SSESpecificationProperty, None]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

stream_specification

AWS::DynamoDB::Table.StreamSpecification.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-streamspecification

Return type

Union[IResolvable, StreamSpecificationProperty, None]

table_name

AWS::DynamoDB::Table.TableName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tablename

Return type

Optional[str]

tags

AWS::DynamoDB::Table.Tags.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-tags

Return type

TagManager

time_to_live_specification

AWS::DynamoDB::Table.TimeToLiveSpecification.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html#cfn-dynamodb-table-timetolivespecification

Return type

Union[IResolvable, TimeToLiveSpecificationProperty, None]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

AttributeDefinitionProperty

class CfnTable.AttributeDefinitionProperty(*, attribute_name, attribute_type)

Bases: object

Parameters
  • attribute_name (str) – CfnTable.AttributeDefinitionProperty.AttributeName.

  • attribute_type (str) – CfnTable.AttributeDefinitionProperty.AttributeType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-attributedef.html

Attributes

attribute_name

CfnTable.AttributeDefinitionProperty.AttributeName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-attributedef.html#cfn-dynamodb-attributedef-attributename

Return type

str

attribute_type

CfnTable.AttributeDefinitionProperty.AttributeType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-attributedef.html#cfn-dynamodb-attributedef-attributename-attributetype

Return type

str

GlobalSecondaryIndexProperty

class CfnTable.GlobalSecondaryIndexProperty(*, index_name, key_schema, projection, provisioned_throughput=None)

Bases: object

Parameters
See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-gsi.html

Attributes

index_name

CfnTable.GlobalSecondaryIndexProperty.IndexName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-gsi.html#cfn-dynamodb-gsi-indexname

Return type

str

key_schema

CfnTable.GlobalSecondaryIndexProperty.KeySchema.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-gsi.html#cfn-dynamodb-gsi-keyschema

Return type

Union[IResolvable, List[Union[KeySchemaProperty, IResolvable]]]

projection

CfnTable.GlobalSecondaryIndexProperty.Projection.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-gsi.html#cfn-dynamodb-gsi-projection

Return type

Union[IResolvable, ProjectionProperty]

provisioned_throughput

CfnTable.GlobalSecondaryIndexProperty.ProvisionedThroughput.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-gsi.html#cfn-dynamodb-gsi-provisionedthroughput

Return type

Union[IResolvable, ProvisionedThroughputProperty, None]

KeySchemaProperty

class CfnTable.KeySchemaProperty(*, attribute_name, key_type)

Bases: object

Parameters
  • attribute_name (str) – CfnTable.KeySchemaProperty.AttributeName.

  • key_type (str) – CfnTable.KeySchemaProperty.KeyType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html

Attributes

attribute_name

CfnTable.KeySchemaProperty.AttributeName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html#aws-properties-dynamodb-keyschema-attributename

Return type

str

key_type

CfnTable.KeySchemaProperty.KeyType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-keyschema.html#aws-properties-dynamodb-keyschema-keytype

Return type

str

LocalSecondaryIndexProperty

class CfnTable.LocalSecondaryIndexProperty(*, index_name, key_schema, projection)

Bases: object

Parameters
See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-lsi.html

Attributes

index_name

CfnTable.LocalSecondaryIndexProperty.IndexName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-lsi.html#cfn-dynamodb-lsi-indexname

Return type

str

key_schema

CfnTable.LocalSecondaryIndexProperty.KeySchema.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-lsi.html#cfn-dynamodb-lsi-keyschema

Return type

Union[IResolvable, List[Union[KeySchemaProperty, IResolvable]]]

projection

CfnTable.LocalSecondaryIndexProperty.Projection.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-lsi.html#cfn-dynamodb-lsi-projection

Return type

Union[IResolvable, ProjectionProperty]

PointInTimeRecoverySpecificationProperty

class CfnTable.PointInTimeRecoverySpecificationProperty(*, point_in_time_recovery_enabled=None)

Bases: object

Parameters

point_in_time_recovery_enabled (Union[bool, IResolvable, None]) – CfnTable.PointInTimeRecoverySpecificationProperty.PointInTimeRecoveryEnabled.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-pointintimerecoveryspecification.html

Attributes

point_in_time_recovery_enabled

CfnTable.PointInTimeRecoverySpecificationProperty.PointInTimeRecoveryEnabled.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-pointintimerecoveryspecification.html#cfn-dynamodb-table-pointintimerecoveryspecification-pointintimerecoveryenabled

Return type

Union[bool, IResolvable, None]

ProjectionProperty

class CfnTable.ProjectionProperty(*, non_key_attributes=None, projection_type=None)

Bases: object

Parameters
  • non_key_attributes (Optional[List[str]]) – CfnTable.ProjectionProperty.NonKeyAttributes.

  • projection_type (Optional[str]) – CfnTable.ProjectionProperty.ProjectionType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-projectionobject.html

Attributes

non_key_attributes

CfnTable.ProjectionProperty.NonKeyAttributes.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-projectionobject.html#cfn-dynamodb-projectionobj-nonkeyatt

Return type

Optional[List[str]]

projection_type

CfnTable.ProjectionProperty.ProjectionType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-projectionobject.html#cfn-dynamodb-projectionobj-projtype

Return type

Optional[str]

ProvisionedThroughputProperty

class CfnTable.ProvisionedThroughputProperty(*, read_capacity_units, write_capacity_units)

Bases: object

Parameters
  • read_capacity_units (Union[int, float]) – CfnTable.ProvisionedThroughputProperty.ReadCapacityUnits.

  • write_capacity_units (Union[int, float]) – CfnTable.ProvisionedThroughputProperty.WriteCapacityUnits.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html

Attributes

read_capacity_units

CfnTable.ProvisionedThroughputProperty.ReadCapacityUnits.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html#cfn-dynamodb-provisionedthroughput-readcapacityunits

Return type

Union[int, float]

write_capacity_units

CfnTable.ProvisionedThroughputProperty.WriteCapacityUnits.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-provisionedthroughput.html#cfn-dynamodb-provisionedthroughput-writecapacityunits

Return type

Union[int, float]

SSESpecificationProperty

class CfnTable.SSESpecificationProperty(*, sse_enabled, kms_master_key_id=None, sse_type=None)

Bases: object

Parameters
  • sse_enabled (Union[bool, IResolvable]) – CfnTable.SSESpecificationProperty.SSEEnabled.

  • kms_master_key_id (Optional[str]) – CfnTable.SSESpecificationProperty.KMSMasterKeyId.

  • sse_type (Optional[str]) – CfnTable.SSESpecificationProperty.SSEType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html

Attributes

kms_master_key_id

CfnTable.SSESpecificationProperty.KMSMasterKeyId.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html#cfn-dynamodb-table-ssespecification-kmsmasterkeyid

Return type

Optional[str]

sse_enabled

CfnTable.SSESpecificationProperty.SSEEnabled.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html#cfn-dynamodb-table-ssespecification-sseenabled

Return type

Union[bool, IResolvable]

sse_type

CfnTable.SSESpecificationProperty.SSEType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-ssespecification.html#cfn-dynamodb-table-ssespecification-ssetype

Return type

Optional[str]

StreamSpecificationProperty

class CfnTable.StreamSpecificationProperty(*, stream_view_type)

Bases: object

Parameters

stream_view_type (str) – CfnTable.StreamSpecificationProperty.StreamViewType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-streamspecification.html

Attributes

stream_view_type

CfnTable.StreamSpecificationProperty.StreamViewType.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-streamspecification.html#cfn-dynamodb-streamspecification-streamviewtype

Return type

str

TimeToLiveSpecificationProperty

class CfnTable.TimeToLiveSpecificationProperty(*, attribute_name, enabled)

Bases: object

Parameters
  • attribute_name (str) – CfnTable.TimeToLiveSpecificationProperty.AttributeName.

  • enabled (Union[bool, IResolvable]) – CfnTable.TimeToLiveSpecificationProperty.Enabled.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-timetolivespecification.html

Attributes

attribute_name

CfnTable.TimeToLiveSpecificationProperty.AttributeName.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-timetolivespecification.html#cfn-dynamodb-timetolivespecification-attributename

Return type

str

enabled

CfnTable.TimeToLiveSpecificationProperty.Enabled.

See

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-timetolivespecification.html#cfn-dynamodb-timetolivespecification-enabled

Return type

Union[bool, IResolvable]