Menu
Amazon Redshift
API Reference (API Version 2012-12-01)

RestoreFromClusterSnapshot

Creates a new cluster from a snapshot. By default, Amazon Redshift creates the resulting cluster with the same configuration as the original cluster from which the snapshot was created, except that the new cluster is created with the default cluster security and parameter groups. After Amazon Redshift creates the cluster, you can use the ModifyCluster API to associate a different security group and different parameter group with the restored cluster. If you are using a DS node type, you can also choose to change to another DS node type of the same size during restore.

If you restore a cluster into a VPC, you must provide a cluster subnet group where you want the cluster restored.

For more information about working with snapshots, go to Amazon Redshift Snapshots in the Amazon Redshift Cluster Management Guide.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

ClusterIdentifier

The identifier of the cluster that will be created from restoring the snapshot.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • Alphabetic characters must be lowercase.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

  • Must be unique for all clusters within an AWS account.

Type: String

Required: Yes

SnapshotIdentifier

The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.

Example: my-snapshot-id

Type: String

Required: Yes

AdditionalInfo

Reserved.

Type: String

Required: No

AllowVersionUpgrade

If true, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

Default: true

Type: Boolean

Required: No

AutomatedSnapshotRetentionPeriod

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.

Default: The value selected for the cluster from which the snapshot was taken.

Constraints: Must be a value from 0 to 35.

Type: Integer

Required: No

AvailabilityZone

The Amazon EC2 Availability Zone in which to restore the cluster.

Default: A random, system-chosen Availability Zone.

Example: us-east-1a

Type: String

Required: No

ClusterParameterGroupName

The name of the parameter group to be associated with this cluster.

Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups.

Constraints:

  • Must be 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Type: String

Required: No

ClusterSecurityGroups.ClusterSecurityGroupName.N

A list of security groups to be associated with this cluster.

Default: The default cluster security group for Amazon Redshift.

Cluster security groups only apply to clusters outside of VPCs.

Type: Array of strings

Required: No

ClusterSubnetGroupName

The name of the subnet group where you want to cluster restored.

A snapshot of cluster in VPC can be restored only in VPC. Therefore, you must provide subnet group name where you want the cluster restored.

Type: String

Required: No

ElasticIp

The elastic IP (EIP) address for the cluster.

Type: String

Required: No

EnhancedVpcRouting

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.

If this option is true, enhanced VPC routing is enabled.

Default: false

Type: Boolean

Required: No

HsmClientCertificateIdentifier

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.

Type: String

Required: No

HsmConfigurationIdentifier

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.

Type: String

Required: No

IamRoles.IamRoleArn.N

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.

A cluster can have up to 10 IAM roles associated at any time.

Type: Array of strings

Required: No

KmsKeyId

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.

Type: String

Required: No

NodeType

The node type that the restored cluster will be provisioned with.

Default: The node type of the cluster from which the snapshot was taken. You can modify this if you are using any DS node type. In that case, you can choose to restore into another DS node type of the same size. For example, you can restore ds1.8xlarge into ds2.8xlarge, or ds2.xlarge into ds1.xlarge. If you have a DC instance type, you must restore into that same instance type and size. In other words, you can only restore a dc1.large instance type into another dc1.large instance type or dc2.large instance type. You can't restore DC1.8xlarge to DC2.8xlarge. First restore to a DC1.8xlareg cluster, then resize to a DC2.8large cluster. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide.

Type: String

Required: No

OwnerAccount

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.

Type: String

Required: No

Port

The port number on which the cluster accepts connections.

Default: The same port as the original cluster.

Constraints: Must be between 1115 and 65535.

Type: Integer

Required: No

PreferredMaintenanceWindow

The weekly time range (in UTC) during which automated cluster maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi

Default: The value selected for the cluster from which the snapshot was taken. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Minimum 30-minute window.

Type: String

Required: No

PubliclyAccessible

If true, the cluster can be accessed from a public network.

Type: Boolean

Required: No

SnapshotClusterIdentifier

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.

Type: String

Required: No

VpcSecurityGroupIds.VpcSecurityGroupId.N

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Default: The default VPC security group is associated with the cluster.

VPC security groups only apply to clusters in VPCs.

Type: Array of strings

Required: No

Response Elements

The following element is returned by the service.

Cluster

Describes a cluster.

Type: Cluster object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessToSnapshotDenied

The owner of the specified snapshot has not authorized your account to access the snapshot.

HTTP Status Code: 400

ClusterAlreadyExists

The account already has a cluster with the given identifier.

HTTP Status Code: 400

ClusterParameterGroupNotFound

The parameter group name does not refer to an existing parameter group.

