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

Inherits:

Struct

• Object
• Struct
• Aws::DocDB::Types::DBInstance

Includes:

Structure

Defined in:

lib/aws-sdk-docdb/types.rb

Overview

Detailed information about an instance.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #auto_minor_version_upgrade ⇒ Boolean

  Does not apply.

• #availability_zone ⇒ String

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

• #backup_retention_period ⇒ Integer

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

• #ca_certificate_identifier ⇒ String

  The identifier of the CA certificate for this DB instance.

• #certificate_details ⇒ Types::CertificateDetails

  The details of the DB instance’s server certificate.

• #copy_tags_to_snapshot ⇒ Boolean

  A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance.

• #db_cluster_identifier ⇒ String

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

• #db_instance_arn ⇒ String

  The Amazon Resource Name (ARN) for the instance.

• #db_instance_class ⇒ String

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

• #db_instance_identifier ⇒ String

  Contains a user-provided database identifier.

• #db_instance_status ⇒ String

  Specifies the current state of this database.

• #db_subnet_group ⇒ Types::DBSubnetGroup

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

• #dbi_resource_id ⇒ String

  The Amazon Web Services Region-unique, immutable identifier for the instance.

• #enabled_cloudwatch_logs_exports ⇒ Array<String>

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

• #endpoint ⇒ Types::Endpoint

  Specifies the connection endpoint.

• #engine ⇒ String

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

• #engine_version ⇒ String

  Indicates the database engine version.

• #instance_create_time ⇒ Time

  Provides the date and time that the instance was created.

• #kms_key_id ⇒ String

  If ‘StorageEncrypted` is `true`, the KMS key identifier for the encrypted instance.

• #latest_restorable_time ⇒ Time

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

• #pending_modified_values ⇒ Types::PendingModifiedValues

  Specifies that changes to the instance are pending.

• #performance_insights_enabled ⇒ Boolean

  Set to ‘true` if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise `false`.

• #performance_insights_kms_key_id ⇒ String

  The KMS key identifier for encryption of Performance Insights data.

• #preferred_backup_window ⇒ String

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

• #preferred_maintenance_window ⇒ String

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

• #promotion_tier ⇒ Integer

  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.

• #publicly_accessible ⇒ Boolean

  Not supported.

• #status_infos ⇒ Array<Types::DBInstanceStatusInfo>

  The status of a read replica.

• #storage_encrypted ⇒ Boolean

  Specifies whether or not the instance is encrypted.

• #vpc_security_groups ⇒ Array<Types::VpcSecurityGroupMembership>

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

Instance Attribute Details

#auto_minor_version_upgrade ⇒ Boolean

Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

Returns:

• (Boolean)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#availability_zone ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#backup_retention_period ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#ca_certificate_identifier ⇒ String

The identifier of the CA certificate for this DB instance.

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_details ⇒ Types::CertificateDetails

The details of the DB instance’s server certificate.

Returns:

• (Types::CertificateDetails)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags_to_snapshot ⇒ Boolean

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

Returns:

• (Boolean)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#db_cluster_identifier ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_arn ⇒ String

The Amazon Resource Name (ARN) for the instance.

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_class ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_identifier ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#db_instance_status ⇒ String

Specifies the current state of this database.

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#db_subnet_group ⇒ Types::DBSubnetGroup

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

Returns:

• (Types::DBSubnetGroup)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#dbi_resource_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#enabled_cloudwatch_logs_exports ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint ⇒ Types::Endpoint

Specifies the connection endpoint.

Returns:

• (Types::Endpoint)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#engine ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ String

Indicates the database engine version.

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#instance_create_time ⇒ Time

Provides the date and time that the instance was created.

Returns:

• (Time)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

If ‘StorageEncrypted` is `true`, the KMS key identifier for the encrypted instance.

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#latest_restorable_time ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#pending_modified_values ⇒ Types::PendingModifiedValues

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

Returns:

• (Types::PendingModifiedValues)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#performance_insights_enabled ⇒ Boolean

Set to ‘true` if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise `false`.

Returns:

• (Boolean)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#performance_insights_kms_key_id ⇒ String

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

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_backup_window ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_maintenance_window ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#promotion_tier ⇒ Integer

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)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessible ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#status_infos ⇒ Array<Types::DBInstanceStatusInfo>

The status of a read replica. If the instance is not a read replica, this is blank.

Returns:

• (Array<Types::DBInstanceStatusInfo>)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#storage_encrypted ⇒ Boolean

Specifies whether or not the instance is encrypted.

Returns:

• (Boolean)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_security_groups ⇒ Array<Types::VpcSecurityGroupMembership>

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

Returns:

• (Array<Types::VpcSecurityGroupMembership>)

# File 'lib/aws-sdk-docdb/types.rb', line 2160

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,
  :copy_tags_to_snapshot,
  :promotion_tier,
  :db_instance_arn,
  :enabled_cloudwatch_logs_exports,
  :certificate_details,
  :performance_insights_enabled,
  :performance_insights_kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end