Package software.amazon.awscdk.services.dynamodb

Class GlobalSecondaryIndexProps.Jsii$Proxy

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

  • 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(GlobalSecondaryIndexProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the GlobalSecondaryIndexProps.Builder.

  • Method Details

    • getContributorInsightsEnabled

      public final Boolean getContributorInsightsEnabled()
      Description copied from interface: GlobalSecondaryIndexProps
      (deprecated) Whether CloudWatch contributor insights is enabled for the specified global secondary index.

      Default: false

      Specified by:
      getContributorInsightsEnabled in interface GlobalSecondaryIndexProps

    • getContributorInsightsSpecification

      public final ContributorInsightsSpecification getContributorInsightsSpecification()
      Description copied from interface: GlobalSecondaryIndexProps
      Whether CloudWatch contributor insights is enabled and what mode is selected.

      Default: - contributor insights is not enabled

      Specified by:
      getContributorInsightsSpecification in interface GlobalSecondaryIndexProps

    • getMaxReadRequestUnits

      public final Number getMaxReadRequestUnits()
      Description copied from interface: GlobalSecondaryIndexProps
      The maximum read request units for the global secondary index.

      Can only be provided if table billingMode is PAY_PER_REQUEST.

      Default: - on-demand throughput is disabled

      Specified by:
      getMaxReadRequestUnits in interface GlobalSecondaryIndexProps

    • getMaxWriteRequestUnits

      public final Number getMaxWriteRequestUnits()
      Description copied from interface: GlobalSecondaryIndexProps
      The maximum write request units for the global secondary index.

      Can only be provided if table billingMode is PAY_PER_REQUEST.

      Default: - on-demand throughput is disabled

      Specified by:
      getMaxWriteRequestUnits in interface GlobalSecondaryIndexProps

    • getPartitionKeys

      public final List<Attribute> getPartitionKeys()
      Description copied from interface: GlobalSecondaryIndexProps
      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 GlobalSecondaryIndexProps

    • getReadCapacity

      public final Number getReadCapacity()
      Description copied from interface: GlobalSecondaryIndexProps
      The read capacity for the global secondary index.

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

      Default: 5

      Specified by:
      getReadCapacity in interface GlobalSecondaryIndexProps

    • getSortKeys

      public final List<Attribute> getSortKeys()
      Description copied from interface: GlobalSecondaryIndexProps
      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 GlobalSecondaryIndexProps

    • getWarmThroughput

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

      Default: - no warm throughput is configured

      Specified by:
      getWarmThroughput in interface GlobalSecondaryIndexProps

    • getWriteCapacity

      public final Number getWriteCapacity()
      Description copied from interface: GlobalSecondaryIndexProps
      The write capacity for the global secondary index.

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

      Default: 5

      Specified by:
      getWriteCapacity in interface GlobalSecondaryIndexProps

    • 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

    • getPartitionKey

      public final Attribute getPartitionKey()
      Description copied from interface: SchemaOptions
      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 SchemaOptions

    • getSortKey

      public final Attribute getSortKey()
      Description copied from interface: SchemaOptions
      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 SchemaOptions

    • $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