RestoreFromClusterSnapshotRequest
Types
Properties
Reserved.
If true
, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot.
The Amazon EC2 Availability Zone in which to restore the cluster.
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.
The identifier of the cluster that will be created from restoring the snapshot.
The name of the parameter group to be associated with this cluster.
A list of security groups to be associated with this cluster.
The name of the subnet group where you want to cluster restored.
The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last modified while it was restored from a snapshot.
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
The IP address type for the cluster. Possible values are ipv4
and dualstack
.
The Key Management Service (KMS) key ID of the encryption key that encrypts data in the cluster restored from a shared snapshot. You can also provide the key ID when you restore from an unencrypted snapshot to an encrypted cluster in the same account. Additionally, you can specify a new KMS key ID when you restore from an encrypted snapshot in the same account in order to change it. In that case, the restored cluster is encrypted with the new KMS key ID.
The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the MaintenanceTrack
value from the cluster. The snapshot might be on a different track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source cluster are on different tracks.
If true
, Amazon Redshift uses Secrets Manager to manage the restored cluster's admin credentials. If ManageMasterPassword
is false or not set, Amazon Redshift uses the admin credentials the cluster had at the time the snapshot was taken.
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. You can only use this parameter if ManageMasterPassword
is true.
The number of nodes specified when provisioning the restored cluster.
The Amazon Web Services account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot.
The weekly time range (in UTC) during which automated cluster maintenance can occur.
If true
, the cluster can be accessed from a public network.
The identifier of the target reserved node offering.
The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster. You must specify this parameter or snapshotIdentifier
, but not both.
The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. You must specify this parameter or snapshotArn
, but not both.
A unique identifier for the snapshot schedule.
The identifier of the target reserved node offering.
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.