class Aws::DocDB::Types::DBCluster

Detailed information about a cluster.

@!attribute [rw] availability_zones

Provides the list of Amazon EC2 Availability Zones that instances in
the cluster can be created in.
@return [Array<String>]

@!attribute [rw] backup_retention_period

Specifies the number of days for which automatic snapshots are
retained.
@return [Integer]

@!attribute [rw] db_cluster_identifier

Contains a user-supplied cluster identifier. This identifier is the
unique key that identifies a cluster.
@return [String]

@!attribute [rw] db_cluster_parameter_group

Specifies the name of the cluster parameter group for the cluster.
@return [String]

@!attribute [rw] db_subnet_group

Specifies information on the subnet group that is associated with
the cluster, including the name, description, and subnets in the
subnet group.
@return [String]

@!attribute [rw] status

Specifies the current state of this cluster.
@return [String]

@!attribute [rw] percent_progress

Specifies the progress of the operation as a percentage.
@return [String]

@!attribute [rw] earliest_restorable_time

The earliest time to which a database can be restored with
point-in-time restore.
@return [Time]

@!attribute [rw] endpoint

Specifies the connection endpoint for the primary instance of the
cluster.
@return [String]

@!attribute [rw] reader_endpoint

The reader endpoint for the cluster. The reader endpoint for a
cluster load balances connections across the Amazon DocumentDB
replicas that are available in a cluster. As clients request new
connections to the reader endpoint, Amazon DocumentDB distributes
the connection requests among the Amazon DocumentDB replicas in the
cluster. This functionality can help balance your read workload
across multiple Amazon DocumentDB replicas in your cluster.

If a failover occurs, and the Amazon DocumentDB replica that you are
connected to is promoted to be the primary instance, your connection
is dropped. To continue sending your read workload to other Amazon
DocumentDB replicas in the cluster, you can then reconnect to the
reader endpoint.
@return [String]

@!attribute [rw] multi_az

Specifies whether the cluster has instances in multiple Availability
Zones.
@return [Boolean]

@!attribute [rw] engine

Provides the name of the database engine to be used for this
cluster.
@return [String]

@!attribute [rw] engine_version

Indicates the database engine version.
@return [String]

@!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] port

Specifies the port that the database engine is listening on.
@return [Integer]

@!attribute [rw] master_username

Contains the master user name for the cluster.
@return [String]

@!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] preferred_maintenance_window

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

@!attribute [rw] replication_source_identifier

Contains the identifier of the source cluster if this cluster is a
secondary cluster.
@return [String]

@!attribute [rw] read_replica_identifiers

Contains one or more identifiers of the secondary clusters that are
associated with this cluster.
@return [Array<String>]

@!attribute [rw] db_cluster_members

Provides the list of instances that make up the cluster.
@return [Array<Types::DBClusterMember>]

@!attribute [rw] vpc_security_groups

Provides a list of virtual private cloud (VPC) security groups that
the cluster belongs to.
@return [Array<Types::VpcSecurityGroupMembership>]

@!attribute [rw] hosted_zone_id

Specifies the ID that Amazon Route 53 assigns when you create a
hosted zone.
@return [String]

@!attribute [rw] storage_encrypted

Specifies whether the cluster is encrypted.
@return [Boolean]

@!attribute [rw] kms_key_id

If `StorageEncrypted` is `true`, the KMS key identifier for the
encrypted cluster.
@return [String]

@!attribute [rw] db_cluster_resource_id

The Region-unique, immutable identifier for the cluster. This
identifier is found in CloudTrail log entries whenever the KMS key
for the cluster is accessed.
@return [String]

@!attribute [rw] db_cluster_arn

The Amazon Resource Name (ARN) for the cluster.
@return [String]

@!attribute [rw] associated_roles

Provides a list of the Identity and Access Management (IAM) roles
that are associated with the cluster. (IAM) roles that are
associated with a cluster grant permission for the cluster to access
other Amazon Web Services services on your behalf.
@return [Array<Types::DBClusterRole>]

@!attribute [rw] cluster_create_time

Specifies the time when the cluster was created, in Universal
Coordinated Time (UTC).
@return [Time]

@!attribute [rw] enabled_cloudwatch_logs_exports

A list of log types that this cluster is configured to export to
Amazon CloudWatch Logs.
@return [Array<String>]

@!attribute [rw] deletion_protection

Specifies whether this cluster can be deleted. If
`DeletionProtection` is enabled, the cluster cannot be deleted
unless it is modified and `DeletionProtection` is disabled.
`DeletionProtection` protects clusters from being accidentally
deleted.
@return [Boolean]

@see docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/DBCluster AWS API Documentation

Constants

SENSITIVE