Class: Aws::DynamoDB::Types::GlobalSecondaryIndexDescription

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-dynamodb/types.rb

Overview

Represents the properties of a global secondary index.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#backfilling ⇒ Boolean

Indicates whether the index is currently backfilling. Backfilling is the process of reading items from the table and determining whether they can be added to the index. (Not all items will qualify: For example, a partition key cannot have any duplicate values.) If an item can be added to the index, DynamoDB will do so. After all items have been processed, the backfilling operation is complete and ‘Backfilling` is false.

You can delete an index that is being created during the ‘Backfilling` phase when `IndexStatus` is set to CREATING and `Backfilling` is true. You can’t delete the index that is being created when ‘IndexStatus` is set to CREATING and `Backfilling` is false.

<note markdown=“1”> For indexes that were created during a ‘CreateTable` operation, the `Backfilling` attribute does not appear in the `DescribeTable` output.

</note>

Returns:

  • (Boolean) 


4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 4281

class GlobalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_status,
  :backfilling,
  :provisioned_throughput,
  :index_size_bytes,
  :item_count,
  :index_arn,
  :on_demand_throughput,
  :warm_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#index_arn ⇒ String

The Amazon Resource Name (ARN) that uniquely identifies the index.

Returns:

  • (String) 


4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 4281

class GlobalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_status,
  :backfilling,
  :provisioned_throughput,
  :index_size_bytes,
  :item_count,
  :index_arn,
  :on_demand_throughput,
  :warm_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#index_name ⇒ String

The name of the global secondary index.

Returns:

  • (String) 


4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 4281

class GlobalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_status,
  :backfilling,
  :provisioned_throughput,
  :index_size_bytes,
  :item_count,
  :index_arn,
  :on_demand_throughput,
  :warm_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#index_size_bytes ⇒ Integer

The total size of the specified index, in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

Returns:

  • (Integer) 


4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 4281

class GlobalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_status,
  :backfilling,
  :provisioned_throughput,
  :index_size_bytes,
  :item_count,
  :index_arn,
  :on_demand_throughput,
  :warm_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#index_status ⇒ String

The current state of the global secondary index:

  • ‘CREATING` - The index is being created.

  • ‘UPDATING` - The index is being updated.

  • ‘DELETING` - The index is being deleted.

  • ‘ACTIVE` - The index is ready for use.

Returns:

  • (String) 


4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 4281

class GlobalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_status,
  :backfilling,
  :provisioned_throughput,
  :index_size_bytes,
  :item_count,
  :index_arn,
  :on_demand_throughput,
  :warm_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#item_count ⇒ Integer

The number of items in the specified index. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

Returns:

  • (Integer) 


4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 4281

class GlobalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_status,
  :backfilling,
  :provisioned_throughput,
  :index_size_bytes,
  :item_count,
  :index_arn,
  :on_demand_throughput,
  :warm_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#key_schema ⇒ Array<Types::KeySchemaElement>

The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types:

  • ‘HASH` - partition key

  • ‘RANGE` - sort key

<note markdown=“1”> The partition key of an item is also known as its *hash attribute*. The term “hash attribute” derives from DynamoDB’s usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its *range attribute*. The

term “range attribute” derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

</note>

Returns:



4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 4281

class GlobalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_status,
  :backfilling,
  :provisioned_throughput,
  :index_size_bytes,
  :item_count,
  :index_arn,
  :on_demand_throughput,
  :warm_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#on_demand_throughput ⇒ Types::OnDemandThroughput

The maximum number of read and write units for the specified global secondary index. If you use this parameter, you must specify ‘MaxReadRequestUnits`, `MaxWriteRequestUnits`, or both.

Returns:



4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 4281

class GlobalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_status,
  :backfilling,
  :provisioned_throughput,
  :index_size_bytes,
  :item_count,
  :index_arn,
  :on_demand_throughput,
  :warm_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#projection ⇒ Types::Projection

Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.

Returns:



4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 4281

class GlobalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_status,
  :backfilling,
  :provisioned_throughput,
  :index_size_bytes,
  :item_count,
  :index_arn,
  :on_demand_throughput,
  :warm_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#provisioned_throughput ⇒ Types::ProvisionedThroughputDescription

Represents the provisioned throughput settings for the specified global secondary index.

For current minimum and maximum provisioned throughput values, see

Service, Account, and Table Quotas][1

in the *Amazon DynamoDB

Developer Guide*.

[1]: docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html

Returns:



4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 4281

class GlobalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_status,
  :backfilling,
  :provisioned_throughput,
  :index_size_bytes,
  :item_count,
  :index_arn,
  :on_demand_throughput,
  :warm_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#warm_throughput ⇒ Types::GlobalSecondaryIndexWarmThroughputDescription

Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index.

Returns:



4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
 
# File 'lib/aws-sdk-dynamodb/types.rb', line 4281

class GlobalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_status,
  :backfilling,
  :provisioned_throughput,
  :index_size_bytes,
  :item_count,
  :index_arn,
  :on_demand_throughput,
  :warm_throughput)
  SENSITIVE = []
  include Aws::Structure
end