You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::RDS::Types::DBInstance

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

Overview

Contains the details of an Amazon RDS DB instance.

This data type is used as a response element in the DescribeDBInstances action.

Instance Attribute Summary collapse

Instance Attribute Details

#allocated_storageInteger

Specifies the allocated storage size specified in gigabytes.

Returns:

  • (Integer)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#auto_minor_version_upgradeBoolean

Indicates that minor version patches are applied automatically.

Returns:

  • (Boolean)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#availability_zoneString

Specifies the name of the Availability Zone the DB instance is located in.

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#backup_retention_periodInteger

Specifies the number of days for which automatic DB snapshots are retained.

Returns:

  • (Integer)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#ca_certificate_identifierString

The identifier of the CA certificate for this DB instance.

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#character_set_nameString

If present, specifies the name of the character set that this instance is associated with.

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#copy_tags_to_snapshotBoolean

Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

Returns:

  • (Boolean)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#db_cluster_identifierString

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#db_instance_arnString

The Amazon Resource Name (ARN) for the DB instance.

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#db_instance_classString

Contains the name of the compute and memory capacity class of the DB instance.

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#db_instance_identifierString

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#db_instance_portInteger

Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.

Returns:

  • (Integer)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#db_instance_statusString

Specifies the current state of this database.

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#db_nameString

The meaning of this parameter differs according to the database engine you use. For example, this value returns MySQL, MariaDB, or PostgreSQL information when returning values from CreateDBInstanceReadReplica since Read Replicas are only supported for these engines.

MySQL, MariaDB, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Type: String

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#db_parameter_groupsArray<Types::DBParameterGroupStatus>

Provides the list of DB parameter groups applied to this DB instance.

Returns:



4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#db_security_groupsArray<Types::DBSecurityGroupMembership>

Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.



4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#db_subnet_groupTypes::DBSubnetGroup

Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.



4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#dbi_resource_idString

The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#domain_membershipsArray<Types::DomainMembership>

The Active Directory Domain membership records associated with the DB instance.

Returns:



4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#endpointTypes::Endpoint

Specifies the connection endpoint.

Returns:



4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#engineString

Provides the name of the database engine to be used for this DB instance.

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#engine_versionString

Indicates the database engine version.

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#enhanced_monitoring_resource_arnString

The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#iam_database_authentication_enabledBoolean

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

IAM database authentication can be enabled for the following database engines

  • For MySQL 5.6, minor version 5.6.34 or higher

  • For MySQL 5.7, minor version 5.7.16 or higher

  • Aurora 5.6 or higher. To enable IAM database authentication for Aurora, see DBCluster Type.

Returns:

  • (Boolean)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#instance_create_timeTime

Provides the date and time the DB instance was created.

Returns:

  • (Time)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#iopsInteger

Specifies the Provisioned IOPS (I/O operations per second) value.

Returns:

  • (Integer)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#kms_key_idString

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#latest_restorable_timeTime

Specifies the latest time to which a database can be restored with point-in-time restore.

Returns:

  • (Time)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#license_modelString

License model information for this DB instance.

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#master_usernameString

Contains the master username for the DB instance.

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#monitoring_intervalInteger

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

Returns:

  • (Integer)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#monitoring_role_arnString

The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#multi_azBoolean

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

Returns:

  • (Boolean)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#option_group_membershipsArray<Types::OptionGroupMembership>

Provides the list of option group memberships for this DB instance.

Returns:



4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#pending_modified_valuesTypes::PendingModifiedValues

Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.



4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#performance_insights_enabledBoolean

True if Performance Insights is enabled for the DB instance, and otherwise false.

Returns:

  • (Boolean)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#performance_insights_kms_key_idString

The AWS KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#preferred_backup_windowString

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#preferred_maintenance_windowString

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#promotion_tierInteger

A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster.

Returns:

  • (Integer)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#publicly_accessibleBoolean

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

Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.

  • Default VPC:true

  • VPC:false

If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance is private.

Returns:

  • (Boolean)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#read_replica_db_cluster_identifiersArray<String>

Contains one or more identifiers of Aurora DB clusters that are Read Replicas of this DB instance.

Returns:

  • (Array<String>)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#read_replica_db_instance_identifiersArray<String>

Contains one or more identifiers of the Read Replicas associated with this DB instance.

Returns:

  • (Array<String>)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#read_replica_source_db_instance_identifierString

Contains the identifier of the source DB instance if this DB instance is a Read Replica.

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#secondary_availability_zoneString

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#status_infosArray<Types::DBInstanceStatusInfo>

The status of a Read Replica. If the instance is not a Read Replica, this is blank.

Returns:



4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#storage_encryptedBoolean

Specifies whether the DB instance is encrypted.

Returns:

  • (Boolean)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#storage_typeString

Specifies the storage type associated with DB instance.

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#tde_credential_arnString

The ARN from the key store with which the instance is associated for TDE encryption.

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#timezoneString

The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.

Returns:

  • (String)


4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end

#vpc_security_groupsArray<Types::VpcSecurityGroupMembership>

Provides a list of VPC security group elements that the DB instance belongs to.



4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 4429

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :master_username,
  :db_name,
  :endpoint,
  :allocated_storage,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :db_security_groups,
  :vpc_security_groups,
  :db_parameter_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :multi_az,
  :engine_version,
  :auto_minor_version_upgrade,
  :read_replica_source_db_instance_identifier,
  :read_replica_db_instance_identifiers,
  :read_replica_db_cluster_identifiers,
  :license_model,
  :iops,
  :option_group_memberships,
  :character_set_name,
  :secondary_availability_zone,
  :publicly_accessible,
  :status_infos,
  :storage_type,
  :tde_credential_arn,
  :db_instance_port,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :domain_memberships,
  :copy_tags_to_snapshot,
  :monitoring_interval,
  :enhanced_monitoring_resource_arn,
  :monitoring_role_arn,
  :promotion_tier,
  :db_instance_arn,
  :timezone,
  :iam_database_authentication_enabled,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  include Aws::Structure
end