AWS SDK Version 2 for .NET
API 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.

.NET Framework 4.5
 
Container for the parameters to the RestoreFromClusterSnapshot operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Redshift.AmazonRedshiftRequest
      Amazon.Redshift.Model.RestoreFromClusterSnapshotRequest

Namespace: Amazon.Redshift.Model
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public class RestoreFromClusterSnapshotRequest : AmazonRedshiftRequest
         IRequestEvents

The RestoreFromClusterSnapshotRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property AllowVersionUpgrade System.Boolean Gets and sets the property 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

Public Property AutomatedSnapshotRetentionPeriod System.Int32 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.

Public Property AvailabilityZone System.String 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: us-east-1a

Public Property ClusterIdentifier System.String 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.

Public Property ClusterParameterGroupName System.String 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.
Public Property ClusterSecurityGroups System.Collections.Generic.List<System.String> 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.

Public Property ClusterSubnetGroupName System.String 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.

Public Property ElasticIp System.String Gets and sets the property ElasticIp.

The elastic IP (EIP) address for the cluster.

Public Property HsmClientCertificateIdentifier System.String 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.

Public Property HsmConfigurationIdentifier System.String 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.

Public Property KmsKeyId System.String Gets and sets the property 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.

Public Property NodeType System.String Gets and sets the property 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. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide

Public Property OwnerAccount System.String 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.

Public Property Port System.Int32 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 1115 and 65535.

Public Property PreferredMaintenanceWindow System.String Gets and sets the property 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.

Public Property PubliclyAccessible System.Boolean Gets and sets the property PubliclyAccessible.

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

Public Property SnapshotClusterIdentifier System.String 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.

Public Property SnapshotIdentifier System.String 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: my-snapshot-id

Public Property VpcSecurityGroupIds System.Collections.Generic.List<System.String> 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.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8