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

Instance Attribute Summary collapse

Instance Attribute Details

#auto_minor_version_upgradeBoolean

Indicates that minor version patches are applied automatically.

Returns:

  • (Boolean)

    Indicates that minor version patches are applied automatically.

#availability_zoneString

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

Returns:

  • (String)

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

#backup_retention_periodInteger

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

Returns:

  • (Integer)

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

#ca_certificate_identifierString

The identifier of the CA certificate for this DB instance.

Returns:

  • (String)

    The identifier of the CA certificate for this DB instance.

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

    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.

#db_instance_arnString

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

Returns:

  • (String)

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

#db_instance_classString

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

Returns:

  • (String)

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

#db_instance_identifierString

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

Returns:

  • (String)

    Contains a user-provided database identifier.

#db_instance_statusString

Specifies the current state of this database.

Returns:

  • (String)

    Specifies the current state of this database.

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

Returns:

  • (Types::DBSubnetGroup)

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

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

    The AWS Region-unique, immutable identifier for the DB instance.

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

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

#endpointTypes::Endpoint

Specifies the connection endpoint.

Returns:

#engineString

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

Returns:

  • (String)

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

#engine_versionString

Indicates the database engine version.

Returns:

  • (String)

    Indicates the database engine version.

#instance_create_timeTime

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

Returns:

  • (Time)

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

#kms_key_idString

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

Returns:

  • (String)

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

#latest_restorable_timeTime

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

Returns:

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

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

#preferred_maintenance_windowString

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

    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_accessibleBoolean

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

Returns:

  • (Boolean)

    Not supported.

#status_infosArray<Types::DBInstanceStatusInfo>

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

Returns:

#storage_encryptedBoolean

Specifies whether or not the DB instance is encrypted.

Returns:

  • (Boolean)

    Specifies whether or not the DB instance is encrypted.

#vpc_security_groupsArray<Types::VpcSecurityGroupMembership>

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

Returns: