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

Calls the Amazon Redshift RestoreFromClusterSnapshot API operation.

Syntax

Restore-RSFromClusterSnapshot
-ClusterIdentifier <String>
-SnapshotIdentifier <String>
-AdditionalInfo <String>
-AllowVersionUpgrade <Boolean>
-AquaConfigurationStatus <AquaConfigurationStatus>
-AutomatedSnapshotRetentionPeriod <Int32>
-AvailabilityZone <String>
-AvailabilityZoneRelocation <Boolean>
-ClusterParameterGroupName <String>
-ClusterSecurityGroup <String[]>
-ClusterSubnetGroupName <String>
-DefaultIamRoleArn <String>
-ElasticIp <String>
-Encrypted <Boolean>
-EnhancedVpcRouting <Boolean>
-HsmClientCertificateIdentifier <String>
-HsmConfigurationIdentifier <String>
-IamRole <String[]>
-IpAddressType <String>
-KmsKeyId <String>
-MaintenanceTrackName <String>
-ManageMasterPassword <Boolean>
-ManualSnapshotRetentionPeriod <Int32>
-MasterPasswordSecretKmsKeyId <String>
-MultiAZ <Boolean>
-NodeType <String>
-NumberOfNode <Int32>
-OwnerAccount <String>
-Port <Int32>
-PreferredMaintenanceWindow <String>
-PubliclyAccessible <Boolean>
-ReservedNodeId <String>
-SnapshotArn <String>
-SnapshotClusterIdentifier <String>
-SnapshotScheduleIdentifier <String>
-TargetReservedNodeOfferingId <String>
-VpcSecurityGroupId <String[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonRedshiftConfig>

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?True (ByPropertyName)
-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?True (ByPropertyName)
-AquaConfigurationStatus <AquaConfigurationStatus>
This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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. You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.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?True (ByPropertyName)
-AvailabilityZone <String>
The Amazon EC2 Availability Zone in which to restore the cluster.Default: A random, system-chosen Availability Zone.Example: us-east-2a
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AvailabilityZoneRelocation <Boolean>
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonRedshiftConfig>
Amazon.PowerShell.Cmdlets.RS.AmazonRedshiftClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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 Amazon Web Services account.
Required?True
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?True (ByPropertyName)
-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?True (ByPropertyName)
AliasesClusterSecurityGroups
-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)
-DefaultIamRoleArn <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ElasticIp <String>
The Elastic IP (EIP) address for the cluster. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Encrypted <Boolean>
Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service (KMS) and a customer managed key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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?True (ByPropertyName)
-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?True (ByPropertyName)
-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?True (ByPropertyName)
-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 Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesIamRoles
-IpAddressType <String>
The IP address type for the cluster. Possible values are ipv4 and dualstack.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KmsKeyId <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaintenanceTrackName <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManageMasterPassword <Boolean>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ManualSnapshotRetentionPeriod <Int32>
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 value must be either -1 or an integer between 1 and 3,653.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MasterPasswordSecretKmsKeyId <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MultiAZ <Boolean>
If true, the snapshot will be restored to a cluster deployed in two Availability Zones.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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 ds1.xlarge into ds2.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.8xlarge 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NumberOfNode <Int32>
The number of nodes specified when provisioning the restored cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNumberOfNodes
-OwnerAccount <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ClusterIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^ClusterIdentifier' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Port <Int32>
The port number on which the cluster accepts connections.Default: The same port as the original cluster.Valid values: For clusters with ds2 or dc2 nodes, must be within the range 1150-65535. For clusters with ra3 nodes, must be within the ranges 5431-5455 or 8191-8215.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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?True (ByPropertyName)
-PubliclyAccessible <Boolean>
If true, the cluster can be accessed from a public network.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ReservedNodeId <String>
The identifier of the target reserved node offering.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Cluster'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Redshift.Model.RestoreFromClusterSnapshotResponse). Specifying the name of a property of type Amazon.Redshift.Model.RestoreFromClusterSnapshotResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SnapshotArn <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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?True (ByPropertyName)
-SnapshotIdentifier <String>
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.Example: my-snapshot-id
Required?False
Position?2
Accept pipeline input?True (ByPropertyName)
-SnapshotScheduleIdentifier <String>
A unique identifier for the snapshot schedule.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TargetReservedNodeOfferingId <String>
The identifier of the target reserved node offering.
Required?False
Position?Named
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?True (ByPropertyName)
AliasesVpcSecurityGroupIds

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?True (ByPropertyName)
AliasesAK
-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?True (ByValue, ByPropertyName)
-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?True (ByPropertyName)
-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?True (ByValue, ByPropertyName)
-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.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?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-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?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-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?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.Redshift.Model.Cluster or Amazon.Redshift.Model.RestoreFromClusterSnapshotResponse
This cmdlet returns an Amazon.Redshift.Model.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.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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