Package software.amazon.awscdk.cfnpropertymixins.services.dynamodb

Class CfnTablePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.dynamodb.CfnTablePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTablePropsMixin>

Enclosing class:

CfnTablePropsMixin

@Stability(Stable)
public static final class CfnTablePropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnTablePropsMixin>

A fluent builder for CfnTablePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnTablePropsMixin.Builder	attributeDefinitions(List<? extends Object> attributeDefinitions)	A list of attributes that describe the key schema for the table and indexes.
CfnTablePropsMixin.Builder	attributeDefinitions(IResolvable attributeDefinitions)	A list of attributes that describe the key schema for the table and indexes.
CfnTablePropsMixin.Builder	billingMode(String billingMode)	Specify how you are charged for read and write throughput and how you manage capacity.
CfnTablePropsMixin	build()
CfnTablePropsMixin.Builder	contributorInsightsSpecification(CfnTablePropsMixin.ContributorInsightsSpecificationProperty contributorInsightsSpecification)	The settings used to specify whether to enable CloudWatch Contributor Insights for the table and define which events to monitor.
CfnTablePropsMixin.Builder	contributorInsightsSpecification(IResolvable contributorInsightsSpecification)	The settings used to specify whether to enable CloudWatch Contributor Insights for the table and define which events to monitor.
static CfnTablePropsMixin.Builder	create()
static CfnTablePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnTablePropsMixin.Builder	deletionProtectionEnabled(Boolean deletionProtectionEnabled)	Determines if a table is protected from deletion.
CfnTablePropsMixin.Builder	deletionProtectionEnabled(IResolvable deletionProtectionEnabled)	Determines if a table is protected from deletion.
CfnTablePropsMixin.Builder	globalSecondaryIndexes(List<? extends Object> globalSecondaryIndexes)	Global secondary indexes to be created on the table.
CfnTablePropsMixin.Builder	globalSecondaryIndexes(IResolvable globalSecondaryIndexes)	Global secondary indexes to be created on the table.
CfnTablePropsMixin.Builder	importSourceSpecification(CfnTablePropsMixin.ImportSourceSpecificationProperty importSourceSpecification)	Specifies the properties of data being imported from the S3 bucket source to the" table.
CfnTablePropsMixin.Builder	importSourceSpecification(IResolvable importSourceSpecification)	Specifies the properties of data being imported from the S3 bucket source to the" table.
CfnTablePropsMixin.Builder	keySchema(List<? extends Object> keySchema)	Specifies the attributes that make up the primary key for the table.
CfnTablePropsMixin.Builder	keySchema(IResolvable keySchema)	Specifies the attributes that make up the primary key for the table.
CfnTablePropsMixin.Builder	kinesisStreamSpecification(CfnTablePropsMixin.KinesisStreamSpecificationProperty kinesisStreamSpecification)	The Kinesis Data Streams configuration for the specified table.
CfnTablePropsMixin.Builder	kinesisStreamSpecification(IResolvable kinesisStreamSpecification)	The Kinesis Data Streams configuration for the specified table.
CfnTablePropsMixin.Builder	localSecondaryIndexes(List<? extends Object> localSecondaryIndexes)	Local secondary indexes to be created on the table.
CfnTablePropsMixin.Builder	localSecondaryIndexes(IResolvable localSecondaryIndexes)	Local secondary indexes to be created on the table.
CfnTablePropsMixin.Builder	onDemandThroughput(CfnTablePropsMixin.OnDemandThroughputProperty onDemandThroughput)	Sets the maximum number of read and write units for the specified on-demand table.
CfnTablePropsMixin.Builder	onDemandThroughput(IResolvable onDemandThroughput)	Sets the maximum number of read and write units for the specified on-demand table.
CfnTablePropsMixin.Builder	pointInTimeRecoverySpecification(CfnTablePropsMixin.PointInTimeRecoverySpecificationProperty pointInTimeRecoverySpecification)	The settings used to enable point in time recovery.
CfnTablePropsMixin.Builder	pointInTimeRecoverySpecification(IResolvable pointInTimeRecoverySpecification)	The settings used to enable point in time recovery.
CfnTablePropsMixin.Builder	provisionedThroughput(CfnTablePropsMixin.ProvisionedThroughputProperty provisionedThroughput)	Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits .
CfnTablePropsMixin.Builder	provisionedThroughput(IResolvable provisionedThroughput)	Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits .
CfnTablePropsMixin.Builder	resourcePolicy(CfnTablePropsMixin.ResourcePolicyProperty resourcePolicy)	An AWS resource-based policy document in JSON format that will be attached to the table.
CfnTablePropsMixin.Builder	resourcePolicy(IResolvable resourcePolicy)	An AWS resource-based policy document in JSON format that will be attached to the table.
CfnTablePropsMixin.Builder	sseSpecification(CfnTablePropsMixin.SSESpecificationProperty sseSpecification)	Specifies the settings to enable server-side encryption.
CfnTablePropsMixin.Builder	sseSpecification(IResolvable sseSpecification)	Specifies the settings to enable server-side encryption.
CfnTablePropsMixin.Builder	streamSpecification(CfnTablePropsMixin.StreamSpecificationProperty streamSpecification)	The settings for the DynamoDB table stream, which captures changes to items stored in the table.
CfnTablePropsMixin.Builder	streamSpecification(IResolvable streamSpecification)	The settings for the DynamoDB table stream, which captures changes to items stored in the table.
CfnTablePropsMixin.Builder	tableClass(String tableClass)	The table class of the new table.
CfnTablePropsMixin.Builder	tableName(String tableName)	A name for the table.
CfnTablePropsMixin.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.
CfnTablePropsMixin.Builder	timeToLiveSpecification(CfnTablePropsMixin.TimeToLiveSpecificationProperty timeToLiveSpecification)	Specifies the Time to Live (TTL) settings for the table.
CfnTablePropsMixin.Builder	timeToLiveSpecification(IResolvable timeToLiveSpecification)	Specifies the Time to Live (TTL) settings for the table.
CfnTablePropsMixin.Builder	warmThroughput(CfnTablePropsMixin.WarmThroughputProperty warmThroughput)	Represents the warm throughput (in read units per second and write units per second) for creating a table.
CfnTablePropsMixin.Builder	warmThroughput(IResolvable warmThroughput)	Represents the warm throughput (in read units per second and write units per second) for creating a table.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnTablePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnTablePropsMixin.Builder.

