Class: Aws::DocDB::Types::DBCluster

Inherits:

Struct

• Object
• Struct
• Aws::DocDB::Types::DBCluster

Defined in:

(unknown)

Overview

Detailed information about a cluster.

Returned by:

• CreateDBClusterResult#db_cluster
• Aws::DocDB::Types::DeleteDBClusterResult#db_cluster
• FailoverDBClusterResult#db_cluster
• ModifyDBClusterResult#db_cluster
• RestoreDBClusterFromSnapshotResult#db_cluster
• RestoreDBClusterToPointInTimeResult#db_cluster
• StartDBClusterResult#db_cluster
• StopDBClusterResult#db_cluster

See Also:

• AWS API Documentation

Instance Attribute Summary

• #associated_roles ⇒ Array<Types::DBClusterRole>

  Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the cluster.

• #availability_zones ⇒ Array<String>

  Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

• #backup_retention_period ⇒ Integer

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

• #cluster_create_time ⇒ Time

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

• #db_cluster_arn ⇒ String

  The Amazon Resource Name (ARN) for the cluster.

• #db_cluster_identifier ⇒ String

  Contains a user-supplied cluster identifier.

• #db_cluster_members ⇒ Array<Types::DBClusterMember>

  Provides the list of instances that make up the cluster.

• #db_cluster_parameter_group ⇒ String

  Specifies the name of the cluster parameter group for the cluster.

• #db_cluster_resource_id ⇒ String

  The AWS Region-unique, immutable identifier for the cluster.

• #db_subnet_group ⇒ String

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

• #deletion_protection ⇒ Boolean

  Specifies whether this cluster can be deleted.

• #earliest_restorable_time ⇒ Time

  The earliest time to which a database can be restored with point-in-time restore.

• #enabled_cloudwatch_logs_exports ⇒ Array<String>

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

• #endpoint ⇒ String

  Specifies the connection endpoint for the primary instance of the cluster.

• #engine ⇒ String

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

• #engine_version ⇒ String

  Indicates the database engine version.

• #hosted_zone_id ⇒ String

  Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

• #kms_key_id ⇒ String

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

• #latest_restorable_time ⇒ Time

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

• #master_username ⇒ String

  Contains the master user name for the cluster.

• #multi_az ⇒ Boolean

  Specifies whether the cluster has instances in multiple Availability Zones.

• #percent_progress ⇒ String

  Specifies the progress of the operation as a percentage.

• #port ⇒ Integer

  Specifies the port that the database engine is listening on.

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

• #reader_endpoint ⇒ String

  The reader endpoint for the cluster.

• #status ⇒ String

  Specifies the current state of this cluster.

• #storage_encrypted ⇒ Boolean

  Specifies whether the cluster is encrypted.

• #vpc_security_groups ⇒ Array<Types::VpcSecurityGroupMembership>

  Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

Instance Attribute Details

#associated_roles ⇒ Array<Types::DBClusterRole>

Provides a list of the AWS 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 AWS services on your behalf.

Returns:

• (Array<Types::DBClusterRole>) —

  Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the cluster.

#availability_zones ⇒ Array<String>

Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

Returns:

• (Array<String>) —

  Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created 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.

#cluster_create_time ⇒ Time

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

Returns:

• (Time) —

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

#db_cluster_arn ⇒ String

The Amazon Resource Name (ARN) for the cluster.

Returns:

• (String) —

  The Amazon Resource Name (ARN) for the cluster.

#db_cluster_identifier ⇒ String

Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

Returns:

• (String) —

  Contains a user-supplied cluster identifier.

#db_cluster_members ⇒ Array<Types::DBClusterMember>

Provides the list of instances that make up the cluster.

Returns:

• (Array<Types::DBClusterMember>) —

  Provides the list of instances that make up the cluster.

#db_cluster_parameter_group ⇒ String

Specifies the name of the cluster parameter group for the cluster.

Returns:

• (String) —

  Specifies the name of the cluster parameter group for the cluster.

#db_cluster_resource_id ⇒ String

The AWS Region-unique, immutable identifier for the cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the cluster is accessed.

Returns:

• (String) —

  The AWS Region-unique, immutable identifier for the cluster.

#db_subnet_group ⇒ String

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

Returns:

• (String) —

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

#deletion_protection ⇒ Boolean

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.

Returns:

• (Boolean) —

  Specifies whether this cluster can be deleted.

#earliest_restorable_time ⇒ Time

The earliest time to which a database can be restored with point-in-time restore.

Returns:

• (Time) —

  The earliest time to which a database can be restored with point-in-time restore.

#enabled_cloudwatch_logs_exports ⇒ Array<String>

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

Returns:

• (Array<String>) —

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

#endpoint ⇒ String

Specifies the connection endpoint for the primary instance of the cluster.

Returns:

• (String) —

  Specifies the connection endpoint for the primary instance of the cluster.

#engine ⇒ String

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

Returns:

• (String) —

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

#engine_version ⇒ String

Indicates the database engine version.

Returns:

• (String) —

  Indicates the database engine version.

#hosted_zone_id ⇒ String

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

Returns:

• (String) —

  Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

#kms_key_id ⇒ String

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

Returns:

• (String) —

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

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

#master_username ⇒ String

Contains the master user name for the cluster.

Returns:

• (String) —

  Contains the master user name for the cluster.

#multi_az ⇒ Boolean

Specifies whether the cluster has instances in multiple Availability Zones.

Returns:

• (Boolean) —

  Specifies whether the cluster has instances in multiple Availability Zones.

#percent_progress ⇒ String

Specifies the progress of the operation as a percentage.

Returns:

• (String) —

  Specifies the progress of the operation as a percentage.

#port ⇒ Integer

Specifies the port that the database engine is listening on.

Returns:

• (Integer) —

  Specifies the port that the database engine is listening on.

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

#reader_endpoint ⇒ String

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.

Returns:

• (String) —

  The reader endpoint for the cluster.

#status ⇒ String

Specifies the current state of this cluster.

Returns:

• (String) —

  Specifies the current state of this cluster.

#storage_encrypted ⇒ Boolean

Specifies whether the cluster is encrypted.

Returns:

• (Boolean) —

  Specifies whether the cluster is encrypted.

#vpc_security_groups ⇒ Array<Types::VpcSecurityGroupMembership>

Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

Returns:

• (Array<Types::VpcSecurityGroupMembership>) —

  Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.