Struct aws_sdk_docdb::model::DbCluster

source · [−]

#[non_exhaustive]
pub struct DbCluster {Show 31 fields
    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,
}

Expand description

Detailed information about a cluster.

Fields (Non-exhaustive)

This struct is marked as 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.

Struct aws_sdk_docdb::model::DbCluster

Fields (Non-exhaustive)

Implementations

impl DbCluster

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

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

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

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

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

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

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

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

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

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

pub fn multi_az(&self) -> bool

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

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

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

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

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

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

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

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

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

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

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

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

pub fn storage_encrypted(&self) -> bool

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

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

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

pub fn associated_roles(&self) -> Option<&[DbClusterRole]>

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

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

pub fn deletion_protection(&self) -> bool

impl DbCluster

pub fn builder() -> Builder

Trait Implementations

impl Clone for DbCluster

fn clone(&self) -> DbCluster

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

impl Debug for DbCluster

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

impl PartialEq<DbCluster> for DbCluster

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

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

impl StructuralPartialEq for DbCluster

Auto Trait Implementations

impl RefUnwindSafe for DbCluster

impl Send for DbCluster

impl Sync for DbCluster

impl Unpin for DbCluster

impl UnwindSafe for DbCluster

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

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

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

pub fn associated_roles(&self) -> Option<&[DbClusterRole ]>

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,