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

Class: Aws::DocDB::Types::DBInstance

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

Overview

Detailed information about a DB instance.

Instance Attribute Summary collapse

Instance Attribute Details

#auto_minor_version_upgradeBoolean

Indicates that minor version patches are applied automatically.

Returns:

  • (Boolean)


1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  include Aws::Structure
end

#availability_zoneString

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

Returns:

  • (String)


1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  include Aws::Structure
end

#backup_retention_periodInteger

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

Returns:

  • (Integer)


1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  include Aws::Structure
end

#ca_certificate_identifierString

The identifier of the CA certificate for this DB instance.

Returns:

  • (String)


1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  include Aws::Structure
end

#db_cluster_identifierString

Contains the name of the DB cluster that the DB instance is a member of if the DB instance is a member of a DB cluster.

Returns:

  • (String)


1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  include Aws::Structure
end

#db_instance_arnString

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

Returns:

  • (String)


1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  include Aws::Structure
end

#db_instance_classString

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

Returns:

  • (String)


1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  include Aws::Structure
end

#db_instance_identifierString

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

Returns:

  • (String)


1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  include Aws::Structure
end

#db_instance_statusString

Specifies the current state of this database.

Returns:

  • (String)


1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  include Aws::Structure
end

#db_subnet_groupTypes::DBSubnetGroup

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



1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  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)


1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  include Aws::Structure
end

#enabled_cloudwatch_logs_exportsArray<String>

A list of log types that this DB instance is configured to export to Amazon CloudWatch Logs.

Returns:

  • (Array<String>)


1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  include Aws::Structure
end

#endpointTypes::Endpoint

Specifies the connection endpoint.

Returns:



1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  include Aws::Structure
end

#engineString

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

Returns:

  • (String)


1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  include Aws::Structure
end

#engine_versionString

Indicates the database engine version.

Returns:

  • (String)


1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  include Aws::Structure
end

#instance_create_timeTime

Provides the date and time that the DB instance was created.

Returns:

  • (Time)


1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  include Aws::Structure
end

#kms_key_idString

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

Returns:

  • (String)


1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  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)


1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  include Aws::Structure
end

#pending_modified_valuesTypes::PendingModifiedValues

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



1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  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)


1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  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)


1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  include Aws::Structure
end

#promotion_tierInteger

A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

Returns:

  • (Integer)


1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  include Aws::Structure
end

#publicly_accessibleBoolean

Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

Returns:

  • (Boolean)


1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  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:



1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  include Aws::Structure
end

#storage_encryptedBoolean

Specifies whether or not the DB instance is encrypted.

Returns:

  • (Boolean)


1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  include Aws::Structure
end

#vpc_security_groupsArray<Types::VpcSecurityGroupMembership>

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



1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1742

class DBInstance < Struct.new(
  :db_instance_identifier,
  :db_instance_class,
  :engine,
  :db_instance_status,
  :endpoint,
  :instance_create_time,
  :preferred_backup_window,
  :backup_retention_period,
  :vpc_security_groups,
  :availability_zone,
  :db_subnet_group,
  :preferred_maintenance_window,
  :pending_modified_values,
  :latest_restorable_time,
  :engine_version,
  :auto_minor_version_upgrade,
  :publicly_accessible,
  :status_infos,
  :db_cluster_identifier,
  :storage_encrypted,
  :kms_key_id,
  :dbi_resource_id,
  :ca_certificate_identifier,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports)
  include Aws::Structure
end