AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Invokes the RestoreFromClusterSnapshot operation against Amazon Redshift.

Syntax

Restore-RSFromClusterSnapshot
-ClusterIdentifier <String>
-SnapshotIdentifier <String>
-AdditionalInfo <String>
-AllowVersionUpgrade <Boolean>
-AutomatedSnapshotRetentionPeriod <Int32>
-AvailabilityZone <String>
-ClusterParameterGroupName <String>
-ClusterSecurityGroup <String[]>
-ClusterSubnetGroupName <String>
-ElasticIp <String>
-EnhancedVpcRouting <Boolean>
-HsmClientCertificateIdentifier <String>
-HsmConfigurationIdentifier <String>
-IamRole <String[]>
-KmsKeyId <String>
-NodeType <String>
-OwnerAccount <String>
-Port <Int32>
-PreferredMaintenanceWindow <String>
-PubliclyAccessible <Boolean>
-SnapshotClusterIdentifier <String>
-VpcSecurityGroupId <String[]>
-Force <SwitchParameter>

Description

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.

Parameters

-AdditionalInfo <String>
Reserved.
Required?False
Position?Named
Accept pipeline input?False
-AllowVersionUpgrade <Boolean>
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
Required?False
Position?Named
Accept pipeline input?False
-AutomatedSnapshotRetentionPeriod <Int32>
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.
Required?False
Position?Named
Accept pipeline input?False
-AvailabilityZone <String>
The Amazon EC2 Availability Zone in which to restore the cluster.Default: A random, system-chosen Availability Zone.Example: us-east-1a
Required?False
Position?Named
Accept pipeline input?False
-ClusterIdentifier <String>
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.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ClusterParameterGroupName <String>
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.
Required?False
Position?Named
Accept pipeline input?False
-ClusterSecurityGroup <String[]>
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.
Required?False
Position?Named
Accept pipeline input?False
-ClusterSubnetGroupName <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ElasticIp <String>
The elastic IP (EIP) address for the cluster.
Required?False
Position?Named
Accept pipeline input?False
-EnhancedVpcRouting <Boolean>
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
Required?False
Position?Named
Accept pipeline input?False
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?False
-HsmClientCertificateIdentifier <String>
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
Required?False
Position?Named
Accept pipeline input?False
-HsmConfigurationIdentifier <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IamRole <String[]>
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.
Required?False
Position?Named
Accept pipeline input?False
-KmsKeyId <String>
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.
Required?False
Position?Named
Accept pipeline input?False
-NodeType <String>
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. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide
Required?False
Position?Named
Accept pipeline input?False
-OwnerAccount <String>
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.
Required?False
Position?Named
Accept pipeline input?False
-Port <Int32>
The port number on which the cluster accepts connections.Default: The same port as the original cluster.Constraints: Must be between 1115 and 65535.
Required?False
Position?Named
Accept pipeline input?False
-PreferredMaintenanceWindow <String>
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 | SunConstraints: Minimum 30-minute window.
Required?False
Position?Named
Accept pipeline input?False
-PubliclyAccessible <Boolean>
If true, the cluster can be accessed from a public network.
Required?False
Position?Named
Accept pipeline input?False
-SnapshotClusterIdentifier <String>
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.
Required?False
Position?Named
Accept pipeline input?False
-SnapshotIdentifier <String>
The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.Example: my-snapshot-id
Required?False
Position?2
Accept pipeline input?True (ByPropertyName)
-VpcSecurityGroupId <String[]>
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.
Required?False
Position?Named
Accept pipeline input?False

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

You can pipe a String object to this cmdlet for the ClusterIdentifier parameter.

Outputs

This cmdlet returns a Cluster object. The service call response (type Amazon.Redshift.Model.RestoreFromClusterSnapshotResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z