RestoreFromClusterSnapshotRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.redshift.model.RestoreFromClusterSnapshotRequest

All Implemented Interfaces:

Serializable
```
public class RestoreFromClusterSnapshotRequest
extends AmazonWebServiceRequest
implements Serializable
```
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 a snapshot is taken of a cluster in VPC, you can restore it only in VPC. In this case, you must provide a cluster subnet group where you want the cluster restored. If snapshot is taken of a cluster outside VPC, then you can restore it only outside VPC.

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

See Also:
AmazonRedshift.restoreFromClusterSnapshot(RestoreFromClusterSnapshotRequest), Serialized Form

Constructor Summary

Constructors
Constructor and Description

RestoreFromClusterSnapshotRequest()

Constructors
Constructor and Description
`RestoreFromClusterSnapshotRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Boolean`	`getAllowVersionUpgrade()` If `true`, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
`String`	`getAvailabilityZone()` The Amazon EC2 Availability Zone in which to restore the cluster.
`String`	`getClusterIdentifier()` The identifier of the cluster that will be created from restoring the snapshot.
`String`	`getClusterSubnetGroupName()` The name of the subnet group where you want to cluster restored.
`String`	`getOwnerAccount()` The AWS customer account used to create or copy the snapshot.
`Integer`	`getPort()` The port number on which the cluster accepts connections.
`Boolean`	`getPubliclyAccessible()` If `true`, the cluster can be accessed from a public network.
`String`	`getSnapshotClusterIdentifier()` The name of the cluster the source snapshot was created from.
`String`	`getSnapshotIdentifier()` The name of the snapshot from which to create the new cluster.
`int`	`hashCode()`
`Boolean`	`isAllowVersionUpgrade()` If `true`, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
`Boolean`	`isPubliclyAccessible()` If `true`, the cluster can be accessed from a public network.
`void`	`setAllowVersionUpgrade(Boolean allowVersionUpgrade)` If `true`, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
`void`	`setAvailabilityZone(String availabilityZone)` The Amazon EC2 Availability Zone in which to restore the cluster.
`void`	`setClusterIdentifier(String clusterIdentifier)` The identifier of the cluster that will be created from restoring the snapshot.
`void`	`setClusterSubnetGroupName(String clusterSubnetGroupName)` The name of the subnet group where you want to cluster restored.
`void`	`setOwnerAccount(String ownerAccount)` The AWS customer account used to create or copy the snapshot.
`void`	`setPort(Integer port)` The port number on which the cluster accepts connections.
`void`	`setPubliclyAccessible(Boolean publiclyAccessible)` If `true`, the cluster can be accessed from a public network.
`void`	`setSnapshotClusterIdentifier(String snapshotClusterIdentifier)` The name of the cluster the source snapshot was created from.
`void`	`setSnapshotIdentifier(String snapshotIdentifier)` The name of the snapshot from which to create the new cluster.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`RestoreFromClusterSnapshotRequest`	`withAllowVersionUpgrade(Boolean allowVersionUpgrade)` If `true`, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
`RestoreFromClusterSnapshotRequest`	`withAvailabilityZone(String availabilityZone)` The Amazon EC2 Availability Zone in which to restore the cluster.
`RestoreFromClusterSnapshotRequest`	`withClusterIdentifier(String clusterIdentifier)` The identifier of the cluster that will be created from restoring the snapshot.
`RestoreFromClusterSnapshotRequest`	`withClusterSubnetGroupName(String clusterSubnetGroupName)` The name of the subnet group where you want to cluster restored.
`RestoreFromClusterSnapshotRequest`	`withOwnerAccount(String ownerAccount)` The AWS customer account used to create or copy the snapshot.
`RestoreFromClusterSnapshotRequest`	`withPort(Integer port)` The port number on which the cluster accepts connections.
`RestoreFromClusterSnapshotRequest`	`withPubliclyAccessible(Boolean publiclyAccessible)` If `true`, the cluster can be accessed from a public network.
`RestoreFromClusterSnapshotRequest`	`withSnapshotClusterIdentifier(String snapshotClusterIdentifier)` The name of the cluster the source snapshot was created from.
`RestoreFromClusterSnapshotRequest`	`withSnapshotIdentifier(String snapshotIdentifier)` The name of the snapshot from which to create the new cluster.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RestoreFromClusterSnapshotRequest
```
public RestoreFromClusterSnapshotRequest()
```
- Method Detail
  - getClusterIdentifier
```
public String getClusterIdentifier()
```
    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.
    Returns:
    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.
  - setClusterIdentifier
