#[non_exhaustive]pub struct DbInstance {Show 30 fields
pub db_instance_identifier: Option<String>,
pub db_instance_class: Option<String>,
pub engine: Option<String>,
pub db_instance_status: Option<String>,
pub endpoint: Option<Endpoint>,
pub instance_create_time: Option<DateTime>,
pub preferred_backup_window: Option<String>,
pub backup_retention_period: Option<i32>,
pub vpc_security_groups: Option<Vec<VpcSecurityGroupMembership>>,
pub availability_zone: Option<String>,
pub db_subnet_group: Option<DbSubnetGroup>,
pub preferred_maintenance_window: Option<String>,
pub pending_modified_values: Option<PendingModifiedValues>,
pub latest_restorable_time: Option<DateTime>,
pub engine_version: Option<String>,
pub auto_minor_version_upgrade: Option<bool>,
pub publicly_accessible: Option<bool>,
pub status_infos: Option<Vec<DbInstanceStatusInfo>>,
pub db_cluster_identifier: Option<String>,
pub storage_encrypted: Option<bool>,
pub kms_key_id: Option<String>,
pub dbi_resource_id: Option<String>,
pub ca_certificate_identifier: Option<String>,
pub copy_tags_to_snapshot: Option<bool>,
pub promotion_tier: Option<i32>,
pub db_instance_arn: Option<String>,
pub enabled_cloudwatch_logs_exports: Option<Vec<String>>,
pub certificate_details: Option<CertificateDetails>,
pub performance_insights_enabled: Option<bool>,
pub performance_insights_kms_key_id: Option<String>,
}Expand description
Detailed information about an instance.
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.db_instance_identifier: Option<String>Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.
db_instance_class: Option<String>Contains the name of the compute and memory capacity class of the instance.
engine: Option<String>Provides the name of the database engine to be used for this instance.
db_instance_status: Option<String>Specifies the current state of this database.
endpoint: Option<Endpoint>Specifies the connection endpoint.
instance_create_time: Option<DateTime>Provides the date and time that the instance was created.
preferred_backup_window: Option<String>Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
backup_retention_period: Option<i32>Specifies the number of days for which automatic snapshots are retained.
vpc_security_groups: Option<Vec<VpcSecurityGroupMembership>>Provides a list of VPC security group elements that the instance belongs to.
availability_zone: Option<String>Specifies the name of the Availability Zone that the instance is located in.
db_subnet_group: Option<DbSubnetGroup>Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.
preferred_maintenance_window: Option<String>Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
pending_modified_values: Option<PendingModifiedValues>Specifies that changes to the instance are pending. This element is included only when changes are pending. Specific changes are identified by subelements.
latest_restorable_time: Option<DateTime>Specifies the latest time to which a database can be restored with point-in-time restore.
engine_version: Option<String>Indicates the database engine version.
auto_minor_version_upgrade: Option<bool>Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
publicly_accessible: Option<bool>Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.
status_infos: Option<Vec<DbInstanceStatusInfo>>The status of a read replica. If the instance is not a read replica, this is blank.
db_cluster_identifier: Option<String>Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
storage_encrypted: Option<bool>Specifies whether or not the instance is encrypted.
kms_key_id: Option<String>If StorageEncrypted is true, the KMS key identifier for the encrypted instance.
dbi_resource_id: Option<String>The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.
ca_certificate_identifier: Option<String>The identifier of the CA certificate for this DB instance.
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
promotion_tier: Option<i32>A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
db_instance_arn: Option<String>The Amazon Resource Name (ARN) for the instance.
enabled_cloudwatch_logs_exports: Option<Vec<String>>A list of log types that this instance is configured to export to CloudWatch Logs.
certificate_details: Option<CertificateDetails>The details of the DB instance's server certificate.
performance_insights_enabled: Option<bool>Set to true if Amazon RDS Performance Insights is enabled for the DB instance, and otherwise false.
performance_insights_kms_key_id: Option<String>The KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
Implementations§
Source§impl DbInstance
impl DbInstance
Sourcepub fn db_instance_identifier(&self) -> Option<&str>
pub fn db_instance_identifier(&self) -> Option<&str>
Contains a user-provided database identifier. This identifier is the unique key that identifies an 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 instance.
Sourcepub fn engine(&self) -> Option<&str>
pub fn engine(&self) -> Option<&str>
Provides the name of the database engine to be used for this instance.
Sourcepub fn db_instance_status(&self) -> Option<&str>
pub fn db_instance_status(&self) -> Option<&str>
Specifies the current state of this database.
Sourcepub fn instance_create_time(&self) -> Option<&DateTime>
pub fn instance_create_time(&self) -> Option<&DateTime>
Provides the date and time that the 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) -> Option<i32>
pub fn backup_retention_period(&self) -> Option<i32>
Specifies the number of days for which automatic snapshots are retained.
Sourcepub fn vpc_security_groups(&self) -> &[VpcSecurityGroupMembership]
pub fn vpc_security_groups(&self) -> &[VpcSecurityGroupMembership]
Provides a list of VPC security group elements that the instance 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 availability_zone(&self) -> Option<&str>
pub fn availability_zone(&self) -> Option<&str>
Specifies the name of the Availability Zone that the 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 that is associated with the 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>
Specifies that changes to the instance are pending. This element is included only 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 engine_version(&self) -> Option<&str>
pub fn engine_version(&self) -> Option<&str>
Indicates the database engine version.
Sourcepub fn auto_minor_version_upgrade(&self) -> Option<bool>
pub fn auto_minor_version_upgrade(&self) -> Option<bool>
Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
Sourcepub fn publicly_accessible(&self) -> Option<bool>
pub fn publicly_accessible(&self) -> Option<bool>
Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.
Sourcepub fn status_infos(&self) -> &[DbInstanceStatusInfo]
pub fn status_infos(&self) -> &[DbInstanceStatusInfo]
The status of a read replica. If the instance is not a read replica, this is blank.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .status_infos.is_none().
Sourcepub fn db_cluster_identifier(&self) -> Option<&str>
pub fn db_cluster_identifier(&self) -> Option<&str>
Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
Sourcepub fn storage_encrypted(&self) -> Option<bool>
pub fn storage_encrypted(&self) -> Option<bool>
Specifies whether or not the instance is encrypted.
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 instance.
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 instance. This identifier is found in CloudTrail log entries whenever the KMS key for the 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.
A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.
Sourcepub fn promotion_tier(&self) -> Option<i32>
pub fn promotion_tier(&self) -> Option<i32>
A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.
Sourcepub fn db_instance_arn(&self) -> Option<&str>
pub fn db_instance_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) for the instance.
Sourcepub fn enabled_cloudwatch_logs_exports(&self) -> &[String]
pub fn enabled_cloudwatch_logs_exports(&self) -> &[String]
A list of log types that this instance 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_cloudwatch_logs_exports.is_none().
Sourcepub fn certificate_details(&self) -> Option<&CertificateDetails>
pub fn certificate_details(&self) -> Option<&CertificateDetails>
The details of the DB instance's server certificate.
Sourcepub fn performance_insights_enabled(&self) -> Option<bool>
pub fn performance_insights_enabled(&self) -> Option<bool>
Set to true if Amazon RDS 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 KMS key identifier for encryption of Performance Insights data. The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS key alias for the KMS encryption key.
Source§impl DbInstance
impl DbInstance
Sourcepub fn builder() -> DbInstanceBuilder
pub fn builder() -> DbInstanceBuilder
Creates a new builder-style object to manufacture DbInstance.
Trait Implementations§
Source§impl Clone for DbInstance
impl Clone for DbInstance
Source§fn clone(&self) -> DbInstance
fn clone(&self) -> DbInstance
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for DbInstance
impl Debug for DbInstance
Source§impl PartialEq for DbInstance
impl PartialEq for DbInstance
impl StructuralPartialEq for DbInstance
Auto Trait Implementations§
impl Freeze for DbInstance
impl RefUnwindSafe for DbInstance
impl Send for DbInstance
impl Sync for DbInstance
impl Unpin for DbInstance
impl UnwindSafe for DbInstance
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);