@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RestoreFromClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
RestoreFromClusterSnapshotRequest() |
Modifier and Type | Method and Description |
---|---|
RestoreFromClusterSnapshotRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getAdditionalInfo()
Reserved.
|
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. |
String |
getAquaConfigurationStatus()
This parameter is retired.
|
Integer |
getAutomatedSnapshotRetentionPeriod()
The number of days that automated snapshots are retained.
|
String |
getAvailabilityZone()
The Amazon EC2 Availability Zone in which to restore the cluster.
|
Boolean |
getAvailabilityZoneRelocation()
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is
restored.
|
String |
getClusterIdentifier()
The identifier of the cluster that will be created from restoring the snapshot.
|
String |
getClusterParameterGroupName()
The name of the parameter group to be associated with this cluster.
|
List<String> |
getClusterSecurityGroups()
A list of security groups to be associated with this cluster.
|
String |
getClusterSubnetGroupName()
The name of the subnet group where you want to cluster restored.
|
String |
getDefaultIamRoleArn()
The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last
modified while it was restored from a snapshot.
|
String |
getElasticIp()
The Elastic IP (EIP) address for the cluster.
|
Boolean |
getEncrypted()
Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service (KMS)
and a customer managed key.
|
Boolean |
getEnhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
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.
|
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.
|
List<String> |
getIamRoles()
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web
Services services.
|
String |
getIpAddressType()
The IP address type for the cluster.
|
String |
getKmsKeyId()
The Key Management Service (KMS) key ID of the encryption key that encrypts data in the cluster restored from a
shared snapshot.
|
String |
getMaintenanceTrackName()
The name of the maintenance track for the restored cluster.
|
Boolean |
getManageMasterPassword()
If
true , Amazon Redshift uses Secrets Manager to manage the restored cluster's admin credentials. |
Integer |
getManualSnapshotRetentionPeriod()
The default number of days to retain a manual snapshot.
|
String |
getMasterPasswordSecretKmsKeyId()
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
|
Boolean |
getMultiAZ()
If true, the snapshot will be restored to a cluster deployed in two Availability Zones.
|
String |
getNodeType()
The node type that the restored cluster will be provisioned with.
|
Integer |
getNumberOfNodes()
The number of nodes specified when provisioning the restored cluster.
|
String |
getOwnerAccount()
The Amazon Web Services account used to create or copy the snapshot.
|
Integer |
getPort()
The port number on which the cluster accepts connections.
|
String |
getPreferredMaintenanceWindow()
The weekly time range (in UTC) during which automated cluster maintenance can occur.
|
Boolean |
getPubliclyAccessible()
If
true , the cluster can be accessed from a public network. |
String |
getReservedNodeId()
The identifier of the target reserved node offering.
|
String |
getSnapshotArn()
The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster.
|
String |
getSnapshotClusterIdentifier()
The name of the cluster the source snapshot was created from.
|
String |
getSnapshotIdentifier()
The name of the snapshot from which to create the new cluster.
|
String |
getSnapshotScheduleIdentifier()
A unique identifier for the snapshot schedule.
|
String |
getTargetReservedNodeOfferingId()
The identifier of the target reserved node offering.
|
List<String> |
getVpcSecurityGroupIds()
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
|
int |
hashCode() |
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. |
Boolean |
isAvailabilityZoneRelocation()
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is
restored.
|
Boolean |
isEncrypted()
Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service (KMS)
and a customer managed key.
|
Boolean |
isEnhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
Boolean |
isManageMasterPassword()
If
true , Amazon Redshift uses Secrets Manager to manage the restored cluster's admin credentials. |
Boolean |
isMultiAZ()
If true, the snapshot will be restored to a cluster deployed in two Availability Zones.
|
Boolean |
isPubliclyAccessible()
If
true , the cluster can be accessed from a public network. |
void |
setAdditionalInfo(String additionalInfo)
Reserved.
|
void |
setAllowVersionUpgrade(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 |
setAquaConfigurationStatus(String aquaConfigurationStatus)
This parameter is retired.
|
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 |
setAvailabilityZoneRelocation(Boolean availabilityZoneRelocation)
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is
restored.
|
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 |
setDefaultIamRoleArn(String defaultIamRoleArn)
The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last
modified while it was restored from a snapshot.
|
void |
setElasticIp(String elasticIp)
The Elastic IP (EIP) address for the cluster.
|
void |
setEncrypted(Boolean encrypted)
Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service (KMS)
and a customer managed key.
|
void |
setEnhancedVpcRouting(Boolean enhancedVpcRouting)
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
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 Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web
Services services.
|
void |
setIpAddressType(String ipAddressType)
The IP address type for the cluster.
|
void |
setKmsKeyId(String kmsKeyId)
The Key Management Service (KMS) key ID of the encryption key that encrypts data in the cluster restored from a
shared snapshot.
|
void |
setMaintenanceTrackName(String maintenanceTrackName)
The name of the maintenance track for the restored cluster.
|
void |
setManageMasterPassword(Boolean manageMasterPassword)
If
true , Amazon Redshift uses Secrets Manager to manage the restored cluster's admin credentials. |
void |
setManualSnapshotRetentionPeriod(Integer manualSnapshotRetentionPeriod)
The default number of days to retain a manual snapshot.
|
void |
setMasterPasswordSecretKmsKeyId(String masterPasswordSecretKmsKeyId)
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
|
void |
setMultiAZ(Boolean multiAZ)
If true, the snapshot will be restored to a cluster deployed in two Availability Zones.
|
void |
setNodeType(String nodeType)
The node type that the restored cluster will be provisioned with.
|
void |
setNumberOfNodes(Integer numberOfNodes)
The number of nodes specified when provisioning the restored cluster.
|
void |
setOwnerAccount(String ownerAccount)
The Amazon Web Services account used to create or copy the snapshot.
|
void |
setPort(Integer port)
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)
If
true , the cluster can be accessed from a public network. |
void |
setReservedNodeId(String reservedNodeId)
The identifier of the target reserved node offering.
|
void |
setSnapshotArn(String snapshotArn)
The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster.
|
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 |
setSnapshotScheduleIdentifier(String snapshotScheduleIdentifier)
A unique identifier for the snapshot schedule.
|
void |
setTargetReservedNodeOfferingId(String targetReservedNodeOfferingId)
The identifier of the target reserved node offering.
|
void |
setVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
|
String |
toString()
Returns a string representation of this object.
|
RestoreFromClusterSnapshotRequest |
withAdditionalInfo(String additionalInfo)
Reserved.
|
RestoreFromClusterSnapshotRequest |
withAllowVersionUpgrade(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 |
withAquaConfigurationStatus(AquaConfigurationStatus aquaConfigurationStatus)
This parameter is retired.
|
RestoreFromClusterSnapshotRequest |
withAquaConfigurationStatus(String aquaConfigurationStatus)
This parameter is retired.
|
RestoreFromClusterSnapshotRequest |
withAutomatedSnapshotRetentionPeriod(Integer automatedSnapshotRetentionPeriod)
The number of days that automated snapshots are retained.
|
RestoreFromClusterSnapshotRequest |
withAvailabilityZone(String availabilityZone)
The Amazon EC2 Availability Zone in which to restore the cluster.
|
RestoreFromClusterSnapshotRequest |
withAvailabilityZoneRelocation(Boolean availabilityZoneRelocation)
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is
restored.
|
RestoreFromClusterSnapshotRequest |
withClusterIdentifier(String clusterIdentifier)
The identifier of the cluster that will be created from restoring the snapshot.
|
RestoreFromClusterSnapshotRequest |
withClusterParameterGroupName(String clusterParameterGroupName)
The name of the parameter group to be associated with this cluster.
|
RestoreFromClusterSnapshotRequest |
withClusterSecurityGroups(Collection<String> clusterSecurityGroups)
A list of security groups to be associated with this cluster.
|
RestoreFromClusterSnapshotRequest |
withClusterSecurityGroups(String... clusterSecurityGroups)
A list of security groups to be associated with this cluster.
|
RestoreFromClusterSnapshotRequest |
withClusterSubnetGroupName(String clusterSubnetGroupName)
The name of the subnet group where you want to cluster restored.
|
RestoreFromClusterSnapshotRequest |
withDefaultIamRoleArn(String defaultIamRoleArn)
The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last
modified while it was restored from a snapshot.
|
RestoreFromClusterSnapshotRequest |
withElasticIp(String elasticIp)
The Elastic IP (EIP) address for the cluster.
|
RestoreFromClusterSnapshotRequest |
withEncrypted(Boolean encrypted)
Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service (KMS)
and a customer managed key.
|
RestoreFromClusterSnapshotRequest |
withEnhancedVpcRouting(Boolean enhancedVpcRouting)
An option that specifies whether to create the cluster with enhanced VPC routing enabled.
|
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.
|
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.
|
RestoreFromClusterSnapshotRequest |
withIamRoles(Collection<String> iamRoles)
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web
Services services.
|
RestoreFromClusterSnapshotRequest |
withIamRoles(String... iamRoles)
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web
Services services.
|
RestoreFromClusterSnapshotRequest |
withIpAddressType(String ipAddressType)
The IP address type for the cluster.
|
RestoreFromClusterSnapshotRequest |
withKmsKeyId(String kmsKeyId)
The Key Management Service (KMS) key ID of the encryption key that encrypts data in the cluster restored from a
shared snapshot.
|
RestoreFromClusterSnapshotRequest |
withMaintenanceTrackName(String maintenanceTrackName)
The name of the maintenance track for the restored cluster.
|
RestoreFromClusterSnapshotRequest |
withManageMasterPassword(Boolean manageMasterPassword)
If
true , Amazon Redshift uses Secrets Manager to manage the restored cluster's admin credentials. |
RestoreFromClusterSnapshotRequest |
withManualSnapshotRetentionPeriod(Integer manualSnapshotRetentionPeriod)
The default number of days to retain a manual snapshot.
|
RestoreFromClusterSnapshotRequest |
withMasterPasswordSecretKmsKeyId(String masterPasswordSecretKmsKeyId)
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
|
RestoreFromClusterSnapshotRequest |
withMultiAZ(Boolean multiAZ)
If true, the snapshot will be restored to a cluster deployed in two Availability Zones.
|
RestoreFromClusterSnapshotRequest |
withNodeType(String nodeType)
The node type that the restored cluster will be provisioned with.
|
RestoreFromClusterSnapshotRequest |
withNumberOfNodes(Integer numberOfNodes)
The number of nodes specified when provisioning the restored cluster.
|
RestoreFromClusterSnapshotRequest |
withOwnerAccount(String ownerAccount)
The Amazon Web Services account used to create or copy the snapshot.
|
RestoreFromClusterSnapshotRequest |
withPort(Integer port)
The port number on which the cluster accepts connections.
|
RestoreFromClusterSnapshotRequest |
withPreferredMaintenanceWindow(String preferredMaintenanceWindow)
The weekly time range (in UTC) during which automated cluster maintenance can occur.
|
RestoreFromClusterSnapshotRequest |
withPubliclyAccessible(Boolean publiclyAccessible)
If
true , the cluster can be accessed from a public network. |
RestoreFromClusterSnapshotRequest |
withReservedNodeId(String reservedNodeId)
The identifier of the target reserved node offering.
|
RestoreFromClusterSnapshotRequest |
withSnapshotArn(String snapshotArn)
The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster.
|
RestoreFromClusterSnapshotRequest |
withSnapshotClusterIdentifier(String snapshotClusterIdentifier)
The name of the cluster the source snapshot was created from.
|
RestoreFromClusterSnapshotRequest |
withSnapshotIdentifier(String snapshotIdentifier)
The name of the snapshot from which to create the new cluster.
|
RestoreFromClusterSnapshotRequest |
withSnapshotScheduleIdentifier(String snapshotScheduleIdentifier)
A unique identifier for the snapshot schedule.
|
RestoreFromClusterSnapshotRequest |
withTargetReservedNodeOfferingId(String targetReservedNodeOfferingId)
The identifier of the target reserved node offering.
|
RestoreFromClusterSnapshotRequest |
withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
|
RestoreFromClusterSnapshotRequest |
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setClusterIdentifier(String clusterIdentifier)
The identifier of the cluster that will be created from restoring the snapshot.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an Amazon Web Services account.
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 Amazon Web Services account.
public String getClusterIdentifier()
The identifier of the cluster that will be created from restoring the snapshot.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an Amazon Web Services account.
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 Amazon Web Services account.
public RestoreFromClusterSnapshotRequest withClusterIdentifier(String clusterIdentifier)
The identifier of the cluster that will be created from restoring the snapshot.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens.
Alphabetic characters must be lowercase.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Must be unique for all clusters within an Amazon Web Services account.
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 Amazon Web Services account.
public void setSnapshotIdentifier(String snapshotIdentifier)
The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. You must
specify this parameter or snapshotArn
, but not both.
Example: my-snapshot-id
snapshotIdentifier
- The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. You
must specify this parameter or snapshotArn
, but not both.
Example: my-snapshot-id
public String getSnapshotIdentifier()
The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. You must
specify this parameter or snapshotArn
, but not both.
Example: my-snapshot-id
snapshotArn
, but not both.
Example: my-snapshot-id
public RestoreFromClusterSnapshotRequest withSnapshotIdentifier(String snapshotIdentifier)
The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. You must
specify this parameter or snapshotArn
, but not both.
Example: my-snapshot-id
snapshotIdentifier
- The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. You
must specify this parameter or snapshotArn
, but not both.
Example: my-snapshot-id
public void setSnapshotArn(String snapshotArn)
The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster. You must
specify this parameter or snapshotIdentifier
, but not both.
snapshotArn
- The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster. You
must specify this parameter or snapshotIdentifier
, but not both.public String getSnapshotArn()
The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster. You must
specify this parameter or snapshotIdentifier
, but not both.
snapshotIdentifier
, but not both.public RestoreFromClusterSnapshotRequest withSnapshotArn(String snapshotArn)
The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster. You must
specify this parameter or snapshotIdentifier
, but not both.
snapshotArn
- The Amazon Resource Name (ARN) of the snapshot associated with the message to restore from a cluster. You
must specify this parameter or snapshotIdentifier
, but not both.public void setSnapshotClusterIdentifier(String snapshotClusterIdentifier)
The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name.
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 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(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(Integer port)
The port number on which the cluster accepts connections.
Default: The same port as the original cluster.
Valid values: For clusters with DC2 nodes, must be within the range 1150
-65535
. For
clusters with ra3 nodes, must be within the ranges 5431
-5455
or 8191
-
8215
.
port
- The port number on which the cluster accepts connections.
Default: The same port as the original cluster.
Valid values: For clusters with DC2 nodes, must be within the range 1150
-65535
.
For clusters with ra3 nodes, must be within the ranges 5431
-5455
or
8191
-8215
.
public Integer getPort()
The port number on which the cluster accepts connections.
Default: The same port as the original cluster.
Valid values: For clusters with DC2 nodes, must be within the range 1150
-65535
. For
clusters with ra3 nodes, must be within the ranges 5431
-5455
or 8191
-
8215
.
Default: The same port as the original cluster.
Valid values: For clusters with DC2 nodes, must be within the range 1150
-65535
.
For clusters with ra3 nodes, must be within the ranges 5431
-5455
or
8191
-8215
.
public RestoreFromClusterSnapshotRequest withPort(Integer port)
The port number on which the cluster accepts connections.
Default: The same port as the original cluster.
Valid values: For clusters with DC2 nodes, must be within the range 1150
-65535
. For
clusters with ra3 nodes, must be within the ranges 5431
-5455
or 8191
-
8215
.
port
- The port number on which the cluster accepts connections.
Default: The same port as the original cluster.
Valid values: For clusters with DC2 nodes, must be within the range 1150
-65535
.
For clusters with ra3 nodes, must be within the ranges 5431
-5455
or
8191
-8215
.
public void setAvailabilityZone(String availabilityZone)
The Amazon EC2 Availability Zone in which to restore the cluster.
Default: A random, system-chosen Availability Zone.
Example: us-east-2a
availabilityZone
- The Amazon EC2 Availability Zone in which to restore the cluster.
Default: A random, system-chosen Availability Zone.
Example: us-east-2a
public String getAvailabilityZone()
The Amazon EC2 Availability Zone in which to restore the cluster.
Default: A random, system-chosen Availability Zone.
Example: us-east-2a
Default: A random, system-chosen Availability Zone.
Example: us-east-2a
public RestoreFromClusterSnapshotRequest withAvailabilityZone(String availabilityZone)
The Amazon EC2 Availability Zone in which to restore the cluster.
Default: A random, system-chosen Availability Zone.
Example: us-east-2a
availabilityZone
- The Amazon EC2 Availability Zone in which to restore the cluster.
Default: A random, system-chosen Availability Zone.
Example: us-east-2a
public void setAllowVersionUpgrade(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 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(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 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(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 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(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(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 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(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 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(String ownerAccount)
The Amazon Web Services 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 Amazon Web Services 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 String getOwnerAccount()
The Amazon Web Services 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(String ownerAccount)
The Amazon Web Services 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 Amazon Web Services 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(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 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(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(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 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(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(String elasticIp)
The Elastic IP (EIP) address for the cluster. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on.
elasticIp
- The Elastic IP (EIP) address for the cluster. Don't specify the Elastic IP address for a publicly
accessible cluster with availability zone relocation turned on.public String getElasticIp()
The Elastic IP (EIP) address for the cluster. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on.
public RestoreFromClusterSnapshotRequest withElasticIp(String elasticIp)
The Elastic IP (EIP) address for the cluster. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on.
elasticIp
- The Elastic IP (EIP) address for the cluster. Don't specify the Elastic IP address for a publicly
accessible cluster with availability zone relocation turned on.public void setClusterParameterGroupName(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.
clusterParameterGroupName
- The name of the parameter group to be associated with this cluster.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups.
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
public 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:
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.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups.
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
public 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.
clusterParameterGroupName
- The name of the parameter group to be associated with this cluster.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups.
Constraints:
Must be 1 to 255 alphanumeric characters or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
public List<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(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.
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(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(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.
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 List<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(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.
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(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(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.
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(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 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(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(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.
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
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.
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
Default: The value selected for the cluster from which the snapshot was taken.
Constraints: Must be a value from 0 to 35.
public 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.
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
Default: The value selected for the cluster from which the snapshot was taken.
Constraints: Must be a value from 0 to 35.
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
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(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.
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
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.
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
Default: The value selected for the cluster from which the snapshot was taken.
Constraints: Must be a value from 0 to 35.
public void setManualSnapshotRetentionPeriod(Integer manualSnapshotRetentionPeriod)
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
manualSnapshotRetentionPeriod
- The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained
indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
public Integer getManualSnapshotRetentionPeriod()
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
The value must be either -1 or an integer between 1 and 3,653.
public RestoreFromClusterSnapshotRequest withManualSnapshotRetentionPeriod(Integer manualSnapshotRetentionPeriod)
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
manualSnapshotRetentionPeriod
- The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained
indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
public void setKmsKeyId(String kmsKeyId)
The Key Management Service (KMS) key ID of the encryption key that encrypts data in the cluster restored from a shared snapshot. You can also provide the key ID when you restore from an unencrypted snapshot to an encrypted cluster in the same account. Additionally, you can specify a new KMS key ID when you restore from an encrypted snapshot in the same account in order to change it. In that case, the restored cluster is encrypted with the new KMS key ID.
kmsKeyId
- The Key Management Service (KMS) key ID of the encryption key that encrypts data in the cluster restored
from a shared snapshot. You can also provide the key ID when you restore from an unencrypted snapshot to
an encrypted cluster in the same account. Additionally, you can specify a new KMS key ID when you restore
from an encrypted snapshot in the same account in order to change it. In that case, the restored cluster
is encrypted with the new KMS key ID.public String getKmsKeyId()
The Key Management Service (KMS) key ID of the encryption key that encrypts data in the cluster restored from a shared snapshot. You can also provide the key ID when you restore from an unencrypted snapshot to an encrypted cluster in the same account. Additionally, you can specify a new KMS key ID when you restore from an encrypted snapshot in the same account in order to change it. In that case, the restored cluster is encrypted with the new KMS key ID.
public RestoreFromClusterSnapshotRequest withKmsKeyId(String kmsKeyId)
The Key Management Service (KMS) key ID of the encryption key that encrypts data in the cluster restored from a shared snapshot. You can also provide the key ID when you restore from an unencrypted snapshot to an encrypted cluster in the same account. Additionally, you can specify a new KMS key ID when you restore from an encrypted snapshot in the same account in order to change it. In that case, the restored cluster is encrypted with the new KMS key ID.
kmsKeyId
- The Key Management Service (KMS) key ID of the encryption key that encrypts data in the cluster restored
from a shared snapshot. You can also provide the key ID when you restore from an unencrypted snapshot to
an encrypted cluster in the same account. Additionally, you can specify a new KMS key ID when you restore
from an encrypted snapshot in the same account in order to change it. In that case, the restored cluster
is encrypted with the new KMS key ID.public void setNodeType(String nodeType)
The node type that the restored cluster will be provisioned with.
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 dc2.large node type into another dc2 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.
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 dc2.large node type into another dc2 type. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide.
public String getNodeType()
The node type that the restored cluster will be provisioned with.
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 dc2.large node type into another dc2 type. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide.
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 dc2.large node type into another dc2 type. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide.
public RestoreFromClusterSnapshotRequest withNodeType(String nodeType)
The node type that the restored cluster will be provisioned with.
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 dc2.large node type into another dc2 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.
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 dc2.large node type into another dc2 type. For more information about node types, see About Clusters and Nodes in the Amazon Redshift Cluster Management Guide.
public void setEnhancedVpcRouting(Boolean enhancedVpcRouting)
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true
, enhanced VPC routing is enabled.
Default: false
enhancedVpcRouting
- An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a
cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing
in the Amazon Redshift Cluster Management Guide.
If this option is true
, enhanced VPC routing is enabled.
Default: false
public Boolean getEnhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true
, enhanced VPC routing is enabled.
Default: false
If this option is true
, enhanced VPC routing is enabled.
Default: false
public RestoreFromClusterSnapshotRequest withEnhancedVpcRouting(Boolean enhancedVpcRouting)
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true
, enhanced VPC routing is enabled.
Default: false
enhancedVpcRouting
- An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a
cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing
in the Amazon Redshift Cluster Management Guide.
If this option is true
, enhanced VPC routing is enabled.
Default: false
public Boolean isEnhancedVpcRouting()
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true
, enhanced VPC routing is enabled.
Default: false
If this option is true
, enhanced VPC routing is enabled.
Default: false
public void setAdditionalInfo(String additionalInfo)
Reserved.
additionalInfo
- Reserved.public String getAdditionalInfo()
Reserved.
public RestoreFromClusterSnapshotRequest withAdditionalInfo(String additionalInfo)
Reserved.
additionalInfo
- Reserved.public List<String> getIamRoles()
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.
public void setIamRoles(Collection<String> iamRoles)
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.
iamRoles
- A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other
Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.
public RestoreFromClusterSnapshotRequest withIamRoles(String... iamRoles)
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.
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 Identity and Access Management (IAM) roles that can be used by the cluster to access other
Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.
public RestoreFromClusterSnapshotRequest withIamRoles(Collection<String> iamRoles)
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.
iamRoles
- A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other
Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.
public void setMaintenanceTrackName(String maintenanceTrackName)
The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the
MaintenanceTrack
value from the cluster. The snapshot might be on a different track than the cluster
that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the
current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source
cluster are on different tracks.
maintenanceTrackName
- The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot
inherits the MaintenanceTrack
value from the cluster. The snapshot might be on a different
track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot
of a cluster that is on the current track and then change the cluster to be on the trailing track. In this
case, the snapshot and the source cluster are on different tracks.public String getMaintenanceTrackName()
The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the
MaintenanceTrack
value from the cluster. The snapshot might be on a different track than the cluster
that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the
current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source
cluster are on different tracks.
MaintenanceTrack
value from the cluster. The snapshot might be on a different
track than the cluster that was the source for the snapshot. For example, suppose that you take a
snapshot of a cluster that is on the current track and then change the cluster to be on the trailing
track. In this case, the snapshot and the source cluster are on different tracks.public RestoreFromClusterSnapshotRequest withMaintenanceTrackName(String maintenanceTrackName)
The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the
MaintenanceTrack
value from the cluster. The snapshot might be on a different track than the cluster
that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the
current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source
cluster are on different tracks.
maintenanceTrackName
- The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot
inherits the MaintenanceTrack
value from the cluster. The snapshot might be on a different
track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot
of a cluster that is on the current track and then change the cluster to be on the trailing track. In this
case, the snapshot and the source cluster are on different tracks.public void setSnapshotScheduleIdentifier(String snapshotScheduleIdentifier)
A unique identifier for the snapshot schedule.
snapshotScheduleIdentifier
- A unique identifier for the snapshot schedule.public String getSnapshotScheduleIdentifier()
A unique identifier for the snapshot schedule.
public RestoreFromClusterSnapshotRequest withSnapshotScheduleIdentifier(String snapshotScheduleIdentifier)
A unique identifier for the snapshot schedule.
snapshotScheduleIdentifier
- A unique identifier for the snapshot schedule.public void setNumberOfNodes(Integer numberOfNodes)
The number of nodes specified when provisioning the restored cluster.
numberOfNodes
- The number of nodes specified when provisioning the restored cluster.public Integer getNumberOfNodes()
The number of nodes specified when provisioning the restored cluster.
public RestoreFromClusterSnapshotRequest withNumberOfNodes(Integer numberOfNodes)
The number of nodes specified when provisioning the restored cluster.
numberOfNodes
- The number of nodes specified when provisioning the restored cluster.public void setAvailabilityZoneRelocation(Boolean availabilityZoneRelocation)
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.
availabilityZoneRelocation
- The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the
cluster is restored.public Boolean getAvailabilityZoneRelocation()
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.
public RestoreFromClusterSnapshotRequest withAvailabilityZoneRelocation(Boolean availabilityZoneRelocation)
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.
availabilityZoneRelocation
- The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the
cluster is restored.public Boolean isAvailabilityZoneRelocation()
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is restored.
public void setAquaConfigurationStatus(String aquaConfigurationStatus)
This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
aquaConfigurationStatus
- This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically
determines whether to use AQUA (Advanced Query Accelerator).AquaConfigurationStatus
public String getAquaConfigurationStatus()
This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
AquaConfigurationStatus
public RestoreFromClusterSnapshotRequest withAquaConfigurationStatus(String aquaConfigurationStatus)
This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
aquaConfigurationStatus
- This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically
determines whether to use AQUA (Advanced Query Accelerator).AquaConfigurationStatus
public RestoreFromClusterSnapshotRequest withAquaConfigurationStatus(AquaConfigurationStatus aquaConfigurationStatus)
This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
aquaConfigurationStatus
- This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically
determines whether to use AQUA (Advanced Query Accelerator).AquaConfigurationStatus
public void setDefaultIamRoleArn(String defaultIamRoleArn)
The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last modified while it was restored from a snapshot.
defaultIamRoleArn
- The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster
was last modified while it was restored from a snapshot.public String getDefaultIamRoleArn()
The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last modified while it was restored from a snapshot.
public RestoreFromClusterSnapshotRequest withDefaultIamRoleArn(String defaultIamRoleArn)
The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was last modified while it was restored from a snapshot.
defaultIamRoleArn
- The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster
was last modified while it was restored from a snapshot.public void setReservedNodeId(String reservedNodeId)
The identifier of the target reserved node offering.
reservedNodeId
- The identifier of the target reserved node offering.public String getReservedNodeId()
The identifier of the target reserved node offering.
public RestoreFromClusterSnapshotRequest withReservedNodeId(String reservedNodeId)
The identifier of the target reserved node offering.
reservedNodeId
- The identifier of the target reserved node offering.public void setTargetReservedNodeOfferingId(String targetReservedNodeOfferingId)
The identifier of the target reserved node offering.
targetReservedNodeOfferingId
- The identifier of the target reserved node offering.public String getTargetReservedNodeOfferingId()
The identifier of the target reserved node offering.
public RestoreFromClusterSnapshotRequest withTargetReservedNodeOfferingId(String targetReservedNodeOfferingId)
The identifier of the target reserved node offering.
targetReservedNodeOfferingId
- The identifier of the target reserved node offering.public void setEncrypted(Boolean encrypted)
Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service (KMS) and a customer managed key.
encrypted
- Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service
(KMS) and a customer managed key.public Boolean getEncrypted()
Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service (KMS) and a customer managed key.
public RestoreFromClusterSnapshotRequest withEncrypted(Boolean encrypted)
Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service (KMS) and a customer managed key.
encrypted
- Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service
(KMS) and a customer managed key.public Boolean isEncrypted()
Enables support for restoring an unencrypted snapshot to a cluster encrypted with Key Management Service (KMS) and a customer managed key.
public void setManageMasterPassword(Boolean manageMasterPassword)
If true
, Amazon Redshift uses Secrets Manager to manage the restored cluster's admin credentials. If
ManageMasterPassword
is false or not set, Amazon Redshift uses the admin credentials the cluster had
at the time the snapshot was taken.
manageMasterPassword
- If true
, Amazon Redshift uses Secrets Manager to manage the restored cluster's admin
credentials. If ManageMasterPassword
is false or not set, Amazon Redshift uses the admin
credentials the cluster had at the time the snapshot was taken.public Boolean getManageMasterPassword()
If true
, Amazon Redshift uses Secrets Manager to manage the restored cluster's admin credentials. If
ManageMasterPassword
is false or not set, Amazon Redshift uses the admin credentials the cluster had
at the time the snapshot was taken.
true
, Amazon Redshift uses Secrets Manager to manage the restored cluster's admin
credentials. If ManageMasterPassword
is false or not set, Amazon Redshift uses the admin
credentials the cluster had at the time the snapshot was taken.public RestoreFromClusterSnapshotRequest withManageMasterPassword(Boolean manageMasterPassword)
If true
, Amazon Redshift uses Secrets Manager to manage the restored cluster's admin credentials. If
ManageMasterPassword
is false or not set, Amazon Redshift uses the admin credentials the cluster had
at the time the snapshot was taken.
manageMasterPassword
- If true
, Amazon Redshift uses Secrets Manager to manage the restored cluster's admin
credentials. If ManageMasterPassword
is false or not set, Amazon Redshift uses the admin
credentials the cluster had at the time the snapshot was taken.public Boolean isManageMasterPassword()
If true
, Amazon Redshift uses Secrets Manager to manage the restored cluster's admin credentials. If
ManageMasterPassword
is false or not set, Amazon Redshift uses the admin credentials the cluster had
at the time the snapshot was taken.
true
, Amazon Redshift uses Secrets Manager to manage the restored cluster's admin
credentials. If ManageMasterPassword
is false or not set, Amazon Redshift uses the admin
credentials the cluster had at the time the snapshot was taken.public void setMasterPasswordSecretKmsKeyId(String masterPasswordSecretKmsKeyId)
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
You can only use this parameter if ManageMasterPassword
is true.
masterPasswordSecretKmsKeyId
- The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials
secret. You can only use this parameter if ManageMasterPassword
is true.public String getMasterPasswordSecretKmsKeyId()
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
You can only use this parameter if ManageMasterPassword
is true.
ManageMasterPassword
is true.public RestoreFromClusterSnapshotRequest withMasterPasswordSecretKmsKeyId(String masterPasswordSecretKmsKeyId)
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
You can only use this parameter if ManageMasterPassword
is true.
masterPasswordSecretKmsKeyId
- The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials
secret. You can only use this parameter if ManageMasterPassword
is true.public void setIpAddressType(String ipAddressType)
The IP address type for the cluster. Possible values are ipv4
and dualstack
.
ipAddressType
- The IP address type for the cluster. Possible values are ipv4
and dualstack
.public String getIpAddressType()
The IP address type for the cluster. Possible values are ipv4
and dualstack
.
ipv4
and dualstack
.public RestoreFromClusterSnapshotRequest withIpAddressType(String ipAddressType)
The IP address type for the cluster. Possible values are ipv4
and dualstack
.
ipAddressType
- The IP address type for the cluster. Possible values are ipv4
and dualstack
.public void setMultiAZ(Boolean multiAZ)
If true, the snapshot will be restored to a cluster deployed in two Availability Zones.
multiAZ
- If true, the snapshot will be restored to a cluster deployed in two Availability Zones.public Boolean getMultiAZ()
If true, the snapshot will be restored to a cluster deployed in two Availability Zones.
public RestoreFromClusterSnapshotRequest withMultiAZ(Boolean multiAZ)
If true, the snapshot will be restored to a cluster deployed in two Availability Zones.
multiAZ
- If true, the snapshot will be restored to a cluster deployed in two Availability Zones.public Boolean isMultiAZ()
If true, the snapshot will be restored to a cluster deployed in two Availability Zones.
public String toString()
toString
in class Object
Object.toString()
public RestoreFromClusterSnapshotRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()