Class: Aws::DynamoDB::Types::GlobalSecondaryIndex
- Inherits:
-
Struct
- Object
- Struct
- Aws::DynamoDB::Types::GlobalSecondaryIndex
- Defined in:
- gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb
Overview
Represents the properties of a global secondary index.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#index_name ⇒ String
The name of the global secondary index.
-
#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:.
-
#on_demand_throughput ⇒ Types::OnDemandThroughput
The maximum number of read and write units for the specified global secondary index.
-
#projection ⇒ Types::Projection
Represents attributes that are copied (projected) from the table into the global secondary index.
-
#provisioned_throughput ⇒ Types::ProvisionedThroughput
Represents the provisioned throughput settings for the specified global secondary index.
-
#warm_throughput ⇒ Types::WarmThroughput
Represents the warm throughput value (in read units per second and write units per second) for the specified secondary index.
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.
4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4198 class GlobalSecondaryIndex < Struct.new( :index_name, :key_schema, :projection, :provisioned_throughput, :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 keyRANGE
- sort key
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.
4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4198 class GlobalSecondaryIndex < Struct.new( :index_name, :key_schema, :projection, :provisioned_throughput, :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. You must use
either OnDemandThroughput
or ProvisionedThroughput
based on your
table's capacity mode.
4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4198 class GlobalSecondaryIndex < Struct.new( :index_name, :key_schema, :projection, :provisioned_throughput, :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.
4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4198 class GlobalSecondaryIndex < Struct.new( :index_name, :key_schema, :projection, :provisioned_throughput, :on_demand_throughput, :warm_throughput) SENSITIVE = [] include Aws::Structure end |
#provisioned_throughput ⇒ Types::ProvisionedThroughput
Represents the provisioned throughput settings for the specified
global secondary index. You must use either OnDemandThroughput
or
ProvisionedThroughput
based on your table's capacity mode.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4198 class GlobalSecondaryIndex < Struct.new( :index_name, :key_schema, :projection, :provisioned_throughput, :on_demand_throughput, :warm_throughput) SENSITIVE = [] include Aws::Structure end |
#warm_throughput ⇒ Types::WarmThroughput
Represents the warm throughput value (in read units per second and
write units per second) for the specified secondary index. If you
use this parameter, you must specify ReadUnitsPerSecond
,
WriteUnitsPerSecond
, or both.
4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 4198 class GlobalSecondaryIndex < Struct.new( :index_name, :key_schema, :projection, :provisioned_throughput, :on_demand_throughput, :warm_throughput) SENSITIVE = [] include Aws::Structure end |