create

@Stability(Stable)
public static CfnTablePropsMixin.Builder create()

Returns:

a new instance of CfnTablePropsMixin.Builder.

attributeDefinitions

@Stability(Stable)
public CfnTablePropsMixin.Builder attributeDefinitions(IResolvable attributeDefinitions)

A list of attributes that describe the key schema for the table and indexes.

This property is required to create a DynamoDB table.

Update requires: Some interruptions . Replacement if you edit an existing AttributeDefinition.

Parameters:

attributeDefinitions - A list of attributes that describe the key schema for the table and indexes. This parameter is required.

Returns:

this

See Also:

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

attributeDefinitions

@Stability(Stable)
public CfnTablePropsMixin.Builder attributeDefinitions(List<? extends Object> attributeDefinitions)

A list of attributes that describe the key schema for the table and indexes.

This property is required to create a DynamoDB table.

Update requires: Some interruptions . Replacement if you edit an existing AttributeDefinition.

Parameters:

attributeDefinitions - A list of attributes that describe the key schema for the table and indexes. This parameter is required.

Returns:

this

See Also:

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

billingMode

@Stability(Stable)
public CfnTablePropsMixin.Builder billingMode(String billingMode)

Specify how you are charged for read and write throughput and how you manage capacity.

Valid values include:

• PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for most DynamoDB workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode .
• PROVISIONED - We recommend using PROVISIONED for steady workloads with predictable growth where capacity requirements can be reliably forecasted. PROVISIONED sets the billing mode to Provisioned capacity mode .

If not specified, the default is PROVISIONED .

Parameters:

billingMode - Specify how you are charged for read and write throughput and how you manage capacity. This parameter is required.

Returns:

this

See Also:

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

contributorInsightsSpecification

@Stability(Stable)
public CfnTablePropsMixin.Builder contributorInsightsSpecification(IResolvable contributorInsightsSpecification)

The settings used to specify whether to enable CloudWatch Contributor Insights for the table and define which events to monitor.

Parameters:

contributorInsightsSpecification - The settings used to specify whether to enable CloudWatch Contributor Insights for the table and define which events to monitor. This parameter is required.

Returns:

this

See Also:

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

contributorInsightsSpecification

@Stability(Stable)
public CfnTablePropsMixin.Builder contributorInsightsSpecification(CfnTablePropsMixin.ContributorInsightsSpecificationProperty contributorInsightsSpecification)

The settings used to specify whether to enable CloudWatch Contributor Insights for the table and define which events to monitor.

Parameters:

contributorInsightsSpecification - The settings used to specify whether to enable CloudWatch Contributor Insights for the table and define which events to monitor. This parameter is required.

