@Generated(value="software.amazon.awssdk:codegen") public final class RestoreDbInstanceToPointInTimeRequest extends RdsRequest implements ToCopyableBuilder<RestoreDbInstanceToPointInTimeRequest.Builder,RestoreDbInstanceToPointInTimeRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
RestoreDbInstanceToPointInTimeRequest.Builder |
Modifier and Type | Method and Description |
---|---|
Boolean |
autoMinorVersionUpgrade()
Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
|
String |
availabilityZone()
The EC2 Availability Zone that the DB instance is created in.
|
static RestoreDbInstanceToPointInTimeRequest.Builder |
builder() |
Boolean |
copyTagsToSnapshot()
True to copy all tags from the restored DB instance to snapshots of the DB instance, and otherwise false.
|
String |
dbInstanceClass()
The compute and memory capacity of the Amazon RDS DB instance, for example,
db.m4.large . |
String |
dbName()
The database name for the restored DB instance.
|
String |
dbSubnetGroupName()
The DB subnet group name to use for the new instance.
|
String |
domain()
Specify the Active Directory Domain to restore the instance in.
|
String |
domainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
Boolean |
enableIAMDatabaseAuthentication()
True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise
false.
|
String |
engine()
The database engine to use for the new instance.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
Integer |
iops()
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB
instance.
|
String |
licenseModel()
License model information for the restored DB instance.
|
Boolean |
multiAZ()
Specifies if the DB instance is a Multi-AZ deployment.
|
String |
optionGroupName()
The name of the option group to be used for the restored DB instance.
|
Integer |
port()
The port number on which the database accepts connections.
|
Boolean |
publiclyAccessible()
Specifies the accessibility options for the DB instance.
|
Instant |
restoreTime()
The date and time to restore from.
|
static Class<? extends RestoreDbInstanceToPointInTimeRequest.Builder> |
serializableBuilderClass() |
String |
sourceDBInstanceIdentifier()
The identifier of the source DB instance from which to restore.
|
String |
storageType()
Specifies the storage type to be associated with the DB instance.
|
List<Tag> |
tags()
Returns the value of the Tags property for this object.
|
String |
targetDBInstanceIdentifier()
The name of the new DB instance to be created.
|
String |
tdeCredentialArn()
The ARN from the key store with which to associate the instance for TDE encryption.
|
String |
tdeCredentialPassword()
The password for the given ARN from the key store in order to access the device.
|
RestoreDbInstanceToPointInTimeRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
Boolean |
useLatestRestorableTime()
Specifies whether (
true ) or not (false ) the DB instance is restored from the latest
backup time. |
overrideConfiguration
copy
public String sourceDBInstanceIdentifier()
The identifier of the source DB instance from which to restore.
Constraints:
Must match the identifier of an existing DBInstance.
Constraints:
Must match the identifier of an existing DBInstance.
public 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
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
public 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
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
public 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.
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.
public 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.
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.
public 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.
Constraints: Value must be 1150-65535
Default: The same port as the original DB instance.
public 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
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
public 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
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
public 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
.
Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to
true
.
public 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.
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.
public Boolean autoMinorVersionUpgrade()
Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.
public 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
Default: Same as source.
Valid values: license-included
| bring-your-own-license
|
general-public-license
public String dbName()
The database name for the restored DB instance.
This parameter is not used for the MySQL or MariaDB engines.
This parameter is not used for the MySQL or MariaDB engines.
public 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
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
public 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.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine is not supported.
public 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
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
public 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.
public List<Tag> tags()
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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
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
public String tdeCredentialArn()
The ARN from the key store with which to associate the instance for TDE encryption.
public String tdeCredentialPassword()
The password for the given ARN from the key store in order to access the device.
public String domain()
Specify the Active Directory Domain to restore the instance in.
public String domainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
public 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
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
public RestoreDbInstanceToPointInTimeRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<RestoreDbInstanceToPointInTimeRequest.Builder,RestoreDbInstanceToPointInTimeRequest>
toBuilder
in class RdsRequest
public static RestoreDbInstanceToPointInTimeRequest.Builder builder()
public static Class<? extends RestoreDbInstanceToPointInTimeRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.