class Amazonite::DynamoDB::CreateGlobalSecondaryIndexAction

Overview

Represents a new global secondary index to be added to an existing table.

Included Modules

Defined in:

dynamodb/create_global_secondary_index_action.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(index_name : String, key_schema : Array(KeySchemaElement), projection : Projection, provisioned_throughput : ProvisionedThroughput | Nil = nil, on_demand_throughput : OnDemandThroughput | Nil = nil, warm_throughput : WarmThroughput | Nil = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def index_name : String #

The name of the global secondary index to be created.


[View source]
def index_name=(index_name : String) #

The name of the global secondary index to be created.


[View source]
def key_schema : Array(KeySchemaElement) #

The key schema for the global secondary index. Global secondary index supports up to 4 partition and up to 4 sort keys.


[View source]
def key_schema=(key_schema : Array(KeySchemaElement)) #

The key schema for the global secondary index. Global secondary index supports up to 4 partition and up to 4 sort keys.


[View source]
def on_demand_throughput : OnDemandThroughput | Nil #

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.


[View source]
def on_demand_throughput=(on_demand_throughput : OnDemandThroughput | Nil) #

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.


[View source]
def projection : 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.


[View source]
def projection=(projection : 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.


[View source]
def provisioned_throughput : ProvisionedThroughput | Nil #

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.


[View source]
def provisioned_throughput=(provisioned_throughput : ProvisionedThroughput | Nil) #

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.


[View source]
def validate! : Nil #

[View source]
def warm_throughput : WarmThroughput | Nil #

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


[View source]
def warm_throughput=(warm_throughput : WarmThroughput | Nil) #

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


[View source]