Class: Aws::RDS::Types::RestoreDBInstanceToPointInTimeMessage

Inherits:

Struct

Object
Struct
Aws::RDS::Types::RestoreDBInstanceToPointInTimeMessage

show all

Includes:: Structure

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

Overview

Note:

When making an API call, you may pass RestoreDBInstanceToPointInTimeMessage data as a hash:

{
  source_db_instance_identifier: "String",
  target_db_instance_identifier: "String", # required
  restore_time: Time.now,
  use_latest_restorable_time: false,
  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",
  copy_tags_to_snapshot: false,
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
  storage_type: "String",
  tde_credential_arn: "String",
  tde_credential_password: "String",
  vpc_security_group_ids: ["String"],
  domain: "String",
  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,
  source_dbi_resource_id: "String",
}

Instance Attribute Summary collapse

#auto_minor_version_upgrade ⇒ Boolean

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

The EC2 Availability Zone that the DB instance is created in.
#copy_tags_to_snapshot ⇒ Boolean

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

The compute and memory capacity of the Amazon RDS DB instance, for example, ‘db.m4.large`.
#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_subnet_group_name ⇒ String

The DB subnet group name to use for the new instance.
#deletion_protection ⇒ Boolean

Indicates if the DB instance should have deletion protection enabled.
#domain ⇒ String

Specify the Active Directory Domain to restore the 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

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.
#engine ⇒ String

The database engine to use for the new instance.
#iops ⇒ Integer

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
#license_model ⇒ String

License model information for the restored DB instance.
#multi_az ⇒ Boolean

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

Specifies the accessibility options for the DB instance.
#restore_time ⇒ Time

The date and time to restore from.
#source_db_instance_identifier ⇒ String

The identifier of the source DB instance from which to restore.
#source_dbi_resource_id ⇒ String

The resource ID of the source DB instance from which to restore.
#storage_type ⇒ String

Specifies the storage type to be associated with the DB instance.
#tags ⇒ Array<Types::Tag>

A list of tags.
#target_db_instance_identifier ⇒ String

The name of the new DB instance to be created.
#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 specifies that the DB instance class of the DB instance uses its default processor features.
#use_latest_restorable_time ⇒ Boolean

Specifies whether (‘true`) or not (`false`) the DB instance is restored from the latest backup time.
#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`

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

Returns:

(Boolean)

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

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  include Aws::Structure
end

#availability_zone ⇒ `String`

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

Default: A random, system-chosen Availability Zone.

Constraint: You can’t specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

Example: ‘us-east-1a`

Returns:

(String)

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

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  include Aws::Structure
end

#copy_tags_to_snapshot ⇒ `Boolean`

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

Returns:

(Boolean)

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

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  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 15061

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  include Aws::Structure
end

#db_name ⇒ `String`

The database name for the restored DB instance.

<note markdown=“1”> This parameter is not used for the MySQL or MariaDB engines.

</note>

Returns:

(String)

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

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  include Aws::Structure
end

#db_parameter_group_name ⇒ `String`

The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default DBParameterGroup for the specified 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 15061

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  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 15061

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  include Aws::Structure
end

#deletion_protection ⇒ `Boolean`

Indicates if the DB instance should have deletion protection enabled. The database can’t be deleted when this value is set to true. The default is false. 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 15061

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  include Aws::Structure
end

#domain ⇒ `String`

Specify the Active Directory Domain to restore the instance in.

Returns:

(String)

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

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  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 15061

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  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 15061

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  include Aws::Structure
end

#enable_iam_database_authentication ⇒ `Boolean`

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

You can enable IAM database authentication for the following database engines

For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher

Default: ‘false`

Returns:

(Boolean)

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

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  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

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 15061

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  include Aws::Structure
end

#iops ⇒ `Integer`

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.

Constraints: Must be an integer greater than 1000.

**SQL Server**

Setting the IOPS value for the SQL Server database engine is not supported.

Returns:

(Integer)

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

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  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 15061

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  include Aws::Structure
end

#multi_az ⇒ `Boolean`

Specifies if the DB instance is a Multi-AZ deployment.

