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/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:16.916Z")
 @Stability(value=Experimental)
public interface GlobalSecondaryIndexProps
extends software.amazon.jsii.JsiiSerializable, SecondaryIndexProps

(experimental) Properties for a global secondary index.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static GlobalSecondaryIndexProps.Builder	builder()
Attribute	getPartitionKey() (experimental) The attribute of a partition key for the global secondary index.
default Number	getReadCapacity() (experimental) The read capacity for the global secondary index.
default Attribute	getSortKey() (experimental) The attribute of a sort key for the global secondary index.
default Number	getWriteCapacity() (experimental) 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)
 @NotNull
Attribute getPartitionKey()

(experimental) The attribute of a partition key for the global secondary index.

getReadCapacity

@Stability(value=Experimental)
 @Nullable
default Number getReadCapacity()

(experimental) The read capacity for the global secondary index.

Can only be provided if table billingMode is Provisioned or undefined.

Default: 5

getSortKey

@Stability(value=Experimental)
 @Nullable
default Attribute getSortKey()

(experimental) The attribute of a sort key for the global secondary index.

Default: - No sort key

getWriteCapacity

@Stability(value=Experimental)
 @Nullable
default Number getWriteCapacity()

(experimental) The write capacity for the global secondary index.

Can only be provided if table billingMode is Provisioned or undefined.

Default: 5

builder

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

Specified by:

builder in interface SecondaryIndexProps

Returns:

a GlobalSecondaryIndexProps.Builder of GlobalSecondaryIndexProps