Struct aws_sdk_rds::types::DbCluster
source · #[non_exhaustive]pub struct DbCluster { /* private fields */ }Expand description
Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.
For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.
For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
Implementations§
source§impl DbCluster
impl DbCluster
sourcepub fn allocated_storage(&self) -> Option<i32>
pub fn allocated_storage(&self) -> Option<i32>
For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
sourcepub fn availability_zones(&self) -> Option<&[String]>
pub fn availability_zones(&self) -> Option<&[String]>
Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.
sourcepub fn backup_retention_period(&self) -> Option<i32>
pub fn backup_retention_period(&self) -> Option<i32>
Specifies the number of days for which automatic DB snapshots are retained.
sourcepub fn character_set_name(&self) -> Option<&str>
pub fn character_set_name(&self) -> Option<&str>
If present, specifies the name of the character set that this cluster is associated with.
sourcepub fn database_name(&self) -> Option<&str>
pub fn database_name(&self) -> Option<&str>
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
sourcepub fn db_cluster_identifier(&self) -> Option<&str>
pub fn db_cluster_identifier(&self) -> Option<&str>
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
sourcepub fn db_cluster_parameter_group(&self) -> Option<&str>
pub fn db_cluster_parameter_group(&self) -> Option<&str>
Specifies 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>
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
sourcepub fn automatic_restart_time(&self) -> Option<&DateTime>
pub fn automatic_restart_time(&self) -> Option<&DateTime>
The time when a stopped DB cluster is restarted automatically.
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 DB cluster.
sourcepub fn reader_endpoint(&self) -> Option<&str>
pub fn reader_endpoint(&self) -> Option<&str>
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora 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 Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
sourcepub fn custom_endpoints(&self) -> Option<&[String]>
pub fn custom_endpoints(&self) -> Option<&[String]>
Identifies all custom endpoints associated with the cluster.
sourcepub fn multi_az(&self) -> Option<bool>
pub fn multi_az(&self) -> Option<bool>
Specifies 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 be used for this DB 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 username for the DB cluster.
sourcepub fn db_cluster_option_group_memberships(
&self
) -> Option<&[DbClusterOptionGroupStatus]>
pub fn db_cluster_option_group_memberships( &self ) -> Option<&[DbClusterOptionGroupStatus]>
Provides the list of option group memberships for this DB 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 DB cluster if this DB cluster is a read replica.
sourcepub fn read_replica_identifiers(&self) -> Option<&[String]>
pub fn read_replica_identifiers(&self) -> Option<&[String]>
Contains one or more identifiers of the read replicas associated with this DB cluster.
sourcepub fn db_cluster_members(&self) -> Option<&[DbClusterMember]>
pub fn db_cluster_members(&self) -> Option<&[DbClusterMember]>
Provides the list of instances that make up the DB cluster.
sourcepub fn vpc_security_groups(&self) -> Option<&[VpcSecurityGroupMembership]>
pub fn vpc_security_groups(&self) -> Option<&[VpcSecurityGroupMembership]>
Provides a list of VPC security groups that the DB cluster belongs to.
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) -> bool
pub fn storage_encrypted(&self) -> bool
Specifies whether the DB cluster is encrypted.
sourcepub fn kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
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 DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB 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 DB cluster.
sourcepub fn associated_roles(&self) -> Option<&[DbClusterRole]>
pub fn associated_roles(&self) -> Option<&[DbClusterRole]>
Provides a list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
sourcepub fn iam_database_authentication_enabled(&self) -> Option<bool>
pub fn iam_database_authentication_enabled(&self) -> Option<bool>
A value that indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
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 DB cluster was created, in Universal Coordinated Time (UTC).
sourcepub fn earliest_backtrack_time(&self) -> Option<&DateTime>
pub fn earliest_backtrack_time(&self) -> Option<&DateTime>
The earliest time to which a DB cluster can be backtracked.
sourcepub fn backtrack_window(&self) -> Option<i64>
pub fn backtrack_window(&self) -> Option<i64>
The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
sourcepub fn backtrack_consumed_change_records(&self) -> Option<i64>
pub fn backtrack_consumed_change_records(&self) -> Option<i64>
The number of change records stored for Backtrack.
sourcepub fn enabled_cloudwatch_logs_exports(&self) -> Option<&[String]>
pub fn enabled_cloudwatch_logs_exports(&self) -> Option<&[String]>
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
sourcepub fn capacity(&self) -> Option<i32>
pub fn capacity(&self) -> Option<i32>
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0 (zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
sourcepub fn engine_mode(&self) -> Option<&str>
pub fn engine_mode(&self) -> Option<&str>
The DB engine mode of the DB cluster, either provisioned or serverless.
For more information, see CreateDBCluster.
sourcepub fn scaling_configuration_info(&self) -> Option<&ScalingConfigurationInfo>
pub fn scaling_configuration_info(&self) -> Option<&ScalingConfigurationInfo>
Shows the scaling configuration for an Aurora DB cluster in serverless DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
sourcepub fn deletion_protection(&self) -> Option<bool>
pub fn deletion_protection(&self) -> Option<bool>
Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
sourcepub fn http_endpoint_enabled(&self) -> Option<bool>
pub fn http_endpoint_enabled(&self) -> Option<bool>
A value that indicates whether the HTTP endpoint for an Aurora Serverless v1 DB cluster is enabled.
When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless v1 DB cluster. You can also query your database from inside the RDS console with the query editor.
For more information, see Using the Data API for Aurora Serverless v1 in the Amazon Aurora User Guide.
sourcepub fn activity_stream_mode(&self) -> Option<&ActivityStreamMode>
pub fn activity_stream_mode(&self) -> Option<&ActivityStreamMode>
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
sourcepub fn activity_stream_status(&self) -> Option<&ActivityStreamStatus>
pub fn activity_stream_status(&self) -> Option<&ActivityStreamStatus>
The status of the database activity stream.
sourcepub fn activity_stream_kms_key_id(&self) -> Option<&str>
pub fn activity_stream_kms_key_id(&self) -> Option<&str>
The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
sourcepub fn activity_stream_kinesis_stream_name(&self) -> Option<&str>
pub fn activity_stream_kinesis_stream_name(&self) -> Option<&str>
The name of the Amazon Kinesis data stream used for the database activity stream.
Specifies 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>
Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
sourcepub fn domain_memberships(&self) -> Option<&[DomainMembership]>
pub fn domain_memberships(&self) -> Option<&[DomainMembership]>
The Active Directory Domain membership records associated with the DB cluster.
sourcepub fn tag_list(&self) -> Option<&[Tag]>
pub fn tag_list(&self) -> Option<&[Tag]>
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
sourcepub fn global_write_forwarding_status(&self) -> Option<&WriteForwardingStatus>
pub fn global_write_forwarding_status(&self) -> Option<&WriteForwardingStatus>
Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.
sourcepub fn global_write_forwarding_requested(&self) -> Option<bool>
pub fn global_write_forwarding_requested(&self) -> Option<bool>
Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.
sourcepub fn pending_modified_values(&self) -> Option<&ClusterPendingModifiedValues>
pub fn pending_modified_values(&self) -> Option<&ClusterPendingModifiedValues>
A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
sourcepub fn db_cluster_instance_class(&self) -> Option<&str>
pub fn db_cluster_instance_class(&self) -> Option<&str>
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
sourcepub fn storage_type(&self) -> Option<&str>
pub fn storage_type(&self) -> Option<&str>
The storage type associated with the DB cluster.
sourcepub fn iops(&self) -> Option<i32>
pub fn iops(&self) -> Option<i32>
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
sourcepub fn publicly_accessible(&self) -> Option<bool>
pub fn publicly_accessible(&self) -> Option<bool>
Specifies the accessibility options for the DB instance.
When the DB instance is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB instance's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses. That public access is not permitted if the security group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
For more information, see CreateDBInstance.
This setting is only for non-Aurora Multi-AZ DB clusters.
sourcepub fn auto_minor_version_upgrade(&self) -> bool
pub fn auto_minor_version_upgrade(&self) -> bool
A value that indicates that minor version patches are applied automatically.
This setting is only for non-Aurora Multi-AZ DB clusters.
sourcepub fn monitoring_interval(&self) -> Option<i32>
pub fn monitoring_interval(&self) -> Option<i32>
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
This setting is only for non-Aurora Multi-AZ DB clusters.
sourcepub fn monitoring_role_arn(&self) -> Option<&str>
pub fn monitoring_role_arn(&self) -> Option<&str>
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for non-Aurora Multi-AZ DB clusters.
sourcepub fn performance_insights_enabled(&self) -> Option<bool>
pub fn performance_insights_enabled(&self) -> Option<bool>
True if Performance Insights is enabled for the DB cluster, and otherwise false.
This setting is only for non-Aurora Multi-AZ DB clusters.
sourcepub fn performance_insights_kms_key_id(&self) -> Option<&str>
pub fn performance_insights_kms_key_id(&self) -> Option<&str>
The Amazon Web Services KMS key identifier for encryption of Performance Insights data.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
This setting is only for non-Aurora Multi-AZ DB clusters.
sourcepub fn performance_insights_retention_period(&self) -> Option<i32>
pub fn performance_insights_retention_period(&self) -> Option<i32>
The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:
-
7
-
month * 31, where month is a number of months from 1-23
-
731
For example, the following values are valid:
-
93 (3 months * 31)
-
341 (11 months * 31)
-
589 (19 months * 31)
-
731
This setting is only for non-Aurora Multi-AZ DB clusters.
sourcepub fn serverless_v2_scaling_configuration(
&self
) -> Option<&ServerlessV2ScalingConfigurationInfo>
pub fn serverless_v2_scaling_configuration( &self ) -> Option<&ServerlessV2ScalingConfigurationInfo>
Shows the scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
sourcepub fn network_type(&self) -> Option<&str>
pub fn network_type(&self) -> Option<&str>
The network type of the DB instance.
Valid values:
-
IPV4 -
DUAL
The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
This setting is only for Aurora DB clusters.
sourcepub fn db_system_id(&self) -> Option<&str>
pub fn db_system_id(&self) -> Option<&str>
Reserved for future use.
sourcepub fn master_user_secret(&self) -> Option<&MasterUserSecret>
pub fn master_user_secret(&self) -> Option<&MasterUserSecret>
Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.
For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
sourcepub fn io_optimized_next_allowed_modification_time(&self) -> Option<&DateTime>
pub fn io_optimized_next_allowed_modification_time(&self) -> Option<&DateTime>
The next time you can modify the DB cluster to use the aurora-iopt1 storage type.
This setting is only for Aurora DB clusters.