software.amazon.awscdk.services.dynamodb

Interface GlobalSecondaryIndexProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, SecondaryIndexProps

All Known Implementing Classes:

GlobalSecondaryIndexProps.Jsii$Proxy

@Generated(value="jsii-pacmak/0.11.3 (build 464b8c6)",
           date="2019-06-19T15:09:58.079Z")
 @Stability(value=Experimental)
public interface GlobalSecondaryIndexProps
extends software.amazon.jsii.JsiiSerializable, SecondaryIndexProps

EXPERIMENTAL

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GlobalSecondaryIndexProps.Builder A builder for GlobalSecondaryIndexProps
static class	GlobalSecondaryIndexProps.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
static GlobalSecondaryIndexProps.Builder	builder()
Attribute	getPartitionKey() The attribute of a partition key for the global secondary index.
Number	getReadCapacity() The read capacity for the global secondary index.
Attribute	getSortKey() The attribute of a sort key for the global secondary index.
Number	getWriteCapacity() The write capacity for the global secondary index.

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

getIndexName, getNonKeyAttributes, getProjectionType

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getPartitionKey

@Stability(value=Experimental)
Attribute getPartitionKey()

The attribute of a partition key for the global secondary index. EXPERIMENTAL

getReadCapacity

@Stability(value=Experimental)
Number getReadCapacity()

The read capacity for the global secondary index. Can only be provided if table billingMode is Provisioned or undefined. Default: 5 EXPERIMENTAL

getSortKey

@Stability(value=Experimental)
Attribute getSortKey()

The attribute of a sort key for the global secondary index. Default: undefined EXPERIMENTAL

getWriteCapacity

@Stability(value=Experimental)
Number getWriteCapacity()

The write capacity for the global secondary index. Can only be provided if table billingMode is Provisioned or undefined. Default: 5 EXPERIMENTAL

builder

@Stability(value=Experimental)
static GlobalSecondaryIndexProps.Builder builder()

Specified by:

builder in interface SecondaryIndexProps

Returns:

a GlobalSecondaryIndexProps.Builder of GlobalSecondaryIndexProps