Skip to content

RestoreFromSnapshotRequest

Source code in docs_src/capo_redshift_serverless/types/restore_from_snapshot_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class RestoreFromSnapshotRequest(TypedDict, closed=True):
    namespace_name: "capo_redshift_serverless.types.namespace_name.NamespaceName"
    """<p>The name of the namespace to restore the snapshot to.</p>"""
    workgroup_name: "capo_redshift_serverless.types.workgroup_name.WorkgroupName"
    """<p>The name of the workgroup used to restore the snapshot.</p>"""
    snapshot_name: NotRequired["str"]
    """<p>The name of the snapshot to restore from. Must not be specified at the same time as <code>snapshotArn</code>.</p>"""
    snapshot_arn: NotRequired["str"]
    """<p>The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from a provisioned cluster to Amazon Redshift Serverless. Must not be specified at the same time as <code>snapshotName</code>.</p> <p>The format of the ARN is arn:aws:redshift:&lt;region&gt;:&lt;account_id&gt;:snapshot:&lt;cluster_identifier&gt;/&lt;snapshot_identifier&gt;.</p>"""
    owner_account: NotRequired["str"]
    """<p>The Amazon Web Services account that owns the snapshot.</p>"""
    manage_admin_password: NotRequired["bool"]
    """<p>If <code>true</code>, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials. If <code>MmanageAdminPassword</code> is false or not set, Amazon Redshift uses the admin credentials that the namespace or cluster had at the time the snapshot was taken.</p>"""
    admin_password_secret_kms_key_id: NotRequired[
        "capo_redshift_serverless.types.kms_key_id.KmsKeyId"
    ]
    """<p>The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.</p>"""
    maintain_integration: NotRequired["bool"]
    """<p>If <code>true</code>, maintain existing data sharing, zero-ETL and S3 event integrations when restoring. Otherwise, integrations will not be maintained after the restore operation. Integrations are only maintained when restored to the same serverless namespace.</p> <p>Default: true</p>"""

admin_password_secret_kms_key_id instance-attribute 

admin_password_secret_kms_key_id: NotRequired[KmsKeyId]

The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.

maintain_integration instance-attribute 

maintain_integration: NotRequired[bool]

If true, maintain existing data sharing, zero-ETL and S3 event integrations when restoring. Otherwise, integrations will not be maintained after the restore operation. Integrations are only maintained when restored to the same serverless namespace.

Default: true

manage_admin_password instance-attribute 

manage_admin_password: NotRequired[bool]

If true, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials. If MmanageAdminPassword is false or not set, Amazon Redshift uses the admin credentials that the namespace or cluster had at the time the snapshot was taken.

namespace_name instance-attribute 

namespace_name: NamespaceName

The name of the namespace to restore the snapshot to.

owner_account instance-attribute 

owner_account: NotRequired[str]

The Amazon Web Services account that owns the snapshot.

snapshot_arn instance-attribute 

snapshot_arn: NotRequired[str]

The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from a provisioned cluster to Amazon Redshift Serverless. Must not be specified at the same time as snapshotName.

The format of the ARN is arn:aws:redshift:<region>:<account_id>:snapshot:<cluster_identifier>/<snapshot_identifier>.

snapshot_name instance-attribute 

snapshot_name: NotRequired[str]

The name of the snapshot to restore from. Must not be specified at the same time as snapshotArn.

workgroup_name instance-attribute 

workgroup_name: WorkgroupName

The name of the workgroup used to restore the snapshot.