```
public void setClusterIdentifier(String 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.
    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.
  - withClusterIdentifier
```
public RestoreFromClusterSnapshotRequest withClusterIdentifier(String 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.
    Returns a reference to this object so that method calls can be chained together.
    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.
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSnapshotIdentifier
```
public String getSnapshotIdentifier()
```
    The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
    Example: my-snapshot-id
    
    Returns:
    The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
    Example: my-snapshot-id
  - setSnapshotIdentifier
```
public void setSnapshotIdentifier(String snapshotIdentifier)
```
    The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
    Example: my-snapshot-id
    
    Parameters:
    snapshotIdentifier - The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
    Example: my-snapshot-id
  - withSnapshotIdentifier
```
public RestoreFromClusterSnapshotRequest withSnapshotIdentifier(String snapshotIdentifier)
```
    The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
    Example: my-snapshot-id
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    snapshotIdentifier - The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
    Example: my-snapshot-id
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSnapshotClusterIdentifier
```
public String getSnapshotClusterIdentifier()
```
    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.
    
    Returns:
    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.
  - setSnapshotClusterIdentifier
```
public void setSnapshotClusterIdentifier(String 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.
    
    Parameters:
    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.
  - withSnapshotClusterIdentifier
```
public RestoreFromClusterSnapshotRequest withSnapshotClusterIdentifier(String 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.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    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.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getPort
```
public Integer getPort()
```
    The port number on which the cluster accepts connections.
    Default: The same port as the original cluster.
    Constraints: Must be between 1115 and 65535.
    
    Returns:
    The port number on which the cluster accepts connections.
    Default: The same port as the original cluster.
    Constraints: Must be between 1115 and 65535.
  - setPort
```
public void setPort(Integer 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.
    
    Parameters:
    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.
  - withPort
```
public RestoreFromClusterSnapshotRequest withPort(Integer 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.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    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.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getAvailabilityZone
```
public String getAvailabilityZone()
```
    The Amazon EC2 Availability Zone in which to restore the cluster.
    Default: A random, system-chosen Availability Zone.
    Example: us-east-1a
    
    Returns:
    The Amazon EC2 Availability Zone in which to restore the cluster.
    Default: A random, system-chosen Availability Zone.
    Example: us-east-1a
  - setAvailabilityZone
```
public void setAvailabilityZone(String availabilityZone)
```
    The Amazon EC2 Availability Zone in which to restore the cluster.
    Default: A random, system-chosen Availability Zone.
    Example: us-east-1a
    
    Parameters:
    availabilityZone - The Amazon EC2 Availability Zone in which to restore the cluster.
    Default: A random, system-chosen Availability Zone.
    Example: us-east-1a
  - withAvailabilityZone
```
public RestoreFromClusterSnapshotRequest withAvailabilityZone(String availabilityZone)
```
    The Amazon EC2 Availability Zone in which to restore the cluster.
    Default: A random, system-chosen Availability Zone.
    Example: us-east-1a
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    availabilityZone - The Amazon EC2 Availability Zone in which to restore the cluster.
    Default: A random, system-chosen Availability Zone.
    Example: us-east-1a
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - isAllowVersionUpgrade
```
public Boolean isAllowVersionUpgrade()
```
    If true, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
    Default: true
    
    Returns:
    If true, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
    Default: true
  - setAllowVersionUpgrade
```
public void setAllowVersionUpgrade(Boolean allowVersionUpgrade)
```
    If true, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
    Default: true
    
    Parameters:
    allowVersionUpgrade - If true, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
    Default: true
  - withAllowVersionUpgrade
```
public RestoreFromClusterSnapshotRequest withAllowVersionUpgrade(Boolean allowVersionUpgrade)
```
    If true, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
    Default: true
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    allowVersionUpgrade - If true, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
    Default: true
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getAllowVersionUpgrade
```
public Boolean getAllowVersionUpgrade()
```
    If true, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
    Default: true
    
    Returns:
    If true, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
    Default: true
  - getClusterSubnetGroupName
```
public String getClusterSubnetGroupName()
```
    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.
    
    Returns:
    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.
  - setClusterSubnetGroupName
```
public void setClusterSubnetGroupName(String 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.
    
    Parameters:
    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.
  - withClusterSubnetGroupName
```
public RestoreFromClusterSnapshotRequest withClusterSubnetGroupName(String 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.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    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.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - isPubliclyAccessible
```
public Boolean isPubliclyAccessible()
```
    If true, the cluster can be accessed from a public network.
    
    Returns:
    If true, the cluster can be accessed from a public network.
  - setPubliclyAccessible
```
public void setPubliclyAccessible(Boolean publiclyAccessible)
```
    If true, the cluster can be accessed from a public network.
    
    Parameters:
    publiclyAccessible - If true, the cluster can be accessed from a public network.
  - withPubliclyAccessible
```
public RestoreFromClusterSnapshotRequest withPubliclyAccessible(Boolean publiclyAccessible)
```
    If true, the cluster can be accessed from a public network.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    publiclyAccessible - If true, the cluster can be accessed from a public network.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getPubliclyAccessible
```
public Boolean getPubliclyAccessible()
```
    If true, the cluster can be accessed from a public network.
    
    Returns:
    If true, the cluster can be accessed from a public network.
  - getOwnerAccount
```
public String getOwnerAccount()
```
    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.
    
    Returns:
    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.
  - setOwnerAccount
```
public void setOwnerAccount(String 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.
    
    Parameters:
    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.
  - withOwnerAccount
```
public RestoreFromClusterSnapshotRequest withOwnerAccount(String 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.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    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.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Did this page help you?

Class RestoreFromClusterSnapshotRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

RestoreFromClusterSnapshotRequest

Method Detail

getClusterIdentifier

setClusterIdentifier

withClusterIdentifier

getSnapshotIdentifier

setSnapshotIdentifier

withSnapshotIdentifier

getSnapshotClusterIdentifier

setSnapshotClusterIdentifier

withSnapshotClusterIdentifier

getPort

setPort

withPort

getAvailabilityZone

setAvailabilityZone

withAvailabilityZone

isAllowVersionUpgrade

setAllowVersionUpgrade

withAllowVersionUpgrade

getAllowVersionUpgrade

getClusterSubnetGroupName

setClusterSubnetGroupName

withClusterSubnetGroupName

isPubliclyAccessible

setPubliclyAccessible

withPubliclyAccessible

getPubliclyAccessible

getOwnerAccount

setOwnerAccount

withOwnerAccount

toString

hashCode

equals