Package software.amazon.awscdk.services.dynamodb

Class CfnTableProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.dynamodb.CfnTableProps.Jsii$Proxy

All Implemented Interfaces:

CfnTableProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnTableProps

@Stability(Stable)
@Internal
public static final class CfnTableProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnTableProps

An implementation for CfnTableProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.dynamodb.CfnTableProps

CfnTableProps.Builder, CfnTableProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnTableProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnTableProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getAttributeDefinitions()	A list of attributes that describe the key schema for the table and indexes.
final String	getBillingMode()	Specify how you are charged for read and write throughput and how you manage capacity.
final Object	getContributorInsightsSpecification()	The settings used to specify whether to enable CloudWatch Contributor Insights for the table and define which events to monitor.
final Object	getDeletionProtectionEnabled()	Determines if a table is protected from deletion.
final Object	getGlobalSecondaryIndexes()	Global secondary indexes to be created on the table.
final Object	getImportSourceSpecification()	Specifies the properties of data being imported from the S3 bucket source to the" table.
final Object	getKeySchema()	Specifies the attributes that make up the primary key for the table.
final Object	getKinesisStreamSpecification()	The Kinesis Data Streams configuration for the specified table.
final Object	getLocalSecondaryIndexes()	Local secondary indexes to be created on the table.
final Object	getOnDemandThroughput()	Sets the maximum number of read and write units for the specified on-demand table.
final Object	getPointInTimeRecoverySpecification()	The settings used to enable point in time recovery.
final Object	getProvisionedThroughput()	Throughput for the specified table, which consists of values for ReadCapacityUnits and WriteCapacityUnits .
final Object	getResourcePolicy()	An AWS resource-based policy document in JSON format that will be attached to the table.
final Object	getSseSpecification()	Specifies the settings to enable server-side encryption.
final Object	getStreamSpecification()	The settings for the DynamoDB table stream, which captures changes to items stored in the table.
final String	getTableClass()	The table class of the new table.
final String	getTableName()	A name for the table.
final List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
final Object	getTimeToLiveSpecification()	Specifies the Time to Live (TTL) settings for the table.
final Object	getWarmThroughput()	Represents the warm throughput (in read units per second and write units per second) for creating a table.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnTableProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnTableProps.Builder.

Method Details

getKeySchema

public final Object getKeySchema()

Description copied from interface: CfnTableProps

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTable.KeySchemaProperty>

Specified by:

getKeySchema in interface CfnTableProps

See Also:

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

getAttributeDefinitions

public final Object getAttributeDefinitions()

Description copied from interface: CfnTableProps

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTable.AttributeDefinitionProperty>

Specified by:

getAttributeDefinitions in interface CfnTableProps

See Also:

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

getBillingMode

public final String getBillingMode()

Description copied from interface: CfnTableProps

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 .

Specified by:

getBillingMode in interface CfnTableProps

See Also:

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

getContributorInsightsSpecification

public final Object getContributorInsightsSpecification()

Description copied from interface: CfnTableProps

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

Returns union: either IResolvable or CfnTable.ContributorInsightsSpecificationProperty

Specified by:

getContributorInsightsSpecification in interface CfnTableProps

See Also:

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

getDeletionProtectionEnabled

public final Object getDeletionProtectionEnabled()

Description copied from interface: CfnTableProps

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 .

Returns union: either Boolean or IResolvable

Specified by:

getDeletionProtectionEnabled in interface CfnTableProps

See Also:

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

getGlobalSecondaryIndexes

public final Object getGlobalSecondaryIndexes()

Description copied from interface: CfnTableProps

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTable.GlobalSecondaryIndexProperty>

Specified by:

getGlobalSecondaryIndexes in interface CfnTableProps

See Also:

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

getImportSourceSpecification

public final Object getImportSourceSpecification()

Description copied from interface: CfnTableProps

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.

Returns union: either IResolvable or CfnTable.ImportSourceSpecificationProperty

Specified by:

getImportSourceSpecification in interface CfnTableProps

See Also:

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

getKinesisStreamSpecification

public final Object getKinesisStreamSpecification()

Description copied from interface: CfnTableProps

The Kinesis Data Streams configuration for the specified table.

Returns union: either IResolvable or CfnTable.KinesisStreamSpecificationProperty

Specified by:

getKinesisStreamSpecification in interface CfnTableProps

See Also:

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

getLocalSecondaryIndexes

public final Object getLocalSecondaryIndexes()

Description copied from interface: CfnTableProps

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.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTable.LocalSecondaryIndexProperty>

Specified by:

getLocalSecondaryIndexes in interface CfnTableProps

See Also:

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

getOnDemandThroughput

public final Object getOnDemandThroughput()

Description copied from interface: CfnTableProps

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.

Returns union: either IResolvable or CfnTable.OnDemandThroughputProperty

Specified by:

getOnDemandThroughput in interface CfnTableProps

See Also:

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

getPointInTimeRecoverySpecification

public final Object getPointInTimeRecoverySpecification()

Description copied from interface: CfnTableProps

The settings used to enable point in time recovery.

Returns union: either IResolvable or CfnTable.PointInTimeRecoverySpecificationProperty

Specified by:

getPointInTimeRecoverySpecification in interface CfnTableProps

See Also:

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

getProvisionedThroughput

public final Object getProvisionedThroughput()

Description copied from interface: CfnTableProps

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.

Returns union: either IResolvable or CfnTable.ProvisionedThroughputProperty

Specified by:

getProvisionedThroughput in interface CfnTableProps

See Also:

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

getResourcePolicy

public final Object getResourcePolicy()

Description copied from interface: CfnTableProps

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.

Returns union: either IResolvable or CfnTable.ResourcePolicyProperty

Specified by:

getResourcePolicy in interface CfnTableProps

See Also:

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

getSseSpecification

public final Object getSseSpecification()

Description copied from interface: CfnTableProps

Specifies the settings to enable server-side encryption.

Returns union: either IResolvable or CfnTable.SSESpecificationProperty

Specified by:

getSseSpecification in interface CfnTableProps

See Also:

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

getStreamSpecification

public final Object getStreamSpecification()

Description copied from interface: CfnTableProps

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.

Returns union: either IResolvable or CfnTable.StreamSpecificationProperty

Specified by:

getStreamSpecification in interface CfnTableProps

See Also:

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

getTableClass

public final String getTableClass()

Description copied from interface: CfnTableProps

The table class of the new table.

Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS .

Specified by:

getTableClass in interface CfnTableProps

See Also:

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

getTableName

public final String getTableName()

Description copied from interface: CfnTableProps

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.

Specified by:

getTableName in interface CfnTableProps

See Also:

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

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnTableProps

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

For more information, see Tag .

Specified by:

getTags in interface CfnTableProps

See Also:

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

getTimeToLiveSpecification

public final Object getTimeToLiveSpecification()

Description copied from interface: CfnTableProps

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.

Returns union: either IResolvable or CfnTable.TimeToLiveSpecificationProperty

Specified by:

getTimeToLiveSpecification in interface CfnTableProps

See Also:

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

getWarmThroughput

public final Object getWarmThroughput()

Description copied from interface: CfnTableProps

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

Returns union: either IResolvable or CfnTable.WarmThroughputProperty

Specified by:

getWarmThroughput in interface CfnTableProps

See Also:

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

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object