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

Inherits:

Struct

Object
Struct
Aws::RDS::Types::RestoreDBInstanceFromDBSnapshotMessage

show all

Includes:: Structure

Defined in:: lib/aws-sdk-rds/types.rb

Overview

Note:

When making an API call, you may pass RestoreDBInstanceFromDBSnapshotMessage data as a 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,
  enable_customer_owned_ip: false,
}

Constant Summary collapse

SENSITIVE =

[]

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_customer_owned_ip ⇒ Boolean

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.
#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.

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

#db_name ⇒ `String`

The database name for the restored DB instance.

<note markdown=“1”> This parameter doesn’t apply to the MySQL, PostgreSQL, or MariaDB engines.

</note>

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

#domain_iam_role_name ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch

Returns:

(Array<String>)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

#enable_customer_owned_ip ⇒ `Boolean`

A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.

A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.

For more information about RDS on Outposts, see [Working with Amazon RDS on AWS Outposts] in the *Amazon RDS User Guide*.

For more information about CoIPs, see [Customer-owned IP addresses] in the *AWS Outposts User Guide*.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html [2]: docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS

Returns:

(Integer)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

#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

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(Integer)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(Array<Types::ProcessorFeature>)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Array<Types::Tag>`

A list of tags. For more information, see [Tagging Amazon RDS Resources] in the *Amazon RDS User Guide.*

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html

Returns:

(Array<Types::Tag>)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

#tde_credential_arn ⇒ `String`

The ARN from the key store with which to associate the instance for TDE encryption.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

#tde_credential_password ⇒ `String`

The password for the given ARN from the key store in order to access the device.

Returns:

(String)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

#use_default_processor_features ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

(Array<String>)

# File 'lib/aws-sdk-rds/types.rb', line 18421

class RestoreDBInstanceFromDBSnapshotMessage < Struct.new(
  :db_instance_identifier,
  :db_snapshot_identifier,
  :db_instance_class,
  :port,
  :availability_zone,
  :db_subnet_group_name,
  :multi_az,
  :publicly_accessible,
  :auto_minor_version_upgrade,
  :license_model,
  :db_name,
  :engine,
  :iops,
  :option_group_name,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :copy_tags_to_snapshot,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :enable_customer_owned_ip)
  SENSITIVE = []
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#auto_minor_version_upgrade ⇒ Boolean

#availability_zone ⇒ String

#copy_tags_to_snapshot ⇒ Boolean

#db_instance_class ⇒ String

#db_instance_identifier ⇒ String

#db_name ⇒ String

#db_parameter_group_name ⇒ String

#db_snapshot_identifier ⇒ String

#db_subnet_group_name ⇒ String

#deletion_protection ⇒ Boolean

#domain ⇒ String

#domain_iam_role_name ⇒ String

#enable_cloudwatch_logs_exports ⇒ Array<String>

#enable_customer_owned_ip ⇒ Boolean

#enable_iam_database_authentication ⇒ Boolean

#engine ⇒ String

#iops ⇒ Integer

#license_model ⇒ String

#multi_az ⇒ Boolean

#option_group_name ⇒ String

#port ⇒ Integer

#processor_features ⇒ Array<Types::ProcessorFeature>

#publicly_accessible ⇒ Boolean

#storage_type ⇒ String

#tags ⇒ Array<Types::Tag>

#tde_credential_arn ⇒ String

#tde_credential_password ⇒ String

#use_default_processor_features ⇒ Boolean

#vpc_security_group_ids ⇒ Array<String>

#auto_minor_version_upgrade ⇒ `Boolean`

#availability_zone ⇒ `String`

#copy_tags_to_snapshot ⇒ `Boolean`

#db_instance_class ⇒ `String`

#db_instance_identifier ⇒ `String`

#db_name ⇒ `String`

#db_parameter_group_name ⇒ `String`

#db_snapshot_identifier ⇒ `String`

#db_subnet_group_name ⇒ `String`

#deletion_protection ⇒ `Boolean`

#domain ⇒ `String`

#domain_iam_role_name ⇒ `String`

#enable_cloudwatch_logs_exports ⇒ `Array<String>`

#enable_customer_owned_ip ⇒ `Boolean`

#enable_iam_database_authentication ⇒ `Boolean`

#engine ⇒ `String`

#iops ⇒ `Integer`

#license_model ⇒ `String`

#multi_az ⇒ `Boolean`

#option_group_name ⇒ `String`

#port ⇒ `Integer`

#processor_features ⇒ `Array<Types::ProcessorFeature>`

#publicly_accessible ⇒ `Boolean`

#storage_type ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

#tde_credential_arn ⇒ `String`

#tde_credential_password ⇒ `String`

#use_default_processor_features ⇒ `Boolean`

#vpc_security_group_ids ⇒ `Array<String>`