public static interface RestoreDbInstanceToPointInTimeRequest.Builder extends RdsRequest.Builder, CopyableBuilder<RestoreDbInstanceToPointInTimeRequest.Builder,RestoreDbInstanceToPointInTimeRequest>
Modifier and Type | Method and Description |
---|---|
RestoreDbInstanceToPointInTimeRequest.Builder |
autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance
window.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
availabilityZone(String availabilityZone)
The EC2 Availability Zone that the DB instance is created in.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
copyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the restored DB instance to snapshots of the DB instance, and otherwise false.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
dbInstanceClass(String dbInstanceClass)
The compute and memory capacity of the Amazon RDS DB instance, for example,
db.m4.large . |
RestoreDbInstanceToPointInTimeRequest.Builder |
dbName(String dbName)
The database name for the restored DB instance.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
dbSubnetGroupName(String dbSubnetGroupName)
The DB subnet group name to use for the new instance.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
domain(String domain)
Specify the Active Directory Domain to restore the instance in.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
domainIAMRoleName(String domainIAMRoleName)
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and
otherwise false.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
engine(String engine)
The database engine to use for the new instance.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
iops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB
instance.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
licenseModel(String licenseModel)
License model information for the restored DB instance.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
multiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
optionGroupName(String optionGroupName)
The name of the option group to be used for the restored DB instance.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
port(Integer port)
The port number on which the database accepts connections.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
publiclyAccessible(Boolean publiclyAccessible)
Specifies the accessibility options for the DB instance.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
restoreTime(Instant restoreTime)
The date and time to restore from.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
sourceDBInstanceIdentifier(String sourceDBInstanceIdentifier)
The identifier of the source DB instance from which to restore.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
storageType(String storageType)
Specifies the storage type to be associated with the DB instance.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
tags(Collection<Tag> tags)
Sets the value of the Tags property for this object.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
Sets the value of the Tags property for this object.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
tags(Tag... tags)
Sets the value of the Tags property for this object.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
targetDBInstanceIdentifier(String targetDBInstanceIdentifier)
The name of the new DB instance to be created.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
tdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which to associate the instance for TDE encryption.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
tdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the key store in order to access the device.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
useLatestRestorableTime(Boolean useLatestRestorableTime)
Specifies whether (
true ) or not (false ) the DB instance is restored from the latest
backup time. |
build
overrideConfiguration
copy
applyMutation, build
RestoreDbInstanceToPointInTimeRequest.Builder sourceDBInstanceIdentifier(String sourceDBInstanceIdentifier)
The identifier of the source DB instance from which to restore.
Constraints:
Must match the identifier of an existing DBInstance.
sourceDBInstanceIdentifier
- The identifier of the source DB instance from which to restore.
Constraints:
Must match the identifier of an existing DBInstance.
RestoreDbInstanceToPointInTimeRequest.Builder targetDBInstanceIdentifier(String targetDBInstanceIdentifier)
The name of the new DB instance to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
targetDBInstanceIdentifier
- The name of the new DB instance to be created.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
RestoreDbInstanceToPointInTimeRequest.Builder restoreTime(Instant restoreTime)
The date and time to restore from.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Cannot be specified if UseLatestRestorableTime parameter is true
Example: 2009-09-07T23:45:00Z
restoreTime
- The date and time to restore from.
Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
Constraints:
Must be before the latest restorable time for the DB instance
Cannot be specified if UseLatestRestorableTime parameter is true
Example: 2009-09-07T23:45:00Z
RestoreDbInstanceToPointInTimeRequest.Builder useLatestRestorableTime(Boolean useLatestRestorableTime)
Specifies whether (true
) or not (false
) the DB instance is restored from the latest
backup time.
Default: false
Constraints: Cannot be specified if RestoreTime parameter is provided.
useLatestRestorableTime
- Specifies whether (true
) or not (false
) the DB instance is restored from the
latest backup time.
Default: false
Constraints: Cannot be specified if RestoreTime parameter is provided.
RestoreDbInstanceToPointInTimeRequest.Builder dbInstanceClass(String dbInstanceClass)
The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large
. Not all
DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB
instance classes, and availability for your engine, see DB Instance
Class in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
dbInstanceClass
- The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large
.
Not all DB instance classes are available in all AWS Regions, or for all database engines. For the
full list of DB instance classes, and availability for your engine, see DB Instance
Class in the Amazon RDS User Guide.
Default: The same DBInstanceClass as the original DB instance.
RestoreDbInstanceToPointInTimeRequest.Builder port(Integer port)
The port number on which the database accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
port
- The port number on which the database accepts connections.
Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
RestoreDbInstanceToPointInTimeRequest.Builder availabilityZone(String availabilityZone)
The EC2 Availability Zone that the DB instance is created in.
Default: A random, system-chosen Availability Zone.
Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Example: us-east-1a
availabilityZone
- The EC2 Availability Zone that the DB instance is created in.
Default: A random, system-chosen Availability Zone.
Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.
Example: us-east-1a
RestoreDbInstanceToPointInTimeRequest.Builder dbSubnetGroupName(String dbSubnetGroupName)
The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
dbSubnetGroupName
- The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
RestoreDbInstanceToPointInTimeRequest.Builder multiAZ(Boolean multiAZ)
Specifies if the DB instance is a Multi-AZ deployment.
Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to
true
.
multiAZ
- Specifies if the DB instance is a Multi-AZ deployment.
Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to
true
.
RestoreDbInstanceToPointInTimeRequest.Builder publiclyAccessible(Boolean publiclyAccessible)
Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC:true
VPC:false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
publiclyAccessible
- Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing
instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false
specifies an internal instance with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
Default VPC:true
VPC:false
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.
RestoreDbInstanceToPointInTimeRequest.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
autoMinorVersionUpgrade
- Indicates that minor version upgrades are applied automatically to the DB instance during the
maintenance window.RestoreDbInstanceToPointInTimeRequest.Builder licenseModel(String licenseModel)
License model information for the restored DB instance.
Default: Same as source.
Valid values: license-included
| bring-your-own-license
|
general-public-license
licenseModel
- License model information for the restored DB instance.
Default: Same as source.
Valid values: license-included
| bring-your-own-license
|
general-public-license
RestoreDbInstanceToPointInTimeRequest.Builder dbName(String dbName)
The database name for the restored DB instance.
This parameter is not used for the MySQL or MariaDB engines.
dbName
- The database name for the restored DB instance. This parameter is not used for the MySQL or MariaDB engines.
RestoreDbInstanceToPointInTimeRequest.Builder engine(String engine)
The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values:
aurora
aurora-postgresql
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
engine
- The database engine to use for the new instance.
Default: The same as source
Constraint: Must be compatible with the engine of the source
Valid Values:
aurora
aurora-postgresql
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
RestoreDbInstanceToPointInTimeRequest.Builder iops(Integer iops)
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
iops
- The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the
DB instance.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
RestoreDbInstanceToPointInTimeRequest.Builder optionGroupName(String optionGroupName)
The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
optionGroupName
- The name of the option group to be used for the restored DB instance.
Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance once it is associated with a DB instance
RestoreDbInstanceToPointInTimeRequest.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)
True to copy all tags from the restored DB instance to snapshots of the DB instance, and otherwise false. The default is false.
copyTagsToSnapshot
- True to copy all tags from the restored DB instance to snapshots of the DB instance, and otherwise
false. The default is false.RestoreDbInstanceToPointInTimeRequest.Builder tags(Collection<Tag> tags)
tags
- The new value for the Tags property for this object.RestoreDbInstanceToPointInTimeRequest.Builder tags(Tag... tags)
tags
- The new value for the Tags property for this object.RestoreDbInstanceToPointInTimeRequest.Builder tags(Consumer<Tag.Builder>... tags)
List.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)
RestoreDbInstanceToPointInTimeRequest.Builder storageType(String storageType)
Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified, otherwise standard
storageType
- Specifies the storage type to be associated with the DB instance.
Valid values: standard | gp2 | io1
If you specify io1
, you must also include a value for the Iops
parameter.
Default: io1
if the Iops
parameter is specified, otherwise
standard
RestoreDbInstanceToPointInTimeRequest.Builder tdeCredentialArn(String tdeCredentialArn)
The ARN from the key store with which to associate the instance for TDE encryption.
tdeCredentialArn
- The ARN from the key store with which to associate the instance for TDE encryption.RestoreDbInstanceToPointInTimeRequest.Builder tdeCredentialPassword(String tdeCredentialPassword)
The password for the given ARN from the key store in order to access the device.
tdeCredentialPassword
- The password for the given ARN from the key store in order to access the device.RestoreDbInstanceToPointInTimeRequest.Builder domain(String domain)
Specify the Active Directory Domain to restore the instance in.
domain
- Specify the Active Directory Domain to restore the instance in.RestoreDbInstanceToPointInTimeRequest.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.RestoreDbInstanceToPointInTimeRequest.Builder enableIAMDatabaseAuthentication(Boolean enableIAMDatabaseAuthentication)
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
You can enable IAM database authentication for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher.
Default: false
enableIAMDatabaseAuthentication
- True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and
otherwise false.
You can enable IAM database authentication for the following database engines
For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher.
Default: false
RestoreDbInstanceToPointInTimeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.RestoreDbInstanceToPointInTimeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.