Returns:

this

See Also:

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

deletionProtectionEnabled

@Stability(Stable)
public CfnTablePropsMixin.Builder deletionProtectionEnabled(Boolean deletionProtectionEnabled)

Determines if a table is protected from deletion.

When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see Using deletion protection in the Amazon DynamoDB Developer Guide .

Parameters:

deletionProtectionEnabled - Determines if a table is protected from deletion. This parameter is required.

Returns:

this

See Also:

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

deletionProtectionEnabled

@Stability(Stable)
public CfnTablePropsMixin.Builder deletionProtectionEnabled(IResolvable deletionProtectionEnabled)

Determines if a table is protected from deletion.

When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see Using deletion protection in the Amazon DynamoDB Developer Guide .

Parameters:

deletionProtectionEnabled - Determines if a table is protected from deletion. This parameter is required.

Returns:

this

See Also:

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

globalSecondaryIndexes

@Stability(Stable)
public CfnTablePropsMixin.Builder globalSecondaryIndexes(IResolvable globalSecondaryIndexes)

Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes.

If you update a table to include a new global secondary index, AWS CloudFormation initiates the index creation and then proceeds with the stack update. AWS CloudFormation doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ACTIVE . You can track its status by using the DynamoDB DescribeTable command.

If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index.

Updates are not supported. The following are exceptions:

• If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption.
• You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails.

Parameters:

globalSecondaryIndexes - Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. This parameter is required.

Returns:

this

See Also:

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

globalSecondaryIndexes

@Stability(Stable)
public CfnTablePropsMixin.Builder globalSecondaryIndexes(List<? extends Object> globalSecondaryIndexes)

Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes.

If you update a table to include a new global secondary index, AWS CloudFormation initiates the index creation and then proceeds with the stack update. AWS CloudFormation doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ACTIVE . You can track its status by using the DynamoDB DescribeTable command.

If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index.

Updates are not supported. The following are exceptions:

• If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption.
• You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails.

Parameters:

globalSecondaryIndexes - Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. This parameter is required.

Returns:

this

See Also:

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

importSourceSpecification

@Stability(Stable)
public CfnTablePropsMixin.Builder importSourceSpecification(IResolvable importSourceSpecification)

Specifies the properties of data being imported from the S3 bucket source to the" table.

If you specify the ImportSourceSpecification property, and also specify either the StreamSpecification , the TableClass property, the DeletionProtectionEnabled property, or the WarmThroughput property, the IAM entity creating/updating stack must have UpdateTable permission.

Parameters:

importSourceSpecification - Specifies the properties of data being imported from the S3 bucket source to the" table. This parameter is required.

Returns:

this

See Also:

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

importSourceSpecification

@Stability(Stable)
public CfnTablePropsMixin.Builder importSourceSpecification(CfnTablePropsMixin.ImportSourceSpecificationProperty importSourceSpecification)

Specifies the properties of data being imported from the S3 bucket source to the" table.

If you specify the ImportSourceSpecification property, and also specify either the StreamSpecification , the TableClass property, the DeletionProtectionEnabled property, or the WarmThroughput property, the IAM entity creating/updating stack must have UpdateTable permission.

Parameters:

importSourceSpecification - Specifies the properties of data being imported from the S3 bucket source to the" table. This parameter is required.

Returns:

this

See Also:

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

keySchema

@Stability(Stable)
public CfnTablePropsMixin.Builder keySchema(IResolvable keySchema)

Specifies the attributes that make up the primary key for the table.

The attributes in the KeySchema property must also be defined in the AttributeDefinitions property.

Parameters:

keySchema - Specifies the attributes that make up the primary key for the table. This parameter is required.

Returns:

this

See Also:

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

keySchema

@Stability(Stable)
public CfnTablePropsMixin.Builder keySchema(List<? extends Object> keySchema)

Specifies the attributes that make up the primary key for the table.

The attributes in the KeySchema property must also be defined in the AttributeDefinitions property.

Parameters:

keySchema - Specifies the attributes that make up the primary key for the table. This parameter is required.

Returns:

this

See Also:

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

kinesisStreamSpecification

@Stability(Stable)
public CfnTablePropsMixin.Builder kinesisStreamSpecification(IResolvable kinesisStreamSpecification)

The Kinesis Data Streams configuration for the specified table.

Parameters:

kinesisStreamSpecification - The Kinesis Data Streams configuration for the specified table. This parameter is required.

Returns:

this

See Also:

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

kinesisStreamSpecification

