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

Inherits:
Struct
  • Object
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",
  max_allocated_storage: 1,
  source_db_instance_automated_backups_arn: "String",
  enable_customer_owned_ip: false,
  custom_iam_instance_profile: "String",
  backup_target: "String",
  network_type: "String",
}

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.

This setting doesn't apply to RDS Custom.

Returns:

  • (Boolean)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  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)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#backup_targetString

Specifies where automated backups and manual snapshots are stored for the restored DB instance.

Possible values are `outposts` (Amazon Web Services Outposts) and `region` (Amazon Web Services Region). The default is `region`.

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

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html

Returns:

  • (String)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  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)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#custom_iam_instance_profileString

The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:

  • The profile must exist in your account.

  • The profile must have an IAM role that Amazon EC2 has permissions to assume.

  • The instance profile name and the associated IAM role name must start with the prefix `AWSRDSCustom`.

For the list of permissions required for the IAM role, see [ Configure IAM and your VPC] in the *Amazon RDS User Guide*.

This setting is required for RDS Custom.

[1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc

Returns:

  • (String)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  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 Amazon Web Services 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)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#db_nameString

The database name for the restored DB instance.

<note markdown=“1”> This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.

</note>

Returns:

  • (String)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  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.

This setting doesn't apply to RDS Custom.

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)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  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: `mydbsubnetgroup`

Returns:

  • (String)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  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 isn't enabled. For more information, see [ Deleting a DB Instance].

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

Returns:

  • (Boolean)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#domainString

Specify the Active Directory directory ID to restore the DB instance in. Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain.

This setting doesn't apply to RDS Custom.

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)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  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.

This setting doesn't apply to RDS Custom.

Returns:

  • (String)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  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*.

This setting doesn't apply to RDS Custom.

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

Returns:

  • (Array<String>)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#enable_customer_owned_ipBoolean

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.

This setting doesn't apply to RDS Custom.

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

For more information about CoIPs, see [Customer-owned IP addresses] in the *Amazon Web Services 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)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#enable_iam_database_authenticationBoolean

A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled.

This setting doesn't apply to RDS Custom.

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)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#engineString

The database engine to use for the new instance.

This setting doesn't apply to RDS Custom.

Default: The same as source

Constraint: Must be compatible with the engine of the source

Valid Values:

  • `mariadb`

  • `mysql`

  • `oracle-ee`

  • `oracle-ee-cdb`

  • `oracle-se2`

  • `oracle-se2-cdb`

  • `postgres`

  • `sqlserver-ee`

  • `sqlserver-se`

  • `sqlserver-ex`

  • `sqlserver-web`

Returns:

  • (String)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#iopsInteger

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 isn't supported.

Returns:

  • (Integer)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#license_modelString

License model information for the restored DB instance.

This setting doesn't apply to RDS Custom.

Default: Same as source.

Valid values: `license-included` | `bring-your-own-license` | `general-public-license`

Returns:

  • (String)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#max_allocated_storageInteger

The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.

For more information about this setting, including limitations that apply to it, see [ Managing capacity automatically with Amazon RDS storage autoscaling] in the *Amazon RDS User Guide*.

This setting doesn't apply to RDS Custom.

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

Returns:

  • (Integer)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#multi_azBoolean

A value that indicates whether the DB instance is a Multi-AZ deployment.

This setting doesn't apply to RDS Custom.

Constraint: You can't specify the `AvailabilityZone` parameter if the DB instance is a Multi-AZ deployment.

Returns:

  • (Boolean)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#network_typeString

The network type of the DB instance.

Valid values:

  • `IPV4`

  • `DUAL`

The network type is determined by the `DBSubnetGroup` specified for the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (`DUAL`).

For more information, see [ Working with a DB instance in a VPC] in the *Amazon RDS User Guide.*

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

Returns:

  • (String)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  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 after it is associated with a DB instance

This setting doesn't apply to RDS Custom.

Returns:

  • (String)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#portInteger

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)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  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.

This setting doesn't apply to RDS Custom.

Returns:


22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessibleBoolean

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

When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster 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)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#restore_timeTime

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 the `UseLatestRestorableTime` parameter is enabled

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

Returns:

  • (Time)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#source_db_instance_automated_backups_arnString

The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, `arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.

This setting doesn't apply to RDS Custom.

Returns:

  • (String)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#source_db_instance_identifierString

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

Constraints:

  • Must match the identifier of an existing DB instance.

^

Returns:

  • (String)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#source_dbi_resource_idString

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

Returns:

  • (String)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  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)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  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.*

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

Returns:


22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#target_db_instance_identifierString

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)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#tde_credential_arnString

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

This setting doesn't apply to RDS Custom.

Returns:

  • (String)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#tde_credential_passwordString

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

This setting doesn't apply to RDS Custom.

Returns:

  • (String)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  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.

This setting doesn't apply to RDS Custom.

Returns:

  • (Boolean)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end

#use_latest_restorable_timeBoolean

A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time.

Constraints: Can't be specified if the `RestoreTime` parameter is provided.

Returns:

  • (Boolean)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  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>)

22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
# File 'lib/aws-sdk-rds/types.rb', line 22406

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,
  :max_allocated_storage,
  :source_db_instance_automated_backups_arn,
  :enable_customer_owned_ip,
  :custom_iam_instance_profile,
  :backup_target,
  :network_type)
  SENSITIVE = []
  include Aws::Structure
end