Class: Aws::DynamoDB::Types::CreateGlobalSecondaryIndexAction
- Inherits:
-
Struct
- Object
- Struct
- Aws::DynamoDB::Types::CreateGlobalSecondaryIndexAction
- Defined in:
- gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb
Overview
Represents a new global secondary index to be added to an existing table.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#index_name ⇒ String
The name of the global secondary index to be created.
-
#key_schema ⇒ Array<Types::KeySchemaElement>
The key schema for the global secondary index.
-
#on_demand_throughput ⇒ Types::OnDemandThroughput
The maximum number of read and write units for the global secondary index being created.
-
#projection ⇒ Types::Projection
Represents attributes that are copied (projected) from the table into an 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) when creating a secondary index.
Instance Attribute Details
#index_name ⇒ String
The name of the global secondary index to be created.
1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1744 class CreateGlobalSecondaryIndexAction < 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 key schema for the global secondary index.
1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1744 class CreateGlobalSecondaryIndexAction < 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 global secondary
index being created. If you use this parameter, you must specify
MaxReadRequestUnits
, MaxWriteRequestUnits
, or both. You must use
either OnDemand Throughput
or ProvisionedThroughput
based on
your table's capacity mode.
1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1744 class CreateGlobalSecondaryIndexAction < 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 an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1744 class CreateGlobalSecondaryIndexAction < 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.
For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.
1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1744 class CreateGlobalSecondaryIndexAction < 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) when creating a secondary index.
1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 |
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1744 class CreateGlobalSecondaryIndexAction < Struct.new( :index_name, :key_schema, :projection, :provisioned_throughput, :on_demand_throughput, :warm_throughput) SENSITIVE = [] include Aws::Structure end |