Constraint: You can’t specify the AvailabilityZone parameter if the MultiAZ parameter is set to ‘true`.

Returns:

(Boolean)

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

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  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 15061

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  include Aws::Structure
end

#port ⇒ `Integer`

The port number on which the database accepts connections.

Constraints: Value must be ‘1150-65535`

Default: The same port as the original DB instance.

Returns:

(Integer)

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

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  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 15061

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  include Aws::Structure
end

#publicly_accessible ⇒ `Boolean`

Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

Returns:

(Boolean)

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

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  include Aws::Structure
end

#restore_time ⇒ `Time`

The date and time to restore from.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

Must be before the latest restorable time for the DB instance
Can’t be specified if UseLatestRestorableTime parameter is true

Example: ‘2009-09-07T23:45:00Z`

Returns:

(Time)

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

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  include Aws::Structure
end

#source_db_instance_identifier ⇒ `String`

The identifier of the source DB instance from which to restore.

Constraints:

Must match the identifier of an existing DB instance.

Returns:

(String)

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

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  include Aws::Structure
end

#source_dbi_resource_id ⇒ `String`

The resource ID of the source DB instance from which to restore.

Returns:

(String)

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

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  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 `standard`

Returns:

(String)

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

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  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 15061

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  include Aws::Structure
end

#target_db_instance_identifier ⇒ `String`

The name of the new DB instance to be created.

Constraints:

Must contain from 1 to 63 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 15061

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  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 15061

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  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 15061

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  include Aws::Structure
end

#use_default_processor_features ⇒ `Boolean`

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

Returns:

(Boolean)

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

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  include Aws::Structure
end

#use_latest_restorable_time ⇒ `Boolean`

Specifies whether (‘true`) or not (`false`) the DB instance is restored from the latest backup time.

Default: ‘false`

Constraints: Can’t be specified if RestoreTime parameter is provided.

Returns:

(Boolean)

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

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  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 15061

class RestoreDBInstanceToPointInTimeMessage < Struct.new(
  :source_db_instance_identifier,
  :target_db_instance_identifier,
  :restore_time,
  :use_latest_restorable_time,
  :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,
  :copy_tags_to_snapshot,
  :tags,
  :storage_type,
  :tde_credential_arn,
  :tde_credential_password,
  :vpc_security_group_ids,
  :domain,
  :domain_iam_role_name,
  :enable_iam_database_authentication,
  :enable_cloudwatch_logs_exports,
  :processor_features,
  :use_default_processor_features,
  :db_parameter_group_name,
  :deletion_protection,
  :source_dbi_resource_id)
  include Aws::Structure
end

Class: Aws::RDS::Types::RestoreDBInstanceToPointInTimeMessage

Overview

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_name ⇒ String

#db_parameter_group_name ⇒ String

#db_subnet_group_name ⇒ String

#deletion_protection ⇒ Boolean

#domain ⇒ String

#domain_iam_role_name ⇒ String

#enable_cloudwatch_logs_exports ⇒ Array<String>

#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

#restore_time ⇒ Time

#source_db_instance_identifier ⇒ String

#source_dbi_resource_id ⇒ String

#storage_type ⇒ String

#tags ⇒ Array<Types::Tag>

#target_db_instance_identifier ⇒ String

#tde_credential_arn ⇒ String

#tde_credential_password ⇒ String

#use_default_processor_features ⇒ Boolean

#use_latest_restorable_time ⇒ 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_name ⇒ `String`

#db_parameter_group_name ⇒ `String`

#db_subnet_group_name ⇒ `String`

#deletion_protection ⇒ `Boolean`

#domain ⇒ `String`

#domain_iam_role_name ⇒ `String`

#enable_cloudwatch_logs_exports ⇒ `Array<String>`

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

#restore_time ⇒ `Time`

#source_db_instance_identifier ⇒ `String`

#source_dbi_resource_id ⇒ `String`

#storage_type ⇒ `String`

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

#target_db_instance_identifier ⇒ `String`

#tde_credential_arn ⇒ `String`

#tde_credential_password ⇒ `String`

#use_default_processor_features ⇒ `Boolean`

#use_latest_restorable_time ⇒ `Boolean`

#vpc_security_group_ids ⇒ `Array<String>`