DBCluster

Struct DBCluster 

Source
pub struct DBCluster {
Show 29 fields pub associated_roles: Option<Vec<DBClusterRole>>, pub availability_zones: Option<Vec<String>>, pub backup_retention_period: Option<i64>, pub cluster_create_time: Option<String>, pub db_cluster_arn: Option<String>, pub db_cluster_identifier: Option<String>, pub db_cluster_members: Option<Vec<DBClusterMember>>, pub db_cluster_parameter_group: Option<String>, pub db_subnet_group: Option<String>, pub db_cluster_resource_id: Option<String>, pub deletion_protection: Option<bool>, pub earliest_restorable_time: Option<String>, pub enabled_cloudwatch_logs_exports: Option<Vec<String>>, pub endpoint: Option<String>, pub engine: Option<String>, pub engine_version: Option<String>, pub hosted_zone_id: Option<String>, pub kms_key_id: Option<String>, pub latest_restorable_time: Option<String>, pub master_username: Option<String>, pub multi_az: Option<bool>, pub percent_progress: Option<String>, pub port: Option<i64>, pub preferred_backup_window: Option<String>, pub preferred_maintenance_window: Option<String>, pub reader_endpoint: Option<String>, pub status: Option<String>, pub storage_encrypted: Option<bool>, pub vpc_security_groups: Option<Vec<VpcSecurityGroupMembership>>,
}
Expand description

Detailed information about a cluster.

Fields§

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

§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<i64>

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

§cluster_create_time: Option<String>

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

§db_cluster_arn: Option<String>

The Amazon Resource Name (ARN) for the cluster.

§db_cluster_identifier: Option<String>

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

§db_cluster_members: Option<Vec<DBClusterMember>>

Provides the list of instances that make up the 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.

§db_cluster_resource_id: Option<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.

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

§earliest_restorable_time: Option<String>

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

§enabled_cloudwatch_logs_exports: Option<Vec<String>>

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

§endpoint: Option<String>

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

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

§hosted_zone_id: Option<String>

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

§kms_key_id: Option<String>

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

§latest_restorable_time: Option<String>

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

§master_username: Option<String>

Contains the master user name for the cluster.

§multi_az: Option<bool>

Specifies whether the cluster has instances in multiple Availability Zones.

§percent_progress: Option<String>

Specifies the progress of the operation as a percentage.

§port: Option<i64>

Specifies the port that the database engine is listening on.

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

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

§status: Option<String>

Specifies the current state of this cluster.

§storage_encrypted: Option<bool>

Specifies whether the cluster is encrypted.

§vpc_security_groups: Option<Vec<VpcSecurityGroupMembership>>

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

Trait Implementations§

Source§

impl Clone for DBCluster

Source§

fn clone(&self) -> DBCluster

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DBCluster

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for DBCluster

Source§

fn default() -> DBCluster

Returns the “default value” for a type. Read more
Source§

impl PartialEq for DBCluster

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for DBCluster

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

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

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,