AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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",
  vpc_security_group_ids: ["String"],
  domain: "String",
  copy_tags_to_snapshot: false,
  domain_iam_role_name: "String",
  enable_iam_database_authentication: false,
  enable_cloudwatch_logs_exports: ["String"],
  processor_features: [
    {
      name: "String",
      value: "String",
    },
  ],
  use_default_processor_features: false,
  db_parameter_group_name: "String",
  deletion_protection: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#auto_minor_version_upgradeBoolean

A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

Returns:

  • (Boolean)

    A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

#availability_zoneString

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

Returns:

  • (String)

    The Availability Zone (AZ) where the DB instance will be created.

#copy_tags_to_snapshotBoolean

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.

Returns:

  • (Boolean)

    A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.

#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

  • Can\'t 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_parameter_group_nameString

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.

Returns:

  • (String)

    The name of the DB parameter group to associate with this 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.

#deletion_protectionBoolean

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.

Returns:

  • (Boolean)

    A value that indicates whether the DB instance has deletion protection enabled.

#domainString

Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.

For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.

For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.

Returns:

  • (String)

    Specify the Active Directory directory ID to restore the DB 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_cloudwatch_logs_exportsArray<String>

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 Aurora User Guide.

Returns:

  • (Array<String>)

    The list of logs that the restored DB instance is to export to CloudWatch Logs.

#enable_iam_database_authenticationBoolean

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 information about the supported DB engines, see CreateDBInstance.

For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.

Returns:

  • (Boolean)

    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.

#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. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

Valid Values:

  • 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 isn\'t 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 in the Amazon RDS User Guide.

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

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.

Returns:

  • (Boolean)

    A value that indicates whether 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.

#processor_featuresArray<Types::ProcessorFeature>

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

Returns:

  • (Array<Types::ProcessorFeature>)

    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

#publicly_accessibleBoolean

A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance isn\'t publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

Returns:

  • (Boolean)

    A value that indicates whether the DB instance is publicly accessible.

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

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 in the Amazon RDS User Guide.

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.

#use_default_processor_featuresBoolean

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

Returns:

  • (Boolean)

    A value that indicates whether the DB instance class of the DB instance uses its default processor features.

#vpc_security_group_idsArray<String>

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.

Returns:

  • (Array<String>)

    A list of EC2 VPC security groups to associate with this DB instance.