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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb

Overview

Note:

When making an API call, you may pass RestoreTableFromBackupInput data as a 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
  },
  sse_specification_override: {
    enabled: false,
    sse_type: "AES256", # accepts AES256, KMS
    kms_master_key_id: "KMSMasterKeyId",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#backup_arnString

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

Returns:

  • (String)


8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 8387

class RestoreTableFromBackupInput < Struct.new(
  :target_table_name,
  :backup_arn,
  :billing_mode_override,
  :global_secondary_index_override,
  :local_secondary_index_override,
  :provisioned_throughput_override,
  :sse_specification_override)
  SENSITIVE = []
  include Aws::Structure
end

#billing_mode_overrideString

The billing mode of the restored table.

Returns:

  • (String)


8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 8387

class RestoreTableFromBackupInput < Struct.new(
  :target_table_name,
  :backup_arn,
  :billing_mode_override,
  :global_secondary_index_override,
  :local_secondary_index_override,
  :provisioned_throughput_override,
  :sse_specification_override)
  SENSITIVE = []
  include Aws::Structure
end

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



8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 8387

class RestoreTableFromBackupInput < Struct.new(
  :target_table_name,
  :backup_arn,
  :billing_mode_override,
  :global_secondary_index_override,
  :local_secondary_index_override,
  :provisioned_throughput_override,
  :sse_specification_override)
  SENSITIVE = []
  include Aws::Structure
end

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



8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 8387

class RestoreTableFromBackupInput < Struct.new(
  :target_table_name,
  :backup_arn,
  :billing_mode_override,
  :global_secondary_index_override,
  :local_secondary_index_override,
  :provisioned_throughput_override,
  :sse_specification_override)
  SENSITIVE = []
  include Aws::Structure
end

#provisioned_throughput_overrideTypes::ProvisionedThroughput

Provisioned throughput settings for the restored table.



8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 8387

class RestoreTableFromBackupInput < Struct.new(
  :target_table_name,
  :backup_arn,
  :billing_mode_override,
  :global_secondary_index_override,
  :local_secondary_index_override,
  :provisioned_throughput_override,
  :sse_specification_override)
  SENSITIVE = []
  include Aws::Structure
end

#sse_specification_overrideTypes::SSESpecification

The new server-side encryption settings for the restored table.



8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 8387

class RestoreTableFromBackupInput < Struct.new(
  :target_table_name,
  :backup_arn,
  :billing_mode_override,
  :global_secondary_index_override,
  :local_secondary_index_override,
  :provisioned_throughput_override,
  :sse_specification_override)
  SENSITIVE = []
  include Aws::Structure
end

#target_table_nameString

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

Returns:

  • (String)


8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/types.rb', line 8387

class RestoreTableFromBackupInput < Struct.new(
  :target_table_name,
  :backup_arn,
  :billing_mode_override,
  :global_secondary_index_override,
  :local_secondary_index_override,
  :provisioned_throughput_override,
  :sse_specification_override)
  SENSITIVE = []
  include Aws::Structure
end