Package software.amazon.awscdk.services.dynamodb

Class GlobalSecondaryIndexPropsV2.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.dynamodb.GlobalSecondaryIndexPropsV2.Jsii$Proxy
All Implemented Interfaces:
GlobalSecondaryIndexPropsV2, SecondaryIndexProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
GlobalSecondaryIndexPropsV2
@Stability(Stable) @Internal public static final class GlobalSecondaryIndexPropsV2.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements GlobalSecondaryIndexPropsV2
An implementation for GlobalSecondaryIndexPropsV2

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(GlobalSecondaryIndexPropsV2.Builder builder)
      Constructor that initializes the object based on literal property values passed by the GlobalSecondaryIndexPropsV2.Builder.

  • Method Details

    • getMaxReadRequestUnits

      public final Number getMaxReadRequestUnits()
      Description copied from interface: GlobalSecondaryIndexPropsV2
      The maximum read request units.

      Note: This can only be configured if the primary table billing is PAY_PER_REQUEST.

      Default: - inherited from the primary table.

      Specified by:
      getMaxReadRequestUnits in interface GlobalSecondaryIndexPropsV2

    • getMaxWriteRequestUnits

      public final Number getMaxWriteRequestUnits()
      Description copied from interface: GlobalSecondaryIndexPropsV2
      The maximum write request units.

      Note: This can only be configured if the primary table billing is PAY_PER_REQUEST.

      Default: - inherited from the primary table.

      Specified by:
      getMaxWriteRequestUnits in interface GlobalSecondaryIndexPropsV2

    • getPartitionKey

      public final Attribute getPartitionKey()
      Description copied from interface: GlobalSecondaryIndexPropsV2
      Partition key attribute definition.

      If a single field forms the partition key, you can use this field. Use the partitionKeys field if the partition key is a multi-attribute key (consists of multiple fields).

      Default: - exactly one of `partitionKey` and `partitionKeys` must be specified.

      Specified by:
      getPartitionKey in interface GlobalSecondaryIndexPropsV2

    • getPartitionKeys

      public final List<Attribute> getPartitionKeys()
      Description copied from interface: GlobalSecondaryIndexPropsV2
      Multi-attribute partition key.

      If a single field forms the partition key, you can use either partitionKey or partitionKeys to specify the partition key. Exactly one of these must be specified.

      You must use partitionKeys field if the partition key is a multi-attribute key (consists of multiple fields).

      NOTE: although the name of this field makes it sound like it creates multiple keys, it does not. It defines a single key that consists of of multiple fields.

      The order of fields is not important.

      Default: - exactly one of `partitionKey` and `partitionKeys` must be specified.

      Specified by:
      getPartitionKeys in interface GlobalSecondaryIndexPropsV2

    • getReadCapacity

      public final Capacity getReadCapacity()
      Description copied from interface: GlobalSecondaryIndexPropsV2
      The read capacity.

      Note: This can only be configured if the primary table billing is provisioned.

      Default: - inherited from the primary table.

      Specified by:
      getReadCapacity in interface GlobalSecondaryIndexPropsV2

    • getSortKey

      public final Attribute getSortKey()
      Description copied from interface: GlobalSecondaryIndexPropsV2
      Sort key attribute definition.

      If a single field forms the sort key, you can use this field. Use the sortKeys field if the sort key is a multi-attribute key (consists of multiple fields).

      Default: - no sort key

      Specified by:
      getSortKey in interface GlobalSecondaryIndexPropsV2

    • getSortKeys

      public final List<Attribute> getSortKeys()
      Description copied from interface: GlobalSecondaryIndexPropsV2
      Multi-attribute sort key.

      If a single field forms the sort key, you can use either sortKey or sortKeys to specify the sort key. At most one of these may be specified.

      You must use sortKeys field if the sort key is a multi-attribute key (consists of multiple fields).

      NOTE: although the name of this field makes it sound like it creates multiple keys, it does not. It defines a single key that consists of of multiple fields at the same time.

      NOTE: The order of fields is important!

      Default: - no sort key

      Specified by:
      getSortKeys in interface GlobalSecondaryIndexPropsV2

    • getWarmThroughput

      public final WarmThroughput getWarmThroughput()
      Description copied from interface: GlobalSecondaryIndexPropsV2
      The warm throughput configuration for the global secondary index.

      Default: - no warm throughput is configured

      Specified by:
      getWarmThroughput in interface GlobalSecondaryIndexPropsV2

    • getWriteCapacity

      public final Capacity getWriteCapacity()
      Description copied from interface: GlobalSecondaryIndexPropsV2
      The write capacity.

      Note: This can only be configured if the primary table billing is provisioned.

      Default: - inherited from the primary table.

      Specified by:
      getWriteCapacity in interface GlobalSecondaryIndexPropsV2

    • getIndexName

      public final String getIndexName()
      Description copied from interface: SecondaryIndexProps
      The name of the secondary index.
      Specified by:
      getIndexName in interface SecondaryIndexProps

    • getNonKeyAttributes

      public final List<String> getNonKeyAttributes()
      Description copied from interface: SecondaryIndexProps
      The non-key attributes that are projected into the secondary index.

      Default: - No additional attributes

      Specified by:
      getNonKeyAttributes in interface SecondaryIndexProps

    • getProjectionType

      public final ProjectionType getProjectionType()
      Description copied from interface: SecondaryIndexProps
      The set of attributes that are projected into the secondary index.

      Default: ALL

      Specified by:
      getProjectionType in interface SecondaryIndexProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object