Package com.pulumi.aws.dynamodb.inputs

Class TableGlobalSecondaryIndexArgs

  • public final class TableGlobalSecondaryIndexArgs
extends com.pulumi.resources.ResourceArgs

    • Method Detail

      • hashKey

        @Deprecated
public java.util.Optional<com.pulumi.core.Output<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.Optional<com.pulumi.core.Output<java.util.List<TableGlobalSecondaryIndexKeySchemaArgs>>> 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 com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the index.

      • nonKeyAttributes

        public java.util.Optional<com.pulumi.core.Output<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<com.pulumi.core.Output<TableGlobalSecondaryIndexOnDemandThroughputArgs>> onDemandThroughput()
        Returns:
        Sets the maximum number of read and write units for the specified on-demand index. See below.

      • projectionType

        public com.pulumi.core.Output<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<com.pulumi.core.Output<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<com.pulumi.core.Output<java.lang.Integer>> readCapacity()
        Returns:
        Number of read units for this index. Must be set if billingMode is set to PROVISIONED.

      • writeCapacity

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> writeCapacity()
        Returns:
        Number of write units for this index. Must be set if billingMode is set to PROVISIONED.