Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Class: Aws::DynamoDB::Types::CreateGlobalSecondaryIndexAction

Inherits:
Struct
  • Object
show all
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

Instance Attribute Details

#index_nameString

The name of the global secondary index to be created.

Returns:

  • (String)

1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1735

class CreateGlobalSecondaryIndexAction < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :provisioned_throughput,
  :on_demand_throughput,
  :warm_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#key_schemaArray<Types::KeySchemaElement>

The key schema for the global secondary index.

Returns:


1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1735

class CreateGlobalSecondaryIndexAction < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :provisioned_throughput,
  :on_demand_throughput,
  :warm_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#on_demand_throughputTypes::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.


1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1735

class CreateGlobalSecondaryIndexAction < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :provisioned_throughput,
  :on_demand_throughput,
  :warm_throughput)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:


1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1735

class CreateGlobalSecondaryIndexAction < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :provisioned_throughput,
  :on_demand_throughput,
  :warm_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#provisioned_throughputTypes::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.


1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1735

class CreateGlobalSecondaryIndexAction < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :provisioned_throughput,
  :on_demand_throughput,
  :warm_throughput)
  SENSITIVE = []
  include Aws::Structure
end

#warm_throughputTypes::WarmThroughput

Represents the warm throughput value (in read units per second and write units per second) when creating a secondary index.


1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 1735

class CreateGlobalSecondaryIndexAction < Struct.new(
  :index_name,
  :key_schema,
  :projection,
  :provisioned_throughput,
  :on_demand_throughput,
  :warm_throughput)
  SENSITIVE = []
  include Aws::Structure
end