RestoreFromClusterSnapshotRequest Class

Container for the parameters to the RestoreFromClusterSnapshot operation. Creates a new cluster from a snapshot. 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 group. 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 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 Management Guide.

Declaration Syntax

public class RestoreFromClusterSnapshotRequest : AmazonWebServiceRequest

Members

Icon	Member	Description
	RestoreFromClusterSnapshotRequest()()()()	Initializes a new instance of the RestoreFromClusterSnapshotRequest class
	AllowVersionUpgrade	Gets and sets the property AllowVersionUpgrade. If CopyC# true , upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default: CopyC# true
	AutomatedSnapshotRetentionPeriod	Gets and sets the property 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.
	AvailabilityZone	Gets and sets the property AvailabilityZone. The Amazon EC2 Availability Zone in which to restore the cluster. Default: A random, system-chosen Availability Zone. Example: CopyC# us-east-1a
	ClusterIdentifier	Gets and sets the property 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.
	ClusterParameterGroupName	Gets and sets the property 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.
	ClusterSecurityGroups	Gets and sets the property ClusterSecurityGroups. 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.
	ClusterSubnetGroupName	Gets and sets the property 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.
	ElasticIp	Gets and sets the property ElasticIp. The elastic IP (EIP) address for the cluster.
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetHashCode()()()()	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType()()()()	Gets the type of the current instance. (Inherited from Object.)
	HsmClientCertificateIdentifier	Gets and sets the property HsmClientCertificateIdentifier. Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
	HsmConfigurationIdentifier	Gets and sets the property 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.
	OwnerAccount	Gets and sets the property 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.
	Port	Gets and sets the property Port. The port number on which the cluster accepts connections. Default: The same port as the original cluster. Constraints: Must be between CopyC# 1115 and CopyC# 65535 .
	PreferredMaintenanceWindow	Gets and sets the property PreferredMaintenanceWindow. The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: CopyC# ddd:hh24:mi-ddd:hh24:mi Default: The value selected for the cluster from which the snapshot was taken. The following list shows the time blocks for each region from which the default maintenance windows are assigned. US-East (Northern Virginia) Region: 03:00-11:00 UTC US-West (Oregon) Region 06:00-14:00 UTC EU (Ireland) Region 22:00-06:00 UTC Asia Pacific (Singapore) Region 14:00-22:00 UTC Asia Pacific (Sydney) Region 12:00-20:00 UTC Asia Pacific (Tokyo) Region 17:00-03:00 UTC Valid Days: Mon \| Tue \| Wed \| Thu \| Fri \| Sat \| Sun Constraints: Minimum 30-minute window.
	PubliclyAccessible	Gets and sets the property PubliclyAccessible. If CopyC# true , the cluster can be accessed from a public network.
	SnapshotClusterIdentifier	Gets and sets the property 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.
	SnapshotIdentifier	Gets and sets the property SnapshotIdentifier. The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. Example: CopyC# my-snapshot-id
	ToString()()()()	Returns a string that represents the current object. (Inherited from Object.)
	VpcSecurityGroupIds	Gets and sets the property VpcSecurityGroupIds. 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.
	WithAllowVersionUpgrade(Boolean)	Obsolete. Sets the AllowVersionUpgrade property
	WithAutomatedSnapshotRetentionPeriod(Int32)	Obsolete. Sets the AutomatedSnapshotRetentionPeriod property
	WithAvailabilityZone(String)	Obsolete. Sets the AvailabilityZone property
	WithClusterIdentifier(String)	Obsolete. Sets the ClusterIdentifier property
	WithClusterParameterGroupName(String)	Obsolete. Sets the ClusterParameterGroupName property
	WithClusterSecurityGroups(array<String>[]()[][])	Obsolete. Sets the ClusterSecurityGroups property
	WithClusterSecurityGroups(IEnumerable<(Of <<'(String>)>>))	Obsolete. Sets the ClusterSecurityGroups property
	WithClusterSubnetGroupName(String)	Obsolete. Sets the ClusterSubnetGroupName property
	WithElasticIp(String)	Obsolete. Sets the ElasticIp property
	WithHsmClientCertificateIdentifier(String)	Obsolete. Sets the HsmClientCertificateIdentifier property
	WithHsmConfigurationIdentifier(String)	Obsolete. Sets the HsmConfigurationIdentifier property
	WithOwnerAccount(String)	Obsolete. Sets the OwnerAccount property
	WithPort(Int32)	Obsolete. Sets the Port property
	WithPreferredMaintenanceWindow(String)	Obsolete. Sets the PreferredMaintenanceWindow property
	WithPubliclyAccessible(Boolean)	Obsolete. Sets the PubliclyAccessible property
	WithSnapshotClusterIdentifier(String)	Obsolete. Sets the SnapshotClusterIdentifier property
	WithSnapshotIdentifier(String)	Obsolete. Sets the SnapshotIdentifier property
	WithVpcSecurityGroupIds(array<String>[]()[][])	Obsolete. Sets the VpcSecurityGroupIds property
	WithVpcSecurityGroupIds(IEnumerable<(Of <<'(String>)>>))	Obsolete. Sets the VpcSecurityGroupIds property

Inheritance Hierarchy

Object
	AmazonWebServiceRequest
		RestoreFromClusterSnapshotRequest

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)

All Members	Constructors	Methods	Properties
Public Protected		Instance Static		Declared Inherited