Struct aws_sdk_rds::model::DbInstance
source · [−]#[non_exhaustive]pub struct DbInstance { /* private fields */ }Expand description
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance, CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances, ModifyDBInstance, PromoteReadReplica, RebootDBInstance, RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3, RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
Implementations
sourceimpl DbInstance
impl DbInstance
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 engine(&self) -> Option<&str>
pub fn engine(&self) -> Option<&str>
The name of the database engine to be used for this DB instance.
sourcepub fn db_instance_status(&self) -> Option<&str>
pub fn db_instance_status(&self) -> Option<&str>
Specifies the current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
sourcepub fn automatic_restart_time(&self) -> Option<&DateTime>
pub fn automatic_restart_time(&self) -> Option<&DateTime>
The time when a stopped DB instance is restarted automatically.
sourcepub fn master_username(&self) -> Option<&str>
pub fn master_username(&self) -> Option<&str>
Contains the master username for the DB instance.
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.
Type: String
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 endpoint(&self) -> Option<&Endpoint>
pub fn endpoint(&self) -> Option<&Endpoint>
Specifies the connection endpoint.
The endpoint might not be shown for instances whose status is creating.
sourcepub fn allocated_storage(&self) -> i32
pub fn allocated_storage(&self) -> i32
Specifies the allocated storage size specified in gibibytes (GiB).
sourcepub fn instance_create_time(&self) -> Option<&DateTime>
pub fn instance_create_time(&self) -> Option<&DateTime>
Provides the date and time the DB instance was created.
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 backup_retention_period(&self) -> i32
pub fn backup_retention_period(&self) -> i32
Specifies the number of days for which automatic DB snapshots are retained.
sourcepub fn db_security_groups(&self) -> Option<&[DbSecurityGroupMembership]>
pub fn db_security_groups(&self) -> Option<&[DbSecurityGroupMembership]>
A list of DB security group elements containing DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
sourcepub fn vpc_security_groups(&self) -> Option<&[VpcSecurityGroupMembership]>
pub fn vpc_security_groups(&self) -> Option<&[VpcSecurityGroupMembership]>
Provides a list of VPC security group elements that the DB instance belongs to.
sourcepub fn db_parameter_groups(&self) -> Option<&[DbParameterGroupStatus]>
pub fn db_parameter_groups(&self) -> Option<&[DbParameterGroupStatus]>
Provides the list of DB parameter groups applied to this DB instance.
sourcepub fn availability_zone(&self) -> Option<&str>
pub fn availability_zone(&self) -> Option<&str>
Specifies the name of the Availability Zone the DB instance is located in.
sourcepub fn db_subnet_group(&self) -> Option<&DbSubnetGroup>
pub fn db_subnet_group(&self) -> Option<&DbSubnetGroup>
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
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 pending_modified_values(&self) -> Option<&PendingModifiedValues>
pub fn pending_modified_values(&self) -> Option<&PendingModifiedValues>
A value that specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
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 multi_az(&self) -> bool
pub fn multi_az(&self) -> bool
Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
sourcepub fn engine_version(&self) -> Option<&str>
pub fn engine_version(&self) -> Option<&str>
Indicates the database engine version.
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.
sourcepub fn read_replica_source_db_instance_identifier(&self) -> Option<&str>
pub fn read_replica_source_db_instance_identifier(&self) -> Option<&str>
Contains the identifier of the source DB instance if this DB instance is a read replica.
sourcepub fn read_replica_db_instance_identifiers(&self) -> Option<&[String]>
pub fn read_replica_db_instance_identifiers(&self) -> Option<&[String]>
Contains one or more 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]>
Contains one or more identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica. For example, when you create an Aurora read replica of an RDS for MySQL DB instance, the Aurora MySQL DB cluster for the Aurora read replica is shown. This output doesn't contain information about cross-Region Aurora read replicas.
Currently, each RDS DB instance can have only one Aurora read replica.
sourcepub fn replica_mode(&self) -> Option<&ReplicaMode>
pub fn replica_mode(&self) -> Option<&ReplicaMode>
The open mode of an Oracle read replica. The default is open-read-only. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
This attribute is only supported in RDS for Oracle.
sourcepub fn license_model(&self) -> Option<&str>
pub fn license_model(&self) -> Option<&str>
License model information for this DB instance. This setting doesn't apply to RDS Custom.
sourcepub fn iops(&self) -> Option<i32>
pub fn iops(&self) -> Option<i32>
Specifies the Provisioned IOPS (I/O operations per second) value.
sourcepub fn option_group_memberships(&self) -> Option<&[OptionGroupMembership]>
pub fn option_group_memberships(&self) -> Option<&[OptionGroupMembership]>
Provides 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>
If present, specifies the name of the character set that this instance is associated with.
sourcepub fn nchar_character_set_name(&self) -> Option<&str>
pub fn nchar_character_set_name(&self) -> Option<&str>
The name of the NCHAR character set for the Oracle DB instance. This character set specifies the Unicode encoding for data stored in table columns of type NCHAR, NCLOB, or NVARCHAR2.
sourcepub fn secondary_availability_zone(&self) -> Option<&str>
pub fn secondary_availability_zone(&self) -> Option<&str>
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
sourcepub fn publicly_accessible(&self) -> bool
pub fn publicly_accessible(&self) -> bool
Specifies the accessibility options for the DB instance.
When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster 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.
sourcepub fn status_infos(&self) -> Option<&[DbInstanceStatusInfo]>
pub fn status_infos(&self) -> Option<&[DbInstanceStatusInfo]>
The status of a read replica. If the instance isn't a read replica, this is blank.
sourcepub fn storage_type(&self) -> Option<&str>
pub fn storage_type(&self) -> Option<&str>
Specifies the storage type associated with DB instance.
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 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 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 storage_encrypted(&self) -> bool
pub fn storage_encrypted(&self) -> bool
Specifies whether the DB instance is encrypted.
sourcepub fn kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
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 Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
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 domain_memberships(&self) -> Option<&[DomainMembership]>
pub fn domain_memberships(&self) -> Option<&[DomainMembership]>
The Active Directory Domain membership records associated with the DB instance.
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. For more information, see DBCluster.
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 instance.
sourcepub fn enhanced_monitoring_resource_arn(&self) -> Option<&str>
pub fn enhanced_monitoring_resource_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data 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 RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
sourcepub fn promotion_tier(&self) -> Option<i32>
pub fn promotion_tier(&self) -> Option<i32>
A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide.
sourcepub fn db_instance_arn(&self) -> Option<&str>
pub fn db_instance_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) for the DB instance.
sourcepub fn timezone(&self) -> Option<&str>
pub fn timezone(&self) -> Option<&str>
The time zone of the DB instance. In most cases, the Timezone element is empty. Timezone content appears only for Microsoft SQL Server DB instances that were created with a time zone specified.
sourcepub fn iam_database_authentication_enabled(&self) -> bool
pub fn iam_database_authentication_enabled(&self) -> bool
True if mapping of Amazon Web Services Identity and Access Management (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. To enable IAM database authentication for Aurora, see DBCluster Type.
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 instance, and otherwise false.
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.
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
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 instance 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 RDS User Guide.
sourcepub fn processor_features(&self) -> Option<&[ProcessorFeature]>
pub fn processor_features(&self) -> Option<&[ProcessorFeature]>
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
sourcepub fn deletion_protection(&self) -> bool
pub fn deletion_protection(&self) -> bool
Indicates if the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. For more information, see Deleting a DB Instance.
sourcepub fn associated_roles(&self) -> Option<&[DbInstanceRole]>
pub fn associated_roles(&self) -> Option<&[DbInstanceRole]>
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
sourcepub fn listener_endpoint(&self) -> Option<&Endpoint>
pub fn listener_endpoint(&self) -> Option<&Endpoint>
Specifies the listener connection endpoint for SQL Server Always On.
sourcepub fn max_allocated_storage(&self) -> Option<i32>
pub fn max_allocated_storage(&self) -> Option<i32>
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
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 db_instance_automated_backups_replications(
&self
) -> Option<&[DbInstanceAutomatedBackupsReplication]>
pub fn db_instance_automated_backups_replications(
&self
) -> Option<&[DbInstanceAutomatedBackupsReplication]>
The list of replicated automated backups associated with the DB instance.
sourcepub fn customer_owned_ip_enabled(&self) -> Option<bool>
pub fn customer_owned_ip_enabled(&self) -> Option<bool>
Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
sourcepub fn aws_backup_recovery_point_arn(&self) -> Option<&str>
pub fn aws_backup_recovery_point_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
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.
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. RDS for Oracle always handles these events asynchronously.
sourcepub fn activity_stream_engine_native_audit_fields_included(
&self
) -> Option<bool>
pub fn activity_stream_engine_native_audit_fields_included(
&self
) -> Option<bool>
Indicates whether engine-native audit fields are included in the database activity stream.
sourcepub fn automation_mode(&self) -> Option<&AutomationMode>
pub fn automation_mode(&self) -> Option<&AutomationMode>
The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.
sourcepub fn resume_full_automation_mode_time(&self) -> Option<&DateTime>
pub fn resume_full_automation_mode_time(&self) -> Option<&DateTime>
The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
sourcepub fn custom_iam_instance_profile(&self) -> Option<&str>
pub fn custom_iam_instance_profile(&self) -> Option<&str>
The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements:
-
The profile must exist in your account.
-
The profile must have an IAM role that Amazon EC2 has permissions to assume.
-
The instance profile name and the associated IAM role name must start with the prefix
AWSRDSCustom.
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide.
sourcepub fn backup_target(&self) -> Option<&str>
pub fn backup_target(&self) -> Option<&str>
Specifies where automated backups and manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
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 instance. 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 RDS User Guide and Working with a DB instance in a VPC in the Amazon Aurora User Guide.
sourcepub fn activity_stream_policy_status(
&self
) -> Option<&ActivityStreamPolicyStatus>
pub fn activity_stream_policy_status(
&self
) -> Option<&ActivityStreamPolicyStatus>
The status of the policy state of the activity stream.
sourceimpl DbInstance
impl DbInstance
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture DbInstance.
Trait Implementations
sourceimpl Clone for DbInstance
impl Clone for DbInstance
sourcefn clone(&self) -> DbInstance
fn clone(&self) -> DbInstance
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more