Restore From Cluster Snapshot
GET {{aws_redshift_base_url}}/?ClusterIdentifier&SnapshotIdentifier&AdditionalInfo&AllowVersionUpgrade&AutomatedSnapshotRetentionPeriod&AvailabilityZone&ClusterParameterGroupName&ClusterSecurityGroups.ClusterSecurityGroupName.N&ClusterSubnetGroupName&ElasticIp&EnhancedVpcRouting&HsmClientCertificateIdentifier&HsmConfigurationIdentifier&IamRoles.IamRoleArn.N&KmsKeyId&MaintenanceTrackName&ManualSnapshotRetentionPeriod&NodeType&NumberOfNodes&OwnerAccount&Port&PreferredMaintenanceWindow&PubliclyAccessible&SnapshotClusterIdentifier&SnapshotScheduleIdentifier&VpcSecurityGroupIds.VpcSecurityGroupId.N
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
ClusterIdentifier | null | The identifier of the cluster that will be created from restoring the snapshot. | |
SnapshotIdentifier | null | The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. | |
AdditionalInfo | null | Reserved. | |
AllowVersionUpgrade | null | If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. | |
AutomatedSnapshotRetentionPeriod | null | 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. | |
AvailabilityZone | null | The Amazon EC2 Availability Zone in which to restore the cluster. | |
ClusterParameterGroupName | null | The name of the parameter group to be associated with this cluster. | |
ClusterSecurityGroups.ClusterSecurityGroupName.N | null | A list of security groups to be associated with this cluster. | |
ClusterSubnetGroupName | null | The name of the subnet group where you want to cluster restored. | |
ElasticIp | null | The elastic IP (EIP) address for the cluster. | |
EnhancedVpcRouting | null | 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. | |
HsmClientCertificateIdentifier | null | Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM. | |
HsmConfigurationIdentifier | null | 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. | |
IamRoles.IamRoleArn.N | null | A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 10 IAM roles in a single request. | |
KmsKeyId | null | The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster that you restore from a shared snapshot. | |
MaintenanceTrackName | null | 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. | |
ManualSnapshotRetentionPeriod | null | 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. | |
NodeType | null | The node type that the restored cluster will be provisioned with. | |
NumberOfNodes | null | The number of nodes specified when provisioning the restored cluster. | |
OwnerAccount | null | The AWS customer 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. | |
Port | null | The port number on which the cluster accepts connections. | |
PreferredMaintenanceWindow | null | The weekly time range (in UTC) during which automated cluster maintenance can occur. | |
PubliclyAccessible | null | If true, the cluster can be accessed from a public network. | |
SnapshotClusterIdentifier | null | 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. | |
SnapshotScheduleIdentifier | null | A unique identifier for the snapshot schedule. | |
VpcSecurityGroupIds.VpcSecurityGroupId.N | null | A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. |