Package com.pulumi.aws.dynamodb.outputs

Class TableGlobalSecondaryIndex

java.lang.Object

com.pulumi.aws.dynamodb.outputs.TableGlobalSecondaryIndex

public final class TableGlobalSecondaryIndex
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TableGlobalSecondaryIndex.Builder

Method Summary

Modifier and Type	Method	Description
static TableGlobalSecondaryIndex.Builder	builder()
static TableGlobalSecondaryIndex.Builder	builder(TableGlobalSecondaryIndex defaults)
java.util.Optional<java.lang.String>	hashKey()	Deprecated. hash_key is deprecated.
java.util.List<TableGlobalSecondaryIndexKeySchema>	keySchemas()
java.lang.String	name()
java.util.List<java.lang.String>	nonKeyAttributes()
java.util.Optional<TableGlobalSecondaryIndexOnDemandThroughput>	onDemandThroughput()
java.lang.String	projectionType()
java.util.Optional<java.lang.String>	rangeKey()	Deprecated. range_key is deprecated.
java.util.Optional<java.lang.Integer>	readCapacity()
java.util.Optional<TableGlobalSecondaryIndexWarmThroughput>	warmThroughput()
java.util.Optional<java.lang.Integer>	writeCapacity()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

hashKey

@Deprecated
public java.util.Optional<java.lang.String> hashKey()

Deprecated.

hash_key is deprecated. Use keySchema instead.

Returns:

Name of the hash key in the index; must be defined as an attribute in the resource. Mutually exclusive with `keySchema`. Use `keySchema` instead.

keySchemas

public java.util.List<TableGlobalSecondaryIndexKeySchema> keySchemas()

Returns:

Configuration block(s) for the key schema. Mutually exclusive with `hashKey` and `rangeKey`. Required if `hashKey` is not specified. Supports multi-attribute keys for the [Multi-Attribute Keys design pattern](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GSI.DesignPattern.MultiAttributeKeys.html). See below.

name

public java.lang.String name()

Returns:

Name of the index.

nonKeyAttributes

public java.util.List<java.lang.String> nonKeyAttributes()

Returns:

Only required with `INCLUDE` as a projection type; a list of attributes to project into the index. These do not need to be defined as attributes on the table.

onDemandThroughput

public java.util.Optional<TableGlobalSecondaryIndexOnDemandThroughput> onDemandThroughput()

Returns:

Sets the maximum number of read and write units for the specified on-demand index. See below.

projectionType

public java.lang.String projectionType()

Returns:

One of `ALL`, `INCLUDE` or `KEYS_ONLY` where `ALL` projects every attribute into the index, `KEYS_ONLY` projects into the index only the table and index hashKey and sortKey attributes, `INCLUDE` projects into the index all of the attributes that are defined in `nonKeyAttributes` in addition to the attributes that `KEYS_ONLY` project.

rangeKey

@Deprecated
public java.util.Optional<java.lang.String> rangeKey()

Deprecated.

range_key is deprecated. Use keySchema instead.

Returns:

Name of the range key; must be defined as an attribute in the resource. Mutually exclusive with `keySchema`. Use `keySchema` instead.

readCapacity

public java.util.Optional<java.lang.Integer> readCapacity()

Returns:

Number of read units for this index. Must be set if billingMode is set to PROVISIONED.

warmThroughput

public java.util.Optional<TableGlobalSecondaryIndexWarmThroughput> warmThroughput()

Returns:

Sets the number of warm read and write units for this index. See below.

writeCapacity

public java.util.Optional<java.lang.Integer> writeCapacity()

Returns:

Number of write units for this index. Must be set if billingMode is set to PROVISIONED.

builder

public static TableGlobalSecondaryIndex.Builder builder()

builder

public static TableGlobalSecondaryIndex.Builder builder(TableGlobalSecondaryIndex defaults)