TableOptions
- class aws_cdk.aws_dynamodb.TableOptions(*, partition_key, sort_key=None, billing_mode=None, contributor_insights_enabled=None, deletion_protection=None, encryption=None, encryption_key=None, import_source=None, max_read_request_units=None, max_write_request_units=None, point_in_time_recovery=None, read_capacity=None, removal_policy=None, replication_regions=None, replication_timeout=None, resource_policy=None, stream=None, table_class=None, time_to_live_attribute=None, wait_for_replication_to_finish=None, write_capacity=None)
Bases:
SchemaOptions
Properties of a DynamoDB Table.
Use
TableProps
for all table properties- Parameters:
partition_key (
Union
[Attribute
,Dict
[str
,Any
]]) – Partition key attribute definition.sort_key (
Union
[Attribute
,Dict
[str
,Any
],None
]) – Sort key attribute definition. Default: no sort keybilling_mode (
Optional
[BillingMode
]) – Specify how you are charged for read and write throughput and how you manage capacity. Default: PROVISIONED ifreplicationRegions
is not specified, PAY_PER_REQUEST otherwisecontributor_insights_enabled (
Optional
[bool
]) – Whether CloudWatch contributor insights is enabled. Default: falsedeletion_protection (
Optional
[bool
]) – Enables deletion protection for the table. Default: falseencryption (
Optional
[TableEncryption
]) – Whether server-side encryption with an AWS managed customer master key is enabled. This property cannot be set ifserverSideEncryption
is set. .. epigraph:: NOTE: if you set this toCUSTOMER_MANAGED
andencryptionKey
is not specified, the key that the Tablet generates for you will be created with default permissions. If you are using CDKv2, these permissions will be sufficient to enable the key for use with DynamoDB tables. If you are using CDKv1, make sure the feature flag@aws-cdk/aws-kms:defaultKeyPolicies
is set totrue
in yourcdk.json
. Default: - The table is encrypted with an encryption key managed by DynamoDB, and you are not charged any fee for using it.encryption_key (
Optional
[IKey
]) – External KMS key to use for table encryption. This property can only be set ifencryption
is set toTableEncryption.CUSTOMER_MANAGED
. Default: - Ifencryption
is set toTableEncryption.CUSTOMER_MANAGED
and this property is undefined, a new KMS key will be created and associated with this table. Ifencryption
and this property are both undefined, then the table is encrypted with an encryption key managed by DynamoDB, and you are not charged any fee for using it.import_source (
Union
[ImportSourceSpecification
,Dict
[str
,Any
],None
]) – The properties of data being imported from the S3 bucket source to the table. Default: - no data import from the S3 bucketmax_read_request_units (
Union
[int
,float
,None
]) – The maximum read request units for the table. Careful if you add Global Secondary Indexes, as those will share the table’s maximum on-demand throughput. Can only be provided if billingMode is PAY_PER_REQUEST. Default: - on-demand throughput is disabledmax_write_request_units (
Union
[int
,float
,None
]) – The write request units for the table. Careful if you add Global Secondary Indexes, as those will share the table’s maximum on-demand throughput. Can only be provided if billingMode is PAY_PER_REQUEST. Default: - on-demand throughput is disabledpoint_in_time_recovery (
Optional
[bool
]) – Whether point-in-time recovery is enabled. Default: - point-in-time recovery is disabledread_capacity (
Union
[int
,float
,None
]) – The read capacity for the table. Careful if you add Global Secondary Indexes, as those will share the table’s provisioned throughput. Can only be provided if billingMode is Provisioned. Default: 5removal_policy (
Optional
[RemovalPolicy
]) – The removal policy to apply to the DynamoDB Table. Default: RemovalPolicy.RETAINreplication_regions (
Optional
[Sequence
[str
]]) – Regions where replica tables will be created. Default: - no replica tables are createdreplication_timeout (
Optional
[Duration
]) – The timeout for a table replication operation in a single region. Default: Duration.minutes(30)resource_policy (
Optional
[PolicyDocument
]) – Resource policy to assign to table. Default: - No resource policy statementstream (
Optional
[StreamViewType
]) – When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. Default: - streams are disabled unlessreplicationRegions
is specifiedtable_class (
Optional
[TableClass
]) – Specify the table class. Default: STANDARDtime_to_live_attribute (
Optional
[str
]) – The name of TTL attribute. Default: - TTL is disabledwait_for_replication_to_finish (
Optional
[bool
]) – [WARNING: Use this flag with caution, misusing this flag may cause deleting existing replicas, refer to the detailed documentation for more information] Indicates whether CloudFormation stack waits for replication to finish. If set to false, the CloudFormation resource will mark the resource as created and replication will be completed asynchronously. This property is ignored if replicationRegions property is not set. WARNING: DO NOT UNSET this property if adding/removing multiple replicationRegions in one deployment, as CloudFormation only supports one region replication at a time. CDK overcomes this limitation by waiting for replication to finish before starting new replicationRegion. If the custom resource which handles replication has a physical resource ID with the formatregion
instead oftablename-region
(this would happen if the custom resource hasn’t received an event since v1.91.0), DO NOT SET this property to false without making a change to the table name. This will cause the existing replicas to be deleted. Default: truewrite_capacity (
Union
[int
,float
,None
]) – The write capacity for the table. Careful if you add Global Secondary Indexes, as those will share the table’s provisioned throughput. Can only be provided if billingMode is Provisioned. Default: 5
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk as cdk from aws_cdk import aws_dynamodb as dynamodb from aws_cdk import aws_iam as iam from aws_cdk import aws_kms as kms from aws_cdk import aws_s3 as s3 # bucket: s3.Bucket # input_format: dynamodb.InputFormat # key: kms.Key # policy_document: iam.PolicyDocument table_options = dynamodb.TableOptions( partition_key=dynamodb.Attribute( name="name", type=dynamodb.AttributeType.BINARY ), # the properties below are optional billing_mode=dynamodb.BillingMode.PAY_PER_REQUEST, contributor_insights_enabled=False, deletion_protection=False, encryption=dynamodb.TableEncryption.DEFAULT, encryption_key=key, import_source=dynamodb.ImportSourceSpecification( bucket=bucket, input_format=input_format, # the properties below are optional bucket_owner="bucketOwner", compression_type=dynamodb.InputCompressionType.GZIP, key_prefix="keyPrefix" ), max_read_request_units=123, max_write_request_units=123, point_in_time_recovery=False, read_capacity=123, removal_policy=cdk.RemovalPolicy.DESTROY, replication_regions=["replicationRegions"], replication_timeout=cdk.Duration.minutes(30), resource_policy=policy_document, sort_key=dynamodb.Attribute( name="name", type=dynamodb.AttributeType.BINARY ), stream=dynamodb.StreamViewType.NEW_IMAGE, table_class=dynamodb.TableClass.STANDARD, time_to_live_attribute="timeToLiveAttribute", wait_for_replication_to_finish=False, write_capacity=123 )
Attributes
- billing_mode
Specify how you are charged for read and write throughput and how you manage capacity.
- Default:
PROVISIONED if
replicationRegions
is not specified, PAY_PER_REQUEST otherwise
- contributor_insights_enabled
Whether CloudWatch contributor insights is enabled.
- Default:
false
- deletion_protection
Enables deletion protection for the table.
- Default:
false
- encryption
Whether server-side encryption with an AWS managed customer master key is enabled.
This property cannot be set if
serverSideEncryption
is set. .. epigraph:**NOTE**: if you set this to ``CUSTOMER_MANAGED`` and ``encryptionKey`` is not specified, the key that the Tablet generates for you will be created with default permissions. If you are using CDKv2, these permissions will be sufficient to enable the key for use with DynamoDB tables. If you are using CDKv1, make sure the feature flag ``@aws-cdk/aws-kms:defaultKeyPolicies`` is set to ``true`` in your ``cdk.json``.
- Default:
The table is encrypted with an encryption key managed by DynamoDB, and you are not charged any fee for using it.
- encryption_key
External KMS key to use for table encryption.
This property can only be set if
encryption
is set toTableEncryption.CUSTOMER_MANAGED
.- Default:
If
encryption
is set toTableEncryption.CUSTOMER_MANAGED
and this
property is undefined, a new KMS key will be created and associated with this table. If
encryption
and this property are both undefined, then the table is encrypted with an encryption key managed by DynamoDB, and you are not charged any fee for using it.
- import_source
The properties of data being imported from the S3 bucket source to the table.
- Default:
no data import from the S3 bucket
- max_read_request_units
The maximum read request units for the table.
Careful if you add Global Secondary Indexes, as those will share the table’s maximum on-demand throughput.
Can only be provided if billingMode is PAY_PER_REQUEST.
- Default:
on-demand throughput is disabled
- max_write_request_units
The write request units for the table.
Careful if you add Global Secondary Indexes, as those will share the table’s maximum on-demand throughput.
Can only be provided if billingMode is PAY_PER_REQUEST.
- Default:
on-demand throughput is disabled
- partition_key
Partition key attribute definition.
- point_in_time_recovery
Whether point-in-time recovery is enabled.
- Default:
point-in-time recovery is disabled
- read_capacity
The read capacity for the table.
Careful if you add Global Secondary Indexes, as those will share the table’s provisioned throughput.
Can only be provided if billingMode is Provisioned.
- Default:
5
- removal_policy
The removal policy to apply to the DynamoDB Table.
- Default:
RemovalPolicy.RETAIN
- replication_regions
Regions where replica tables will be created.
- Default:
no replica tables are created
- replication_timeout
The timeout for a table replication operation in a single region.
- Default:
Duration.minutes(30)
- resource_policy
Resource policy to assign to table.
- Default:
No resource policy statement
- See:
- sort_key
Sort key attribute definition.
- Default:
no sort key
- stream
When an item in the table is modified, StreamViewType determines what information is written to the stream for this table.
- Default:
streams are disabled unless
replicationRegions
is specified
- table_class
Specify the table class.
- Default:
STANDARD
- time_to_live_attribute
The name of TTL attribute.
- Default:
TTL is disabled
- wait_for_replication_to_finish
Use this flag with caution, misusing this flag may cause deleting existing replicas, refer to the detailed documentation for more information] Indicates whether CloudFormation stack waits for replication to finish.
If set to false, the CloudFormation resource will mark the resource as created and replication will be completed asynchronously. This property is ignored if replicationRegions property is not set.
WARNING: DO NOT UNSET this property if adding/removing multiple replicationRegions in one deployment, as CloudFormation only supports one region replication at a time. CDK overcomes this limitation by waiting for replication to finish before starting new replicationRegion.
If the custom resource which handles replication has a physical resource ID with the format
region
instead oftablename-region
(this would happen if the custom resource hasn’t received an event since v1.91.0), DO NOT SET this property to false without making a change to the table name. This will cause the existing replicas to be deleted.- Default:
true
- See:
- Type:
[WARNING
- write_capacity
The write capacity for the table.
Careful if you add Global Secondary Indexes, as those will share the table’s provisioned throughput.
Can only be provided if billingMode is Provisioned.
- Default:
5