Struct aws_sdk_docdb::model::DbCluster
source · #[non_exhaustive]pub struct DbCluster { /* private fields */ }Expand description
Detailed information about a cluster.
Implementations§
source§impl DbCluster
impl DbCluster
sourcepub fn availability_zones(&self) -> Option<&[String]>
pub fn availability_zones(&self) -> Option<&[String]>
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
sourcepub fn backup_retention_period(&self) -> Option<i32>
pub fn backup_retention_period(&self) -> Option<i32>
Specifies the number of days for which automatic snapshots are retained.
sourcepub fn db_cluster_identifier(&self) -> Option<&str>
pub fn db_cluster_identifier(&self) -> Option<&str>
Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
sourcepub fn db_cluster_parameter_group(&self) -> Option<&str>
pub fn db_cluster_parameter_group(&self) -> Option<&str>
Specifies the name of the cluster parameter group for the cluster.
sourcepub fn db_subnet_group(&self) -> Option<&str>
pub fn db_subnet_group(&self) -> Option<&str>
Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
sourcepub fn percent_progress(&self) -> Option<&str>
pub fn percent_progress(&self) -> Option<&str>
Specifies the progress of the operation as a percentage.
sourcepub fn earliest_restorable_time(&self) -> Option<&DateTime>
pub fn earliest_restorable_time(&self) -> Option<&DateTime>
The earliest time to which a database can be restored with point-in-time restore.
sourcepub fn endpoint(&self) -> Option<&str>
pub fn endpoint(&self) -> Option<&str>
Specifies the connection endpoint for the primary instance of the cluster.
sourcepub fn reader_endpoint(&self) -> Option<&str>
pub fn reader_endpoint(&self) -> Option<&str>
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.
sourcepub fn multi_az(&self) -> bool
pub fn multi_az(&self) -> bool
Specifies whether the cluster has instances in multiple Availability Zones.
sourcepub fn engine(&self) -> Option<&str>
pub fn engine(&self) -> Option<&str>
Provides the name of the database engine to be used for this cluster.
sourcepub fn engine_version(&self) -> Option<&str>
pub fn engine_version(&self) -> Option<&str>
Indicates the database engine version.
sourcepub fn latest_restorable_time(&self) -> Option<&DateTime>
pub fn latest_restorable_time(&self) -> Option<&DateTime>
Specifies the latest time to which a database can be restored with point-in-time restore.
sourcepub fn master_username(&self) -> Option<&str>
pub fn master_username(&self) -> Option<&str>
Contains the master user name for the cluster.
sourcepub fn preferred_backup_window(&self) -> Option<&str>
pub fn preferred_backup_window(&self) -> Option<&str>
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
sourcepub fn preferred_maintenance_window(&self) -> Option<&str>
pub fn preferred_maintenance_window(&self) -> Option<&str>
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
sourcepub fn replication_source_identifier(&self) -> Option<&str>
pub fn replication_source_identifier(&self) -> Option<&str>
Contains the identifier of the source cluster if this cluster is a secondary cluster.
sourcepub fn read_replica_identifiers(&self) -> Option<&[String]>
pub fn read_replica_identifiers(&self) -> Option<&[String]>
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
sourcepub fn db_cluster_members(&self) -> Option<&[DbClusterMember]>
pub fn db_cluster_members(&self) -> Option<&[DbClusterMember]>
Provides the list of instances that make up the cluster.
sourcepub fn vpc_security_groups(&self) -> Option<&[VpcSecurityGroupMembership]>
pub fn vpc_security_groups(&self) -> Option<&[VpcSecurityGroupMembership]>
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
sourcepub fn hosted_zone_id(&self) -> Option<&str>
pub fn hosted_zone_id(&self) -> Option<&str>
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
sourcepub fn storage_encrypted(&self) -> bool
pub fn storage_encrypted(&self) -> bool
Specifies whether the cluster is encrypted.
sourcepub fn kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.
sourcepub fn db_cluster_resource_id(&self) -> Option<&str>
pub fn db_cluster_resource_id(&self) -> Option<&str>
The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.
sourcepub fn db_cluster_arn(&self) -> Option<&str>
pub fn db_cluster_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) for the cluster.
sourcepub fn associated_roles(&self) -> Option<&[DbClusterRole]>
pub fn associated_roles(&self) -> Option<&[DbClusterRole]>
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.
sourcepub fn clone_group_id(&self) -> Option<&str>
pub fn clone_group_id(&self) -> Option<&str>
Identifies the clone group to which the DB cluster is associated.
sourcepub fn cluster_create_time(&self) -> Option<&DateTime>
pub fn cluster_create_time(&self) -> Option<&DateTime>
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
sourcepub fn enabled_cloudwatch_logs_exports(&self) -> Option<&[String]>
pub fn enabled_cloudwatch_logs_exports(&self) -> Option<&[String]>
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
sourcepub fn deletion_protection(&self) -> bool
pub fn deletion_protection(&self) -> bool
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.