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

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

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

Overview

Represents the properties of a global secondary index.

Instance Attribute Summary collapse

Instance Attribute Details

#backfillingBoolean

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.

For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.

Returns:

  • (Boolean)


2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2369

class GlobalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_status,
  :backfilling,
  :provisioned_throughput,
  :index_size_bytes,
  :item_count,
  :index_arn)
  include Aws::Structure
end

#index_arnString

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

Returns:

  • (String)


2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2369

class GlobalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_status,
  :backfilling,
  :provisioned_throughput,
  :index_size_bytes,
  :item_count,
  :index_arn)
  include Aws::Structure
end

#index_nameString

The name of the global secondary index.

Returns:

  • (String)


2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2369

class GlobalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_status,
  :backfilling,
  :provisioned_throughput,
  :index_size_bytes,
  :item_count,
  :index_arn)
  include Aws::Structure
end

#index_size_bytesInteger

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)


2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2369

class GlobalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_status,
  :backfilling,
  :provisioned_throughput,
  :index_size_bytes,
  :item_count,
  :index_arn)
  include Aws::Structure
end

#index_statusString

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)


2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2369

class GlobalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_status,
  :backfilling,
  :provisioned_throughput,
  :index_size_bytes,
  :item_count,
  :index_arn)
  include Aws::Structure
end

#item_countInteger

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)


2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2369

class GlobalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_status,
  :backfilling,
  :provisioned_throughput,
  :index_size_bytes,
  :item_count,
  :index_arn)
  include Aws::Structure
end

#key_schemaArray<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

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from DynamoDB' 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.

Returns:



2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2369

class GlobalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_status,
  :backfilling,
  :provisioned_throughput,
  :index_size_bytes,
  :item_count,
  :index_arn)
  include Aws::Structure
end

#projectionTypes::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:



2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2369

class GlobalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_status,
  :backfilling,
  :provisioned_throughput,
  :index_size_bytes,
  :item_count,
  :index_arn)
  include Aws::Structure
end

#provisioned_throughputTypes::ProvisionedThroughputDescription

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

For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.



2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 2369

class GlobalSecondaryIndexDescription < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :index_status,
  :backfilling,
  :provisioned_throughput,
  :index_size_bytes,
  :item_count,
  :index_arn)
  include Aws::Structure
end