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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rds/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,
}

Constant Summary collapse

SENSITIVE =
[]

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)


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

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


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

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


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

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


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

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


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

#db_nameString

The database name for the restored DB instance.

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

Returns:

  • (String)


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

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


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

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


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

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


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

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


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

#domainString

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.

Returns:

  • (String)


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

#domain_iam_role_nameString

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

Returns:

  • (String)


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

#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 RDS User Guide.

Returns:

  • (Array<String>)


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

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


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

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


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

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


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

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


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

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


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

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


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

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


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

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



18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessibleBoolean

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)


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

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


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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

Returns:



18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

#tde_credential_arnString

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

Returns:

  • (String)


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

#tde_credential_passwordString

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

Returns:

  • (String)


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

#use_default_processor_featuresBoolean

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

Returns:

  • (Boolean)


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end

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


18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 18008

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)
  SENSITIVE = []
  include Aws::Structure
end