You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DynamoDB::Types::ReplicaGlobalSecondaryIndexSettingsDescription

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Represents the properties of a global secondary index.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#index_name ⇒ String

The name of the global secondary index. The name must be unique among all other indexes on this table.

Returns:

  • (String) —

    The name of the global secondary index.

#index_status ⇒ String

The current status of the global secondary index:

  • CREATING - The global secondary index is being created.

  • UPDATING - The global secondary index is being updated.

  • DELETING - The global secondary index is being deleted.

  • ACTIVE - The global secondary index is ready for use.

    Possible values:

    • CREATING
    • UPDATING
    • DELETING
    • ACTIVE

Returns:

  • (String) —

    The current status of the global secondary index:.

#provisioned_read_capacity_auto_scaling_settings ⇒ Types::AutoScalingSettingsDescription

Auto scaling settings for a global secondary index replica\'s read capacity units.

Returns:

#provisioned_read_capacity_units ⇒ Integer

The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

Returns:

  • (Integer) —

    The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.

#provisioned_write_capacity_auto_scaling_settings ⇒ Types::AutoScalingSettingsDescription

Auto scaling settings for a global secondary index replica\'s write capacity units.

Returns:

#provisioned_write_capacity_units ⇒ Integer

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

Returns:

  • (Integer) —

    The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.