Package software.amazon.awscdk.services.dynamodb

Interface CfnTable.GlobalSecondaryIndexProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTable.GlobalSecondaryIndexProperty.Jsii$Proxy

Enclosing class:

CfnTable

@Stability(Stable)
public static interface CfnTable.GlobalSecondaryIndexProperty
extends software.amazon.jsii.JsiiSerializable

Represents the properties of a global secondary index.

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.*;
 GlobalSecondaryIndexProperty globalSecondaryIndexProperty = 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)
                 // the properties below are optional
                 .mode("mode")
                 .build())
         .onDemandThroughput(OnDemandThroughputProperty.builder()
                 .maxReadRequestUnits(123)
                 .maxWriteRequestUnits(123)
                 .build())
         .provisionedThroughput(ProvisionedThroughputProperty.builder()
                 .readCapacityUnits(123)
                 .writeCapacityUnits(123)
                 .build())
         .warmThroughput(WarmThroughputProperty.builder()
                 .readUnitsPerSecond(123)
                 .writeUnitsPerSecond(123)
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-globalsecondaryindex.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTable.GlobalSecondaryIndexProperty.Builder	builder()
default Object	getContributorInsightsSpecification()	The settings used to specify whether to enable CloudWatch Contributor Insights for the global table and define which events to monitor.
String	getIndexName()	The name of the global secondary index.
Object	getKeySchema()	The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: - HASH - partition key - RANGE - sort key > The partition key of an item is also known as its hash attribute .
default Object	getOnDemandThroughput()	The maximum number of read and write units for the specified global secondary index.
Object	getProjection()	Represents attributes that are copied (projected) from the table into the global secondary index.
default Object	getProvisionedThroughput()	Represents the provisioned throughput settings for the specified global secondary index.
default Object	getWarmThroughput()	Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIndexName

@Stability(Stable)
@NotNull
String getIndexName()

The name of the global secondary index.

The name must be unique among all other indexes on this table.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-globalsecondaryindex.html#cfn-dynamodb-table-globalsecondaryindex-indexname

getKeySchema

@Stability(Stable)
@NotNull
Object getKeySchema()

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: - HASH - partition key - RANGE - sort key > The partition key of an item is also known as its hash attribute .

The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute . The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

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

See Also:

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

getProjection

@Stability(Stable)
@NotNull
Object getProjection()

Represents attributes that are copied (projected) from the table into the global secondary index.

These are in addition to the primary key attributes and index key attributes, which are automatically projected.

Returns union: either IResolvable or CfnTable.ProjectionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-table-globalsecondaryindex.html#cfn-dynamodb-table-globalsecondaryindex-projection

getContributorInsightsSpecification

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

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

Returns union: either IResolvable or CfnTable.ContributorInsightsSpecificationProperty

See Also:

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

getOnDemandThroughput

@Stability(Stable)
@Nullable
default Object getOnDemandThroughput()

The maximum number of read and write units for the specified global secondary index.

If you use this parameter, you must specify MaxReadRequestUnits , MaxWriteRequestUnits , or both. You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.

Returns union: either IResolvable or CfnTable.OnDemandThroughputProperty

See Also:

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

getProvisionedThroughput

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

Represents the provisioned throughput settings for the specified global secondary index.

You must use either OnDemandThroughput or ProvisionedThroughput based on your table's capacity mode.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide .

Returns union: either IResolvable or CfnTable.ProvisionedThroughputProperty

See Also:

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

getWarmThroughput

@Stability(Stable)
@Nullable
default Object getWarmThroughput()

Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index.

If you use this parameter, you must specify ReadUnitsPerSecond , WriteUnitsPerSecond , or both.

Returns union: either IResolvable or CfnTable.WarmThroughputProperty

See Also:

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

builder

@Stability(Stable)
static CfnTable.GlobalSecondaryIndexProperty.Builder builder()

Returns:

a CfnTable.GlobalSecondaryIndexProperty.Builder of CfnTable.GlobalSecondaryIndexProperty