@Stability(Stable)
public CfnTablePropsMixin.Builder kinesisStreamSpecification(CfnTablePropsMixin.KinesisStreamSpecificationProperty kinesisStreamSpecification)

The Kinesis Data Streams configuration for the specified table.

Parameters:

kinesisStreamSpecification - The Kinesis Data Streams configuration for the specified table. This parameter is required.

Returns:

this

See Also:

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

localSecondaryIndexes

@Stability(Stable)
public CfnTablePropsMixin.Builder localSecondaryIndexes(IResolvable localSecondaryIndexes)

Local secondary indexes to be created on the table.

You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.

Parameters:

localSecondaryIndexes - Local secondary indexes to be created on the table. This parameter is required.

Returns:

this

See Also:

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

localSecondaryIndexes

@Stability(Stable)
public CfnTablePropsMixin.Builder localSecondaryIndexes(List<? extends Object> localSecondaryIndexes)

Local secondary indexes to be created on the table.

You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes.

Parameters:

localSecondaryIndexes - Local secondary indexes to be created on the table. This parameter is required.

Returns:

this

See Also:

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

onDemandThroughput

@Stability(Stable)
public CfnTablePropsMixin.Builder onDemandThroughput(IResolvable onDemandThroughput)

Sets the maximum number of read and write units for the specified on-demand table.

If you use this property, you must specify MaxReadRequestUnits , MaxWriteRequestUnits , or both.

Parameters:

onDemandThroughput - Sets the maximum number of read and write units for the specified on-demand table. This parameter is required.

Returns:

this

See Also:

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

onDemandThroughput

@Stability(Stable)
public CfnTablePropsMixin.Builder onDemandThroughput(CfnTablePropsMixin.OnDemandThroughputProperty onDemandThroughput)

Sets the maximum number of read and write units for the specified on-demand table.

If you use this property, you must specify MaxReadRequestUnits , MaxWriteRequestUnits , or both.

Parameters:

onDemandThroughput - Sets the maximum number of read and write units for the specified on-demand table. This parameter is required.

Returns:

this

See Also:

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

pointInTimeRecoverySpecification

@Stability(Stable)
public CfnTablePropsMixin.Builder pointInTimeRecoverySpecification(IResolvable pointInTimeRecoverySpecification)

The settings used to enable point in time recovery.

Parameters:

pointInTimeRecoverySpecification - The settings used to enable point in time recovery. This parameter is required.

Returns:

this

See Also:

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

pointInTimeRecoverySpecification

@Stability(Stable)
public CfnTablePropsMixin.Builder pointInTimeRecoverySpecification(CfnTablePropsMixin.PointInTimeRecoverySpecificationProperty pointInTimeRecoverySpecification)

The settings used to enable point in time recovery.

Parameters:

pointInTimeRecoverySpecification - The settings used to enable point in time recovery. This parameter is required.

Returns:

this

See Also:

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

provisionedThroughput

@Stability(Stable)
public CfnTablePropsMixin.Builder provisionedThroughput(IResolvable provisionedThroughput)

Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits .

For more information about the contents of a provisioned throughput structure, see Amazon DynamoDB Table ProvisionedThroughput .

If you set BillingMode as PROVISIONED , you must specify this property. If you set BillingMode as PAY_PER_REQUEST , you cannot specify this property.

Parameters:

provisionedThroughput - Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits . This parameter is required.

Returns:

this

See Also:

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

provisionedThroughput

@Stability(Stable)
public CfnTablePropsMixin.Builder provisionedThroughput(CfnTablePropsMixin.ProvisionedThroughputProperty provisionedThroughput)

Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits .

For more information about the contents of a provisioned throughput structure, see Amazon DynamoDB Table ProvisionedThroughput .

If you set BillingMode as PROVISIONED , you must specify this property. If you set BillingMode as PAY_PER_REQUEST , you cannot specify this property.

Parameters:

provisionedThroughput - Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits . This parameter is required.

Returns:

this

See Also:

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

resourcePolicy

@Stability(Stable)
public CfnTablePropsMixin.Builder resourcePolicy(IResolvable resourcePolicy)

An AWS resource-based policy document in JSON format that will be attached to the table.

When you attach a resource-based policy while creating a table, the policy application is strongly consistent .

The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see Resource-based policy considerations .

You need to specify the CreateTable and PutResourcePolicy IAM actions for authorizing a user to create a table with a resource-based policy.

Parameters:

resourcePolicy - An AWS resource-based policy document in JSON format that will be attached to the table. This parameter is required.

Returns:

this

See Also:

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

resourcePolicy

