Class RestoreDBClusterFromSnapshotRequest
- 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
Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.The database name for the restored DB cluster.The name of the DB cluster to create from the DB cluster snapshot.The name of the DB subnet group to use for the new DB cluster.The database engine to use for the new DB cluster.The version of the database engine to use for the new DB cluster.The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster snapshot.The name of the option group to use for the restored DB cluster.getPort()
The port number on which the new DB cluster accepts connections.The identifier for the DB cluster snapshot to restore from.getTags()
The tags to be assigned to the restored DB cluster.A list of VPC security groups that the new DB cluster will belong to.int
hashCode()
void
setAvailabilityZones
(Collection<String> availabilityZones) Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.void
setDatabaseName
(String databaseName) The database name for the restored DB cluster.void
setDBClusterIdentifier
(String dBClusterIdentifier) The name of the DB cluster to create from the DB cluster snapshot.void
setDBSubnetGroupName
(String dBSubnetGroupName) The name of the DB subnet group to use for the new DB cluster.void
The database engine to use for the new DB cluster.void
setEngineVersion
(String engineVersion) The version of the database engine to use for the new DB cluster.void
setKmsKeyId
(String kmsKeyId) The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster snapshot.void
setOptionGroupName
(String optionGroupName) The name of the option group to use for the restored DB cluster.void
The port number on which the new DB cluster accepts connections.void
setSnapshotIdentifier
(String snapshotIdentifier) The identifier for the DB cluster snapshot to restore from.void
setTags
(Collection<Tag> tags) The tags to be assigned to the restored DB cluster.void
setVpcSecurityGroupIds
(Collection<String> vpcSecurityGroupIds) A list of VPC security groups that the new DB cluster will belong to.toString()
Returns a string representation of this object; useful for testing and debugging.withAvailabilityZones
(String... availabilityZones) Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.withAvailabilityZones
(Collection<String> availabilityZones) Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.withDatabaseName
(String databaseName) The database name for the restored DB cluster.withDBClusterIdentifier
(String dBClusterIdentifier) The name of the DB cluster to create from the DB cluster snapshot.withDBSubnetGroupName
(String dBSubnetGroupName) The name of the DB subnet group to use for the new DB cluster.withEngine
(String engine) The database engine to use for the new DB cluster.withEngineVersion
(String engineVersion) The version of the database engine to use for the new DB cluster.withKmsKeyId
(String kmsKeyId) The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster snapshot.withOptionGroupName
(String optionGroupName) The name of the option group to use for the restored DB cluster.The port number on which the new DB cluster accepts connections.withSnapshotIdentifier
(String snapshotIdentifier) The identifier for the DB cluster snapshot to restore from.The tags to be assigned to the restored DB cluster.withTags
(Collection<Tag> tags) The tags to be assigned to the restored DB cluster.withVpcSecurityGroupIds
(String... vpcSecurityGroupIds) A list of VPC security groups that the new DB cluster will belong to.withVpcSecurityGroupIds
(Collection<String> vpcSecurityGroupIds) A list of VPC security groups that the new DB cluster will belong to.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
-
RestoreDBClusterFromSnapshotRequest
public RestoreDBClusterFromSnapshotRequest()
-
-
Method Details
-
getAvailabilityZones
Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
- Returns:
- Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
-
setAvailabilityZones
Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
- Parameters:
availabilityZones
- Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
-
withAvailabilityZones
Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
NOTE: This method appends the values to the existing list (if any). Use
setAvailabilityZones(java.util.Collection)
orwithAvailabilityZones(java.util.Collection)
if you want to override the existing values.- Parameters:
availabilityZones
- Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withAvailabilityZones
public RestoreDBClusterFromSnapshotRequest withAvailabilityZones(Collection<String> availabilityZones) Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
- Parameters:
availabilityZones
- Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDBClusterIdentifier
The name of the DB cluster to create from the DB cluster snapshot. This parameter isn't case-sensitive.
Constraints:
- Must contain from 1 to 255 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
Example:
my-snapshot-id
- Parameters:
dBClusterIdentifier
- The name of the DB cluster to create from the DB cluster snapshot. This parameter isn't case-sensitive.Constraints:
- Must contain from 1 to 255 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
Example:
my-snapshot-id
-
getDBClusterIdentifier
The name of the DB cluster to create from the DB cluster snapshot. This parameter isn't case-sensitive.
Constraints:
- Must contain from 1 to 255 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
Example:
my-snapshot-id
- Returns:
- The name of the DB cluster to create from the DB cluster
snapshot. This parameter isn't case-sensitive.
Constraints:
- Must contain from 1 to 255 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
Example:
my-snapshot-id
-
withDBClusterIdentifier
The name of the DB cluster to create from the DB cluster snapshot. This parameter isn't case-sensitive.
Constraints:
- Must contain from 1 to 255 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
Example:
my-snapshot-id
- Parameters:
dBClusterIdentifier
- The name of the DB cluster to create from the DB cluster snapshot. This parameter isn't case-sensitive.Constraints:
- Must contain from 1 to 255 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
Example:
my-snapshot-id
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setSnapshotIdentifier
The identifier for the DB cluster snapshot to restore from.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
- Parameters:
snapshotIdentifier
- The identifier for the DB cluster snapshot to restore from.Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
-
getSnapshotIdentifier
The identifier for the DB cluster snapshot to restore from.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
- Returns:
- The identifier for the DB cluster snapshot to restore from.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
-
withSnapshotIdentifier
The identifier for the DB cluster snapshot to restore from.
Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
- Parameters:
snapshotIdentifier
- The identifier for the DB cluster snapshot to restore from.Constraints:
- Must contain from 1 to 63 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.
-
setEngine
The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
- Parameters:
engine
- The database engine to use for the new DB cluster.Default: The same as source
Constraint: Must be compatible with the engine of the source
-
getEngine
The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
- Returns:
- The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
-
withEngine
The database engine to use for the new DB cluster.
Default: The same as source
Constraint: Must be compatible with the engine of the source
- Parameters:
engine
- The database engine to use for the new DB cluster.Default: The same as source
Constraint: Must be compatible with the engine of the source
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEngineVersion
The version of the database engine to use for the new DB cluster.
- Parameters:
engineVersion
- The version of the database engine to use for the new DB cluster.
-
getEngineVersion
The version of the database engine to use for the new DB cluster.
- Returns:
- The version of the database engine to use for the new DB cluster.
-
withEngineVersion
The version of the database engine to use for the new DB cluster.
- Parameters:
engineVersion
- The version of the database engine to use for the new DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setPort
The port number on which the new DB cluster accepts connections.
Constraints: Value must be
1150-65535
Default: The same port as the original DB cluster.
- Parameters:
port
- The port number on which the new DB cluster accepts connections.Constraints: Value must be
1150-65535
Default: The same port as the original DB cluster.
-
getPort
The port number on which the new DB cluster accepts connections.
Constraints: Value must be
1150-65535
Default: The same port as the original DB cluster.
- Returns:
- The port number on which the new DB cluster accepts connections.
Constraints: Value must be
1150-65535
Default: The same port as the original DB cluster.
-
withPort
The port number on which the new DB cluster accepts connections.
Constraints: Value must be
1150-65535
Default: The same port as the original DB cluster.
- Parameters:
port
- The port number on which the new DB cluster accepts connections.Constraints: Value must be
1150-65535
Default: The same port as the original DB cluster.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDBSubnetGroupName
The name of the DB subnet group to use for the new DB cluster.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example:
mySubnetgroup
- Parameters:
dBSubnetGroupName
- The name of the DB subnet group to use for the new DB cluster.Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example:
mySubnetgroup
-
getDBSubnetGroupName
The name of the DB subnet group to use for the new DB cluster.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example:
mySubnetgroup
- Returns:
- The name of the DB subnet group to use for the new DB cluster.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example:
mySubnetgroup
-
withDBSubnetGroupName
The name of the DB subnet group to use for the new DB cluster.
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example:
mySubnetgroup
- Parameters:
dBSubnetGroupName
- The name of the DB subnet group to use for the new DB cluster.Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example:
mySubnetgroup
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setDatabaseName
The database name for the restored DB cluster.
- Parameters:
databaseName
- The database name for the restored DB cluster.
-
getDatabaseName
The database name for the restored DB cluster.
- Returns:
- The database name for the restored DB cluster.
-
withDatabaseName
The database name for the restored DB cluster.
- Parameters:
databaseName
- The database name for the restored DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setOptionGroupName
The name of the option group to use for the restored DB cluster.
- Parameters:
optionGroupName
- The name of the option group to use for the restored DB cluster.
-
getOptionGroupName
The name of the option group to use for the restored DB cluster.
- Returns:
- The name of the option group to use for the restored DB cluster.
-
withOptionGroupName
The name of the option group to use for the restored DB cluster.
- Parameters:
optionGroupName
- The name of the option group to use for the restored DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getVpcSecurityGroupIds
A list of VPC security groups that the new DB cluster will belong to.
- Returns:
- A list of VPC security groups that the new DB cluster will belong to.
-
setVpcSecurityGroupIds
A list of VPC security groups that the new DB cluster will belong to.
- Parameters:
vpcSecurityGroupIds
- A list of VPC security groups that the new DB cluster will belong to.
-
withVpcSecurityGroupIds
A list of VPC security groups that the new DB cluster will belong to.
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 VPC security groups that the new DB cluster will belong to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withVpcSecurityGroupIds
public RestoreDBClusterFromSnapshotRequest withVpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds) A list of VPC security groups that the new DB cluster will belong to.
- Parameters:
vpcSecurityGroupIds
- A list of VPC security groups that the new DB cluster will belong to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getTags
The tags to be assigned to the restored DB cluster.
- Returns:
- The tags to be assigned to the restored DB cluster.
-
setTags
The tags to be assigned to the restored DB cluster.
- Parameters:
tags
- The tags to be assigned to the restored DB cluster.
-
withTags
The tags to be assigned to the restored DB cluster.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
orwithTags(java.util.Collection)
if you want to override the existing values.- Parameters:
tags
- The tags to be assigned to the restored DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withTags
The tags to be assigned to the restored DB cluster.
- Parameters:
tags
- The tags to be assigned to the restored DB cluster.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setKmsKeyId
The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster snapshot.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If you do not specify a value for the
KmsKeyId
parameter, then the following will occur:- If the DB cluster snapshot is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB cluster snapshot.
- If the DB cluster snapshot is not encrypted, then the restored DB cluster is not encrypted.
If
SnapshotIdentifier
refers to a DB cluster snapshot that is not encrypted, and you specify a value for theKmsKeyId
parameter, then the restore request is rejected.- Parameters:
kmsKeyId
- The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster snapshot.The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If you do not specify a value for the
KmsKeyId
parameter, then the following will occur:- If the DB cluster snapshot is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB cluster snapshot.
- If the DB cluster snapshot is not encrypted, then the restored DB cluster is not encrypted.
If
SnapshotIdentifier
refers to a DB cluster snapshot that is not encrypted, and you specify a value for theKmsKeyId
parameter, then the restore request is rejected.
-
getKmsKeyId
The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster snapshot.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If you do not specify a value for the
KmsKeyId
parameter, then the following will occur:- If the DB cluster snapshot is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB cluster snapshot.
- If the DB cluster snapshot is not encrypted, then the restored DB cluster is not encrypted.
If
SnapshotIdentifier
refers to a DB cluster snapshot that is not encrypted, and you specify a value for theKmsKeyId
parameter, then the restore request is rejected.- Returns:
- The KMS key identifier to use when restoring an encrypted DB
cluster from an encrypted DB cluster snapshot.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If you do not specify a value for the
KmsKeyId
parameter, then the following will occur:- If the DB cluster snapshot is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB cluster snapshot.
- If the DB cluster snapshot is not encrypted, then the restored DB cluster is not encrypted.
If
SnapshotIdentifier
refers to a DB cluster snapshot that is not encrypted, and you specify a value for theKmsKeyId
parameter, then the restore request is rejected.
-
withKmsKeyId
The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster snapshot.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If you do not specify a value for the
KmsKeyId
parameter, then the following will occur:- If the DB cluster snapshot is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB cluster snapshot.
- If the DB cluster snapshot is not encrypted, then the restored DB cluster is not encrypted.
If
SnapshotIdentifier
refers to a DB cluster snapshot that is not encrypted, and you specify a value for theKmsKeyId
parameter, then the restore request is rejected.- Parameters:
kmsKeyId
- The KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster snapshot.The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.
If you do not specify a value for the
KmsKeyId
parameter, then the following will occur:- If the DB cluster snapshot is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB cluster snapshot.
- If the DB cluster snapshot is not encrypted, then the restored DB cluster is not encrypted.
If
SnapshotIdentifier
refers to a DB cluster snapshot that is not encrypted, and you specify a value for theKmsKeyId
parameter, then the restore request is rejected.- 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:
-