#[non_exhaustive]
pub struct AwsRdsDbClusterDetails {
Show 38 fields pub allocated_storage: Option<i32>, pub availability_zones: Option<Vec<String>>, pub backup_retention_period: Option<i32>, pub database_name: Option<String>, pub status: Option<String>, pub endpoint: Option<String>, pub reader_endpoint: Option<String>, pub custom_endpoints: Option<Vec<String>>, pub multi_az: Option<bool>, pub engine: Option<String>, pub engine_version: Option<String>, pub port: Option<i32>, pub master_username: Option<String>, pub preferred_backup_window: Option<String>, pub preferred_maintenance_window: Option<String>, pub read_replica_identifiers: Option<Vec<String>>, pub vpc_security_groups: Option<Vec<AwsRdsDbInstanceVpcSecurityGroup>>, 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 associated_roles: Option<Vec<AwsRdsDbClusterAssociatedRole>>, pub cluster_create_time: Option<String>, pub enabled_cloud_watch_logs_exports: Option<Vec<String>>, pub engine_mode: Option<String>, pub deletion_protection: Option<bool>, pub http_endpoint_enabled: Option<bool>, pub activity_stream_status: Option<String>, pub copy_tags_to_snapshot: Option<bool>, pub cross_account_clone: Option<bool>, pub domain_memberships: Option<Vec<AwsRdsDbDomainMembership>>, pub db_cluster_parameter_group: Option<String>, pub db_subnet_group: Option<String>, pub db_cluster_option_group_memberships: Option<Vec<AwsRdsDbClusterOptionGroupMembership>>, pub db_cluster_identifier: Option<String>, pub db_cluster_members: Option<Vec<AwsRdsDbClusterMember>>, pub iam_database_authentication_enabled: Option<bool>, pub auto_minor_version_upgrade: Option<bool>,
}
Expand description

Information about an Amazon RDS DB 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.
§allocated_storage: Option<i32>

For all database engines except Aurora, specifies the allocated storage size in gibibytes (GiB).

§availability_zones: Option<Vec<String>>

A list of Availability Zones (AZs) where instances in the DB cluster can be created.

§backup_retention_period: Option<i32>

The number of days for which automated backups are retained.

§database_name: Option<String>

The name of the database.

§status: Option<String>

The current status of this DB cluster.

§endpoint: Option<String>

The connection endpoint for the primary instance of the DB cluster.

§reader_endpoint: Option<String>

The reader endpoint for the DB cluster.

§custom_endpoints: Option<Vec<String>>

A list of custom endpoints for the DB cluster.

§multi_az: Option<bool>

Whether the DB cluster has instances in multiple Availability Zones.

§engine: Option<String>

The name of the database engine to use for this DB cluster. Valid values are as follows:

  • aurora

  • aurora-mysql

  • aurora-postgresql

§engine_version: Option<String>

The version number of the database engine to use.

§port: Option<i32>

The port number on which the DB instances in the DB cluster accept connections.

§master_username: Option<String>

The name of the master user for the DB cluster.

§preferred_backup_window: Option<String>

The range of time each day when automated backups are created, if automated backups are enabled.

Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

§preferred_maintenance_window: Option<String>

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

Uses the format :HH:MM- :HH:MM .

For the day values, use mon|tue|wed|thu|fri|sat|sun.

For example, sun:09:32-sun:10:02.

§read_replica_identifiers: Option<Vec<String>>

The identifiers of the read replicas that are associated with this DB cluster.

§vpc_security_groups: Option<Vec<AwsRdsDbInstanceVpcSecurityGroup>>

A list of VPC security groups that the DB cluster belongs to.

§hosted_zone_id: Option<String>

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

§storage_encrypted: Option<bool>

Whether the DB cluster is encrypted.

§kms_key_id: Option<String>

The ARN of the KMS master key that is used to encrypt the database instances in the DB cluster.

§db_cluster_resource_id: Option<String>

The identifier of the DB cluster. The identifier must be unique within each Amazon Web Services Region and is immutable.

§associated_roles: Option<Vec<AwsRdsDbClusterAssociatedRole>>

A list of the IAM roles that are associated with the DB cluster.

§cluster_create_time: Option<String>

Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.

§enabled_cloud_watch_logs_exports: Option<Vec<String>>

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

§engine_mode: Option<String>

The database engine mode of the DB cluster.Valid values are as follows:

  • global

  • multimaster

  • parallelquery

  • provisioned

  • serverless

§deletion_protection: Option<bool>

Whether the DB cluster has deletion protection enabled.

§http_endpoint_enabled: Option<bool>

Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

§activity_stream_status: Option<String>

The status of the database activity stream. Valid values are as follows:

  • started

  • starting

  • stopped

  • stopping

§copy_tags_to_snapshot: Option<bool>

Whether tags are copied from the DB cluster to snapshots of the DB cluster.

§cross_account_clone: Option<bool>

Whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

§domain_memberships: Option<Vec<AwsRdsDbDomainMembership>>

The Active Directory domain membership records that are associated with the DB cluster.

§db_cluster_parameter_group: Option<String>

The name of the DB cluster parameter group for the DB cluster.

§db_subnet_group: Option<String>

The subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.

