#[non_exhaustive]pub struct DbCluster {Show 34 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: Option<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: Option<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 clone_group_id: Option<String>,
pub cluster_create_time: Option<DateTime>,
pub enabled_cloudwatch_logs_exports: Option<Vec<String>>,
pub deletion_protection: Option<bool>,
pub storage_type: Option<String>,
pub master_user_secret: Option<ClusterMasterUserSecret>,
}Expand description
Detailed information about a cluster.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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: Option<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: Option<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 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.
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.
clone_group_id: Option<String>Identifies the clone group to which the DB cluster is associated.
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: 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.
storage_type: Option<String>Storage type associated with your cluster
Storage type associated with your cluster
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
master_user_secret: Option<ClusterMasterUserSecret>The secret managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.
Implementations§
Source§impl DbCluster
impl DbCluster
Sourcepub fn availability_zones(&self) -> &[String]
pub fn availability_zones(&self) -> &[String]
Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .availability_zones.is_none().
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) -> Option<bool>
pub fn multi_az(&self) -> Option<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) -> &[String]
pub fn read_replica_identifiers(&self) -> &[String]
Contains one or more identifiers of the secondary clusters that are associated with this cluster.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .read_replica_identifiers.is_none().
Sourcepub fn db_cluster_members(&self) -> &[DbClusterMember]
pub fn db_cluster_members(&self) -> &[DbClusterMember]
Provides the list of instances that make up the cluster.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .db_cluster_members.is_none().
Sourcepub fn vpc_security_groups(&self) -> &[VpcSecurityGroupMembership]
pub fn vpc_security_groups(&self) -> &[VpcSecurityGroupMembership]
Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .vpc_security_groups.is_none().
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) -> Option<bool>
pub fn storage_encrypted(&self) -> Option<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) -> &[DbClusterRole]
pub fn associated_roles(&self) -> &[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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .associated_roles.is_none().
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) -> &[String]
pub fn enabled_cloudwatch_logs_exports(&self) -> &[String]
A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .enabled_cloudwatch_logs_exports.is_none().
Sourcepub fn deletion_protection(&self) -> Option<bool>
pub fn deletion_protection(&self) -> 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.
Sourcepub fn storage_type(&self) -> Option<&str>
pub fn storage_type(&self) -> Option<&str>
Storage type associated with your cluster
Storage type associated with your cluster
For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.
Valid values for storage type - standard | iopt1
Default value is standard
Sourcepub fn master_user_secret(&self) -> Option<&ClusterMasterUserSecret>
pub fn master_user_secret(&self) -> Option<&ClusterMasterUserSecret>
The secret managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.
Trait Implementations§
impl StructuralPartialEq for DbCluster
Auto Trait Implementations§
impl Freeze for DbCluster
impl RefUnwindSafe for DbCluster
impl Send for DbCluster
impl Sync for DbCluster
impl Unpin for DbCluster
impl UnwindSafe for DbCluster
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);