class Aws::DocDB::Types::DBInstance
Detailed information about an instance.
@!attribute [rw] db_instance_identifier
Contains a user-provided database identifier. This identifier is the unique key that identifies an instance. @return [String]
@!attribute [rw] db_instance_class
Contains the name of the compute and memory capacity class of the instance. @return [String]
@!attribute [rw] engine
Provides the name of the database engine to be used for this instance. @return [String]
@!attribute [rw] db_instance_status
Specifies the current state of this database. @return [String]
@!attribute [rw] endpoint
Specifies the connection endpoint. @return [Types::Endpoint]
@!attribute [rw] instance_create_time
Provides the date and time that the instance was created. @return [Time]
@!attribute [rw] preferred_backup_window
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`. @return [String]
@!attribute [rw] backup_retention_period
Specifies the number of days for which automatic snapshots are retained. @return [Integer]
@!attribute [rw] vpc_security_groups
Provides a list of VPC security group elements that the instance belongs to. @return [Array<Types::VpcSecurityGroupMembership>]
@!attribute [rw] availability_zone
Specifies the name of the Availability Zone that the instance is located in. @return [String]
@!attribute [rw] db_subnet_group
Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group. @return [Types::DBSubnetGroup]
@!attribute [rw] preferred_maintenance_window
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). @return [String]
@!attribute [rw] pending_modified_values
Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements. @return [Types::PendingModifiedValues]
@!attribute [rw] latest_restorable_time
Specifies the latest time to which a database can be restored with point-in-time restore. @return [Time]
@!attribute [rw] engine_version
Indicates the database engine version. @return [String]
@!attribute [rw] auto_minor_version_upgrade
Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set. @return [Boolean]
@!attribute [rw] publicly_accessible
Not supported. Amazon DocumentDB does not currently support public endpoints. The value of `PubliclyAccessible` is always `false`. @return [Boolean]
@!attribute [rw] status_infos
The status of a read replica. If the instance is not a read replica, this is blank. @return [Array<Types::DBInstanceStatusInfo>]
@!attribute [rw] db_cluster_identifier
Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster. @return [String]
@!attribute [rw] storage_encrypted
Specifies whether or not the instance is encrypted. @return [Boolean]
@!attribute [rw] kms_key_id
If `StorageEncrypted` is `true`, the KMS key identifier for the encrypted instance. @return [String]
@!attribute [rw] dbi_resource_id
The Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed. @return [String]
@!attribute [rw] ca_certificate_identifier
The identifier of the CA certificate for this DB instance. @return [String]
@!attribute [rw] promotion_tier
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. @return [Integer]
@!attribute [rw] db_instance_arn
The Amazon Resource Name (ARN) for the instance. @return [String]
@!attribute [rw] enabled_cloudwatch_logs_exports
A list of log types that this instance is configured to export to CloudWatch Logs. @return [Array<String>]
@see docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBInstance AWS API Documentation
Constants
- SENSITIVE