public class RestoreDBClusterFromSnapshotRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Modifier and Type | Field and Description |
---|---|
private SdkInternalList<java.lang.String> |
availabilityZones
Provides the list of EC2 Availability Zones that instances in the
restored DB cluster can be created in.
|
private java.lang.String |
databaseName
The database name for the restored DB cluster.
|
private java.lang.String |
dBClusterIdentifier
The name of the DB cluster to create from the DB cluster snapshot.
|
private java.lang.String |
dBSubnetGroupName
The name of the DB subnet group to use for the new DB cluster.
|
private java.lang.String |
engine
The database engine to use for the new DB cluster.
|
private java.lang.String |
engineVersion
The version of the database engine to use for the new DB cluster.
|
private java.lang.String |
kmsKeyId
The KMS key identifier to use when restoring an encrypted DB cluster from
an encrypted DB cluster snapshot.
|
private java.lang.String |
optionGroupName
The name of the option group to use for the restored DB cluster.
|
private java.lang.Integer |
port
The port number on which the new DB cluster accepts connections.
|
private java.lang.String |
snapshotIdentifier
The identifier for the DB cluster snapshot to restore from.
|
private SdkInternalList<Tag> |
tags
The tags to be assigned to the restored DB cluster.
|
private SdkInternalList<java.lang.String> |
vpcSecurityGroupIds
A list of VPC security groups that the new DB cluster will belong to.
|
NOOP
Constructor and Description |
---|
RestoreDBClusterFromSnapshotRequest() |
Modifier and Type | Method and Description |
---|---|
RestoreDBClusterFromSnapshotRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.util.List<java.lang.String> |
getAvailabilityZones()
Provides the list of EC2 Availability Zones that instances in the
restored DB cluster can be created in.
|
java.lang.String |
getDatabaseName()
The database name for the restored DB cluster.
|
java.lang.String |
getDBClusterIdentifier()
The name of the DB cluster to create from the DB cluster snapshot.
|
java.lang.String |
getDBSubnetGroupName()
The name of the DB subnet group to use for the new DB cluster.
|
java.lang.String |
getEngine()
The database engine to use for the new DB cluster.
|
java.lang.String |
getEngineVersion()
The version of the database engine to use for the new DB cluster.
|
java.lang.String |
getKmsKeyId()
The KMS key identifier to use when restoring an encrypted DB cluster from
an encrypted DB cluster snapshot.
|
java.lang.String |
getOptionGroupName()
The name of the option group to use for the restored DB cluster.
|
java.lang.Integer |
getPort()
The port number on which the new DB cluster accepts connections.
|
java.lang.String |
getSnapshotIdentifier()
The identifier for the DB cluster snapshot to restore from.
|
java.util.List<Tag> |
getTags()
The tags to be assigned to the restored DB cluster.
|
java.util.List<java.lang.String> |
getVpcSecurityGroupIds()
A list of VPC security groups that the new DB cluster will belong to.
|
int |
hashCode() |
void |
setAvailabilityZones(java.util.Collection<java.lang.String> availabilityZones)
Provides the list of EC2 Availability Zones that instances in the
restored DB cluster can be created in.
|
void |
setDatabaseName(java.lang.String databaseName)
The database name for the restored DB cluster.
|
void |
setDBClusterIdentifier(java.lang.String dBClusterIdentifier)
The name of the DB cluster to create from the DB cluster snapshot.
|
void |
setDBSubnetGroupName(java.lang.String dBSubnetGroupName)
The name of the DB subnet group to use for the new DB cluster.
|
void |
setEngine(java.lang.String engine)
The database engine to use for the new DB cluster.
|
void |
setEngineVersion(java.lang.String engineVersion)
The version of the database engine to use for the new DB cluster.
|
void |
setKmsKeyId(java.lang.String kmsKeyId)
The KMS key identifier to use when restoring an encrypted DB cluster from
an encrypted DB cluster snapshot.
|
void |
setOptionGroupName(java.lang.String optionGroupName)
The name of the option group to use for the restored DB cluster.
|
void |
setPort(java.lang.Integer port)
The port number on which the new DB cluster accepts connections.
|
void |
setSnapshotIdentifier(java.lang.String snapshotIdentifier)
The identifier for the DB cluster snapshot to restore from.
|
void |
setTags(java.util.Collection<Tag> tags)
The tags to be assigned to the restored DB cluster.
|
void |
setVpcSecurityGroupIds(java.util.Collection<java.lang.String> vpcSecurityGroupIds)
A list of VPC security groups that the new DB cluster will belong to.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
RestoreDBClusterFromSnapshotRequest |
withAvailabilityZones(java.util.Collection<java.lang.String> availabilityZones)
Provides the list of EC2 Availability Zones that instances in the
restored DB cluster can be created in.
|
RestoreDBClusterFromSnapshotRequest |
withAvailabilityZones(java.lang.String... availabilityZones)
Provides the list of EC2 Availability Zones that instances in the
restored DB cluster can be created in.
|
RestoreDBClusterFromSnapshotRequest |
withDatabaseName(java.lang.String databaseName)
The database name for the restored DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withDBClusterIdentifier(java.lang.String dBClusterIdentifier)
The name of the DB cluster to create from the DB cluster snapshot.
|
RestoreDBClusterFromSnapshotRequest |
withDBSubnetGroupName(java.lang.String dBSubnetGroupName)
The name of the DB subnet group to use for the new DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withEngine(java.lang.String engine)
The database engine to use for the new DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withEngineVersion(java.lang.String engineVersion)
The version of the database engine to use for the new DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withKmsKeyId(java.lang.String kmsKeyId)
The KMS key identifier to use when restoring an encrypted DB cluster from
an encrypted DB cluster snapshot.
|
RestoreDBClusterFromSnapshotRequest |
withOptionGroupName(java.lang.String optionGroupName)
The name of the option group to use for the restored DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withPort(java.lang.Integer port)
The port number on which the new DB cluster accepts connections.
|
RestoreDBClusterFromSnapshotRequest |
withSnapshotIdentifier(java.lang.String snapshotIdentifier)
The identifier for the DB cluster snapshot to restore from.
|
RestoreDBClusterFromSnapshotRequest |
withTags(java.util.Collection<Tag> tags)
The tags to be assigned to the restored DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withTags(Tag... tags)
The tags to be assigned to the restored DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withVpcSecurityGroupIds(java.util.Collection<java.lang.String> vpcSecurityGroupIds)
A list of VPC security groups that the new DB cluster will belong to.
|
RestoreDBClusterFromSnapshotRequest |
withVpcSecurityGroupIds(java.lang.String... vpcSecurityGroupIds)
A list of VPC security groups that the new DB cluster will belong to.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
private SdkInternalList<java.lang.String> availabilityZones
Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
private java.lang.String dBClusterIdentifier
The name of the DB cluster to create from the DB cluster snapshot. This parameter isn't case-sensitive.
Constraints:
Example: my-snapshot-id
private java.lang.String snapshotIdentifier
The identifier for the DB cluster snapshot to restore from.
Constraints:
private java.lang.String 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
private java.lang.String engineVersion
The version of the database engine to use for the new DB cluster.
private java.lang.Integer 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.
private java.lang.String 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
private java.lang.String databaseName
The database name for the restored DB cluster.
private java.lang.String optionGroupName
The name of the option group to use for the restored DB cluster.
private SdkInternalList<java.lang.String> vpcSecurityGroupIds
A list of VPC security groups that the new DB cluster will belong to.
private SdkInternalList<Tag> tags
The tags to be assigned to the restored DB cluster.
private java.lang.String 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 SnapshotIdentifier
refers to a DB cluster snapshot that
is not encrypted, and you specify a value for the KmsKeyId
parameter, then the restore request is rejected.
public java.util.List<java.lang.String> getAvailabilityZones()
Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
public void setAvailabilityZones(java.util.Collection<java.lang.String> availabilityZones)
Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
availabilityZones
- Provides the list of EC2 Availability Zones that instances in the
restored DB cluster can be created in.public RestoreDBClusterFromSnapshotRequest withAvailabilityZones(java.lang.String... availabilityZones)
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)
or
withAvailabilityZones(java.util.Collection)
if you want to
override the existing values.
availabilityZones
- Provides the list of EC2 Availability Zones that instances in the
restored DB cluster can be created in.public RestoreDBClusterFromSnapshotRequest withAvailabilityZones(java.util.Collection<java.lang.String> availabilityZones)
Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
availabilityZones
- Provides the list of EC2 Availability Zones that instances in the
restored DB cluster can be created in.public void setDBClusterIdentifier(java.lang.String dBClusterIdentifier)
The name of the DB cluster to create from the DB cluster snapshot. This parameter isn't case-sensitive.
Constraints:
Example: my-snapshot-id
dBClusterIdentifier
- The name of the DB cluster to create from the DB cluster snapshot.
This parameter isn't case-sensitive.
Constraints:
Example: my-snapshot-id
public java.lang.String getDBClusterIdentifier()
The name of the DB cluster to create from the DB cluster snapshot. This parameter isn't case-sensitive.
Constraints:
Example: my-snapshot-id
Constraints:
Example: my-snapshot-id
public RestoreDBClusterFromSnapshotRequest withDBClusterIdentifier(java.lang.String dBClusterIdentifier)
The name of the DB cluster to create from the DB cluster snapshot. This parameter isn't case-sensitive.
Constraints:
Example: my-snapshot-id
dBClusterIdentifier
- The name of the DB cluster to create from the DB cluster snapshot.
This parameter isn't case-sensitive.
Constraints:
Example: my-snapshot-id
public void setSnapshotIdentifier(java.lang.String snapshotIdentifier)
The identifier for the DB cluster snapshot to restore from.
Constraints:
snapshotIdentifier
- The identifier for the DB cluster snapshot to restore from.
Constraints:
public java.lang.String getSnapshotIdentifier()
The identifier for the DB cluster snapshot to restore from.
Constraints:
Constraints:
public RestoreDBClusterFromSnapshotRequest withSnapshotIdentifier(java.lang.String snapshotIdentifier)
The identifier for the DB cluster snapshot to restore from.
Constraints:
snapshotIdentifier
- The identifier for the DB cluster snapshot to restore from.
Constraints:
public void setEngine(java.lang.String 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
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
public java.lang.String 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
Default: The same as source
Constraint: Must be compatible with the engine of the source
public RestoreDBClusterFromSnapshotRequest withEngine(java.lang.String 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
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
public void setEngineVersion(java.lang.String engineVersion)
The version of the database engine to use for the new DB cluster.
engineVersion
- The version of the database engine to use for the new DB cluster.public java.lang.String getEngineVersion()
The version of the database engine to use for the new DB cluster.
public RestoreDBClusterFromSnapshotRequest withEngineVersion(java.lang.String engineVersion)
The version of the database engine to use for the new DB cluster.
engineVersion
- The version of the database engine to use for the new DB cluster.public void setPort(java.lang.Integer 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.
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.
public java.lang.Integer 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.
Constraints: Value must be 1150-65535
Default: The same port as the original DB cluster.
public RestoreDBClusterFromSnapshotRequest withPort(java.lang.Integer 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.
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.
public void setDBSubnetGroupName(java.lang.String 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
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
public java.lang.String 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
Constraints: Must contain no more than 255 alphanumeric characters, periods, underscores, spaces, or hyphens. Must not be default.
Example: mySubnetgroup
public RestoreDBClusterFromSnapshotRequest withDBSubnetGroupName(java.lang.String 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
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
public void setDatabaseName(java.lang.String databaseName)
The database name for the restored DB cluster.
databaseName
- The database name for the restored DB cluster.public java.lang.String getDatabaseName()
The database name for the restored DB cluster.
public RestoreDBClusterFromSnapshotRequest withDatabaseName(java.lang.String databaseName)
The database name for the restored DB cluster.
databaseName
- The database name for the restored DB cluster.public void setOptionGroupName(java.lang.String optionGroupName)
The name of the option group to use for the restored DB cluster.
optionGroupName
- The name of the option group to use for the restored DB cluster.public java.lang.String getOptionGroupName()
The name of the option group to use for the restored DB cluster.
public RestoreDBClusterFromSnapshotRequest withOptionGroupName(java.lang.String optionGroupName)
The name of the option group to use for the restored DB cluster.
optionGroupName
- The name of the option group to use for the restored DB cluster.public java.util.List<java.lang.String> getVpcSecurityGroupIds()
A list of VPC security groups that the new DB cluster will belong to.
public void setVpcSecurityGroupIds(java.util.Collection<java.lang.String> vpcSecurityGroupIds)
A list of VPC security groups that the new DB cluster will belong to.
vpcSecurityGroupIds
- A list of VPC security groups that the new DB cluster will belong
to.public RestoreDBClusterFromSnapshotRequest withVpcSecurityGroupIds(java.lang.String... vpcSecurityGroupIds)
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)
or
withVpcSecurityGroupIds(java.util.Collection)
if you want to
override the existing values.
vpcSecurityGroupIds
- A list of VPC security groups that the new DB cluster will belong
to.public RestoreDBClusterFromSnapshotRequest withVpcSecurityGroupIds(java.util.Collection<java.lang.String> vpcSecurityGroupIds)
A list of VPC security groups that the new DB cluster will belong to.
vpcSecurityGroupIds
- A list of VPC security groups that the new DB cluster will belong
to.public java.util.List<Tag> getTags()
The tags to be assigned to the restored DB cluster.
public void setTags(java.util.Collection<Tag> tags)
The tags to be assigned to the restored DB cluster.
tags
- The tags to be assigned to the restored DB cluster.public RestoreDBClusterFromSnapshotRequest withTags(Tag... tags)
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)
or
withTags(java.util.Collection)
if you want to override the
existing values.
tags
- The tags to be assigned to the restored DB cluster.public RestoreDBClusterFromSnapshotRequest withTags(java.util.Collection<Tag> tags)
The tags to be assigned to the restored DB cluster.
tags
- The tags to be assigned to the restored DB cluster.public void setKmsKeyId(java.lang.String 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 SnapshotIdentifier
refers to a DB cluster snapshot that
is not encrypted, and you specify a value for the KmsKeyId
parameter, then the restore request is rejected.
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 SnapshotIdentifier
refers to a DB cluster snapshot
that is not encrypted, and you specify a value for the
KmsKeyId
parameter, then the restore request is
rejected.
public java.lang.String 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 SnapshotIdentifier
refers to a DB cluster snapshot that
is not encrypted, and you specify a value for the KmsKeyId
parameter, then the restore request is rejected.
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 SnapshotIdentifier
refers to a DB cluster
snapshot that is not encrypted, and you specify a value for the
KmsKeyId
parameter, then the restore request is
rejected.
public RestoreDBClusterFromSnapshotRequest withKmsKeyId(java.lang.String 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 SnapshotIdentifier
refers to a DB cluster snapshot that
is not encrypted, and you specify a value for the KmsKeyId
parameter, then the restore request is rejected.
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 SnapshotIdentifier
refers to a DB cluster snapshot
that is not encrypted, and you specify a value for the
KmsKeyId
parameter, then the restore request is
rejected.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public RestoreDBClusterFromSnapshotRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()