#[non_exhaustive]pub struct AwsRdsDbInstanceDetails { /* private fields */ }
Expand description
Contains the details of an Amazon RDS DB instance.
Implementations§
source§impl AwsRdsDbInstanceDetails
impl AwsRdsDbInstanceDetails
sourcepub fn associated_roles(&self) -> Option<&[AwsRdsDbInstanceAssociatedRole]>
pub fn associated_roles(&self) -> Option<&[AwsRdsDbInstanceAssociatedRole]>
The IAM roles associated with the DB instance.
sourcepub fn ca_certificate_identifier(&self) -> Option<&str>
pub fn ca_certificate_identifier(&self) -> Option<&str>
The identifier of the CA certificate for this DB instance.
sourcepub fn db_cluster_identifier(&self) -> Option<&str>
pub fn db_cluster_identifier(&self) -> Option<&str>
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
sourcepub fn db_instance_identifier(&self) -> Option<&str>
pub fn db_instance_identifier(&self) -> Option<&str>
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
sourcepub fn db_instance_class(&self) -> Option<&str>
pub fn db_instance_class(&self) -> Option<&str>
Contains the name of the compute and memory capacity class of the DB instance.
sourcepub fn db_instance_port(&self) -> i32
pub fn db_instance_port(&self) -> i32
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
sourcepub fn dbi_resource_id(&self) -> Option<&str>
pub fn dbi_resource_id(&self) -> Option<&str>
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in CloudTrail log entries whenever the KMS key for the DB instance is accessed.
sourcepub fn db_name(&self) -> Option<&str>
pub fn db_name(&self) -> Option<&str>
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
sourcepub fn deletion_protection(&self) -> bool
pub fn deletion_protection(&self) -> bool
Indicates whether the DB instance has deletion protection enabled.
When deletion protection is enabled, the database cannot be deleted.
sourcepub fn endpoint(&self) -> Option<&AwsRdsDbInstanceEndpoint>
pub fn endpoint(&self) -> Option<&AwsRdsDbInstanceEndpoint>
Specifies the connection endpoint.
sourcepub fn engine(&self) -> Option<&str>
pub fn engine(&self) -> Option<&str>
Provides the name of the database engine to use for this DB instance.
sourcepub fn engine_version(&self) -> Option<&str>
pub fn engine_version(&self) -> Option<&str>
Indicates the database engine version.
sourcepub fn iam_database_authentication_enabled(&self) -> bool
pub fn iam_database_authentication_enabled(&self) -> bool
True if mapping of IAM accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines.
-
For MySQL 5.6, minor version 5.6.34 or higher
-
For MySQL 5.7, minor version 5.7.16 or higher
-
Aurora 5.6 or higher
sourcepub fn instance_create_time(&self) -> Option<&str>
pub fn instance_create_time(&self) -> Option<&str>
Indicates when the DB instance was created.
Uses the date-time
format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z
.
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 DB instance.
sourcepub fn publicly_accessible(&self) -> bool
pub fn publicly_accessible(&self) -> bool
Specifies the accessibility options for the DB instance.
A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address.
A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
sourcepub fn storage_encrypted(&self) -> bool
pub fn storage_encrypted(&self) -> bool
Specifies whether the DB instance is encrypted.
sourcepub fn tde_credential_arn(&self) -> Option<&str>
pub fn tde_credential_arn(&self) -> Option<&str>
The ARN from the key store with which the instance is associated for TDE encryption.
sourcepub fn vpc_security_groups(&self) -> Option<&[AwsRdsDbInstanceVpcSecurityGroup]>
pub fn vpc_security_groups(&self) -> Option<&[AwsRdsDbInstanceVpcSecurityGroup]>
A list of VPC security groups that the DB instance belongs to.
sourcepub fn multi_az(&self) -> bool
pub fn multi_az(&self) -> bool
Whether the DB instance is a multiple Availability Zone deployment.
sourcepub fn enhanced_monitoring_resource_arn(&self) -> Option<&str>
pub fn enhanced_monitoring_resource_arn(&self) -> Option<&str>
The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.
sourcepub fn db_instance_status(&self) -> Option<&str>
pub fn db_instance_status(&self) -> Option<&str>
The current status of the DB instance.
sourcepub fn master_username(&self) -> Option<&str>
pub fn master_username(&self) -> Option<&str>
The master user name of the DB instance.
sourcepub fn allocated_storage(&self) -> i32
pub fn allocated_storage(&self) -> i32
The amount of storage (in gigabytes) to initially allocate for the DB instance.
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 backup_retention_period(&self) -> i32
pub fn backup_retention_period(&self) -> i32
The number of days for which to retain automated backups.
sourcepub fn db_security_groups(&self) -> Option<&[String]>
pub fn db_security_groups(&self) -> Option<&[String]>
A list of the DB security groups to assign to the DB instance.
sourcepub fn db_parameter_groups(&self) -> Option<&[AwsRdsDbParameterGroup]>
pub fn db_parameter_groups(&self) -> Option<&[AwsRdsDbParameterGroup]>
A list of the DB parameter groups to assign to the DB instance.
sourcepub fn availability_zone(&self) -> Option<&str>
pub fn availability_zone(&self) -> Option<&str>
The Availability Zone where the DB instance will be created.
sourcepub fn db_subnet_group(&self) -> Option<&AwsRdsDbSubnetGroup>
pub fn db_subnet_group(&self) -> Option<&AwsRdsDbSubnetGroup>
Information about the subnet group that is associated with the DB instance.
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 pending_modified_values(&self) -> Option<&AwsRdsDbPendingModifiedValues>
pub fn pending_modified_values(&self) -> Option<&AwsRdsDbPendingModifiedValues>
Changes to the DB instance that are currently pending.
sourcepub fn latest_restorable_time(&self) -> Option<&str>
pub fn latest_restorable_time(&self) -> Option<&str>
Specifies the latest time to which a database can be restored with point-in-time restore.
Uses the date-time
format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z
.
sourcepub fn auto_minor_version_upgrade(&self) -> bool
pub fn auto_minor_version_upgrade(&self) -> bool
Indicates whether minor version patches are applied automatically.
sourcepub fn read_replica_source_db_instance_identifier(&self) -> Option<&str>
pub fn read_replica_source_db_instance_identifier(&self) -> Option<&str>
If this DB instance is a read replica, contains the identifier of the source DB instance.
sourcepub fn read_replica_db_instance_identifiers(&self) -> Option<&[String]>
pub fn read_replica_db_instance_identifiers(&self) -> Option<&[String]>
List of identifiers of the read replicas associated with this DB instance.
sourcepub fn read_replica_db_cluster_identifiers(&self) -> Option<&[String]>
pub fn read_replica_db_cluster_identifiers(&self) -> Option<&[String]>
List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.
sourcepub fn license_model(&self) -> Option<&str>
pub fn license_model(&self) -> Option<&str>
License model information for this DB instance.
sourcepub fn iops(&self) -> i32
pub fn iops(&self) -> i32
Specifies the provisioned IOPS (I/O operations per second) for this DB instance.
sourcepub fn option_group_memberships(
&self
) -> Option<&[AwsRdsDbOptionGroupMembership]>
pub fn option_group_memberships(
&self
) -> Option<&[AwsRdsDbOptionGroupMembership]>
The list of option group memberships for this DB instance.
sourcepub fn character_set_name(&self) -> Option<&str>
pub fn character_set_name(&self) -> Option<&str>
The name of the character set that this DB instance is associated with.
sourcepub fn secondary_availability_zone(&self) -> Option<&str>
pub fn secondary_availability_zone(&self) -> Option<&str>
For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.
sourcepub fn status_infos(&self) -> Option<&[AwsRdsDbStatusInfo]>
pub fn status_infos(&self) -> Option<&[AwsRdsDbStatusInfo]>
The status of a read replica. If the instance isn't a read replica, this is empty.
sourcepub fn storage_type(&self) -> Option<&str>
pub fn storage_type(&self) -> Option<&str>
The storage type for the DB instance.
sourcepub fn domain_memberships(&self) -> Option<&[AwsRdsDbDomainMembership]>
pub fn domain_memberships(&self) -> Option<&[AwsRdsDbDomainMembership]>
The Active Directory domain membership records associated with the DB instance.
Whether to copy resource tags to snapshots of the DB instance.
sourcepub fn monitoring_interval(&self) -> i32
pub fn monitoring_interval(&self) -> i32
The interval, in seconds, between points when enhanced monitoring metrics are collected for the DB instance.
sourcepub fn monitoring_role_arn(&self) -> Option<&str>
pub fn monitoring_role_arn(&self) -> Option<&str>
The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.
sourcepub fn promotion_tier(&self) -> i32
pub fn promotion_tier(&self) -> i32
The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.
sourcepub fn performance_insights_enabled(&self) -> bool
pub fn performance_insights_enabled(&self) -> bool
Indicates whether Performance Insights is enabled for the DB instance.
sourcepub fn performance_insights_kms_key_id(&self) -> Option<&str>
pub fn performance_insights_kms_key_id(&self) -> Option<&str>
The identifier of the KMS key used to encrypt the Performance Insights data.
sourcepub fn performance_insights_retention_period(&self) -> i32
pub fn performance_insights_retention_period(&self) -> i32
The number of days to retain Performance Insights data.
sourcepub fn enabled_cloud_watch_logs_exports(&self) -> Option<&[String]>
pub fn enabled_cloud_watch_logs_exports(&self) -> Option<&[String]>
A list of log types that this DB instance is configured to export to CloudWatch Logs.
sourcepub fn processor_features(&self) -> Option<&[AwsRdsDbProcessorFeature]>
pub fn processor_features(&self) -> Option<&[AwsRdsDbProcessorFeature]>
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
sourcepub fn listener_endpoint(&self) -> Option<&AwsRdsDbInstanceEndpoint>
pub fn listener_endpoint(&self) -> Option<&AwsRdsDbInstanceEndpoint>
Specifies the connection endpoint.
sourcepub fn max_allocated_storage(&self) -> i32
pub fn max_allocated_storage(&self) -> i32
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
source§impl AwsRdsDbInstanceDetails
impl AwsRdsDbInstanceDetails
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture AwsRdsDbInstanceDetails
.
Trait Implementations§
source§impl Clone for AwsRdsDbInstanceDetails
impl Clone for AwsRdsDbInstanceDetails
source§fn clone(&self) -> AwsRdsDbInstanceDetails
fn clone(&self) -> AwsRdsDbInstanceDetails
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for AwsRdsDbInstanceDetails
impl Debug for AwsRdsDbInstanceDetails
source§impl PartialEq<AwsRdsDbInstanceDetails> for AwsRdsDbInstanceDetails
impl PartialEq<AwsRdsDbInstanceDetails> for AwsRdsDbInstanceDetails
source§fn eq(&self, other: &AwsRdsDbInstanceDetails) -> bool
fn eq(&self, other: &AwsRdsDbInstanceDetails) -> bool
self
and other
values to be equal, and is used
by ==
.