Struct aws_sdk_securityhub::types::AwsRdsDbClusterDetails
source · #[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
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
.
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
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
impl AwsRdsDbClusterDetails
sourcepub fn allocated_storage(&self) -> Option<i32>
pub fn allocated_storage(&self) -> Option<i32>
For all database engines except Aurora, specifies the allocated storage size in gibibytes (GiB).
sourcepub fn availability_zones(&self) -> &[String]
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()
.
sourcepub fn backup_retention_period(&self) -> Option<i32>
pub fn backup_retention_period(&self) -> Option<i32>
The number of days for which automated backups are retained.
sourcepub fn database_name(&self) -> Option<&str>
pub fn database_name(&self) -> Option<&str>
The name of the database.
sourcepub fn endpoint(&self) -> Option<&str>
pub fn endpoint(&self) -> Option<&str>
The connection endpoint for the primary instance of the DB cluster.
sourcepub fn reader_endpoint(&self) -> Option<&str>
pub fn reader_endpoint(&self) -> Option<&str>
The reader endpoint for the DB cluster.
sourcepub fn custom_endpoints(&self) -> &[String]
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()
.
sourcepub fn multi_az(&self) -> Option<bool>
pub fn multi_az(&self) -> Option<bool>
Whether the DB cluster has instances in multiple Availability Zones.
sourcepub fn engine(&self) -> Option<&str>
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
sourcepub fn engine_version(&self) -> Option<&str>
pub fn engine_version(&self) -> Option<&str>
The version number of the database engine to use.
sourcepub fn port(&self) -> Option<i32>
pub fn port(&self) -> Option<i32>
The port number on which the DB instances in the DB cluster accept connections.
sourcepub fn master_username(&self) -> Option<&str>
pub fn master_username(&self) -> Option<&str>
The name of the master user for the DB cluster.
sourcepub fn preferred_backup_window(&self) -> Option<&str>
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
.
sourcepub fn preferred_maintenance_window(&self) -> Option<&str>
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
.
For the day values, use mon
|tue
|wed
|thu
|fri
|sat
|sun
.
For example, sun:09:32-sun:10:02
.
sourcepub fn read_replica_identifiers(&self) -> &[String]
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()
.
sourcepub fn vpc_security_groups(&self) -> &[AwsRdsDbInstanceVpcSecurityGroup]
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()
.
sourcepub fn hosted_zone_id(&self) -> Option<&str>
pub fn hosted_zone_id(&self) -> Option<&str>
Specifies the identifier 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>
Whether the DB cluster is encrypted.
sourcepub fn kms_key_id(&self) -> Option<&str>
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.
sourcepub fn db_cluster_resource_id(&self) -> Option<&str>
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.
sourcepub fn associated_roles(&self) -> &[AwsRdsDbClusterAssociatedRole]
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()
.
sourcepub fn cluster_create_time(&self) -> Option<&str>
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
.
sourcepub fn enabled_cloud_watch_logs_exports(&self) -> &[String]
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()
.
sourcepub fn engine_mode(&self) -> Option<&str>
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
sourcepub fn deletion_protection(&self) -> Option<bool>
pub fn deletion_protection(&self) -> Option<bool>
Whether the DB cluster has deletion protection enabled.
sourcepub fn http_endpoint_enabled(&self) -> Option<bool>
pub fn http_endpoint_enabled(&self) -> Option<bool>
Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
sourcepub fn activity_stream_status(&self) -> Option<&str>
pub fn activity_stream_status(&self) -> Option<&str>
The status of the database activity stream. Valid values are as follows:
-
started
-
starting
-
stopped
-
stopping
Whether tags are copied from the DB cluster to snapshots of the DB cluster.
sourcepub fn cross_account_clone(&self) -> Option<bool>
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.
sourcepub fn domain_memberships(&self) -> &[AwsRdsDbDomainMembership]
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()
.
sourcepub fn db_cluster_parameter_group(&self) -> Option<&str>
pub fn db_cluster_parameter_group(&self) -> Option<&str>
The name of the DB cluster parameter group for the DB cluster.
sourcepub fn db_subnet_group(&self) -> Option<&str>
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.
sourcepub fn db_cluster_option_group_memberships(
&self
) -> &[AwsRdsDbClusterOptionGroupMembership]
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()
.
sourcepub fn db_cluster_identifier(&self) -> Option<&str>
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.
sourcepub fn db_cluster_members(&self) -> &[AwsRdsDbClusterMember]
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()
.
sourcepub fn iam_database_authentication_enabled(&self) -> Option<bool>
pub fn iam_database_authentication_enabled(&self) -> Option<bool>
Whether the mapping of IAM accounts to database accounts is enabled.
sourcepub fn auto_minor_version_upgrade(&self) -> Option<bool>
pub fn auto_minor_version_upgrade(&self) -> Option<bool>
Indicates if minor version upgrades are automatically applied to the cluster.
source§impl AwsRdsDbClusterDetails
impl AwsRdsDbClusterDetails
sourcepub fn builder() -> AwsRdsDbClusterDetailsBuilder
pub fn builder() -> AwsRdsDbClusterDetailsBuilder
Creates a new builder-style object to manufacture AwsRdsDbClusterDetails
.
Trait Implementations§
source§impl Clone for AwsRdsDbClusterDetails
impl Clone for AwsRdsDbClusterDetails
source§fn clone(&self) -> AwsRdsDbClusterDetails
fn clone(&self) -> AwsRdsDbClusterDetails
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for AwsRdsDbClusterDetails
impl Debug for AwsRdsDbClusterDetails
source§impl PartialEq for AwsRdsDbClusterDetails
impl PartialEq for AwsRdsDbClusterDetails
source§fn eq(&self, other: &AwsRdsDbClusterDetails) -> bool
fn eq(&self, other: &AwsRdsDbClusterDetails) -> bool
self
and other
values to be equal, and is used
by ==
.