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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-rds/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storageInteger

The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in ‘CreateDBInstance`.

<note markdown=“1”> Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also allocate additional storage for future growth.

</note>

Returns:

  • (Integer)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#auto_minor_version_upgradeBoolean

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


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  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.

Constraints:

  • You can’t specify the ‘AvailabilityZone` parameter if the DB instance is a Multi-AZ deployment.

^

Example: ‘us-east-1a`

Returns:

  • (String)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#backup_targetString

The location for storing automated backups and manual snapshots for the restored DB instance.

Valid Values:

  • ‘outposts` (Amazon Web Services Outposts)

  • ‘region` (Amazon Web Services Region)

Default: ‘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)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags_to_snapshotBoolean

Specifies whether to copy all tags from the restored DB instance to snapshots of the DB instance. By default, tags are not copied.

Returns:

  • (Boolean)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  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)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  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 DB instance class as the original DB instance.

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

Returns:

  • (String)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#db_nameString

The database name for the restored DB instance.

This parameter doesn’t apply to the following DB instances:

  • RDS Custom

  • RDS for Db2

  • RDS for MariaDB

  • RDS for MySQL

Returns:

  • (String)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  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 DB parameter group.

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


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  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 DB subnet group.

^

Example: ‘mydbsubnetgroup`

Returns:

  • (String)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#dedicated_log_volumeBoolean

Specifies whether to enable a dedicated log volume (DLV) for the DB instance.

Returns:

  • (Boolean)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protectionBoolean

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


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#domainString

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)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#domain_auth_secret_arnString

The ARN for the Secrets Manager secret with the credentials for the user joining the domain.

Constraints:

  • Can’t be longer than 64 characters.

^

Example: ‘arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`

Returns:

  • (String)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#domain_dns_ipsArray<String>

The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers.

Constraints:

  • Two IP addresses must be provided. If there isn’t a secondary domain controller, use the IP address of the primary domain controller for both entries in the list.

^

Example: ‘123.124.125.126,234.235.236.237`

Returns:

  • (Array<String>)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#domain_fqdnString

The fully qualified domain name (FQDN) of an Active Directory domain.

Constraints:

  • Can’t be longer than 64 characters.

^

Example: ‘mymanagedADtest.mymanagedAD.mydomain`

Returns:

  • (String)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#domain_iam_role_nameString

The name of the IAM role to use when making API calls to the Directory Service.

This setting doesn’t apply to RDS Custom DB instances.

Returns:

  • (String)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#domain_ouString

The Active Directory organizational unit for your DB instance to join.

Constraints:

  • Must be in the distinguished name format.

  • Can’t be longer than 64 characters.

Example: ‘OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`

Returns:

  • (String)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  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>)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#enable_customer_owned_ipBoolean

Specifies 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/routing.html#ip-addressing

Returns:

  • (Boolean)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#enable_iam_database_authenticationBoolean

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


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#engineString

The database engine to use for the new instance.

This setting doesn’t apply to RDS Custom.

Valid Values:

  • ‘db2-ae`

  • ‘db2-se`

  • ‘mariadb`

  • ‘mysql`

  • ‘oracle-ee`

  • ‘oracle-ee-cdb`

  • ‘oracle-se2`

  • ‘oracle-se2-cdb`

  • ‘postgres`

  • ‘sqlserver-ee`

  • ‘sqlserver-se`

  • ‘sqlserver-ex`

  • ‘sqlserver-web`

Default: The same as source

Constraints:

  • Must be compatible with the engine of the source.

^

Returns:

  • (String)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#iopsInteger

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

This setting doesn’t apply to SQL Server.

Constraints:

  • Must be an integer greater than 1000.

^

Returns:

  • (Integer)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#license_modelString

The license model information for the restored DB instance.

This setting doesn’t apply to RDS Custom.

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

Default: Same as the source.

Returns:

  • (String)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  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)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#multi_azBoolean

Secifies whether the DB instance is a Multi-AZ deployment.

This setting doesn’t apply to RDS Custom.

Constraints:

  • You can’t specify the ‘AvailabilityZone` parameter if the DB instance is a Multi-AZ deployment.

^

Returns:

  • (Boolean)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#network_typeString

The network type of the DB instance.

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

Valid Values:

  • ‘IPV4`

  • ‘DUAL`

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

Returns:

  • (String)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#option_group_nameString

The name of the option group to use 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)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#portInteger

The port number on which the database accepts connections.

Default: The same port as the original DB instance.

Constraints:

  • The value must be ‘1150-65535`.

^

Returns:

  • (Integer)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  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:



25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessibleBoolean

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


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#restore_timeTime

The date and time to restore from.

Constraints:

  • Must be a time in Universal Coordinated Time (UTC) format.

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


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  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:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.

This setting doesn’t apply to RDS Custom.

Returns:

  • (String)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  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)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#source_dbi_resource_idString

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

Returns:

  • (String)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#storage_throughputInteger

The storage throughput value for the DB instance.

This setting doesn’t apply to RDS Custom or Amazon Aurora.

Returns:

  • (Integer)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#storage_typeString

The storage type to associate with the DB instance.

Valid Values: ‘gp2 | gp3 | io1 | standard`

Default: ‘io1`, if the `Iops` parameter is specified. Otherwise, `gp2`.

Constraints:

  • If you specify ‘io1` or `gp3`, you must also include a value for the `Iops` parameter.

^

Returns:

  • (String)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  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:



25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#target_db_instance_identifierString

The name of the new DB instance to create.

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)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  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)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  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)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#use_default_processor_featuresBoolean

Specifies whether the DB instance class of the DB instance uses its default processor features.

This setting doesn’t apply to RDS Custom.

Returns:

  • (Boolean)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end

#use_latest_restorable_timeBoolean

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


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  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>)


25206
25207
25208
25209
25210
25211
25212
25213
25214
25215
25216
25217
25218
25219
25220
25221
25222
25223
25224
25225
25226
25227
25228
25229
25230
25231
25232
25233
25234
25235
25236
25237
25238
25239
25240
25241
25242
25243
25244
25245
25246
25247
25248
25249
25250
25251
25252
25253
# File 'lib/aws-sdk-rds/types.rb', line 25206

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,
  :domain_fqdn,
  :domain_ou,
  :domain_auth_secret_arn,
  :domain_dns_ips,
  :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,
  :storage_throughput,
  :allocated_storage,
  :dedicated_log_volume)
  SENSITIVE = []
  include Aws::Structure
end