@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class RestoreDBClusterFromSnapshotRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
RestoreDBClusterFromSnapshotRequest() |
Modifier and Type | Method and Description |
---|---|
RestoreDBClusterFromSnapshotRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
List<String> |
getAvailabilityZones()
Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
|
String |
getDatabaseName()
The database name for the restored DB cluster.
|
String |
getDBClusterIdentifier()
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.
|
String |
getDBSubnetGroupName()
The name of the DB subnet group to use for the new DB cluster.
|
Boolean |
getEnableIAMDatabaseAuthentication()
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts, and otherwise false.
|
String |
getEngine()
The database engine to use for the new DB cluster.
|
String |
getEngineVersion()
The version of the database engine to use for the new DB cluster.
|
String |
getKmsKeyId()
The KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
|
String |
getOptionGroupName()
The name of the option group to use for the restored DB cluster.
|
Integer |
getPort()
The port number on which the new DB cluster accepts connections.
|
String |
getSnapshotIdentifier()
The identifier for the DB snapshot or DB cluster snapshot to restore from.
|
List<Tag> |
getTags()
The tags to be assigned to the restored DB cluster.
|
List<String> |
getVpcSecurityGroupIds()
A list of VPC security groups that the new DB cluster will belong to.
|
int |
hashCode() |
Boolean |
isEnableIAMDatabaseAuthentication()
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts, and otherwise false.
|
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 snapshot or DB cluster snapshot.
|
void |
setDBSubnetGroupName(String dBSubnetGroupName)
The name of the DB subnet group to use for the new DB cluster.
|
void |
setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts, and otherwise false.
|
void |
setEngine(String engine)
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 a DB snapshot or DB cluster snapshot.
|
void |
setOptionGroupName(String optionGroupName)
The name of the option group to use for the restored DB cluster.
|
void |
setPort(Integer port)
The port number on which the new DB cluster accepts connections.
|
void |
setSnapshotIdentifier(String snapshotIdentifier)
The identifier for the DB snapshot or 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.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
RestoreDBClusterFromSnapshotRequest |
withAvailabilityZones(Collection<String> availabilityZones)
Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
|
RestoreDBClusterFromSnapshotRequest |
withAvailabilityZones(String... availabilityZones)
Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
|
RestoreDBClusterFromSnapshotRequest |
withDatabaseName(String databaseName)
The database name for the restored DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withDBClusterIdentifier(String dBClusterIdentifier)
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.
|
RestoreDBClusterFromSnapshotRequest |
withDBSubnetGroupName(String dBSubnetGroupName)
The name of the DB subnet group to use for the new DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts, and otherwise false.
|
RestoreDBClusterFromSnapshotRequest |
withEngine(String engine)
The database engine to use for the new DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withEngineVersion(String engineVersion)
The version of the database engine to use for the new DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withKmsKeyId(String kmsKeyId)
The KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.
|
RestoreDBClusterFromSnapshotRequest |
withOptionGroupName(String optionGroupName)
The name of the option group to use for the restored DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withPort(Integer port)
The port number on which the new DB cluster accepts connections.
|
RestoreDBClusterFromSnapshotRequest |
withSnapshotIdentifier(String snapshotIdentifier)
The identifier for the DB snapshot or DB cluster snapshot to restore from.
|
RestoreDBClusterFromSnapshotRequest |
withTags(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(Collection<String> vpcSecurityGroupIds)
A list of VPC security groups that the new DB cluster will belong to.
|
RestoreDBClusterFromSnapshotRequest |
withVpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of VPC security groups that the new DB cluster will belong to.
|
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 List<String> getAvailabilityZones()
Provides the list of EC2 Availability Zones that instances in the restored DB cluster can be created in.
public void setAvailabilityZones(Collection<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(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(Collection<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(String dBClusterIdentifier)
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
dBClusterIdentifier
- The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't
case-sensitive.
Constraints:
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
public String getDBClusterIdentifier()
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
Constraints:
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
public RestoreDBClusterFromSnapshotRequest withDBClusterIdentifier(String dBClusterIdentifier)
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.
Constraints:
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
dBClusterIdentifier
- The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't
case-sensitive.
Constraints:
Must contain from 1 to 255 letters, numbers, or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
public void setSnapshotIdentifier(String snapshotIdentifier)
The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Must match the identifier of an existing Snapshot.
snapshotIdentifier
- The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Must match the identifier of an existing Snapshot.
public String getSnapshotIdentifier()
The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Must match the identifier of an existing Snapshot.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Must match the identifier of an existing Snapshot.
public RestoreDBClusterFromSnapshotRequest withSnapshotIdentifier(String snapshotIdentifier)
The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Must match the identifier of an existing Snapshot.
snapshotIdentifier
- The identifier for the DB snapshot or DB cluster snapshot to restore from.
You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
Constraints:
Must match the identifier of an existing Snapshot.
public void setEngine(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 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(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(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 String getEngineVersion()
The version of the database engine to use for the new DB cluster.
public RestoreDBClusterFromSnapshotRequest withEngineVersion(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(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 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(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(String dBSubnetGroupName)
The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
dBSubnetGroupName
- The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
public String getDBSubnetGroupName()
The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
public RestoreDBClusterFromSnapshotRequest withDBSubnetGroupName(String dBSubnetGroupName)
The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
dBSubnetGroupName
- The name of the DB subnet group to use for the new DB cluster.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
public void setDatabaseName(String databaseName)
The database name for the restored DB cluster.
databaseName
- The database name for the restored DB cluster.public String getDatabaseName()
The database name for the restored DB cluster.
public RestoreDBClusterFromSnapshotRequest withDatabaseName(String databaseName)
The database name for the restored DB cluster.
databaseName
- The database name for the restored DB cluster.public void setOptionGroupName(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 String getOptionGroupName()
The name of the option group to use for the restored DB cluster.
public RestoreDBClusterFromSnapshotRequest withOptionGroupName(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 List<String> getVpcSecurityGroupIds()
A list of VPC security groups that the new DB cluster will belong to.
public void setVpcSecurityGroupIds(Collection<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(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(Collection<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 List<Tag> getTags()
The tags to be assigned to the restored DB cluster.
public void setTags(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(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(String kmsKeyId)
The KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or 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 snapshot or DB cluster snapshot in SnapshotIdentifier
is encrypted, then the restored DB
cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier
is not encrypted, then the restored
DB cluster is not encrypted.
kmsKeyId
- The KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or 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 snapshot or DB cluster snapshot in SnapshotIdentifier
is encrypted, then the
restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster
snapshot.
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier
is not encrypted, then the
restored DB cluster is not encrypted.
public String getKmsKeyId()
The KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or 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 snapshot or DB cluster snapshot in SnapshotIdentifier
is encrypted, then the restored DB
cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier
is not encrypted, then the restored
DB cluster is not encrypted.
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 snapshot or DB cluster snapshot in SnapshotIdentifier
is encrypted, then the
restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster
snapshot.
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier
is not encrypted, then the
restored DB cluster is not encrypted.
public RestoreDBClusterFromSnapshotRequest withKmsKeyId(String kmsKeyId)
The KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or 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 snapshot or DB cluster snapshot in SnapshotIdentifier
is encrypted, then the restored DB
cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier
is not encrypted, then the restored
DB cluster is not encrypted.
kmsKeyId
- The KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or 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 snapshot or DB cluster snapshot in SnapshotIdentifier
is encrypted, then the
restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster
snapshot.
If the DB snapshot or DB cluster snapshot in SnapshotIdentifier
is not encrypted, then the
restored DB cluster is not encrypted.
public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
enableIAMDatabaseAuthentication
- A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to
database accounts, and otherwise false.
Default: false
public Boolean getEnableIAMDatabaseAuthentication()
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
Default: false
public RestoreDBClusterFromSnapshotRequest withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
enableIAMDatabaseAuthentication
- A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to
database accounts, and otherwise false.
Default: false
public Boolean isEnableIAMDatabaseAuthentication()
A Boolean value that is true to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
Default: false
Default: false
public String toString()
toString
in class Object
Object.toString()
public RestoreDBClusterFromSnapshotRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.