§db_cluster_option_group_memberships: Option<Vec<AwsRdsDbClusterOptionGroupMembership>>

The list of option group memberships for this DB cluster.

§db_cluster_identifier: Option<String>

The DB cluster identifier that the user assigned to the cluster. This identifier is the unique key that identifies a DB cluster.

§db_cluster_members: Option<Vec<AwsRdsDbClusterMember>>

The list of instances that make up the DB cluster.

§iam_database_authentication_enabled: Option<bool>

Whether the mapping of IAM accounts to database accounts is enabled.

§auto_minor_version_upgrade: Option<bool>

Indicates if minor version upgrades are automatically applied to the cluster.

Implementations§

source§

impl AwsRdsDbClusterDetails

source

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

For all database engines except Aurora, specifies the allocated storage size in gibibytes (GiB).

source

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

A list of Availability Zones (AZs) where instances in the DB cluster can be created.

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

source

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

The number of days for which automated backups are retained.

source

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

The name of the database.

source

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

The current status of this DB cluster.

source

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

The connection endpoint for the primary instance of the DB cluster.

source

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

The reader endpoint for the DB cluster.

source

pub fn custom_endpoints(&self) -> &[String]

A list of custom endpoints for the DB 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 .custom_endpoints.is_none().

source

pub fn multi_az(&self) -> Option<bool>

Whether the DB cluster has instances in multiple Availability Zones.

source

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

The name of the database engine to use for this DB cluster. Valid values are as follows:

  • aurora

  • aurora-mysql

  • aurora-postgresql

source

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

The version number of the database engine to use.

source

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

The port number on which the DB instances in the DB cluster accept connections.

source

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

The name of the master user for the DB cluster.

source

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

The range of time each day when automated backups are created, if automated backups are enabled.

Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

source

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

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

Uses the format :HH:MM- :HH:MM .

For the day values, use mon|tue|wed|thu|fri|sat|sun.

For example, sun:09:32-sun:10:02.

source

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

The identifiers of the read replicas that are associated with this DB 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().

source

pub fn vpc_security_groups(&self) -> &[AwsRdsDbInstanceVpcSecurityGroup]

A list of VPC security groups that the DB 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().

source

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

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

source

pub fn storage_encrypted(&self) -> Option<bool>

Whether the DB cluster is encrypted.

source

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

The ARN of the KMS master key that is used to encrypt the database instances in the DB cluster.

source

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

The identifier of the DB cluster. The identifier must be unique within each Amazon Web Services Region and is immutable.

source

pub fn associated_roles(&self) -> &[AwsRdsDbClusterAssociatedRole]

A list of the IAM roles that are associated with the DB 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 .associated_roles.is_none().

source

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

Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.

source

pub fn enabled_cloud_watch_logs_exports(&self) -> &[String]

A list of log types that this DB cluster is configured to export to 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_cloud_watch_logs_exports.is_none().

source

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

The database engine mode of the DB cluster.Valid values are as follows:

  • global

  • multimaster

  • parallelquery

  • provisioned

  • serverless

source

pub fn deletion_protection(&self) -> Option<bool>

Whether the DB cluster has deletion protection enabled.

source

pub fn http_endpoint_enabled(&self) -> Option<bool>

Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.

source

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

The status of the database activity stream. Valid values are as follows:

  • started

  • starting

  • stopped

  • stopping

source

pub fn copy_tags_to_snapshot(&self) -> Option<bool>

Whether tags are copied from the DB cluster to snapshots of the DB cluster.

source

pub fn cross_account_clone(&self) -> Option<bool>

Whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

source

pub fn domain_memberships(&self) -> &[AwsRdsDbDomainMembership]

The Active Directory domain membership records that are associated with the DB 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 .domain_memberships.is_none().

source

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

The name of the DB cluster parameter group for the DB cluster.

source

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

The subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.

source

pub fn db_cluster_option_group_memberships( &self ) -> &[AwsRdsDbClusterOptionGroupMembership]

The list of option group memberships for this DB 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_option_group_memberships.is_none().

source

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

The DB cluster identifier that the user assigned to the cluster. This identifier is the unique key that identifies a DB cluster.

source

pub fn db_cluster_members(&self) -> &[AwsRdsDbClusterMember]

The list of instances that make up the DB 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().

source

pub fn iam_database_authentication_enabled(&self) -> Option<bool>

Whether the mapping of IAM accounts to database accounts is enabled.

source

pub fn auto_minor_version_upgrade(&self) -> Option<bool>

Indicates if minor version upgrades are automatically applied to the cluster.

source§

impl AwsRdsDbClusterDetails

source

pub fn builder() -> AwsRdsDbClusterDetailsBuilder

Creates a new builder-style object to manufacture AwsRdsDbClusterDetails.

Trait Implementations§

source§

impl Clone for AwsRdsDbClusterDetails

source§

fn clone(&self) -> AwsRdsDbClusterDetails

Returns a copy 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 AwsRdsDbClusterDetails

source§

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

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

impl PartialEq for AwsRdsDbClusterDetails

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for AwsRdsDbClusterDetails

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. 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, U> Into<U> for Twhere 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<Unshared, Shared> IntoShared<Shared> for Unsharedwhere Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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