Skip to content

RestoreTableRequest

Source code in docs_src/capo_keyspaces/types/restore_table_request.py
class RestoreTableRequest(TypedDict, closed=True):
    source_keyspace_name: "capo_keyspaces.types.keyspace_name.KeyspaceName"
    """<p>The keyspace name of the source table.</p>"""
    source_table_name: "capo_keyspaces.types.table_name.TableName"
    """<p>The name of the source table.</p>"""
    target_keyspace_name: "capo_keyspaces.types.keyspace_name.KeyspaceName"
    """<p>The name of the target keyspace.</p>"""
    target_table_name: "capo_keyspaces.types.table_name.TableName"
    """<p>The name of the target table.</p>"""
    restore_timestamp: NotRequired["capo_keyspaces.types.timestamp.Timestamp"]
    """<p>The restore timestamp in ISO 8601 format.</p>"""
    capacity_specification_override: NotRequired[
        "capo_keyspaces.types.capacity_specification.CapacitySpecification"
    ]
    """<p>Specifies the read/write throughput capacity mode for the target table. The options are:</p> <ul> <li> <p> <code>throughputMode:PAY_PER_REQUEST</code> </p> </li> <li> <p> <code>throughputMode:PROVISIONED</code> - Provisioned capacity mode requires <code>readCapacityUnits</code> and <code>writeCapacityUnits</code> as input.</p> </li> </ul> <p>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"""
    encryption_specification_override: NotRequired[
        "capo_keyspaces.types.encryption_specification.EncryptionSpecification"
    ]
    """<p>Specifies the encryption settings for the target table. You can choose one of the following KMS key (KMS key):</p> <ul> <li> <p> <code>type:AWS_OWNED_KMS_KEY</code> - This key is owned by Amazon Keyspaces. </p> </li> <li> <p> <code>type:CUSTOMER_MANAGED_KMS_KEY</code> - This key is stored in your account and is created, owned, and managed by you. This option requires the <code>kms_key_identifier</code> of the KMS key in Amazon Resource Name (ARN) format as input. </p> </li> </ul> <p>The default is <code>type:AWS_OWNED_KMS_KEY</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">Encryption at rest</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"""
    point_in_time_recovery_override: NotRequired[
        "capo_keyspaces.types.point_in_time_recovery.PointInTimeRecovery"
    ]
    """<p>Specifies the <code>pointInTimeRecovery</code> settings for the target table. The options are:</p> <ul> <li> <p> <code>status=ENABLED</code> </p> </li> <li> <p> <code>status=DISABLED</code> </p> </li> </ul> <p>If it's not specified, the default is <code>status=DISABLED</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html">Point-in-time recovery</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"""
    tags_override: NotRequired["capo_keyspaces.types.tag_list.TagList"]
    """<p>A list of key-value pair tags to be attached to the restored table. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html">Adding tags and labels to Amazon Keyspaces resources</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"""
    auto_scaling_specification: NotRequired[
        "capo_keyspaces.types.auto_scaling_specification.AutoScalingSpecification"
    ]
    """<p>The optional auto scaling settings for the restored table in provisioned capacity mode. Specifies if the service can manage throughput capacity of a provisioned table automatically on your behalf. Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>"""
    replica_specifications: NotRequired[
        "capo_keyspaces.types.replica_specification_list.ReplicaSpecificationList"
    ]
    """<p>The optional Region specific settings of a multi-Regional table.</p>"""

auto_scaling_specification instance-attribute

auto_scaling_specification: NotRequired[AutoScalingSpecification]

The optional auto scaling settings for the restored table in provisioned capacity mode. Specifies if the service can manage throughput capacity of a provisioned table automatically on your behalf. Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic.

For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.

capacity_specification_override instance-attribute

capacity_specification_override: NotRequired[CapacitySpecification]

Specifies the read/write throughput capacity mode for the target table. The options are:

  • throughputMode:PAY_PER_REQUEST

  • throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.

The default is throughput_mode:PAY_PER_REQUEST.

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.

encryption_specification_override instance-attribute

encryption_specification_override: NotRequired[EncryptionSpecification]

Specifies the encryption settings for the target table. You can choose one of the following KMS key (KMS key):

  • type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.

  • type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.

The default is type:AWS_OWNED_KMS_KEY.

For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.

point_in_time_recovery_override instance-attribute

point_in_time_recovery_override: NotRequired[PointInTimeRecovery]

Specifies the pointInTimeRecovery settings for the target table. The options are:

  • status=ENABLED

  • status=DISABLED

If it's not specified, the default is status=DISABLED.

For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.

replica_specifications instance-attribute

replica_specifications: NotRequired[ReplicaSpecificationList]

The optional Region specific settings of a multi-Regional table.

restore_timestamp instance-attribute

restore_timestamp: NotRequired[Timestamp]

The restore timestamp in ISO 8601 format.

source_keyspace_name instance-attribute

source_keyspace_name: KeyspaceName

The keyspace name of the source table.

source_table_name instance-attribute

source_table_name: TableName

The name of the source table.

tags_override instance-attribute

tags_override: NotRequired[TagList]

A list of key-value pair tags to be attached to the restored table.

For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.

target_keyspace_name instance-attribute

target_keyspace_name: KeyspaceName

The name of the target keyspace.

target_table_name instance-attribute

target_table_name: TableName

The name of the target table.