Table.Builder (software.amazon.awscdk:aws-cdk-lib 2.0.0-rc.6 API)

java.lang.Object
- software.amazon.awscdk.services.dynamodb.Table.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<Table>

Enclosing class:: Table

@Stability(value=Experimental)
public static final class Table.Builder
extends Object
implements software.amazon.jsii.Builder<Table>

(experimental) A fluent builder for Table.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Table.Builder`	`billingMode(BillingMode billingMode)` (experimental) Specify how you are charged for read and write throughput and how you manage capacity.
`Table`	`build()`
`Table.Builder`	`contributorInsightsEnabled(Boolean contributorInsightsEnabled)` (experimental) Whether CloudWatch contributor insights is enabled.
`static Table.Builder`	`create(software.constructs.Construct scope, String id)`
`Table.Builder`	`encryption(TableEncryption encryption)` (experimental) Whether server-side encryption with an AWS managed customer master key is enabled.
`Table.Builder`	`encryptionKey(IKey encryptionKey)` (experimental) External KMS key to use for table encryption.
`Table.Builder`	`partitionKey(Attribute partitionKey)` (experimental) Partition key attribute definition.
`Table.Builder`	`pointInTimeRecovery(Boolean pointInTimeRecovery)` (experimental) Whether point-in-time recovery is enabled.
`Table.Builder`	`readCapacity(Number readCapacity)` (experimental) The read capacity for the table.
`Table.Builder`	`removalPolicy(RemovalPolicy removalPolicy)` (experimental) The removal policy to apply to the DynamoDB Table.
`Table.Builder`	`replicationRegions(List<String> replicationRegions)` (experimental) Regions where replica tables will be created.
`Table.Builder`	`replicationTimeout(Duration replicationTimeout)` (experimental) The timeout for a table replication operation in a single region.
`Table.Builder`	`sortKey(Attribute sortKey)` (experimental) Table sort key attribute definition.
`Table.Builder`	`stream(StreamViewType stream)` (experimental) When an item in the table is modified, StreamViewType determines what information is written to the stream for this table.
`Table.Builder`	`tableName(String tableName)` (experimental) Enforces a particular physical table name.
`Table.Builder`	`timeToLiveAttribute(String timeToLiveAttribute)` (experimental) The name of TTL attribute.
`Table.Builder`	`writeCapacity(Number writeCapacity)` (experimental) The write capacity for the table.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
@Stability(value=Experimental)
public static Table.Builder create(software.constructs.Construct scope,
                                                                  String id)
```
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    Returns:
    
    a new instance of Table.Builder.
  - partitionKey
```
@Stability(value=Experimental)
public Table.Builder partitionKey(Attribute partitionKey)
```
    (experimental) Partition key attribute definition.
    
    Parameters:
    
    partitionKey - Partition key attribute definition. This parameter is required.
    
    Returns:
    
    this
  - billingMode
```
@Stability(value=Experimental)
public Table.Builder billingMode(BillingMode billingMode)
```
    (experimental) 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
    
    Parameters:
    
    billingMode - Specify how you are charged for read and write throughput and how you manage capacity. This parameter is required.
    
    Returns:
    
    this
  - contributorInsightsEnabled
```
@Stability(value=Experimental)
public Table.Builder contributorInsightsEnabled(Boolean contributorInsightsEnabled)
```
    (experimental) Whether CloudWatch contributor insights is enabled.
    Default: false
    
    Parameters:
    
    contributorInsightsEnabled - Whether CloudWatch contributor insights is enabled. This parameter is required.
    
    Returns:
    
    this
  - encryption
```
@Stability(value=Experimental)
public Table.Builder encryption(TableEncryption encryption)
```
    (experimental) 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
    
    Parameters:
    
    encryption - Whether server-side encryption with an AWS managed customer master key is enabled. This parameter is required.
    
    Returns:
    
    this
  - encryptionKey
