class Aws::RDS::Types::RestoreDBInstanceToPointInTimeMessage

@see docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceToPointInTimeMessage AWS API Documentation
@return [Boolean]
instance.
Specifies whether to enable a dedicated log volume (DLV) for the DB
@!attribute [rw] dedicated_log_volume
@return [Integer]
</note>
storage for future growth.
the restore operation can succeed. You can also allocate additional
<note markdown=“1”> Be sure to allocate enough storage for your new DB instance so that
`CreateDBInstance`.
DB instance. Follow the allocation rules specified in
The amount of storage (in gibibytes) to allocate initially for the
@!attribute [rw] allocated_storage
@return [Integer]
This setting doesn’t apply to RDS Custom or Amazon Aurora.
The storage throughput value for the DB instance.
@!attribute [rw] storage_throughput
@return [String] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html * ‘DUAL`
* `IPV4`
Valid Values:
in the *Amazon RDS User Guide.*
For more information, see [ Working with a DB instance in a VPC][1]

protocol or the IPv4 and the IPv6 protocols (`DUAL`).
the DB instance. A `DBSubnetGroup` can support only the IPv4
The network type is determined by the `DBSubnetGroup` specified for
The network type of the DB instance.
@!attribute [rw] network_type
@return [String] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html Services Outposts] in the *Amazon RDS User Guide*.
For more information, see [Working with Amazon RDS on Amazon Web
Default: `region`
* `region` (Amazon Web Services Region)
* `outposts` (Amazon Web Services Outposts)
Valid Values:
the restored DB instance.
The location for storing automated backups and manual snapshots for
@!attribute [rw] backup_target
@return [String] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc This setting is required for RDS Custom.
Configure IAM and your VPC] in the *Amazon RDS User Guide*.
For the list of permissions required for the IAM role, see [
start with the prefix `AWSRDSCustom`.
* The instance profile name and the associated IAM role name must
to assume.
* The profile must have an IAM role that Amazon EC2 has permissions
* The profile must exist in your account.
meet the following requirements:
instance of an RDS Custom DB instance. The instance profile must
The instance profile associated with the underlying Amazon EC2
@!attribute [rw] custom_iam_instance_profile
@return [Boolean] : docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing [1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html addresses][2] in the *Amazon Web Services Outposts User Guide*.
For more information about CoIPs, see [Customer-owned IP
Guide*.
RDS on Amazon Web Services Outposts] in the *Amazon RDS User
For more information about RDS on Outposts, see [Working with Amazon
This setting doesn’t apply to RDS Custom.
local network.
instance from outside of its virtual private cloud (VPC) on your
cases, a CoIP can provide lower latency for connections to the DB
your Outpost subnets through your on-premises network. For some use
A CoIP provides local or external connectivity to resources in
an RDS on Outposts DB instance.
Specifies whether to enable a customer-owned IP address (CoIP) for
@!attribute [rw] enable_customer_owned_ip
@return [String]
This setting doesn’t apply to RDS Custom.
‘arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
from which to restore, for example,
The Amazon Resource Name (ARN) of the replicated automated backups
@!attribute [rw] source_db_instance_automated_backups_arn
@return [Integer] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling This setting doesn’t apply to RDS Custom.
storage autoscaling] in the *Amazon RDS User Guide*.
apply to it, see [ Managing capacity automatically with Amazon RDS
For more information about this setting, including limitations that
automatically scale the storage of the DB instance.
The upper limit in gibibytes (GiB) to which Amazon RDS can
@!attribute [rw] max_allocated_storage
@return [String]
The resource ID of the source DB instance from which to restore.
@!attribute [rw] source_dbi_resource_id
@return [Boolean] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html information, see [ Deleting a DB Instance].
By default, deletion protection isn’t enabled. For more
The database can’t be deleted when deletion protection is enabled.
Specifies whether the DB instance has deletion protection enabled.
@!attribute [rw] deletion_protection
@return [String]
* Can’t end with a hyphen or contain two consecutive hyphens.
* First character must be a letter.
* Must be 1 to 255 letters, numbers, or hyphens.
group.
* If supplied, must match the name of an existing DB parameter
Constraints:
This setting doesn’t apply to RDS Custom.
default ‘DBParameterGroup` for the specified DB engine is used.
If you do not specify a value for `DBParameterGroupName`, then the
instance.
The name of the DB parameter group to associate with this DB
@!attribute [rw] db_parameter_group_name
@return [Boolean]
This setting doesn’t apply to RDS Custom.
default processor features.
Specifies whether the DB instance class of the DB instance uses its
@!attribute [rw] use_default_processor_features
@return [Array<Types::ProcessorFeature>]
This setting doesn’t apply to RDS Custom.
DB instance class of the DB instance.
The number of CPU cores and the number of threads per core for the
@!attribute [rw] processor_features
@return [Array<String>] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch This setting doesn’t apply to RDS Custom.
Amazon CloudWatch Logs] in the *Amazon RDS User Guide*.
being used. For more information, see [Publishing Database Logs to
CloudWatch Logs. The values in the list depend on the DB engine
The list of logs that the restored DB instance is to export to
@!attribute [rw] enable_cloudwatch_logs_exports
@return [Boolean] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html RDS User Guide.*
Database Authentication for MySQL and PostgreSQL] in the *Amazon
For more information about IAM database authentication, see [ IAM
This setting doesn’t apply to RDS Custom.
default, mapping isn’t enabled.
and Access Management (IAM) accounts to database accounts. By
Specifies whether to enable mapping of Amazon Web Services Identity
@!attribute [rw] enable_iam_database_authentication
@return [Array<String>]
Example: ‘123.124.125.126,234.235.236.237`
^
controller for both entries in the list.
domain controller, use the IP address of the primary domain
* Two IP addresses must be provided. If there isn’t a secondary
Constraints:
Directory domain controllers.
The IPv4 DNS IP addresses of your primary and secondary Active
@!attribute [rw] domain_dns_ips
@return [String]
‘arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`
Example:
^
* Can’t be longer than 64 characters.
Constraints:
user joining the domain.
The ARN for the Secrets Manager secret with the credentials for the
@!attribute [rw] domain_auth_secret_arn
@return [String]
‘OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`
Example:
* Can’t be longer than 64 characters.
* Must be in the distinguished name format.
Constraints:
join.
The Active Directory organizational unit for your DB instance to
@!attribute [rw] domain_ou
@return [String]
Example: ‘mymanagedADtest.mymanagedAD.mydomain`
^
* Can’t be longer than 64 characters.
Constraints:
domain.
The fully qualified domain name (FQDN) of an Active Directory
@!attribute [rw] domain_fqdn
@return [String]
This setting doesn’t apply to RDS Custom DB instances.
Directory Service.
The name of the IAM role to use when making API calls to the
@!attribute [rw] domain_iam_role_name
@return [String] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html *Amazon RDS User Guide*.
For more information, see [ Kerberos Authentication] in the
This setting doesn’t apply to RDS Custom.
DB instances in an Active Directory Domain.
create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL
Create the domain before running this command. Currently, you can
The Active Directory directory ID to restore the DB instance in.
@!attribute [rw] domain
@return [Array<String>]
group’s VPC.
Default: The default EC2 VPC security group for the DB subnet
instance.
A list of EC2 VPC security groups to associate with this DB
@!attribute [rw] vpc_security_group_ids
@return [String]
This setting doesn’t apply to RDS Custom.
the device.
The password for the given ARN from the key store in order to access
@!attribute [rw] tde_credential_password
@return [String]
This setting doesn’t apply to RDS Custom.
TDE encryption.
The ARN from the key store with which to associate the instance for
@!attribute [rw] tde_credential_arn
@return [String]
^
value for the ‘Iops` parameter.
* If you specify `io1`, `io2`, or `gp3`, you must also include a
Constraints:
`gp2`.
Default: `io1`, if the `Iops` parameter is specified. Otherwise,
Valid Values: `gp2 | gp3 | io1 | io2 | standard`
The storage type to associate with the DB instance.
@!attribute [rw] storage_type
@return [Array<Types::Tag>] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html Resources][1] in the *Amazon RDS User Guide.*
A list of tags. For more information, see [Tagging Amazon RDS
@!attribute [rw] tags
@return [Boolean]
snapshots of the DB instance. By default, tags are not copied.
Specifies whether to copy all tags from the restored DB instance to
@!attribute [rw] copy_tags_to_snapshot
@return [String]
This setting doesn’t apply to RDS Custom.
associated with a DB instance
option group can’t be removed from a DB instance after it is
Security TDE, can’t be removed from an option group, and that
Permanent options, such as the TDE option for Oracle Advanced
The name of the option group to use for the restored DB instance.
@!attribute [rw] option_group_name
@return [Integer]
^
* Must be an integer greater than 1000.
Constraints:
This setting doesn’t apply to SQL Server.
to initially allocate for the DB instance.
The amount of Provisioned IOPS (input/output operations per second)
@!attribute [rw] iops
@return [String]
^
* Must be compatible with the engine of the source.
Constraints:
Default: The same as source
* ‘sqlserver-web`
* `sqlserver-ex`
* `sqlserver-se`
* `sqlserver-ee`
* `postgres`
* `oracle-se2-cdb`
* `oracle-se2`
* `oracle-ee-cdb`
* `oracle-ee`
* `mysql`
* `mariadb`
* `db2-se`
* `db2-ae`
Valid Values:
This setting doesn’t apply to RDS Custom.
The database engine to use for the new instance.
@!attribute [rw] engine
@return [String]
* RDS for MySQL
* RDS for MariaDB
* RDS for Db2
* RDS Custom
This parameter doesn’t apply to the following DB instances:
The database name for the restored DB instance.
@!attribute [rw] db_name
@return [String]
Default: Same as the source.
‘general-public-license`
Valid Values: `license-included` | `bring-your-own-license` |
This setting doesn’t apply to RDS Custom.
The license model information for the restored DB instance.
@!attribute [rw] license_model
@return [Boolean]
This setting doesn’t apply to RDS Custom.
to the DB instance during the maintenance window.
Specifies whether minor version upgrades are applied automatically
@!attribute [rw] auto_minor_version_upgrade
@return [Boolean]
For more information, see CreateDBInstance.
DB instance with a DNS name that resolves to a private IP address.
When the DB instance isn’t publicly accessible, it is an internal
DB cluster doesn’t permit it.
public access isn’t permitted if the security group assigned to the
cluster is ultimately controlled by the security group it uses. That
address from outside of the DB cluster’s VPC. Access to the DB
cluster’s virtual private cloud (VPC). It resolves to the public IP
(DNS) endpoint resolves to the private IP address from within the DB
When the DB cluster is publicly accessible, its Domain Name System
Specifies whether the DB instance is publicly accessible.
@!attribute [rw] publicly_accessible
@return [Boolean]
^
instance is a Multi-AZ deployment.
* You can’t specify the ‘AvailabilityZone` parameter if the DB
Constraints:
This setting doesn’t apply to RDS Custom.
Secifies whether the DB instance is a Multi-AZ deployment.
@!attribute [rw] multi_az
@return [String]
Example: ‘mydbsubnetgroup`
^
* If supplied, must match the name of an existing DB subnet group.
Constraints:
The DB subnet group name to use for the new instance.
@!attribute [rw] db_subnet_group_name
@return [String]
Example: `us-east-1a`
^
instance is a Multi-AZ deployment.
* You can’t specify the ‘AvailabilityZone` parameter if the DB
Constraints:
Default: A random, system-chosen Availability Zone.
The Availability Zone (AZ) where the DB instance will be created.
@!attribute [rw] availability_zone
@return [Integer]
^
* The value must be `1150-65535`.
Constraints:
Default: The same port as the original DB instance.
The port number on which the database accepts connections.
@!attribute [rw] port
@return [String] : docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html Default: The same DB instance class as the original DB instance.
engine, see [DB Instance Class] in the *Amazon RDS User Guide*.
the full list of DB instance classes, and availability for your
all Amazon Web Services Regions, or for all database engines. For
example db.m4.large. Not all DB instance classes are available in
The compute and memory capacity of the Amazon RDS DB instance, for
@!attribute [rw] db_instance_class
@return [Boolean]
^
* Can’t be specified if the ‘RestoreTime` parameter is provided.
Constraints:
backup time.
time. By default, the DB instance isn’t restored from the latest
Specifies whether the DB instance is restored from the latest backup
@!attribute [rw] use_latest_restorable_time
@return [Time]
Example: ‘2009-09-07T23:45:00Z`
enabled.
* Can’t be specified if the ‘UseLatestRestorableTime` parameter is
* Must be before the latest restorable time for the DB instance.
* Must be a time in Universal Coordinated Time (UTC) format.
Constraints:
The date and time to restore from.
@!attribute [rw] restore_time
@return [String]
* Can’t end with a hyphen or contain two consecutive hyphens.
* First character must be a letter.
* Must contain from 1 to 63 letters, numbers, or hyphens.
Constraints:
The name of the new DB instance to create.
@!attribute [rw] target_db_instance_identifier
@return [String]
^
* Must match the identifier of an existing DB instance.
Constraints:
The identifier of the source DB instance from which to restore.
@!attribute [rw] source_db_instance_identifier

class Aws::RDS::Types::RestoreDBInstanceToPointInTimeMessage

Namespace

Included Modules

Defined in