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
- Struct
- Aws::RDS::Types::RestoreDBInstanceFromDBSnapshotMessage
- Defined in:
- (unknown)
Overview
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
-
#auto_minor_version_upgrade ⇒ Boolean
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
-
#availability_zone ⇒ String
The Availability Zone (AZ) where the DB instance will be created.
-
#copy_tags_to_snapshot ⇒ Boolean
A value that indicates whether to copy all tags from the restored DB instance to snapshots of the DB instance.
-
#db_instance_class ⇒ String
The compute and memory capacity of the Amazon RDS DB instance, for example,
db.m4.large
. -
#db_instance_identifier ⇒ String
Name of the DB instance to create from the DB snapshot.
-
#db_name ⇒ String
The database name for the restored DB instance.
-
#db_parameter_group_name ⇒ String
The name of the DB parameter group to associate with this DB instance.
-
#db_snapshot_identifier ⇒ String
The identifier for the DB snapshot to restore from.
-
#db_subnet_group_name ⇒ String
The DB subnet group name to use for the new instance.
-
#deletion_protection ⇒ Boolean
A value that indicates whether the DB instance has deletion protection enabled.
-
#domain ⇒ String
Specify the Active Directory directory ID to restore the DB instance in.
-
#domain_iam_role_name ⇒ String
Specify the name of the IAM role to be used when making API calls to the Directory Service.
-
#enable_cloudwatch_logs_exports ⇒ Array<String>
The list of logs that the restored DB instance is to export to CloudWatch Logs.
-
#enable_iam_database_authentication ⇒ Boolean
A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
-
#engine ⇒ String
The database engine to use for the new instance.
-
#iops ⇒ Integer
Specifies the amount of provisioned IOPS for the DB instance, expressed in I/O operations per second.
-
#license_model ⇒ String
License model information for the restored DB instance.
-
#multi_az ⇒ Boolean
A value that indicates whether the DB instance is a Multi-AZ deployment.
-
#option_group_name ⇒ String
The name of the option group to be used for the restored DB instance.
-
#port ⇒ Integer
The port number on which the database accepts connections.
-
#processor_features ⇒ 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_accessible ⇒ Boolean
A value that indicates whether the DB instance is publicly accessible.
-
#storage_type ⇒ String
Specifies the storage type to be associated with the DB instance.
-
#tags ⇒ Array<Types::Tag>
A list of tags.
-
#tde_credential_arn ⇒ String
The ARN from the key store with which to associate the instance for TDE encryption.
-
#tde_credential_password ⇒ String
The password for the given ARN from the key store in order to access the device.
-
#use_default_processor_features ⇒ Boolean
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
-
#vpc_security_group_ids ⇒ Array<String>
A list of EC2 VPC security groups to associate with this DB instance.
Instance Attribute Details
#auto_minor_version_upgrade ⇒ Boolean
A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
#availability_zone ⇒ String
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
#copy_tags_to_snapshot ⇒ Boolean
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.
#db_instance_class ⇒ String
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_instance_identifier ⇒ String
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
#db_name ⇒ String
The database name for the restored DB instance.
#db_parameter_group_name ⇒ String
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.
#db_snapshot_identifier ⇒ String
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.
#db_subnet_group_name ⇒ String
The DB subnet group name to use for the new instance.
Constraints: If supplied, must match the name of an existing DBSubnetGroup.
Example: mySubnetgroup
#deletion_protection ⇒ Boolean
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.
#domain ⇒ String
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.
#domain_iam_role_name ⇒ String
Specify the name of the IAM role to be used when making API calls to the Directory Service.
#enable_cloudwatch_logs_exports ⇒ Array<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 RDS User Guide.
#enable_iam_database_authentication ⇒ Boolean
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.
#engine ⇒ String
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
#iops ⇒ Integer
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.
#license_model ⇒ String
License model information for the restored DB instance.
Default: Same as source.
Valid values: license-included
| bring-your-own-license
|
general-public-license
#multi_az ⇒ Boolean
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.
#option_group_name ⇒ String
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
#port ⇒ Integer
The port number on which the database accepts connections.
Default: The same port as the original DB instance
Constraints: Value must be 1150-65535
#processor_features ⇒ 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_accessible ⇒ Boolean
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.
#storage_type ⇒ String
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
#tags ⇒ Array<Types::Tag>
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
#tde_credential_arn ⇒ String
The ARN from the key store with which to associate the instance for TDE encryption.
#tde_credential_password ⇒ String
The password for the given ARN from the key store in order to access the device.
#use_default_processor_features ⇒ Boolean
A value that indicates whether the DB instance class of the DB instance uses its default processor features.
#vpc_security_group_ids ⇒ Array<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.