@Stability(Stable)
public CfnTablePropsMixin.Builder resourcePolicy(CfnTablePropsMixin.ResourcePolicyProperty resourcePolicy)

An AWS resource-based policy document in JSON format that will be attached to the table.

When you attach a resource-based policy while creating a table, the policy application is strongly consistent .

The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see Resource-based policy considerations .

You need to specify the CreateTable and PutResourcePolicy IAM actions for authorizing a user to create a table with a resource-based policy.

Parameters:

resourcePolicy - An AWS resource-based policy document in JSON format that will be attached to the table. This parameter is required.

Returns:

this

See Also:

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

sseSpecification

@Stability(Stable)
public CfnTablePropsMixin.Builder sseSpecification(IResolvable sseSpecification)

Specifies the settings to enable server-side encryption.

Parameters:

sseSpecification - Specifies the settings to enable server-side encryption. This parameter is required.

Returns:

this

See Also:

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

sseSpecification

@Stability(Stable)
public CfnTablePropsMixin.Builder sseSpecification(CfnTablePropsMixin.SSESpecificationProperty sseSpecification)

Specifies the settings to enable server-side encryption.

Parameters:

sseSpecification - Specifies the settings to enable server-side encryption. This parameter is required.

Returns:

this

See Also:

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

streamSpecification

@Stability(Stable)
public CfnTablePropsMixin.Builder streamSpecification(IResolvable streamSpecification)

The settings for the DynamoDB table stream, which captures changes to items stored in the table.

Including this property in your AWS CloudFormation template automatically enables streaming.

Parameters:

streamSpecification - The settings for the DynamoDB table stream, which captures changes to items stored in the table. This parameter is required.

Returns:

this

See Also:

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

streamSpecification

@Stability(Stable)
public CfnTablePropsMixin.Builder streamSpecification(CfnTablePropsMixin.StreamSpecificationProperty streamSpecification)

The settings for the DynamoDB table stream, which captures changes to items stored in the table.

Including this property in your AWS CloudFormation template automatically enables streaming.

Parameters:

streamSpecification - The settings for the DynamoDB table stream, which captures changes to items stored in the table. This parameter is required.

Returns:

this

See Also:

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

tableClass

@Stability(Stable)
public CfnTablePropsMixin.Builder tableClass(String tableClass)

The table class of the new table.

Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS .

Parameters:

tableClass - The table class of the new table. This parameter is required.

Returns:

this

See Also:

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

tableName

@Stability(Stable)
public CfnTablePropsMixin.Builder tableName(String tableName)

A name for the table.

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the table name. For more information, see Name Type .

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

Parameters:

tableName - A name for the table. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnTablePropsMixin.Builder tags(List<? extends CfnTag> tags)

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

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

timeToLiveSpecification

@Stability(Stable)
public CfnTablePropsMixin.Builder timeToLiveSpecification(IResolvable timeToLiveSpecification)

Specifies the Time to Live (TTL) settings for the table.

For detailed information about the limits in DynamoDB, see Limits in Amazon DynamoDB in the Amazon DynamoDB Developer Guide.

Parameters:

timeToLiveSpecification - Specifies the Time to Live (TTL) settings for the table. This parameter is required.

Returns:

this

See Also:

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

timeToLiveSpecification

@Stability(Stable)
public CfnTablePropsMixin.Builder timeToLiveSpecification(CfnTablePropsMixin.TimeToLiveSpecificationProperty timeToLiveSpecification)

Specifies the Time to Live (TTL) settings for the table.

For detailed information about the limits in DynamoDB, see Limits in Amazon DynamoDB in the Amazon DynamoDB Developer Guide.

Parameters:

timeToLiveSpecification - Specifies the Time to Live (TTL) settings for the table. This parameter is required.

Returns:

this

See Also:

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

warmThroughput

@Stability(Stable)
public CfnTablePropsMixin.Builder warmThroughput(IResolvable warmThroughput)

Represents the warm throughput (in read units per second and write units per second) for creating a table.

Parameters:

warmThroughput - Represents the warm throughput (in read units per second and write units per second) for creating a table. This parameter is required.

Returns:

this

See Also:

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

warmThroughput

@Stability(Stable)
public CfnTablePropsMixin.Builder warmThroughput(CfnTablePropsMixin.WarmThroughputProperty warmThroughput)

Represents the warm throughput (in read units per second and write units per second) for creating a table.

Parameters:

warmThroughput - Represents the warm throughput (in read units per second and write units per second) for creating a table. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnTablePropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnTablePropsMixin>

Returns:

a newly built instance of CfnTablePropsMixin.