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

Class: Aws::RDS::Types::RestoreDBInstanceFromDBSnapshotMessage

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

Overview

Note:

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

{
  db_instance_identifier: "String", # required
  db_snapshot_identifier: "String", # required
  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",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  storage_type: "String",
  tde_credential_arn: "String",
  tde_credential_password: "String",
  domain: "String",
  copy_tags_to_snapshot: false,
  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 are applied automatically to the DB instance during the maintenance window.

Returns:

  • (Boolean)

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

#availability_zoneString

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

Returns:

  • (String)

    The EC2 Availability Zone that the DB instance is created in.

#copy_tags_to_snapshotBoolean

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

Returns:

  • (Boolean)

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

#db_instance_classString

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.

Returns:

  • (String)

    The compute and memory capacity of the Amazon RDS DB instance, for example, db.m4.large.

#db_instance_identifierString

Name of the DB instance to create from the DB snapshot. This parameter isn\'t case-sensitive.

Constraints:

  • Must contain from 1 to 63 numbers, letters, or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

Returns:

  • (String)

    Name of the DB instance to create from the DB snapshot.

#db_nameString

The database name for the restored DB instance.

This parameter doesn\'t apply to the MySQL, PostgreSQL, or MariaDB engines.

Returns:

  • (String)

    The database name for the restored DB instance.

#db_snapshot_identifierString

The identifier for the DB snapshot to restore from.

Constraints:

  • Must match the identifier of an existing DBSnapshot.

  • If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot.

Returns:

  • (String)

    The identifier for the DB snapshot to restore from.

#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, 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

Returns:

  • (Boolean)

    True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and 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. You can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

Valid Values:

  • aurora

  • aurora-postgresql

  • 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

Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second. If this parameter is not specified, the IOPS value is taken from the backup. If this parameter is set to 0, the new instance is converted to a non-PIOPS instance. The conversion takes additional time, though your DB instance is available for connections before the conversion starts.

The provisioned IOPS value must follow the requirements for your database engine. For more information, see Amazon RDS Provisioned IOPS Storage to Improve Performance.

Constraints: Must be an integer greater than 1000.

Returns:

  • (Integer)

    Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second.

#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 can\'t 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, 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

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.

Default: The same port as the original DB instance

Constraints: Value must be 1150-65535

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 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.

Returns:

  • (Boolean)

    Specifies the accessibility options for the DB instance.

#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. For more information, see Tagging Amazon RDS Resources.

Returns:

#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.