Class RestoreFromClusterSnapshotRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
Reserved.Iftrue
, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.The number of days that automated snapshots are retained.The Amazon EC2 Availability Zone in which to restore the cluster.The identifier of the cluster that will be created from restoring the snapshot.The name of the parameter group to be associated with this cluster.A list of security groups to be associated with this cluster.The name of the subnet group where you want to cluster restored.The elastic IP (EIP) address for the cluster.Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.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.A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.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.The node type that the restored cluster will be provisioned with.The AWS customer account used to create or copy the snapshot.getPort()
The port number on which the cluster accepts connections.The weekly time range (in UTC) during which automated cluster maintenance can occur.Iftrue
, the cluster can be accessed from a public network.The name of the cluster the source snapshot was created from.The name of the snapshot from which to create the new cluster.A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.int
hashCode()
Iftrue
, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.Iftrue
, the cluster can be accessed from a public network.void
setAdditionalInfo
(String additionalInfo) Reserved.void
setAllowVersionUpgrade
(Boolean allowVersionUpgrade) Iftrue
, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.void
setAutomatedSnapshotRetentionPeriod
(Integer automatedSnapshotRetentionPeriod) The number of days that automated snapshots are retained.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
setClusterParameterGroupName
(String clusterParameterGroupName) The name of the parameter group to be associated with this cluster.void
setClusterSecurityGroups
(Collection<String> clusterSecurityGroups) A list of security groups to be associated with this cluster.void
setClusterSubnetGroupName
(String clusterSubnetGroupName) The name of the subnet group where you want to cluster restored.void
setElasticIp
(String elasticIp) The elastic IP (EIP) address for the cluster.void
setHsmClientCertificateIdentifier
(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
(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
(Collection<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
(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
(String nodeType) The node type that the restored cluster will be provisioned with.void
setOwnerAccount
(String ownerAccount) The AWS customer account used to create or copy the snapshot.void
The port number on which the cluster accepts connections.void
setPreferredMaintenanceWindow
(String preferredMaintenanceWindow) The weekly time range (in UTC) during which automated cluster maintenance can occur.void
setPubliclyAccessible
(Boolean publiclyAccessible) Iftrue
, 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.void
setVpcSecurityGroupIds
(Collection<String> vpcSecurityGroupIds) A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.toString()
Returns a string representation of this object; useful for testing and debugging.withAdditionalInfo
(String additionalInfo) Reserved.withAllowVersionUpgrade
(Boolean allowVersionUpgrade) Iftrue
, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.withAutomatedSnapshotRetentionPeriod
(Integer automatedSnapshotRetentionPeriod) The number of days that automated snapshots are retained.withAvailabilityZone
(String availabilityZone) The Amazon EC2 Availability Zone in which to restore the cluster.withClusterIdentifier
(String clusterIdentifier) The identifier of the cluster that will be created from restoring the snapshot.withClusterParameterGroupName
(String clusterParameterGroupName) The name of the parameter group to be associated with this cluster.withClusterSecurityGroups
(String... clusterSecurityGroups) A list of security groups to be associated with this cluster.withClusterSecurityGroups
(Collection<String> clusterSecurityGroups) A list of security groups to be associated with this cluster.withClusterSubnetGroupName
(String clusterSubnetGroupName) The name of the subnet group where you want to cluster restored.withElasticIp
(String elasticIp) The elastic IP (EIP) address for the cluster.withHsmClientCertificateIdentifier
(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.withHsmConfigurationIdentifier
(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.withIamRoles
(String... iamRoles) A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.withIamRoles
(Collection<String> iamRoles) A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.withKmsKeyId
(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.withNodeType
(String nodeType) The node type that the restored cluster will be provisioned with.withOwnerAccount
(String ownerAccount) The AWS customer account used to create or copy the snapshot.The port number on which the cluster accepts connections.withPreferredMaintenanceWindow
(String preferredMaintenanceWindow) The weekly time range (in UTC) during which automated cluster maintenance can occur.withPubliclyAccessible
(Boolean publiclyAccessible) Iftrue
, the cluster can be accessed from a public network.withSnapshotClusterIdentifier
(String snapshotClusterIdentifier) The name of the cluster the source snapshot was created from.withSnapshotIdentifier
(String snapshotIdentifier) The name of the snapshot from which to create the new cluster.withVpcSecurityGroupIds
(String... vpcSecurityGroupIds) A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.withVpcSecurityGroupIds
(Collection<String> vpcSecurityGroupIds) A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
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
-
Constructor Details
-
RestoreFromClusterSnapshotRequest
public RestoreFromClusterSnapshotRequest()
-
-
Method Details
-
setClusterIdentifier
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.
-
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.
-
withClusterIdentifier
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSnapshotIdentifier
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
-
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
-
withSnapshotIdentifier
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSnapshotClusterIdentifier
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.
-
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.
-
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
setPort
The port number on which the cluster accepts connections.
Default: The same port as the original cluster.
Constraints: Must be between
1115
and65535
.- Parameters:
port
- The port number on which the cluster accepts connections.Default: The same port as the original cluster.
Constraints: Must be between
1115
and65535
.
-
getPort
The port number on which the cluster accepts connections.
Default: The same port as the original cluster.
Constraints: Must be between
1115
and65535
.- Returns:
- The port number on which the cluster accepts connections.
Default: The same port as the original cluster.
Constraints: Must be between
1115
and65535
.
-
withPort
The port number on which the cluster accepts connections.
Default: The same port as the original cluster.
Constraints: Must be between
1115
and65535
.- Parameters:
port
- The port number on which the cluster accepts connections.Default: The same port as the original cluster.
Constraints: Must be between
1115
and65535
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAvailabilityZone
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
-
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
-
withAvailabilityZone
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAllowVersionUpgrade
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
- Parameters:
allowVersionUpgrade
- Iftrue
, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.Default:
true
-
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
- Returns:
- 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
-
withAllowVersionUpgrade
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
- Parameters:
allowVersionUpgrade
- Iftrue
, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.Default:
true
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
- Returns:
- 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
-
setClusterSubnetGroupName
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.
-
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.
-
withClusterSubnetGroupName
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPubliclyAccessible
If
true
, the cluster can be accessed from a public network.- Parameters:
publiclyAccessible
- Iftrue
, the cluster can be accessed from a public network.
-
getPubliclyAccessible
If
true
, the cluster can be accessed from a public network.- Returns:
- If
true
, the cluster can be accessed from a public network.
-
withPubliclyAccessible
If
true
, the cluster can be accessed from a public network.- Parameters:
publiclyAccessible
- Iftrue
, the cluster can be accessed from a public network.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isPubliclyAccessible
If
true
, the cluster can be accessed from a public network.- Returns:
- If
true
, the cluster can be accessed from a public network.
-
setOwnerAccount
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.
-
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.
-
withOwnerAccount
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setHsmClientCertificateIdentifier
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
- Parameters:
hsmClientCertificateIdentifier
- Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
-
getHsmClientCertificateIdentifier
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
- Returns:
- Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
-
withHsmClientCertificateIdentifier
public RestoreFromClusterSnapshotRequest withHsmClientCertificateIdentifier(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.
- Parameters:
hsmClientCertificateIdentifier
- Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setHsmConfigurationIdentifier
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.
- Parameters:
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.
-
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.
- Returns:
- 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.
-
withHsmConfigurationIdentifier
public RestoreFromClusterSnapshotRequest withHsmConfigurationIdentifier(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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setElasticIp
The elastic IP (EIP) address for the cluster.
- Parameters:
elasticIp
- The elastic IP (EIP) address for the cluster.
-
getElasticIp
The elastic IP (EIP) address for the cluster.
- Returns:
- The elastic IP (EIP) address for the cluster.
-
withElasticIp
The elastic IP (EIP) address for the cluster.
- Parameters:
elasticIp
- The elastic IP (EIP) address for the cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setClusterParameterGroupName
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.
- Parameters:
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.
-
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:
- 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.
- Returns:
- 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.
-
withClusterParameterGroupName
public RestoreFromClusterSnapshotRequest withClusterParameterGroupName(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:
- 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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Returns:
- 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.
-
setClusterSecurityGroups
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.
- Parameters:
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.
-
withClusterSecurityGroups
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)
orwithClusterSecurityGroups(java.util.Collection)
if you want to override the existing values.- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withClusterSecurityGroups
public RestoreFromClusterSnapshotRequest withClusterSecurityGroups(Collection<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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Returns:
- 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.
-
setVpcSecurityGroupIds
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.
- Parameters:
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.
-
withVpcSecurityGroupIds
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)
orwithVpcSecurityGroupIds(java.util.Collection)
if you want to override the existing values.- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withVpcSecurityGroupIds
public RestoreFromClusterSnapshotRequest withVpcSecurityGroupIds(Collection<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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPreferredMaintenanceWindow
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.
- Parameters:
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.
-
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.
- Returns:
- 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.
-
withPreferredMaintenanceWindow
public RestoreFromClusterSnapshotRequest withPreferredMaintenanceWindow(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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAutomatedSnapshotRetentionPeriod
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.
- Parameters:
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.
-
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.
- Returns:
- 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.
-
withAutomatedSnapshotRetentionPeriod
public RestoreFromClusterSnapshotRequest withAutomatedSnapshotRetentionPeriod(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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setKmsKeyId
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.
- Parameters:
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.
-
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.
- Returns:
- 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.
-
withKmsKeyId
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNodeType
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
- Parameters:
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
-
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
- Returns:
- 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
-
withNodeType
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
- Parameters:
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setAdditionalInfo
Reserved.
- Parameters:
additionalInfo
- Reserved.
-
getAdditionalInfo
Reserved.
- Returns:
- Reserved.
-
withAdditionalInfo
Reserved.
- Parameters:
additionalInfo
- Reserved.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Returns:
- 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.
-
setIamRoles
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.
- Parameters:
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.
-
withIamRoles
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)
orwithIamRoles(java.util.Collection)
if you want to override the existing values.- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withIamRoles
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-