HTTP Status Code: 404

ClusterQuotaExceeded

The request would exceed the allowed number of cluster instances for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

HTTP Status Code: 400

ClusterSecurityGroupNotFound

The cluster security group name does not refer to an existing cluster security group.

HTTP Status Code: 404

ClusterSnapshotNotFound

The snapshot identifier does not refer to an existing cluster snapshot.

HTTP Status Code: 404

ClusterSubnetGroupNotFoundFault

The cluster subnet group name does not refer to an existing cluster subnet group.

HTTP Status Code: 400

DependentServiceRequestThrottlingFault

The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.

HTTP Status Code: 400

HsmClientCertificateNotFoundFault

There is no Amazon Redshift HSM client certificate with the specified identifier.

HTTP Status Code: 400

HsmConfigurationNotFoundFault

There is no Amazon Redshift HSM configuration with the specified identifier.

HTTP Status Code: 400

InsufficientClusterCapacity

The number of nodes specified exceeds the allotted capacity of the cluster.

HTTP Status Code: 400

InvalidClusterSnapshotState

The specified cluster snapshot is not in the available state, or other accounts are authorized to access the snapshot.

HTTP Status Code: 400

InvalidClusterSubnetGroupStateFault

The cluster subnet group cannot be deleted because it is in use.

HTTP Status Code: 400

InvalidElasticIpFault

The Elastic IP (EIP) is invalid or cannot be found.

HTTP Status Code: 400

InvalidRestore

The restore is invalid.

HTTP Status Code: 406

InvalidSubnet

The requested subnet is not valid, or not all of the subnets are in the same VPC.

HTTP Status Code: 400

InvalidVPCNetworkStateFault

The cluster subnet group does not cover all Availability Zones.

HTTP Status Code: 400

LimitExceededFault

The encryption key has exceeded its grant limit in AWS KMS.

HTTP Status Code: 400

NumberOfNodesPerClusterLimitExceeded

The operation would exceed the number of nodes allowed for a cluster.

HTTP Status Code: 400

NumberOfNodesQuotaExceeded

The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

HTTP Status Code: 400

UnauthorizedOperation

Your account is not authorized to perform the requested operation.

HTTP Status Code: 400

Example

Sample Request

https://redshift.us-east-1.amazonaws.com/
    ?Action=RestoreFromClusterSnapshot
    &ClusterIdentifier=examplecluster-restored
    &SnapshotIdentifier=cm:examplecluster-2013-01-22-19-27-58
    &Version=2012-12-01
    &x-amz-algorithm=AWS4-HMAC-SHA256
    &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request
    &x-amz-date=20130123T023350Z
    &x-amz-signedheaders=content-type;host;x-amz-date

Sample Response

<RestoreFromClusterSnapshotResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/">
  <RestoreFromClusterSnapshotResult>
    <Cluster>
      <PendingModifiedValues/>
      <ClusterVersion>1.0</ClusterVersion>
      <VpcSecurityGroups/>
      <ClusterStatus>creating</ClusterStatus>
      <NumberOfNodes>2</NumberOfNodes>
      <AutomatedSnapshotRetentionPeriod>1</AutomatedSnapshotRetentionPeriod>
      <PubliclyAccessible>true</PubliclyAccessible>
      <Encrypted>false</Encrypted>
      <EnhancedVpcRouting>false</EnhancedVpcRouting>
      <DBName>dev</DBName>
      <PreferredMaintenanceWindow>sun:06:30-sun:07:00</PreferredMaintenanceWindow>
      <ClusterParameterGroups>
        <ClusterParameterGroup>
          <ParameterApplyStatus>in-sync</ParameterApplyStatus>
          <ParameterGroupName>default.redshift-1.0</ParameterGroupName>
        </ClusterParameterGroup>
      </ClusterParameterGroups>
      <ClusterSecurityGroups>
        <ClusterSecurityGroup>
          <Status>active</Status>
          <ClusterSecurityGroupName>default</ClusterSecurityGroupName>
        </ClusterSecurityGroup>
      </ClusterSecurityGroups>
      <NodeType>ds2.xlarge</NodeType>
      <ClusterIdentifier>examplecluster-restored</ClusterIdentifier>
      <AllowVersionUpgrade>true</AllowVersionUpgrade>
      <MasterUsername>adminuser</MasterUsername>
    </Cluster>
  </RestoreFromClusterSnapshotResult>
  <ResponseMetadata>
    <RequestId>52a9aee8-6505-11e2-bec0-17624ad140dd</RequestId>
  </ResponseMetadata>
</RestoreFromClusterSnapshotResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: