@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 Availability Zones (AZs) where instances in the restored DB cluster can be created.
|
Long |
getBacktrackWindow()
The target backtrack window, in seconds.
|
Boolean |
getCopyTagsToSnapshot()
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB
cluster.
|
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 |
getDBClusterParameterGroupName()
The name of the DB cluster parameter group to associate with this DB cluster.
|
String |
getDBSubnetGroupName()
The name of the DB subnet group to use for the new DB cluster.
|
Boolean |
getDeletionProtection()
A value that indicates whether the DB cluster has deletion protection enabled.
|
List<String> |
getEnableCloudwatchLogsExports()
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
|
Boolean |
getEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts.
|
String |
getEngine()
The database engine to use for the new DB cluster.
|
String |
getEngineMode()
The DB engine mode of the DB cluster, either
provisioned , serverless ,
parallelquery , global , or multimaster . |
String |
getEngineVersion()
The version of the database engine to use for the new DB cluster.
|
String |
getKmsKeyId()
The AWS 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.
|
ScalingConfiguration |
getScalingConfiguration()
For DB clusters in
serverless DB engine mode, the scaling properties of the DB cluster. |
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 |
isCopyTagsToSnapshot()
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB
cluster.
|
Boolean |
isDeletionProtection()
A value that indicates whether the DB cluster has deletion protection enabled.
|
Boolean |
isEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts.
|
void |
setAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
|
void |
setBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds.
|
void |
setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB
cluster.
|
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 |
setDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to associate with this DB cluster.
|
void |
setDBSubnetGroupName(String dBSubnetGroupName)
The name of the DB subnet group to use for the new DB cluster.
|
void |
setDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB cluster has deletion protection enabled.
|
void |
setEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
|
void |
setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts.
|
void |
setEngine(String engine)
The database engine to use for the new DB cluster.
|
void |
setEngineMode(String engineMode)
The DB engine mode of the DB cluster, either
provisioned , serverless ,
parallelquery , global , or multimaster . |
void |
setEngineVersion(String engineVersion)
The version of the database engine to use for the new DB cluster.
|
void |
setKmsKeyId(String kmsKeyId)
The AWS 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 |
setScalingConfiguration(ScalingConfiguration scalingConfiguration)
For DB clusters in
serverless DB engine mode, the scaling properties of the DB cluster. |
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.
|
RestoreDBClusterFromSnapshotRequest |
withAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
|
RestoreDBClusterFromSnapshotRequest |
withAvailabilityZones(String... availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
|
RestoreDBClusterFromSnapshotRequest |
withBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds.
|
RestoreDBClusterFromSnapshotRequest |
withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB
cluster.
|
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 |
withDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to associate with this DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withDBSubnetGroupName(String dBSubnetGroupName)
The name of the DB subnet group to use for the new DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB cluster has deletion protection enabled.
|
RestoreDBClusterFromSnapshotRequest |
withEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
|
RestoreDBClusterFromSnapshotRequest |
withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
|
RestoreDBClusterFromSnapshotRequest |
withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts.
|
RestoreDBClusterFromSnapshotRequest |
withEngine(String engine)
The database engine to use for the new DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withEngineMode(String engineMode)
The DB engine mode of the DB cluster, either
provisioned , serverless ,
parallelquery , global , or multimaster . |
RestoreDBClusterFromSnapshotRequest |
withEngineVersion(String engineVersion)
The version of the database engine to use for the new DB cluster.
|
RestoreDBClusterFromSnapshotRequest |
withKmsKeyId(String kmsKeyId)
The AWS 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 |
withScalingConfiguration(ScalingConfiguration scalingConfiguration)
For DB clusters in
serverless DB engine mode, the scaling properties of the DB cluster. |
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 Availability Zones (AZs) where instances in the restored DB cluster can be created.
public void setAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
availabilityZones
- Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.public RestoreDBClusterFromSnapshotRequest withAvailabilityZones(String... availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
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 Availability Zones (AZs) where instances in the restored DB cluster can be created.public RestoreDBClusterFromSnapshotRequest withAvailabilityZones(Collection<String> availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
availabilityZones
- Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.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 63 letters, numbers, or hyphens
First character must be a letter
Can't 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 63 letters, numbers, or hyphens
First character must be a letter
Can't 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 63 letters, numbers, or hyphens
First character must be a letter
Can't end with a hyphen or contain two consecutive hyphens
Example: my-snapshot-id
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Can't 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 63 letters, numbers, or hyphens
First character must be a letter
Can't 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 63 letters, numbers, or hyphens
First character must be a letter
Can't 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.
To list all of the available engine versions for aurora
(for MySQL 5.6-compatible Aurora), use the
following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql
(for MySQL 5.7-compatible Aurora), use
the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql
, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
If you aren't using the default engine version, then you must specify the engine version.
Aurora MySQL
Example: 5.6.10a
, 5.6.mysql_aurora.1.19.2
, 5.7.12
,
5.7.mysql_aurora.2.04.5
Aurora PostgreSQL
Example: 9.6.3
, 10.7
engineVersion
- The version of the database engine to use for the new DB cluster.
To list all of the available engine versions for aurora
(for MySQL 5.6-compatible Aurora),
use the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql
(for MySQL 5.7-compatible
Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql
, use the following
command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
If you aren't using the default engine version, then you must specify the engine version.
Aurora MySQL
Example: 5.6.10a
, 5.6.mysql_aurora.1.19.2
, 5.7.12
,
5.7.mysql_aurora.2.04.5
Aurora PostgreSQL
Example: 9.6.3
, 10.7
public String getEngineVersion()
The version of the database engine to use for the new DB cluster.
To list all of the available engine versions for aurora
(for MySQL 5.6-compatible Aurora), use the
following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql
(for MySQL 5.7-compatible Aurora), use
the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql
, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
If you aren't using the default engine version, then you must specify the engine version.
Aurora MySQL
Example: 5.6.10a
, 5.6.mysql_aurora.1.19.2
, 5.7.12
,
5.7.mysql_aurora.2.04.5
Aurora PostgreSQL
Example: 9.6.3
, 10.7
To list all of the available engine versions for aurora
(for MySQL 5.6-compatible Aurora),
use the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql
(for MySQL 5.7-compatible
Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql
, use the following
command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
If you aren't using the default engine version, then you must specify the engine version.
Aurora MySQL
Example: 5.6.10a
, 5.6.mysql_aurora.1.19.2
, 5.7.12
,
5.7.mysql_aurora.2.04.5
Aurora PostgreSQL
Example: 9.6.3
, 10.7
public RestoreDBClusterFromSnapshotRequest withEngineVersion(String engineVersion)
The version of the database engine to use for the new DB cluster.
To list all of the available engine versions for aurora
(for MySQL 5.6-compatible Aurora), use the
following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql
(for MySQL 5.7-compatible Aurora), use
the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql
, use the following command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
If you aren't using the default engine version, then you must specify the engine version.
Aurora MySQL
Example: 5.6.10a
, 5.6.mysql_aurora.1.19.2
, 5.7.12
,
5.7.mysql_aurora.2.04.5
Aurora PostgreSQL
Example: 9.6.3
, 10.7
engineVersion
- The version of the database engine to use for the new DB cluster.
To list all of the available engine versions for aurora
(for MySQL 5.6-compatible Aurora),
use the following command:
aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-mysql
(for MySQL 5.7-compatible
Aurora), use the following command:
aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
To list all of the available engine versions for aurora-postgresql
, use the following
command:
aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
If you aren't using the default engine version, then you must specify the engine version.
Aurora MySQL
Example: 5.6.10a
, 5.6.mysql_aurora.1.19.2
, 5.7.12
,
5.7.mysql_aurora.2.04.5
Aurora PostgreSQL
Example: 9.6.3
, 10.7
public void setPort(Integer port)
The port number on which the new DB cluster accepts connections.
Constraints: This 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: This 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: This value must be 1150-65535
Default: The same port as the original DB cluster.
Constraints: This 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: This 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: This 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 DB subnet group.
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 DB subnet group.
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 DB subnet group.
Example: mySubnetgroup
Constraints: If supplied, must match the name of an existing DB subnet group.
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 DB subnet group.
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 DB subnet group.
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 AWS 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 don't specify a value for the KmsKeyId
parameter, then the following occurs:
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
isn't encrypted, then the restored
DB cluster isn't encrypted.
kmsKeyId
- The AWS 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 don't specify a value for the KmsKeyId
parameter, then the following occurs:
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
isn't encrypted, then the
restored DB cluster isn't encrypted.
public String getKmsKeyId()
The AWS 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 don't specify a value for the KmsKeyId
parameter, then the following occurs:
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
isn't encrypted, then the restored
DB cluster isn't 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 don't specify a value for the KmsKeyId
parameter, then the following occurs:
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
isn't encrypted, then the
restored DB cluster isn't encrypted.
public RestoreDBClusterFromSnapshotRequest withKmsKeyId(String kmsKeyId)
The AWS 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 don't specify a value for the KmsKeyId
parameter, then the following occurs:
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
isn't encrypted, then the restored
DB cluster isn't encrypted.
kmsKeyId
- The AWS 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 don't specify a value for the KmsKeyId
parameter, then the following occurs:
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
isn't encrypted, then the
restored DB cluster isn't encrypted.
public void setEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to
database accounts. By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
public Boolean getEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
public RestoreDBClusterFromSnapshotRequest withEnableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
enableIAMDatabaseAuthentication
- A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to
database accounts. By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
public Boolean isEnableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
public void setBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
backtrackWindow
- The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
public Long getBacktrackWindow()
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
public RestoreDBClusterFromSnapshotRequest withBacktrackWindow(Long backtrackWindow)
The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
backtrackWindow
- The target backtrack window, in seconds. To disable backtracking, set this value to 0.
Default: 0
Constraints:
If specified, this value must be set to a number from 0 to 259,200 (72 hours).
public List<String> getEnableCloudwatchLogsExports()
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
public void setEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
enableCloudwatchLogsExports
- The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the
list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.public RestoreDBClusterFromSnapshotRequest withEnableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
NOTE: This method appends the values to the existing list (if any). Use
setEnableCloudwatchLogsExports(java.util.Collection)
or
withEnableCloudwatchLogsExports(java.util.Collection)
if you want to override the existing values.
enableCloudwatchLogsExports
- The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the
list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.public RestoreDBClusterFromSnapshotRequest withEnableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.
enableCloudwatchLogsExports
- The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the
list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide.public void setEngineMode(String engineMode)
The DB engine mode of the DB cluster, either provisioned
, serverless
,
parallelquery
, global
, or multimaster
.
engineMode
- The DB engine mode of the DB cluster, either provisioned
, serverless
,
parallelquery
, global
, or multimaster
.public String getEngineMode()
The DB engine mode of the DB cluster, either provisioned
, serverless
,
parallelquery
, global
, or multimaster
.
provisioned
, serverless
,
parallelquery
, global
, or multimaster
.public RestoreDBClusterFromSnapshotRequest withEngineMode(String engineMode)
The DB engine mode of the DB cluster, either provisioned
, serverless
,
parallelquery
, global
, or multimaster
.
engineMode
- The DB engine mode of the DB cluster, either provisioned
, serverless
,
parallelquery
, global
, or multimaster
.public void setScalingConfiguration(ScalingConfiguration scalingConfiguration)
For DB clusters in serverless
DB engine mode, the scaling properties of the DB cluster.
scalingConfiguration
- For DB clusters in serverless
DB engine mode, the scaling properties of the DB cluster.public ScalingConfiguration getScalingConfiguration()
For DB clusters in serverless
DB engine mode, the scaling properties of the DB cluster.
serverless
DB engine mode, the scaling properties of the DB cluster.public RestoreDBClusterFromSnapshotRequest withScalingConfiguration(ScalingConfiguration scalingConfiguration)
For DB clusters in serverless
DB engine mode, the scaling properties of the DB cluster.
scalingConfiguration
- For DB clusters in serverless
DB engine mode, the scaling properties of the DB cluster.public void setDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing default DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
dBClusterParameterGroupName
- The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted,
the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing default DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
public String getDBClusterParameterGroupName()
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing default DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
Constraints:
If supplied, must match the name of an existing default DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
public RestoreDBClusterFromSnapshotRequest withDBClusterParameterGroupName(String dBClusterParameterGroupName)
The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing default DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
dBClusterParameterGroupName
- The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted,
the default DB cluster parameter group for the specified engine is used.
Constraints:
If supplied, must match the name of an existing default DB cluster parameter group.
Must be 1 to 255 letters, numbers, or hyphens.
First character must be a letter.
Can't end with a hyphen or contain two consecutive hyphens.
public void setDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
deletionProtection
- A value that indicates whether the DB cluster has deletion protection enabled. The database can't be
deleted when deletion protection is enabled. By default, deletion protection is disabled.public Boolean getDeletionProtection()
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
public RestoreDBClusterFromSnapshotRequest withDeletionProtection(Boolean deletionProtection)
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
deletionProtection
- A value that indicates whether the DB cluster has deletion protection enabled. The database can't be
deleted when deletion protection is enabled. By default, deletion protection is disabled.public Boolean isDeletionProtection()
A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
public void setCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
copyTagsToSnapshot
- A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored
DB cluster. The default is not to copy them.public Boolean getCopyTagsToSnapshot()
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
public RestoreDBClusterFromSnapshotRequest withCopyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
copyTagsToSnapshot
- A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored
DB cluster. The default is not to copy them.public Boolean isCopyTagsToSnapshot()
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.
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.