public static interface RestoreDbClusterFromSnapshotRequest.Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder<RestoreDbClusterFromSnapshotRequest.Builder,RestoreDbClusterFromSnapshotRequest>
Modifier and Type | Method and Description |
---|---|
RestoreDbClusterFromSnapshotRequest.Builder |
availabilityZones(Collection<String> availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
|
RestoreDbClusterFromSnapshotRequest.Builder |
availabilityZones(String... availabilityZones)
Provides the list of Availability Zones (AZs) where instances in the restored DB cluster can be created.
|
RestoreDbClusterFromSnapshotRequest.Builder |
backtrackWindow(Long backtrackWindow)
The target backtrack window, in seconds.
|
RestoreDbClusterFromSnapshotRequest.Builder |
copyTagsToSnapshot(Boolean copyTagsToSnapshot)
A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB
cluster.
|
RestoreDbClusterFromSnapshotRequest.Builder |
databaseName(String databaseName)
The database name for the restored DB cluster.
|
RestoreDbClusterFromSnapshotRequest.Builder |
dbClusterIdentifier(String dbClusterIdentifier)
The name of the DB cluster to create from the DB snapshot or DB cluster snapshot.
|
RestoreDbClusterFromSnapshotRequest.Builder |
dbClusterParameterGroupName(String dbClusterParameterGroupName)
The name of the DB cluster parameter group to associate with this DB cluster.
|
RestoreDbClusterFromSnapshotRequest.Builder |
dbSubnetGroupName(String dbSubnetGroupName)
The name of the DB subnet group to use for the new DB cluster.
|
RestoreDbClusterFromSnapshotRequest.Builder |
deletionProtection(Boolean deletionProtection)
A value that indicates whether the DB cluster has deletion protection enabled.
|
RestoreDbClusterFromSnapshotRequest.Builder |
domain(String domain)
Specify the Active Directory directory ID to restore the DB cluster in.
|
RestoreDbClusterFromSnapshotRequest.Builder |
domainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
RestoreDbClusterFromSnapshotRequest.Builder |
enableCloudwatchLogsExports(Collection<String> enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
|
RestoreDbClusterFromSnapshotRequest.Builder |
enableCloudwatchLogsExports(String... enableCloudwatchLogsExports)
The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.
|
RestoreDbClusterFromSnapshotRequest.Builder |
enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to
database accounts.
|
RestoreDbClusterFromSnapshotRequest.Builder |
engine(String engine)
The database engine to use for the new DB cluster.
|
RestoreDbClusterFromSnapshotRequest.Builder |
engineMode(String engineMode)
The DB engine mode of the DB cluster, either
provisioned , serverless ,
parallelquery , global , or multimaster . |
RestoreDbClusterFromSnapshotRequest.Builder |
engineVersion(String engineVersion)
The version of the database engine to use for the new DB cluster.
|
RestoreDbClusterFromSnapshotRequest.Builder |
kmsKeyId(String kmsKeyId)
The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster
snapshot.
|
RestoreDbClusterFromSnapshotRequest.Builder |
optionGroupName(String optionGroupName)
The name of the option group to use for the restored DB cluster.
|
RestoreDbClusterFromSnapshotRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
RestoreDbClusterFromSnapshotRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
RestoreDbClusterFromSnapshotRequest.Builder |
port(Integer port)
The port number on which the new DB cluster accepts connections.
|
default RestoreDbClusterFromSnapshotRequest.Builder |
scalingConfiguration(Consumer<ScalingConfiguration.Builder> scalingConfiguration)
For DB clusters in
serverless DB engine mode, the scaling properties of the DB cluster. |
RestoreDbClusterFromSnapshotRequest.Builder |
scalingConfiguration(ScalingConfiguration scalingConfiguration)
For DB clusters in
serverless DB engine mode, the scaling properties of the DB cluster. |
RestoreDbClusterFromSnapshotRequest.Builder |
snapshotIdentifier(String snapshotIdentifier)
The identifier for the DB snapshot or DB cluster snapshot to restore from.
|
RestoreDbClusterFromSnapshotRequest.Builder |
tags(Collection<Tag> tags)
The tags to be assigned to the restored DB cluster.
|
RestoreDbClusterFromSnapshotRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
The tags to be assigned to the restored DB cluster.
|
RestoreDbClusterFromSnapshotRequest.Builder |
tags(Tag... tags)
The tags to be assigned to the restored DB cluster.
|
RestoreDbClusterFromSnapshotRequest.Builder |
vpcSecurityGroupIds(Collection<String> vpcSecurityGroupIds)
A list of VPC security groups that the new DB cluster will belong to.
|
RestoreDbClusterFromSnapshotRequest.Builder |
vpcSecurityGroupIds(String... vpcSecurityGroupIds)
A list of VPC security groups that the new DB cluster will belong to.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
RestoreDbClusterFromSnapshotRequest.Builder availabilityZones(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.RestoreDbClusterFromSnapshotRequest.Builder availabilityZones(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.RestoreDbClusterFromSnapshotRequest.Builder dbClusterIdentifier(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
RestoreDbClusterFromSnapshotRequest.Builder snapshotIdentifier(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.
RestoreDbClusterFromSnapshotRequest.Builder engine(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
RestoreDbClusterFromSnapshotRequest.Builder engineVersion(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
RestoreDbClusterFromSnapshotRequest.Builder port(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.
RestoreDbClusterFromSnapshotRequest.Builder dbSubnetGroupName(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
RestoreDbClusterFromSnapshotRequest.Builder databaseName(String databaseName)
The database name for the restored DB cluster.
databaseName
- The database name for the restored DB cluster.RestoreDbClusterFromSnapshotRequest.Builder optionGroupName(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.RestoreDbClusterFromSnapshotRequest.Builder vpcSecurityGroupIds(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.RestoreDbClusterFromSnapshotRequest.Builder vpcSecurityGroupIds(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.RestoreDbClusterFromSnapshotRequest.Builder tags(Collection<Tag> tags)
The tags to be assigned to the restored DB cluster.
tags
- The tags to be assigned to the restored DB cluster.RestoreDbClusterFromSnapshotRequest.Builder tags(Tag... tags)
The tags to be assigned to the restored DB cluster.
tags
- The tags to be assigned to the restored DB cluster.RestoreDbClusterFromSnapshotRequest.Builder tags(Consumer<Tag.Builder>... tags)
The tags to be assigned to the restored DB cluster.
This is a convenience that creates an instance of theList.Builder
avoiding the need to create
one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its result
is passed to #tags(List)
.tags
- a consumer that will call methods on List.Builder
#tags(List)
RestoreDbClusterFromSnapshotRequest.Builder kmsKeyId(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.
RestoreDbClusterFromSnapshotRequest.Builder enableIAMDatabaseAuthentication(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.
RestoreDbClusterFromSnapshotRequest.Builder backtrackWindow(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).
RestoreDbClusterFromSnapshotRequest.Builder enableCloudwatchLogsExports(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.RestoreDbClusterFromSnapshotRequest.Builder enableCloudwatchLogsExports(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.RestoreDbClusterFromSnapshotRequest.Builder engineMode(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
.RestoreDbClusterFromSnapshotRequest.Builder scalingConfiguration(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.default RestoreDbClusterFromSnapshotRequest.Builder scalingConfiguration(Consumer<ScalingConfiguration.Builder> scalingConfiguration)
For DB clusters in serverless
DB engine mode, the scaling properties of the DB cluster.
ScalingConfiguration.Builder
avoiding the need
to create one manually via ScalingConfiguration.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and
its result is passed to scalingConfiguration(ScalingConfiguration)
.scalingConfiguration
- a consumer that will call methods on ScalingConfiguration.Builder
scalingConfiguration(ScalingConfiguration)
RestoreDbClusterFromSnapshotRequest.Builder dbClusterParameterGroupName(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.
RestoreDbClusterFromSnapshotRequest.Builder deletionProtection(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.RestoreDbClusterFromSnapshotRequest.Builder copyTagsToSnapshot(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.RestoreDbClusterFromSnapshotRequest.Builder domain(String domain)
Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created prior to this operation.
domain
- Specify the Active Directory directory ID to restore the DB cluster in. The domain must be created
prior to this operation.RestoreDbClusterFromSnapshotRequest.Builder domainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
domainIAMRoleName
- Specify the name of the IAM role to be used when making API calls to the Directory Service.RestoreDbClusterFromSnapshotRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
RestoreDbClusterFromSnapshotRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2020. All rights reserved.