software.amazon.awscdk.services.dynamodb

Interface CfnTableProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTableProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:05.849Z")
 @Stability(value=Stable)
public interface CfnTableProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::DynamoDB::Table`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dynamodb.*;
 CfnTableProps cfnTableProps = CfnTableProps.builder()
         .keySchema(List.of(KeySchemaProperty.builder()
                 .attributeName("attributeName")
                 .keyType("keyType")
                 .build()))
         // the properties below are optional
         .attributeDefinitions(List.of(AttributeDefinitionProperty.builder()
                 .attributeName("attributeName")
                 .attributeType("attributeType")
                 .build()))
         .billingMode("billingMode")
         .contributorInsightsSpecification(ContributorInsightsSpecificationProperty.builder()
                 .enabled(false)
                 .build())
         .globalSecondaryIndexes(List.of(GlobalSecondaryIndexProperty.builder()
                 .indexName("indexName")
                 .keySchema(List.of(KeySchemaProperty.builder()
                         .attributeName("attributeName")
                         .keyType("keyType")
                         .build()))
                 .projection(ProjectionProperty.builder()
                         .nonKeyAttributes(List.of("nonKeyAttributes"))
                         .projectionType("projectionType")
                         .build())
                 // the properties below are optional
                 .contributorInsightsSpecification(ContributorInsightsSpecificationProperty.builder()
                         .enabled(false)
                         .build())
                 .provisionedThroughput(ProvisionedThroughputProperty.builder()
                         .readCapacityUnits(123)
                         .writeCapacityUnits(123)
                         .build())
                 .build()))
         .kinesisStreamSpecification(KinesisStreamSpecificationProperty.builder()
                 .streamArn("streamArn")
                 .build())
         .localSecondaryIndexes(List.of(LocalSecondaryIndexProperty.builder()
                 .indexName("indexName")
                 .keySchema(List.of(KeySchemaProperty.builder()
                         .attributeName("attributeName")
                         .keyType("keyType")
                         .build()))
                 .projection(ProjectionProperty.builder()
                         .nonKeyAttributes(List.of("nonKeyAttributes"))
                         .projectionType("projectionType")
                         .build())
                 .build()))
         .pointInTimeRecoverySpecification(PointInTimeRecoverySpecificationProperty.builder()
                 .pointInTimeRecoveryEnabled(false)
                 .build())
         .provisionedThroughput(ProvisionedThroughputProperty.builder()
                 .readCapacityUnits(123)
                 .writeCapacityUnits(123)
                 .build())
         .sseSpecification(SSESpecificationProperty.builder()
                 .sseEnabled(false)
                 // the properties below are optional
                 .kmsMasterKeyId("kmsMasterKeyId")
                 .sseType("sseType")
                 .build())
         .streamSpecification(StreamSpecificationProperty.builder()
                 .streamViewType("streamViewType")
                 .build())
         .tableName("tableName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .timeToLiveSpecification(TimeToLiveSpecificationProperty.builder()
                 .attributeName("attributeName")
                 .enabled(false)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnTableProps.Builder	builder()
default Object	getAttributeDefinitions() `AWS::DynamoDB::Table.AttributeDefinitions`.
default String	getBillingMode() `AWS::DynamoDB::Table.BillingMode`.
default Object	getContributorInsightsSpecification() `AWS::DynamoDB::Table.ContributorInsightsSpecification`.
default Object	getGlobalSecondaryIndexes() `AWS::DynamoDB::Table.GlobalSecondaryIndexes`.
Object	getKeySchema() `AWS::DynamoDB::Table.KeySchema`.
default Object	getKinesisStreamSpecification() `AWS::DynamoDB::Table.KinesisStreamSpecification`.
default Object	getLocalSecondaryIndexes() `AWS::DynamoDB::Table.LocalSecondaryIndexes`.
default Object	getPointInTimeRecoverySpecification() `AWS::DynamoDB::Table.PointInTimeRecoverySpecification`.
default Object	getProvisionedThroughput() `AWS::DynamoDB::Table.ProvisionedThroughput`.
default Object	getSseSpecification() `AWS::DynamoDB::Table.SSESpecification`.
default Object	getStreamSpecification() `AWS::DynamoDB::Table.StreamSpecification`.
default String	getTableName() `AWS::DynamoDB::Table.TableName`.
default List<CfnTag>	getTags() `AWS::DynamoDB::Table.Tags`.
default Object	getTimeToLiveSpecification() `AWS::DynamoDB::Table.TimeToLiveSpecification`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAttributeDefinitions

@Stability(value=Stable)
 @Nullable
default Object getAttributeDefinitions()

`AWS::DynamoDB::Table.AttributeDefinitions`.

getBillingMode

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

`AWS::DynamoDB::Table.BillingMode`.

getContributorInsightsSpecification

@Stability(value=Stable)
 @Nullable
default Object getContributorInsightsSpecification()

`AWS::DynamoDB::Table.ContributorInsightsSpecification`.

getGlobalSecondaryIndexes

@Stability(value=Stable)
 @Nullable
default Object getGlobalSecondaryIndexes()

`AWS::DynamoDB::Table.GlobalSecondaryIndexes`.

getKeySchema

@Stability(value=Stable)
 @NotNull
Object getKeySchema()

`AWS::DynamoDB::Table.KeySchema`.

getKinesisStreamSpecification

@Stability(value=Stable)
 @Nullable
default Object getKinesisStreamSpecification()

`AWS::DynamoDB::Table.KinesisStreamSpecification`.

getLocalSecondaryIndexes

@Stability(value=Stable)
 @Nullable
default Object getLocalSecondaryIndexes()

`AWS::DynamoDB::Table.LocalSecondaryIndexes`.

getPointInTimeRecoverySpecification

@Stability(value=Stable)
 @Nullable
default Object getPointInTimeRecoverySpecification()

`AWS::DynamoDB::Table.PointInTimeRecoverySpecification`.

getProvisionedThroughput

@Stability(value=Stable)
 @Nullable
default Object getProvisionedThroughput()

`AWS::DynamoDB::Table.ProvisionedThroughput`.

getSseSpecification

@Stability(value=Stable)
 @Nullable
default Object getSseSpecification()

`AWS::DynamoDB::Table.SSESpecification`.

getStreamSpecification

@Stability(value=Stable)
 @Nullable
default Object getStreamSpecification()

`AWS::DynamoDB::Table.StreamSpecification`.

getTableName

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

`AWS::DynamoDB::Table.TableName`.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

`AWS::DynamoDB::Table.Tags`.

getTimeToLiveSpecification

@Stability(value=Stable)
 @Nullable
default Object getTimeToLiveSpecification()

`AWS::DynamoDB::Table.TimeToLiveSpecification`.

builder

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

Returns:

a CfnTableProps.Builder of CfnTableProps