Struct aws_sdk_docdb::model::DbCluster

#[non_exhaustive]
pub struct DbCluster {

    pub availability_zones: Option<Vec<String>>,
    pub backup_retention_period: Option<i32>,
    pub db_cluster_identifier: Option<String>,
    pub db_cluster_parameter_group: Option<String>,
    pub db_subnet_group: Option<String>,
    pub status: Option<String>,
    pub percent_progress: Option<String>,
    pub earliest_restorable_time: Option<DateTime>,
    pub endpoint: Option<String>,
    pub reader_endpoint: Option<String>,
    pub multi_az: bool,
    pub engine: Option<String>,
    pub engine_version: Option<String>,
    pub latest_restorable_time: Option<DateTime>,
    pub port: Option<i32>,
    pub master_username: Option<String>,
    pub preferred_backup_window: Option<String>,
    pub preferred_maintenance_window: Option<String>,
    pub replication_source_identifier: Option<String>,
    pub read_replica_identifiers: Option<Vec<String>>,
    pub db_cluster_members: Option<Vec<DbClusterMember>>,
    pub vpc_security_groups: Option<Vec<VpcSecurityGroupMembership>>,
    pub hosted_zone_id: Option<String>,
    pub storage_encrypted: bool,
    pub kms_key_id: Option<String>,
    pub db_cluster_resource_id: Option<String>,
    pub db_cluster_arn: Option<String>,
    pub associated_roles: Option<Vec<DbClusterRole>>,
    pub cluster_create_time: Option<DateTime>,
    pub enabled_cloudwatch_logs_exports: Option<Vec<String>>,
    pub deletion_protection: bool,
}

Detailed information about a cluster.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

availability_zones: Option<Vec<String>>

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

backup_retention_period: Option<i32>

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

db_cluster_identifier: Option<String>

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

db_cluster_parameter_group: Option<String>

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

db_subnet_group: Option<String>

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

status: Option<String>

Specifies the current state of this cluster.

percent_progress: Option<String>

Specifies the progress of the operation as a percentage.

earliest_restorable_time: Option<DateTime>

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

endpoint: Option<String>

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

reader_endpoint: Option<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.

multi_az: bool

Specifies whether the cluster has instances in multiple Availability Zones.

engine: Option<String>

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

engine_version: Option<String>

Indicates the database engine version.

latest_restorable_time: Option<DateTime>

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

port: Option<i32>

Specifies the port that the database engine is listening on.

master_username: Option<String>

Contains the master user name for the cluster.

preferred_backup_window: Option<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: Option<String>

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

replication_source_identifier: Option<String>

Contains the identifier of the source cluster if this cluster is a secondary cluster.

read_replica_identifiers: Option<Vec<String>>

Contains one or more identifiers of the secondary clusters that are associated with this cluster.

db_cluster_members: Option<Vec<DbClusterMember>>

Provides the list of instances that make up the cluster.

vpc_security_groups: Option<Vec<VpcSecurityGroupMembership>>

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

hosted_zone_id: Option<String>

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

storage_encrypted: bool

Specifies whether the cluster is encrypted.

kms_key_id: Option<String>

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

db_cluster_resource_id: Option<String>

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.

db_cluster_arn: Option<String>

The Amazon Resource Name (ARN) for the cluster.

associated_roles: Option<Vec<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.

cluster_create_time: Option<DateTime>

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

enabled_cloudwatch_logs_exports: Option<Vec<String>>

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

deletion_protection: 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.

Implementations

impl DbCluster

pub fn availability_zones(&self) -> Option<&[String]>

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

pub fn backup_retention_period(&self) -> Option<i32>

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

pub fn db_cluster_identifier(&self) -> Option<&str>

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

pub fn db_cluster_parameter_group(&self) -> Option<&str>

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

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.

pub fn status(&self) -> Option<&str>

Specifies the current state of this cluster.

pub fn percent_progress(&self) -> Option<&str>

Specifies the progress of the operation as a percentage.

pub fn earliest_restorable_time(&self) -> Option<&DateTime>

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

pub fn endpoint(&self) -> Option<&str>

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

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.

pub fn multi_az(&self) -> bool

Specifies whether the cluster has instances in multiple Availability Zones.

pub fn engine(&self) -> Option<&str>

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

pub fn engine_version(&self) -> Option<&str>

Indicates the database engine version.

pub fn latest_restorable_time(&self) -> Option<&DateTime>

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

pub fn port(&self) -> Option<i32>

Specifies the port that the database engine is listening on.

pub fn master_username(&self) -> Option<&str>

Contains the master user name for the cluster.

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.

pub fn preferred_maintenance_window(&self) -> Option<&str>

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

pub fn replication_source_identifier(&self) -> Option<&str>

Contains the identifier of the source cluster if this cluster is a secondary cluster.

pub fn read_replica_identifiers(&self) -> Option<&[String]>

Contains one or more identifiers of the secondary clusters that are associated with this cluster.

pub fn db_cluster_members(&self) -> Option<&[DbClusterMember]>

Provides the list of instances that make up the cluster.

pub fn vpc_security_groups(&self) -> Option<&[VpcSecurityGroupMembership]>

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

pub fn hosted_zone_id(&self) -> Option<&str>

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

pub fn storage_encrypted(&self) -> bool

Specifies whether the cluster is encrypted.

pub fn kms_key_id(&self) -> Option<&str>

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

pub fn db_cluster_resource_id(&self) -> Option<&str>

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.

pub fn db_cluster_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) for the cluster.

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.

pub fn cluster_create_time(&self) -> Option<&DateTime>

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

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.

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.

impl DbCluster

pub fn builder() -> Builder

Creates a new builder-style object to manufacture DbCluster

Trait Implementations

impl Clone for DbCluster

fn clone(&self) -> DbCluster

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DbCluster

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<DbCluster> for DbCluster

fn eq(&self, other: &DbCluster) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DbCluster) -> bool

This method tests for !=.

impl StructuralPartialEq for DbCluster