Package software.amazon.awscdk.services.dynamodb

Interface CfnGlobalTable.GlobalSecondaryIndexProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGlobalTable.GlobalSecondaryIndexProperty.Jsii$Proxy

Enclosing class:

CfnGlobalTable

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

Allows you to specify a global secondary index for the global table.

The index will be defined on all replicas.

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
         .warmThroughput(WarmThroughputProperty.builder()
                 .readUnitsPerSecond(123)
                 .writeUnitsPerSecond(123)
                 .build())
         .writeOnDemandThroughputSettings(WriteOnDemandThroughputSettingsProperty.builder()
                 .maxWriteRequestUnits(123)
                 .build())
         .writeProvisionedThroughputSettings(WriteProvisionedThroughputSettingsProperty.builder()
                 .writeCapacityAutoScalingSettings(CapacityAutoScalingSettingsProperty.builder()
                         .maxCapacity(123)
                         .minCapacity(123)
                         .targetTrackingScalingPolicyConfiguration(TargetTrackingScalingPolicyConfigurationProperty.builder()
                                 .targetValue(123)
                                 // the properties below are optional
                                 .disableScaleIn(false)
                                 .scaleInCooldown(123)
                                 .scaleOutCooldown(123)
                                 .build())
                         // the properties below are optional
                         .seedCapacity(123)
                         .build())
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnGlobalTable.GlobalSecondaryIndexProperty.Builder	builder()
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 .
Object	getProjection()	Represents attributes that are copied (projected) from the table into the 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.
default Object	getWriteOnDemandThroughputSettings()	Sets the write request settings for a global table or a global secondary index.
default Object	getWriteProvisionedThroughputSettings()	Defines write capacity settings for the global 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-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-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 CfnGlobalTable.KeySchemaProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dynamodb-globaltable-globalsecondaryindex.html#cfn-dynamodb-globaltable-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 CfnGlobalTable.ProjectionProperty

See Also:

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

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 CfnGlobalTable.WarmThroughputProperty

See Also:

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

getWriteOnDemandThroughputSettings

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

Sets the write request settings for a global table or a global secondary index.

You can only specify this setting if your resource uses the PAY_PER_REQUEST BillingMode .

Returns union: either IResolvable or CfnGlobalTable.WriteOnDemandThroughputSettingsProperty

See Also:

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

getWriteProvisionedThroughputSettings

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

Defines write capacity settings for the global secondary index.

You must specify a value for this property if the table's BillingMode is PROVISIONED . All replicas will have the same write capacity settings for this global secondary index.

Returns union: either IResolvable or CfnGlobalTable.WriteProvisionedThroughputSettingsProperty

See Also:

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

builder

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

Returns:

a CfnGlobalTable.GlobalSecondaryIndexProperty.Builder of CfnGlobalTable.GlobalSecondaryIndexProperty