```
@Stability(value=Experimental)
public Table.Builder encryptionKey(IKey encryptionKey)
```
    (experimental) 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.
    
    Parameters:
    
    encryptionKey - External KMS key to use for table encryption. This parameter is required.
    
    Returns:
    
    this
  - pointInTimeRecovery
```
@Stability(value=Experimental)
public Table.Builder pointInTimeRecovery(Boolean pointInTimeRecovery)
```
    (experimental) Whether point-in-time recovery is enabled.
    Default: - point-in-time recovery is disabled
    
    Parameters:
    
    pointInTimeRecovery - Whether point-in-time recovery is enabled. This parameter is required.
    
    Returns:
    
    this
  - readCapacity
```
@Stability(value=Experimental)
public Table.Builder readCapacity(Number readCapacity)
```
    (experimental) 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
    
    Parameters:
    
    readCapacity - The read capacity for the table. This parameter is required.
    
    Returns:
    
    this
  - removalPolicy
```
@Stability(value=Experimental)
public Table.Builder removalPolicy(RemovalPolicy removalPolicy)
```
    (experimental) The removal policy to apply to the DynamoDB Table.
    Default: RemovalPolicy.RETAIN
    
    Parameters:
    
    removalPolicy - The removal policy to apply to the DynamoDB Table. This parameter is required.
    
    Returns:
    
    this
  - replicationRegions
```
@Stability(value=Experimental)
public Table.Builder replicationRegions(List<String> replicationRegions)
```
    (experimental) Regions where replica tables will be created.
    Default: - no replica tables are created
    
    Parameters:
    
    replicationRegions - Regions where replica tables will be created. This parameter is required.
    
    Returns:
    
    this
  - replicationTimeout
```
@Stability(value=Experimental)
public Table.Builder replicationTimeout(Duration replicationTimeout)
```
    (experimental) The timeout for a table replication operation in a single region.
    Default: Duration.minutes(30)
    
    Parameters:
    
    replicationTimeout - The timeout for a table replication operation in a single region. This parameter is required.
    
    Returns:
    
    this
  - sortKey
```
@Stability(value=Experimental)
public Table.Builder sortKey(Attribute sortKey)
```
    (experimental) Table sort key attribute definition.
    Default: no sort key
    
    Parameters:
    
    sortKey - Table sort key attribute definition. This parameter is required.
    
    Returns:
    
    this
  - stream
```
@Stability(value=Experimental)
public Table.Builder stream(StreamViewType stream)
```
    (experimental) 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
    
    Parameters:
    
    stream - When an item in the table is modified, StreamViewType determines what information is written to the stream for this table. This parameter is required.
    
    Returns:
    
    this
  - timeToLiveAttribute
```
@Stability(value=Experimental)
public Table.Builder timeToLiveAttribute(String timeToLiveAttribute)
```
    (experimental) The name of TTL attribute.
    Default: - TTL is disabled
    
    Parameters:
    
    timeToLiveAttribute - The name of TTL attribute. This parameter is required.
    
    Returns:
    
    this
  - writeCapacity
```
@Stability(value=Experimental)
public Table.Builder writeCapacity(Number writeCapacity)
```
    (experimental) 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
    
    Parameters:
    
    writeCapacity - The write capacity for the table. This parameter is required.
    
    Returns:
    
    this
  - tableName
```
@Stability(value=Experimental)
public Table.Builder tableName(String tableName)
```
    (experimental) Enforces a particular physical table name.
    Default:
    
    Parameters:
    
    tableName - Enforces a particular physical table name. This parameter is required.
    
    Returns:
    
    this
  - build
```
@Stability(value=Experimental)
public Table build()
```
    Specified by:
    
    build in interface software.amazon.jsii.Builder<Table>

Class Table.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

partitionKey

billingMode

contributorInsightsEnabled

encryption

encryptionKey

pointInTimeRecovery

readCapacity

removalPolicy

replicationRegions

replicationTimeout

sortKey

stream

timeToLiveAttribute

writeCapacity

tableName

build