You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::RDS::Types::RestoreDBInstanceToPointInTimeMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing RestoreDBInstanceToPointInTimeMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  source_db_instance_identifier: "String", # required
  target_db_instance_identifier: "String", # required
  restore_time: Time.now,
  use_latest_restorable_time: false,
  db_instance_class: "String",
  port: 1,
  availability_zone: "String",
  db_subnet_group_name: "String",
  multi_az: false,
  publicly_accessible: false,
  auto_minor_version_upgrade: false,
  license_model: "String",
  db_name: "String",
  engine: "String",
  iops: 1,
  option_group_name: "String",
  copy_tags_to_snapshot: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  storage_type: "String",
  tde_credential_arn: "String",
  tde_credential_password: "String",
  domain: "String",
  domain_iam_role_name: "String",
  enable_iam_database_authentication: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#auto_minor_version_upgradeBoolean

Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.

Returns:

  • (Boolean)

    Indicates that minor version upgrades will be applied automatically to the DB instance during the maintenance window.

#availability_zoneString

The EC2 Availability Zone that the database instance will be created in.

Default: A random, system-chosen Availability Zone.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Example: us-east-1a

Returns:

  • (String)

    The EC2 Availability Zone that the database instance will be created in.

#copy_tags_to_snapshotBoolean

True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false. The default is false.

Returns:

  • (Boolean)

    True to copy all tags from the restored DB instance to snapshots of the DB instance; otherwise false.

#db_instance_classString

The compute and memory capacity of the Amazon RDS DB instance.

Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large

Default: The same DBInstanceClass as the original DB instance.

Returns:

  • (String)

    The compute and memory capacity of the Amazon RDS DB instance.

#db_nameString

The database name for the restored DB instance.

This parameter is not used for the MySQL or MariaDB engines.

Returns:

  • (String)

    The database name for the restored DB instance.

#db_subnet_group_nameString

The DB subnet group name to use for the new instance.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

Returns:

  • (String)

    The DB subnet group name to use for the new instance.

#domainString

Specify the Active Directory Domain to restore the instance in.

Returns:

  • (String)

    Specify the Active Directory Domain to restore the instance in.

#domain_iam_role_nameString

Specify the name of the IAM role to be used when making API calls to the Directory Service.

Returns:

  • (String)

    Specify the name of the IAM role to be used when making API calls to the Directory Service.

#enable_iam_database_authenticationBoolean

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; 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

Returns:

  • (Boolean)

    True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts; otherwise false.

#engineString

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

  • mariadb

  • mysql

  • oracle-ee

  • oracle-se2

  • oracle-se1

  • oracle-se

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

Returns:

  • (String)

    The database engine to use for the new instance.

#iopsInteger

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.

Returns:

  • (Integer)

    The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

#license_modelString

License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

Returns:

  • (String)

    License model information for the restored DB instance.

#multi_azBoolean

Specifies if the DB instance is a Multi-AZ deployment.

Constraint: You cannot specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Returns:

  • (Boolean)

    Specifies if the DB instance is a Multi-AZ deployment.

#option_group_nameString

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, cannot be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance

Returns:

  • (String)

    The name of the option group to be used for the restored DB instance.

#portInteger

The port number on which the database accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB instance.

Returns:

  • (Integer)

    The port number on which the database accepts connections.

#publicly_accessibleBoolean

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 will be 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 will be private.

Returns:

  • (Boolean)

    Specifies the accessibility options for the DB instance.

#restore_timeTime

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

Returns:

  • (Time)

    The date and time to restore from.

#source_db_instance_identifierString

The identifier of the source DB instance from which to restore.

Constraints:

  • Must match the identifier of an existing DBInstance.

^

Returns:

  • (String)

    The identifier of the source DB instance from which to restore.

#storage_typeString

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

Returns:

  • (String)

    Specifies the storage type to be associated with the DB instance.

#tagsArray<Types::Tag>

A list of tags.

Returns:

#target_db_instance_identifierString

The name of the new database 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

Returns:

  • (String)

    The name of the new database instance to be created.

#tde_credential_arnString

The ARN from the Key Store with which to associate the instance for TDE encryption.

Returns:

  • (String)

    The ARN from the Key Store with which to associate the instance for TDE encryption.

#tde_credential_passwordString

The password for the given ARN from the Key Store in order to access the device.

Returns:

  • (String)

    The password for the given ARN from the Key Store in order to access the device.

#use_latest_restorable_timeBoolean

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.

Returns:

  • (Boolean)

    Specifies whether (true) or not (false) the DB instance is restored from the latest backup time.