@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()
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the
maintenance window.
|
String |
availabilityZone()
The Availability Zone (AZ) where the DB instance will be created.
|
static RestoreDbInstanceToPointInTimeRequest.Builder |
builder() |
Boolean |
copyTagsToSnapshot()
A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.
|
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 |
dbParameterGroupName()
The name of the DB parameter group to associate with this DB instance.
|
String |
dbSubnetGroupName()
The DB subnet group name to use for the new instance.
|
Boolean |
deletionProtection()
A value that indicates whether the DB instance has deletion protection enabled.
|
String |
domain()
Specify the Active Directory directory ID to restore the DB instance in.
|
String |
domainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
List<String> |
enableCloudwatchLogsExports()
The list of logs that the restored DB instance is to export to CloudWatch Logs.
|
Boolean |
enableCustomerOwnedIp()
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
|
Boolean |
enableIAMDatabaseAuthentication()
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database
accounts.
|
String |
engine()
The database engine to use for the new instance.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasEnableCloudwatchLogsExports()
Returns true if the EnableCloudwatchLogsExports property was specified by the sender (it may be empty), or false
if the sender did not specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasProcessorFeatures()
Returns true if the ProcessorFeatures property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
boolean |
hasVpcSecurityGroupIds()
Returns true if the VpcSecurityGroupIds property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
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.
|
Integer |
maxAllocatedStorage()
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
|
Boolean |
multiAZ()
A value that indicates whether 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.
|
List<ProcessorFeature> |
processorFeatures()
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
Boolean |
publiclyAccessible()
A value that indicates whether the DB instance is publicly accessible.
|
Instant |
restoreTime()
The date and time to restore from.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends RestoreDbInstanceToPointInTimeRequest.Builder> |
serializableBuilderClass() |
String |
sourceDBInstanceAutomatedBackupsArn()
The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE. |
String |
sourceDBInstanceIdentifier()
The identifier of the source DB instance from which to restore.
|
String |
sourceDbiResourceId()
The resource ID 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() |
String |
toString()
Returns a string representation of this object.
|
Boolean |
useDefaultProcessorFeatures()
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
|
Boolean |
useLatestRestorableTime()
A value that indicates whether the DB instance is restored from the latest backup time.
|
List<String> |
vpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with this DB instance.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String sourceDBInstanceIdentifier()
The identifier of the source DB instance from which to restore.
Constraints:
Must match the identifier of an existing DB instance.
Constraints:
Must match the identifier of an existing DB instance.
public final 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
Can't 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
Can't end with a hyphen or contain two consecutive hyphens
public final 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
Can't be specified if the UseLatestRestorableTime parameter is enabled
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
Can't be specified if the UseLatestRestorableTime parameter is enabled
Example: 2009-09-07T23:45:00Z
public final Boolean useLatestRestorableTime()
A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.
Constraints: Can't be specified if the RestoreTime parameter is provided.
Constraints: Can't be specified if the RestoreTime parameter is provided.
public final 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 final 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 final String availabilityZone()
The Availability Zone (AZ) where the DB instance will be created.
Default: A random, system-chosen Availability Zone.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ
deployment.
Example: us-east-1a
Default: A random, system-chosen Availability Zone.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a
Multi-AZ deployment.
Example: us-east-1a
public final 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 final Boolean multiAZ()
A value that indicates whether the DB instance is a Multi-AZ deployment.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ
deployment.
Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a
Multi-AZ deployment.
public final Boolean publiclyAccessible()
A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
public final Boolean autoMinorVersionUpgrade()
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
public final 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 final String dbName()
The database name for the restored DB instance.
This parameter isn't used for the MySQL or MariaDB engines.
This parameter isn't used for the MySQL or MariaDB engines.
public final 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:
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:
mariadb
mysql
oracle-ee
oracle-se2
oracle-se1
oracle-se
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
public final 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 isn't supported.
Constraints: Must be an integer greater than 1000.
SQL Server
Setting the IOPS value for the SQL Server database engine isn't supported.
public final 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 final Boolean copyTagsToSnapshot()
A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.
public final boolean hasTags()
public final List<Tag> tags()
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTags() to see if a value was sent in this field.
public final 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 gp2
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 gp2
public final String tdeCredentialArn()
The ARN from the key store with which to associate the instance for TDE encryption.
public final String tdeCredentialPassword()
The password for the given ARN from the key store in order to access the device.
public final boolean hasVpcSecurityGroupIds()
public final List<String> vpcSecurityGroupIds()
A list of EC2 VPC security groups to associate with this DB instance.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasVpcSecurityGroupIds() to see if a value was sent in this field.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
public final String domain()
Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
public final String domainIAMRoleName()
Specify the name of the IAM role to be used when making API calls to the Directory Service.
public final 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 about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
public final boolean hasEnableCloudwatchLogsExports()
public final List<String> enableCloudwatchLogsExports()
The list of logs that the restored DB instance is to export to 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 RDS User Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasEnableCloudwatchLogsExports() to see if a value was sent in this field.
public final boolean hasProcessorFeatures()
public final List<ProcessorFeature> processorFeatures()
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasProcessorFeatures() to see if a value was sent in this field.
public final Boolean useDefaultProcessorFeatures()
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
public final String dbParameterGroupName()
The name of the DB parameter group to associate with this DB instance.
If you do not specify a value for DBParameterGroupName, then the default
DBParameterGroup for the specified DB engine is used.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
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.
If you do not specify a value for DBParameterGroupName, then the default
DBParameterGroup for the specified DB engine is used.
Constraints:
If supplied, must match the name of an existing DBParameterGroup.
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 final Boolean deletionProtection()
A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see Deleting a DB Instance.
public final String sourceDbiResourceId()
The resource ID of the source DB instance from which to restore.
public final Integer maxAllocatedStorage()
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
public final String sourceDBInstanceAutomatedBackupsArn()
The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example,
arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.public final Boolean enableCustomerOwnedIp()
A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the AWS Outposts User Guide.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on AWS Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the AWS Outposts User Guide.
public RestoreDbInstanceToPointInTimeRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<RestoreDbInstanceToPointInTimeRequest.Builder,RestoreDbInstanceToPointInTimeRequest>toBuilder in class RdsRequestpublic static RestoreDbInstanceToPointInTimeRequest.Builder builder()
public static Class<? extends RestoreDbInstanceToPointInTimeRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2021. All rights reserved.