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(value=Stable)
public static interface CfnGlobalTable.GlobalSecondaryIndexProperty
extends software.amazon.jsii.JsiiSerializable

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
         .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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnGlobalTable.GlobalSecondaryIndexProperty.Builder	builder()
String	getIndexName() `CfnGlobalTable.GlobalSecondaryIndexProperty.IndexName`.
Object	getKeySchema() `CfnGlobalTable.GlobalSecondaryIndexProperty.KeySchema`.
Object	getProjection() `CfnGlobalTable.GlobalSecondaryIndexProperty.Projection`.
default Object	getWriteProvisionedThroughputSettings() `CfnGlobalTable.GlobalSecondaryIndexProperty.WriteProvisionedThroughputSettings`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getIndexName

@Stability(value=Stable)
 @NotNull
String getIndexName()

`CfnGlobalTable.GlobalSecondaryIndexProperty.IndexName`.

getKeySchema

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

`CfnGlobalTable.GlobalSecondaryIndexProperty.KeySchema`.

getProjection

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

`CfnGlobalTable.GlobalSecondaryIndexProperty.Projection`.

getWriteProvisionedThroughputSettings

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

`CfnGlobalTable.GlobalSecondaryIndexProperty.WriteProvisionedThroughputSettings`.

builder

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

Returns:

a CfnGlobalTable.GlobalSecondaryIndexProperty.Builder of CfnGlobalTable.GlobalSecondaryIndexProperty