software.amazon.awscdk.services.dynamodb

Interface TableOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, SchemaOptions

All Known Subinterfaces:

TableProps

All Known Implementing Classes:

TableOptions.Jsii$Proxy, TableProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-07-12T14:11:26.770Z")
 @Stability(value=Stable)
public interface TableOptions
extends software.amazon.jsii.JsiiSerializable, SchemaOptions

Properties of a DynamoDB Table.

Use {@link TableProps} for all table properties

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TableOptions.Builder A builder for TableOptions
static class	TableOptions.Jsii$Proxy An implementation for TableOptions

Method Summary

Modifier and Type	Method and Description
static TableOptions.Builder	builder()
default BillingMode	getBillingMode() Specify how you are charged for read and write throughput and how you manage capacity.
default Boolean	getContributorInsightsEnabled() Whether CloudWatch contributor insights is enabled.
default TableEncryption	getEncryption() Whether server-side encryption with an AWS managed customer master key is enabled.
default IKey	getEncryptionKey() External KMS key to use for table encryption.
default Boolean	getPointInTimeRecovery() Whether point-in-time recovery is enabled.
default Number	getReadCapacity() The read capacity for the table.
default RemovalPolicy	getRemovalPolicy() The removal policy to apply to the DynamoDB Table.
default List<String>	getReplicationRegions() Regions where replica tables will be created.
default Duration	getReplicationTimeout() The timeout for a table replication operation in a single region.
default Boolean	getServerSideEncryption() Deprecated. This property is deprecated. In order to obtain the same behavior as enabling this, set the `encryption` property to `TableEncryption.AWS_MANAGED` instead.
default StreamViewType	getStream() When an item in the table is modified, StreamViewType determines what information is written to the stream for this table.
default String	getTimeToLiveAttribute() The name of TTL attribute.
default Number	getWriteCapacity() The write capacity for the table.

Methods inherited from interface software.amazon.awscdk.services.dynamodb.SchemaOptions

getPartitionKey, getSortKey

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBillingMode

@Stability(value=Stable)
 @Nullable
default BillingMode getBillingMode()

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

getContributorInsightsEnabled

@Stability(value=Stable)
 @Nullable
default Boolean getContributorInsightsEnabled()

Whether CloudWatch contributor insights is enabled.

Default: false

getEncryption

@Stability(value=Stable)
 @Nullable
default TableEncryption getEncryption()

Whether server-side encryption with an AWS managed customer master key is enabled.

This property cannot be set if serverSideEncryption is set.

Default: - server-side encryption is enabled with an AWS owned customer master key

getEncryptionKey

@Stability(value=Stable)
 @Nullable
default IKey getEncryptionKey()

External KMS key to use for table encryption.

This property can only be set if encryption is set to TableEncryption.CUSTOMER_MANAGED.

Default: - If `encryption` is set to `TableEncryption.CUSTOMER_MANAGED` and this property is undefined, a new KMS key will be created and associated with this table.

getPointInTimeRecovery

@Stability(value=Stable)
 @Nullable
default Boolean getPointInTimeRecovery()

Whether point-in-time recovery is enabled.

Default: - point-in-time recovery is disabled

getReadCapacity

@Stability(value=Stable)
 @Nullable
default Number getReadCapacity()

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

getRemovalPolicy

@Stability(value=Stable)
 @Nullable
default RemovalPolicy getRemovalPolicy()

The removal policy to apply to the DynamoDB Table.

Default: RemovalPolicy.RETAIN

getReplicationRegions

@Stability(value=Stable)
 @Nullable
default List<String> getReplicationRegions()

Regions where replica tables will be created.

Default: - no replica tables are created

getReplicationTimeout

@Stability(value=Stable)
 @Nullable
default Duration getReplicationTimeout()

The timeout for a table replication operation in a single region.

Default: Duration.minutes(30)

getServerSideEncryption

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default Boolean getServerSideEncryption()

Deprecated. This property is deprecated. In order to obtain the same behavior as enabling this, set the `encryption` property to `TableEncryption.AWS_MANAGED` instead.

(deprecated) Whether server-side encryption with an AWS managed customer master key is enabled.

This property cannot be set if encryption and/or encryptionKey is set.

Default: - server-side encryption is enabled with an AWS owned customer master key

getStream

@Stability(value=Stable)
 @Nullable
default StreamViewType getStream()

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

getTimeToLiveAttribute

@Stability(value=Stable)
 @Nullable
default String getTimeToLiveAttribute()

The name of TTL attribute.

Default: - TTL is disabled

getWriteCapacity

@Stability(value=Stable)
 @Nullable
default Number getWriteCapacity()

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

builder

@Stability(value=Stable)
static TableOptions.Builder builder()

Specified by:

builder in interface SchemaOptions

Returns:

a TableOptions.Builder of TableOptions