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

Class: Aws::DynamoDB::Types::RestoreTableFromBackupInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing RestoreTableFromBackupInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  target_table_name: "TableName", # required
  backup_arn: "BackupArn", # required
  billing_mode_override: "PROVISIONED", # accepts PROVISIONED, PAY_PER_REQUEST
  global_secondary_index_override: [
    {
      index_name: "IndexName", # required
      key_schema: [ # required
        {
          attribute_name: "KeySchemaAttributeName", # required
          key_type: "HASH", # required, accepts HASH, RANGE
        },
      ],
      projection: { # required
        projection_type: "ALL", # accepts ALL, KEYS_ONLY, INCLUDE
        non_key_attributes: ["NonKeyAttributeName"],
      },
      provisioned_throughput: {
        read_capacity_units: 1, # required
        write_capacity_units: 1, # required
      },
    },
  ],
  local_secondary_index_override: [
    {
      index_name: "IndexName", # required
      key_schema: [ # required
        {
          attribute_name: "KeySchemaAttributeName", # required
          key_type: "HASH", # required, accepts HASH, RANGE
        },
      ],
      projection: { # required
        projection_type: "ALL", # accepts ALL, KEYS_ONLY, INCLUDE
        non_key_attributes: ["NonKeyAttributeName"],
      },
    },
  ],
  provisioned_throughput_override: {
    read_capacity_units: 1, # required
    write_capacity_units: 1, # required
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#backup_arnString

The Amazon Resource Name (ARN) associated with the backup.

Returns:

  • (String)

    The Amazon Resource Name (ARN) associated with the backup.

#billing_mode_overrideString

The billing mode of the restored table.

Possible values:

  • PROVISIONED
  • PAY_PER_REQUEST

Returns:

  • (String)

    The billing mode of the restored table.

#global_secondary_index_overrideArray<Types::GlobalSecondaryIndex>

List of global secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.

Returns:

#local_secondary_index_overrideArray<Types::LocalSecondaryIndex>

List of local secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.

Returns:

#provisioned_throughput_overrideTypes::ProvisionedThroughput

Provisioned throughput settings for the restored table.

Returns:

#target_table_nameString

The name of the new table to which the backup must be restored.

Returns:

  • (String)

    The name of the new table to which the backup must be restored.