public class RestoreFromClusterSnapshotRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
additionalInfo
Reserved.
|
private java.lang.Boolean |
allowVersionUpgrade
If
true , major version upgrades can be applied during the
maintenance window to the Amazon Redshift engine that is running on the
cluster. |
private java.lang.Integer |
automatedSnapshotRetentionPeriod
The number of days that automated snapshots are retained.
|
private java.lang.String |
availabilityZone
The Amazon EC2 Availability Zone in which to restore the cluster.
|
private java.lang.String |
clusterIdentifier
The identifier of the cluster that will be created from restoring the
snapshot.
|
private java.lang.String |
clusterParameterGroupName
The name of the parameter group to be associated with this cluster.
|
private SdkInternalList<java.lang.String> |
clusterSecurityGroups
A list of security groups to be associated with this cluster.
|
private java.lang.String |
clusterSubnetGroupName
The name of the subnet group where you want to cluster restored.
|
private java.lang.String |
elasticIp
The elastic IP (EIP) address for the cluster.
|
private java.lang.String |
hsmClientCertificateIdentifier
Specifies the name of the HSM client certificate the Amazon Redshift
cluster uses to retrieve the data encryption keys stored in an HSM.
|
private java.lang.String |
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.
|
private SdkInternalList<java.lang.String> |
iamRoles
A list of AWS Identity and Access Management (IAM) roles that can be used
by the cluster to access other AWS services.
|
private java.lang.String |
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.
|
private java.lang.String |
nodeType
The node type that the restored cluster will be provisioned with.
|
private java.lang.String |
ownerAccount
The AWS customer account used to create or copy the snapshot.
|
private java.lang.Integer |
port
The port number on which the cluster accepts connections.
|
private java.lang.String |
preferredMaintenanceWindow
The weekly time range (in UTC) during which automated cluster maintenance
can occur.
|
private java.lang.Boolean |
publiclyAccessible
If
true , the cluster can be accessed from a public network. |
private java.lang.String |
snapshotClusterIdentifier
The name of the cluster the source snapshot was created from.
|
private java.lang.String |
snapshotIdentifier
The name of the snapshot from which to create the new cluster.
|
private SdkInternalList<java.lang.String> |
vpcSecurityGroupIds
A list of Virtual Private Cloud (VPC) security groups to be associated
with the cluster.
|
NOOP
Constructor and Description |
---|
RestoreFromClusterSnapshotRequest() |
Modifier and Type | Method and Description |
---|---|
RestoreFromClusterSnapshotRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getAdditionalInfo()
Reserved.
|
java.lang.Boolean |
getAllowVersionUpgrade()
If
true , major version upgrades can be applied during the
maintenance window to the Amazon Redshift engine that is running on the
cluster. |
java.lang.Integer |
getAutomatedSnapshotRetentionPeriod()
The number of days that automated snapshots are retained.
|
java.lang.String |
getAvailabilityZone()
The Amazon EC2 Availability Zone in which to restore the cluster.
|
java.lang.String |
getClusterIdentifier()
The identifier of the cluster that will be created from restoring the
snapshot.
|
java.lang.String |
getClusterParameterGroupName()
The name of the parameter group to be associated with this cluster.
|
java.util.List<java.lang.String> |
getClusterSecurityGroups()
A list of security groups to be associated with this cluster.
|
java.lang.String |
getClusterSubnetGroupName()
The name of the subnet group where you want to cluster restored.
|
java.lang.String |
getElasticIp()
The elastic IP (EIP) address for the cluster.
|
java.lang.String |
getHsmClientCertificateIdentifier()
Specifies the name of the HSM client certificate the Amazon Redshift
cluster uses to retrieve the data encryption keys stored in an HSM.
|
java.lang.String |
getHsmConfigurationIdentifier()
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.
|
java.util.List<java.lang.String> |
getIamRoles()
A list of AWS Identity and Access Management (IAM) roles that can be used
by the cluster to access other AWS services.
|
java.lang.String |
getKmsKeyId()
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.
|
java.lang.String |
getNodeType()
The node type that the restored cluster will be provisioned with.
|
java.lang.String |
getOwnerAccount()
The AWS customer account used to create or copy the snapshot.
|
java.lang.Integer |
getPort()
The port number on which the cluster accepts connections.
|
java.lang.String |
getPreferredMaintenanceWindow()
The weekly time range (in UTC) during which automated cluster maintenance
can occur.
|
java.lang.Boolean |
getPubliclyAccessible()
If
true , the cluster can be accessed from a public network. |
java.lang.String |
getSnapshotClusterIdentifier()
The name of the cluster the source snapshot was created from.
|
java.lang.String |
getSnapshotIdentifier()
The name of the snapshot from which to create the new cluster.
|
java.util.List<java.lang.String> |
getVpcSecurityGroupIds()
A list of Virtual Private Cloud (VPC) security groups to be associated
with the cluster.
|
int |
hashCode() |
java.lang.Boolean |
isAllowVersionUpgrade()
If
true , major version upgrades can be applied during the
maintenance window to the Amazon Redshift engine that is running on the
cluster. |
java.lang.Boolean |
isPubliclyAccessible()
If
true , the cluster can be accessed from a public network. |
void |
setAdditionalInfo(java.lang.String additionalInfo)
Reserved.
|
void |
setAllowVersionUpgrade(java.lang.Boolean allowVersionUpgrade)
If
true , major version upgrades can be applied during the
maintenance window to the Amazon Redshift engine that is running on the
cluster. |
void |
setAutomatedSnapshotRetentionPeriod(java.lang.Integer automatedSnapshotRetentionPeriod)
The number of days that automated snapshots are retained.
|
void |
setAvailabilityZone(java.lang.String availabilityZone)
The Amazon EC2 Availability Zone in which to restore the cluster.
|
void |
setClusterIdentifier(java.lang.String clusterIdentifier)
The identifier of the cluster that will be created from restoring the
snapshot.
|
void |
setClusterParameterGroupName(java.lang.String clusterParameterGroupName)
The name of the parameter group to be associated with this cluster.
|
void |
setClusterSecurityGroups(java.util.Collection<java.lang.String> clusterSecurityGroups)
A list of security groups to be associated with this cluster.
|
void |
setClusterSubnetGroupName(java.lang.String clusterSubnetGroupName)
The name of the subnet group where you want to cluster restored.
|
void |
setElasticIp(java.lang.String elasticIp)
The elastic IP (EIP) address for the cluster.
|
void |
setHsmClientCertificateIdentifier(java.lang.String hsmClientCertificateIdentifier)
Specifies the name of the HSM client certificate the Amazon Redshift
cluster uses to retrieve the data encryption keys stored in an HSM.
|
void |
setHsmConfigurationIdentifier(java.lang.String 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.
|
void |
setIamRoles(java.util.Collection<java.lang.String> iamRoles)
A list of AWS Identity and Access Management (IAM) roles that can be used
by the cluster to access other AWS services.
|
void |
setKmsKeyId(java.lang.String 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.
|
void |
setNodeType(java.lang.String nodeType)
The node type that the restored cluster will be provisioned with.
|
void |
setOwnerAccount(java.lang.String ownerAccount)
The AWS customer account used to create or copy the snapshot.
|
void |
setPort(java.lang.Integer port)
The port number on which the cluster accepts connections.
|
void |
setPreferredMaintenanceWindow(java.lang.String preferredMaintenanceWindow)
The weekly time range (in UTC) during which automated cluster maintenance
can occur.
|
void |
setPubliclyAccessible(java.lang.Boolean publiclyAccessible)
If
true , the cluster can be accessed from a public network. |
void |
setSnapshotClusterIdentifier(java.lang.String snapshotClusterIdentifier)
The name of the cluster the source snapshot was created from.
|
void |
setSnapshotIdentifier(java.lang.String snapshotIdentifier)
The name of the snapshot from which to create the new cluster.
|
void |
setVpcSecurityGroupIds(java.util.Collection<java.lang.String> vpcSecurityGroupIds)
A list of Virtual Private Cloud (VPC) security groups to be associated
with the cluster.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
RestoreFromClusterSnapshotRequest |
withAdditionalInfo(java.lang.String additionalInfo)
Reserved.
|
RestoreFromClusterSnapshotRequest |
withAllowVersionUpgrade(java.lang.Boolean allowVersionUpgrade)
If
true , major version upgrades can be applied during the
maintenance window to the Amazon Redshift engine that is running on the
cluster. |
RestoreFromClusterSnapshotRequest |
withAutomatedSnapshotRetentionPeriod(java.lang.Integer automatedSnapshotRetentionPeriod)
The number of days that automated snapshots are retained.
|
RestoreFromClusterSnapshotRequest |
withAvailabilityZone(java.lang.String availabilityZone)
The Amazon EC2 Availability Zone in which to restore the cluster.
|
RestoreFromClusterSnapshotRequest |
withClusterIdentifier(java.lang.String clusterIdentifier)
The identifier of the cluster that will be created from restoring the
snapshot.
|
RestoreFromClusterSnapshotRequest |
withClusterParameterGroupName(java.lang.String clusterParameterGroupName)
The name of the parameter group to be associated with this cluster.
|
RestoreFromClusterSnapshotRequest |
withClusterSecurityGroups(java.util.Collection<java.lang.String> clusterSecurityGroups)
A list of security groups to be associated with this cluster.
|
RestoreFromClusterSnapshotRequest |
withClusterSecurityGroups(java.lang.String... clusterSecurityGroups)
A list of security groups to be associated with this cluster.
|
RestoreFromClusterSnapshotRequest |
withClusterSubnetGroupName(java.lang.String clusterSubnetGroupName)
The name of the subnet group where you want to cluster restored.
|
RestoreFromClusterSnapshotRequest |
withElasticIp(java.lang.String elasticIp)
The elastic IP (EIP) address for the cluster.
|
RestoreFromClusterSnapshotRequest |
withHsmClientCertificateIdentifier(java.lang.String hsmClientCertificateIdentifier)
Specifies the name of the HSM client certificate the Amazon Redshift
cluster uses to retrieve the data encryption keys stored in an HSM.
|
RestoreFromClusterSnapshotRequest |
withHsmConfigurationIdentifier(java.lang.String 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.
|
RestoreFromClusterSnapshotRequest |
withIamRoles(java.util.Collection<java.lang.String> iamRoles)
A list of AWS Identity and Access Management (IAM) roles that can be used
by the cluster to access other AWS services.
|
RestoreFromClusterSnapshotRequest |
withIamRoles(java.lang.String... iamRoles)
A list of AWS Identity and Access Management (IAM) roles that can be used
by the cluster to access other AWS services.
|
RestoreFromClusterSnapshotRequest |
withKmsKeyId(java.lang.String 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.
|
RestoreFromClusterSnapshotRequest |
withNodeType(java.lang.String nodeType)
The node type that the restored cluster will be provisioned with.
|
RestoreFromClusterSnapshotRequest |
withOwnerAccount(java.lang.String ownerAccount)
The AWS customer account used to create or copy the snapshot.
|
RestoreFromClusterSnapshotRequest |
withPort(java.lang.Integer port)
The port number on which the cluster accepts connections.
|
RestoreFromClusterSnapshotRequest |
withPreferredMaintenanceWindow(java.lang.String preferredMaintenanceWindow)
The weekly time range (in UTC) during which automated cluster maintenance
can occur.
|
RestoreFromClusterSnapshotRequest |
withPubliclyAccessible(java.lang.Boolean publiclyAccessible)
If
true , the cluster can be accessed from a public network. |
RestoreFromClusterSnapshotRequest |
withSnapshotClusterIdentifier(java.lang.String snapshotClusterIdentifier)
The name of the cluster the source snapshot was created from.
|
RestoreFromClusterSnapshotRequest |
withSnapshotIdentifier(java.lang.String snapshotIdentifier)
The name of the snapshot from which to create the new cluster.
|
RestoreFromClusterSnapshotRequest |
withVpcSecurityGroupIds(java.util.Collection<java.lang.String> vpcSecurityGroupIds)
A list of Virtual Private Cloud (VPC) security groups to be associated
with the cluster.
|
RestoreFromClusterSnapshotRequest |
withVpcSecurityGroupIds(java.lang.String... vpcSecurityGroupIds)
A list of Virtual Private Cloud (VPC) security groups to be associated
with the cluster.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
private java.lang.String clusterIdentifier
The identifier of the cluster that will be created from restoring the snapshot.
Constraints:
private java.lang.String snapshotIdentifier
The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
Example: my-snapshot-id
private java.lang.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.
private java.lang.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
.
private java.lang.String availabilityZone
The Amazon EC2 Availability Zone in which to restore the cluster.
Default: A random, system-chosen Availability Zone.
Example: us-east-1a
private java.lang.Boolean 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
private java.lang.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.
private java.lang.Boolean publiclyAccessible
If true
, the cluster can be accessed from a public network.
private java.lang.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.
private java.lang.String hsmClientCertificateIdentifier
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
private java.lang.String 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.
private java.lang.String elasticIp
The elastic IP (EIP) address for the cluster.
private java.lang.String 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:
private SdkInternalList<java.lang.String> 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.
private SdkInternalList<java.lang.String> 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.
private java.lang.String 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.
private java.lang.Integer 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.
private java.lang.String 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.
private java.lang.String 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
private java.lang.String additionalInfo
Reserved.
private SdkInternalList<java.lang.String> iamRoles
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.
public void setClusterIdentifier(java.lang.String clusterIdentifier)
The identifier of the cluster that will be created from restoring the snapshot.
Constraints:
clusterIdentifier
- The identifier of the cluster that will be created from restoring
the snapshot.
Constraints:
public java.lang.String getClusterIdentifier()
The identifier of the cluster that will be created from restoring the snapshot.
Constraints:
Constraints:
public RestoreFromClusterSnapshotRequest withClusterIdentifier(java.lang.String clusterIdentifier)
The identifier of the cluster that will be created from restoring the snapshot.
Constraints:
clusterIdentifier
- The identifier of the cluster that will be created from restoring
the snapshot.
Constraints:
public void setSnapshotIdentifier(java.lang.String snapshotIdentifier)
The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
Example: my-snapshot-id
snapshotIdentifier
- The name of the snapshot from which to create the new cluster.
This parameter isn't case sensitive.
Example: my-snapshot-id
public java.lang.String getSnapshotIdentifier()
The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
Example: my-snapshot-id
Example: my-snapshot-id
public RestoreFromClusterSnapshotRequest withSnapshotIdentifier(java.lang.String snapshotIdentifier)
The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive.
Example: my-snapshot-id
snapshotIdentifier
- The name of the snapshot from which to create the new cluster.
This parameter isn't case sensitive.
Example: my-snapshot-id
public void setSnapshotClusterIdentifier(java.lang.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.
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 java.lang.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.
public RestoreFromClusterSnapshotRequest withSnapshotClusterIdentifier(java.lang.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.
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 void setPort(java.lang.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
.
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 java.lang.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
.
Default: The same port as the original cluster.
Constraints: Must be between 1115
and
65535
.
public RestoreFromClusterSnapshotRequest withPort(java.lang.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
.
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 void setAvailabilityZone(java.lang.String availabilityZone)
The Amazon EC2 Availability Zone in which to restore the cluster.
Default: A random, system-chosen Availability Zone.
Example: us-east-1a
availabilityZone
- The Amazon EC2 Availability Zone in which to restore the cluster.
Default: A random, system-chosen Availability Zone.
Example: us-east-1a
public java.lang.String getAvailabilityZone()
The Amazon EC2 Availability Zone in which to restore the cluster.
Default: A random, system-chosen Availability Zone.
Example: us-east-1a
Default: A random, system-chosen Availability Zone.
Example: us-east-1a
public RestoreFromClusterSnapshotRequest withAvailabilityZone(java.lang.String availabilityZone)
The Amazon EC2 Availability Zone in which to restore the cluster.
Default: A random, system-chosen Availability Zone.
Example: us-east-1a
availabilityZone
- The Amazon EC2 Availability Zone in which to restore the cluster.
Default: A random, system-chosen Availability Zone.
Example: us-east-1a
public void setAllowVersionUpgrade(java.lang.Boolean 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
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 java.lang.Boolean getAllowVersionUpgrade()
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
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 RestoreFromClusterSnapshotRequest withAllowVersionUpgrade(java.lang.Boolean 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
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 java.lang.Boolean isAllowVersionUpgrade()
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
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 void setClusterSubnetGroupName(java.lang.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.
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 java.lang.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.
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 RestoreFromClusterSnapshotRequest withClusterSubnetGroupName(java.lang.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.
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 void setPubliclyAccessible(java.lang.Boolean publiclyAccessible)
If true
, the cluster can be accessed from a public network.
publiclyAccessible
- If true
, the cluster can be accessed from a public
network.public java.lang.Boolean getPubliclyAccessible()
If true
, the cluster can be accessed from a public network.
true
, the cluster can be accessed from a public
network.public RestoreFromClusterSnapshotRequest withPubliclyAccessible(java.lang.Boolean publiclyAccessible)
If true
, the cluster can be accessed from a public network.
publiclyAccessible
- If true
, the cluster can be accessed from a public
network.public java.lang.Boolean isPubliclyAccessible()
If true
, the cluster can be accessed from a public network.
true
, the cluster can be accessed from a public
network.public void setOwnerAccount(java.lang.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.
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 java.lang.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.
public RestoreFromClusterSnapshotRequest withOwnerAccount(java.lang.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.
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 void setHsmClientCertificateIdentifier(java.lang.String hsmClientCertificateIdentifier)
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
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 java.lang.String getHsmClientCertificateIdentifier()
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
public RestoreFromClusterSnapshotRequest withHsmClientCertificateIdentifier(java.lang.String hsmClientCertificateIdentifier)
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
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 void setHsmConfigurationIdentifier(java.lang.String 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.
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 java.lang.String getHsmConfigurationIdentifier()
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 RestoreFromClusterSnapshotRequest withHsmConfigurationIdentifier(java.lang.String 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.
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 void setElasticIp(java.lang.String elasticIp)
The elastic IP (EIP) address for the cluster.
elasticIp
- The elastic IP (EIP) address for the cluster.public java.lang.String getElasticIp()
The elastic IP (EIP) address for the cluster.
public RestoreFromClusterSnapshotRequest withElasticIp(java.lang.String elasticIp)
The elastic IP (EIP) address for the cluster.
elasticIp
- The elastic IP (EIP) address for the cluster.public void setClusterParameterGroupName(java.lang.String 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:
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:
public java.lang.String getClusterParameterGroupName()
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:
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups.
Constraints:
public RestoreFromClusterSnapshotRequest withClusterParameterGroupName(java.lang.String 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:
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:
public java.util.List<java.lang.String> getClusterSecurityGroups()
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.
Default: The default cluster security group for Amazon Redshift.
Cluster security groups only apply to clusters outside of VPCs.
public void setClusterSecurityGroups(java.util.Collection<java.lang.String> 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.
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 RestoreFromClusterSnapshotRequest withClusterSecurityGroups(java.lang.String... 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.
NOTE: This method appends the values to the existing list (if
any). Use setClusterSecurityGroups(java.util.Collection)
or
withClusterSecurityGroups(java.util.Collection)
if you want to
override the existing values.
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 RestoreFromClusterSnapshotRequest withClusterSecurityGroups(java.util.Collection<java.lang.String> 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.
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 java.util.List<java.lang.String> getVpcSecurityGroupIds()
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.
Default: The default VPC security group is associated with the cluster.
VPC security groups only apply to clusters in VPCs.
public void setVpcSecurityGroupIds(java.util.Collection<java.lang.String> 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.
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.
public RestoreFromClusterSnapshotRequest withVpcSecurityGroupIds(java.lang.String... 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.
NOTE: This method appends the values to the existing list (if
any). Use setVpcSecurityGroupIds(java.util.Collection)
or
withVpcSecurityGroupIds(java.util.Collection)
if you want to
override the existing values.
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.
public RestoreFromClusterSnapshotRequest withVpcSecurityGroupIds(java.util.Collection<java.lang.String> 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.
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.
public void setPreferredMaintenanceWindow(java.lang.String 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.
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 java.lang.String getPreferredMaintenanceWindow()
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.
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 RestoreFromClusterSnapshotRequest withPreferredMaintenanceWindow(java.lang.String 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.
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 void setAutomatedSnapshotRetentionPeriod(java.lang.Integer 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.
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 java.lang.Integer getAutomatedSnapshotRetentionPeriod()
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.
Default: The value selected for the cluster from which the snapshot was taken.
Constraints: Must be a value from 0 to 35.
public RestoreFromClusterSnapshotRequest withAutomatedSnapshotRetentionPeriod(java.lang.Integer 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.
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 void setKmsKeyId(java.lang.String 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.
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 java.lang.String getKmsKeyId()
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 RestoreFromClusterSnapshotRequest withKmsKeyId(java.lang.String 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.
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 void setNodeType(java.lang.String 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
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 java.lang.String getNodeType()
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
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 RestoreFromClusterSnapshotRequest withNodeType(java.lang.String 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
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 void setAdditionalInfo(java.lang.String additionalInfo)
Reserved.
additionalInfo
- Reserved.public java.lang.String getAdditionalInfo()
Reserved.
public RestoreFromClusterSnapshotRequest withAdditionalInfo(java.lang.String additionalInfo)
Reserved.
additionalInfo
- Reserved.public java.util.List<java.lang.String> getIamRoles()
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.
A cluster can have up to 10 IAM roles associated at any time.
public void setIamRoles(java.util.Collection<java.lang.String> iamRoles)
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.
iamRoles
- 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.
public RestoreFromClusterSnapshotRequest withIamRoles(java.lang.String... iamRoles)
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.
NOTE: This method appends the values to the existing list (if
any). Use setIamRoles(java.util.Collection)
or
withIamRoles(java.util.Collection)
if you want to override the
existing values.
iamRoles
- 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.
public RestoreFromClusterSnapshotRequest withIamRoles(java.util.Collection<java.lang.String> iamRoles)
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.
iamRoles
- 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.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public RestoreFromClusterSnapshotRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()