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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Detailed information about an instance.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#auto_minor_version_upgrade ⇒ Boolean

Indicates that minor version patches are applied automatically.

Returns:

  • (Boolean) —

    Indicates that minor version patches are applied automatically.

#availability_zone ⇒ String

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

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (String) —

    The identifier of the CA certificate for this 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.

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (String) —

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

#db_instance_identifier ⇒ String

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

Returns:

  • (String) —

    Contains a user-provided database identifier.

#db_instance_status ⇒ String

Specifies the current state of this database.

Returns:

  • (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.

Returns:

  • (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 AWS Region-unique, immutable identifier for the instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the instance is accessed.

Returns:

  • (String) —

    The AWS 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 Amazon CloudWatch Logs.

Returns:

  • (Array<String>) —

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

#endpoint ⇒ Types::Endpoint

Specifies the connection endpoint.

Returns:

#engine ⇒ String

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

Returns:

  • (String) —

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

#engine_version ⇒ String

Indicates the database engine version.

Returns:

  • (String) —

    Indicates the database engine version.

#instance_create_time ⇒ Time

Provides the date and time that the instance was created.

Returns:

  • (Time) —

    Provides the date and time that the instance was created.

#kms_key_id ⇒ String

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

Returns:

  • (String) —

    If StorageEncrypted is true, the AWS 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.

Returns:

  • (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. This element is included only when changes are pending. Specific changes are identified by subelements.

Returns:

#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) —

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

Returns:

  • (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.

Returns:

  • (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. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

Returns:

  • (Boolean) —

    Not supported.

#status_infos ⇒ Array<Types::DBInstanceStatusInfo>

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

Returns:

#storage_encrypted ⇒ Boolean

Specifies whether or not the instance is encrypted.

Returns:

  • (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.

Returns: