#[non_exhaustive]pub struct DbInstance {Show 87 fields
pub db_instance_identifier: Option<String>,
pub db_instance_class: Option<String>,
pub engine: Option<String>,
pub db_instance_status: Option<String>,
pub automatic_restart_time: Option<DateTime>,
pub master_username: Option<String>,
pub db_name: Option<String>,
pub endpoint: Option<Endpoint>,
pub allocated_storage: Option<i32>,
pub instance_create_time: Option<DateTime>,
pub preferred_backup_window: Option<String>,
pub backup_retention_period: Option<i32>,
pub db_security_groups: Option<Vec<DbSecurityGroupMembership>>,
pub vpc_security_groups: Option<Vec<VpcSecurityGroupMembership>>,
pub db_parameter_groups: Option<Vec<DbParameterGroupStatus>>,
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 multi_az: Option<bool>,
pub engine_version: Option<String>,
pub auto_minor_version_upgrade: Option<bool>,
pub read_replica_source_db_instance_identifier: Option<String>,
pub read_replica_db_instance_identifiers: Option<Vec<String>>,
pub read_replica_db_cluster_identifiers: Option<Vec<String>>,
pub replica_mode: Option<ReplicaMode>,
pub license_model: Option<String>,
pub iops: Option<i32>,
pub option_group_memberships: Option<Vec<OptionGroupMembership>>,
pub character_set_name: Option<String>,
pub nchar_character_set_name: Option<String>,
pub secondary_availability_zone: Option<String>,
pub publicly_accessible: Option<bool>,
pub status_infos: Option<Vec<DbInstanceStatusInfo>>,
pub storage_type: Option<String>,
pub tde_credential_arn: Option<String>,
pub db_instance_port: Option<i32>,
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 domain_memberships: Option<Vec<DomainMembership>>,
pub copy_tags_to_snapshot: Option<bool>,
pub monitoring_interval: Option<i32>,
pub enhanced_monitoring_resource_arn: Option<String>,
pub monitoring_role_arn: Option<String>,
pub promotion_tier: Option<i32>,
pub db_instance_arn: Option<String>,
pub timezone: Option<String>,
pub iam_database_authentication_enabled: Option<bool>,
pub database_insights_mode: Option<DatabaseInsightsMode>,
pub performance_insights_enabled: Option<bool>,
pub performance_insights_kms_key_id: Option<String>,
pub performance_insights_retention_period: Option<i32>,
pub enabled_cloudwatch_logs_exports: Option<Vec<String>>,
pub processor_features: Option<Vec<ProcessorFeature>>,
pub deletion_protection: Option<bool>,
pub associated_roles: Option<Vec<DbInstanceRole>>,
pub listener_endpoint: Option<Endpoint>,
pub max_allocated_storage: Option<i32>,
pub tag_list: Option<Vec<Tag>>,
pub db_instance_automated_backups_replications: Option<Vec<DbInstanceAutomatedBackupsReplication>>,
pub customer_owned_ip_enabled: Option<bool>,
pub aws_backup_recovery_point_arn: Option<String>,
pub activity_stream_status: Option<ActivityStreamStatus>,
pub activity_stream_kms_key_id: Option<String>,
pub activity_stream_kinesis_stream_name: Option<String>,
pub activity_stream_mode: Option<ActivityStreamMode>,
pub activity_stream_engine_native_audit_fields_included: Option<bool>,
pub automation_mode: Option<AutomationMode>,
pub resume_full_automation_mode_time: Option<DateTime>,
pub custom_iam_instance_profile: Option<String>,
pub backup_target: Option<String>,
pub network_type: Option<String>,
pub activity_stream_policy_status: Option<ActivityStreamPolicyStatus>,
pub storage_throughput: Option<i32>,
pub db_system_id: Option<String>,
pub master_user_secret: Option<MasterUserSecret>,
pub certificate_details: Option<CertificateDetails>,
pub read_replica_source_db_cluster_identifier: Option<String>,
pub percent_progress: Option<String>,
pub dedicated_log_volume: Option<bool>,
pub is_storage_config_upgrade_available: Option<bool>,
pub multi_tenant: Option<bool>,
pub engine_lifecycle_support: Option<String>,
}
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
.
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>
The user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
db_instance_class: Option<String>
The name of the compute and memory capacity class of the DB instance.
engine: Option<String>
The database engine used for this DB instance.
db_instance_status: Option<String>
The current state of this database.
For information about DB instance statuses, see Viewing DB instance status in the Amazon RDS User Guide.
automatic_restart_time: Option<DateTime>
The time when a stopped DB instance is restarted automatically.
master_username: Option<String>
The master username for the DB instance.
db_name: Option<String>
The initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB.
endpoint: Option<Endpoint>
The connection endpoint for the DB instance.
The endpoint might not be shown for instances with the status of creating
.
allocated_storage: Option<i32>
The amount of storage in gibibytes (GiB) allocated for the DB instance.
instance_create_time: Option<DateTime>
The date and time when the DB instance was created.
preferred_backup_window: Option<String>
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>
The number of days for which automatic DB snapshots are retained.
db_security_groups: Option<Vec<DbSecurityGroupMembership>>
A list of DB security group elements containing DBSecurityGroup.Name
and DBSecurityGroup.Status
subelements.
vpc_security_groups: Option<Vec<VpcSecurityGroupMembership>>
The list of Amazon EC2 VPC security groups that the DB instance belongs to.
db_parameter_groups: Option<Vec<DbParameterGroupStatus>>
The list of DB parameter groups applied to this DB instance.
availability_zone: Option<String>
The name of the Availability Zone where the DB instance is located.
db_subnet_group: Option<DbSubnetGroup>
Information about the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
preferred_maintenance_window: Option<String>
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
pending_modified_values: Option<PendingModifiedValues>
Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.
latest_restorable_time: Option<DateTime>
The latest time to which a database in this DB instance can be restored with point-in-time restore.
multi_az: Option<bool>
Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.
engine_version: Option<String>
The version of the database engine.
auto_minor_version_upgrade: Option<bool>
Indicates whether minor version patches are applied automatically.
For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.
read_replica_source_db_instance_identifier: Option<String>
The identifier of the source DB instance if this DB instance is a read replica.
read_replica_db_instance_identifiers: Option<Vec<String>>
The identifiers of the read replicas associated with this DB instance.
read_replica_db_cluster_identifiers: Option<Vec<String>>
The 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.
replica_mode: Option<ReplicaMode>
The open mode of a Db2 or an Oracle read replica. The default is open-read-only
. For more information, see Working with replicas for Amazon RDS for Db2 and Working with read replicas for Amazon RDS for Oracle in the Amazon RDS User Guide.
This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom for Oracle.
license_model: Option<String>
The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
iops: Option<i32>
The Provisioned IOPS (I/O operations per second) value for the DB instance.
option_group_memberships: Option<Vec<OptionGroupMembership>>
The list of option group memberships for this DB instance.
character_set_name: Option<String>
If present, specifies the name of the character set that this instance is associated with.
nchar_character_set_name: Option<String>
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.
secondary_availability_zone: Option<String>
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
publicly_accessible: Option<bool>
Indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. 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
.
status_infos: Option<Vec<DbInstanceStatusInfo>>
The status of a read replica. If the DB instance isn't a read replica, the value is blank.
storage_type: Option<String>
The storage type associated with the DB instance.
tde_credential_arn: Option<String>
The ARN from the key store with which the instance is associated for TDE encryption.
db_instance_port: Option<i32>
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.
db_cluster_identifier: Option<String>
If the DB instance is a member of a DB cluster, indicates the name of the DB cluster that the DB instance is a member of.
storage_encrypted: Option<bool>
Indicates whether the DB instance is encrypted.
kms_key_id: Option<String>
If StorageEncrypted
is enabled, 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.
dbi_resource_id: Option<String>
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.
ca_certificate_identifier: Option<String>
The identifier of the CA certificate for this DB instance.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
domain_memberships: Option<Vec<DomainMembership>>
The Active Directory Domain membership records associated with the DB instance.
Indicates whether tags are copied from the DB instance to snapshots of the DB instance.
This setting doesn't apply to Amazon Aurora DB instances. 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
.
monitoring_interval: Option<i32>
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
enhanced_monitoring_resource_arn: Option<String>
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
monitoring_role_arn: Option<String>
The ARN for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
promotion_tier: Option<i32>
The order of priority 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.
db_instance_arn: Option<String>
The Amazon Resource Name (ARN) for the DB instance.
timezone: Option<String>
The time zone of the DB instance. In most cases, the Timezone
element is empty. Timezone
content appears only for RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified.
iam_database_authentication_enabled: Option<bool>
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.
For a list of engine versions that support IAM database authentication, see IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide.
database_insights_mode: Option<DatabaseInsightsMode>
The mode of Database Insights that is enabled for the instance.
performance_insights_enabled: Option<bool>
Indicates whether Performance Insights is enabled for the DB instance.
performance_insights_kms_key_id: Option<String>
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.
performance_insights_retention_period: Option<i32>
The number of days to retain Performance Insights data.
Valid Values:
-
7
-
month * 31, where month is a number of months from 1-23. Examples:
93
(3 months * 31),341
(11 months * 31),589
(19 months * 31) -
731
Default: 7
days
enabled_cloudwatch_logs_exports: Option<Vec<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 Monitoring Amazon RDS log files in the Amazon RDS User Guide.
processor_features: Option<Vec<ProcessorFeature>>
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
deletion_protection: Option<bool>
Indicates whether 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.
associated_roles: Option<Vec<DbInstanceRole>>
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
listener_endpoint: Option<Endpoint>
The listener connection endpoint for SQL Server Always On.
max_allocated_storage: Option<i32>
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance.
tag_list: Option<Vec<Tag>>
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
db_instance_automated_backups_replications: Option<Vec<DbInstanceAutomatedBackupsReplication>>
The list of replicated automated backups associated with the DB instance.
customer_owned_ip_enabled: Option<bool>
Indicates 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.
aws_backup_recovery_point_arn: Option<String>
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
activity_stream_status: Option<ActivityStreamStatus>
The status of the database activity stream.
activity_stream_kms_key_id: Option<String>
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.
activity_stream_kinesis_stream_name: Option<String>
The name of the Amazon Kinesis data stream used for the database activity stream.
activity_stream_mode: 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.
activity_stream_engine_native_audit_fields_included: Option<bool>
Indicates whether engine-native audit fields are included in the database activity stream.
automation_mode: 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
.
resume_full_automation_mode_time: 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.
custom_iam_instance_profile: Option<String>
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.
backup_target: Option<String>
The location where automated backups and manual snapshots are stored: Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web Services Region.
network_type: Option<String>
The network type of the DB instance.
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.
Valid Values: IPV4 | DUAL
activity_stream_policy_status: Option<ActivityStreamPolicyStatus>
The status of the policy state of the activity stream.
storage_throughput: Option<i32>
The storage throughput for the DB instance.
This setting applies only to the gp3
storage type.
db_system_id: Option<String>
The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.
master_user_secret: Option<MasterUserSecret>
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.
certificate_details: Option<CertificateDetails>
The details of the DB instance's server certificate.
read_replica_source_db_cluster_identifier: Option<String>
The identifier of the source DB cluster if this DB instance is a read replica.
percent_progress: Option<String>
The progress of the storage optimization operation as a percentage.
dedicated_log_volume: Option<bool>
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
is_storage_config_upgrade_available: Option<bool>
Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance. To migrate to the preferred configuration, you can either create a blue/green deployment, or create a read replica from the DB instance. For more information, see Upgrading the storage file system for a DB instance.
multi_tenant: Option<bool>
Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
engine_lifecycle_support: Option<String>
The lifecycle type for the DB instance.
For more information, see CreateDBInstance.
Implementations§
Source§impl DbInstance
impl DbInstance
Sourcepub fn db_instance_identifier(&self) -> Option<&str>
pub fn db_instance_identifier(&self) -> Option<&str>
The 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>
The name of the compute and memory capacity class of the DB instance.
Sourcepub fn db_instance_status(&self) -> Option<&str>
pub fn db_instance_status(&self) -> Option<&str>
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>
The master username for the DB instance.
Sourcepub fn db_name(&self) -> Option<&str>
pub fn db_name(&self) -> Option<&str>
The initial database name that you provided (if required) when you created the DB instance. This name is returned for the life of your DB instance. For an RDS for Oracle CDB instance, the name identifies the PDB rather than the CDB.
Sourcepub fn endpoint(&self) -> Option<&Endpoint>
pub fn endpoint(&self) -> Option<&Endpoint>
The connection endpoint for the DB instance.
The endpoint might not be shown for instances with the status of creating
.
Sourcepub fn allocated_storage(&self) -> Option<i32>
pub fn allocated_storage(&self) -> Option<i32>
The amount of storage in gibibytes (GiB) allocated for the DB instance.
Sourcepub fn instance_create_time(&self) -> Option<&DateTime>
pub fn instance_create_time(&self) -> Option<&DateTime>
The date and time when the DB instance was created.
Sourcepub fn preferred_backup_window(&self) -> Option<&str>
pub fn preferred_backup_window(&self) -> Option<&str>
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>
The number of days for which automatic DB snapshots are retained.
Sourcepub fn db_security_groups(&self) -> &[DbSecurityGroupMembership]
pub fn db_security_groups(&self) -> &[DbSecurityGroupMembership]
A list of DB security group elements containing DBSecurityGroup.Name
and DBSecurityGroup.Status
subelements.
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_security_groups.is_none()
.
Sourcepub fn vpc_security_groups(&self) -> &[VpcSecurityGroupMembership]
pub fn vpc_security_groups(&self) -> &[VpcSecurityGroupMembership]
The list of Amazon EC2 VPC security groups that the DB 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 db_parameter_groups(&self) -> &[DbParameterGroupStatus]
pub fn db_parameter_groups(&self) -> &[DbParameterGroupStatus]
The list of DB parameter groups applied to this DB instance.
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_parameter_groups.is_none()
.
Sourcepub fn availability_zone(&self) -> Option<&str>
pub fn availability_zone(&self) -> Option<&str>
The name of the Availability Zone where the DB instance is located.
Sourcepub fn db_subnet_group(&self) -> Option<&DbSubnetGroup>
pub fn db_subnet_group(&self) -> Option<&DbSubnetGroup>
Information about 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>
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>
Information about pending changes to the DB instance. This information is returned only when there are pending changes. Specific changes are identified by subelements.
Sourcepub fn latest_restorable_time(&self) -> Option<&DateTime>
pub fn latest_restorable_time(&self) -> Option<&DateTime>
The latest time to which a database in this DB instance can be restored with point-in-time restore.
Sourcepub fn multi_az(&self) -> Option<bool>
pub fn multi_az(&self) -> Option<bool>
Indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom DB instances.
Sourcepub fn engine_version(&self) -> Option<&str>
pub fn engine_version(&self) -> Option<&str>
The version of the database engine.
Sourcepub fn auto_minor_version_upgrade(&self) -> Option<bool>
pub fn auto_minor_version_upgrade(&self) -> Option<bool>
Indicates whether minor version patches are applied automatically.
For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.
Sourcepub fn read_replica_source_db_instance_identifier(&self) -> Option<&str>
pub fn read_replica_source_db_instance_identifier(&self) -> Option<&str>
The identifier of the source DB instance if this DB instance is a read replica.
Sourcepub fn read_replica_db_instance_identifiers(&self) -> &[String]
pub fn read_replica_db_instance_identifiers(&self) -> &[String]
The identifiers of the read replicas associated with this DB instance.
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_db_instance_identifiers.is_none()
.
Sourcepub fn read_replica_db_cluster_identifiers(&self) -> &[String]
pub fn read_replica_db_cluster_identifiers(&self) -> &[String]
The 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.
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_db_cluster_identifiers.is_none()
.
Sourcepub fn replica_mode(&self) -> Option<&ReplicaMode>
pub fn replica_mode(&self) -> Option<&ReplicaMode>
The open mode of a Db2 or an Oracle read replica. The default is open-read-only
. For more information, see Working with replicas for Amazon RDS for Db2 and Working with read replicas for Amazon RDS for Oracle in the Amazon RDS User Guide.
This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom for Oracle.
Sourcepub fn license_model(&self) -> Option<&str>
pub fn license_model(&self) -> Option<&str>
The license model information for this DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances.
Sourcepub fn iops(&self) -> Option<i32>
pub fn iops(&self) -> Option<i32>
The Provisioned IOPS (I/O operations per second) value for the DB instance.
Sourcepub fn option_group_memberships(&self) -> &[OptionGroupMembership]
pub fn option_group_memberships(&self) -> &[OptionGroupMembership]
The list of option group memberships for this DB instance.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .option_group_memberships.is_none()
.
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) -> Option<bool>
pub fn publicly_accessible(&self) -> Option<bool>
Indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. 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) -> &[DbInstanceStatusInfo]
pub fn status_infos(&self) -> &[DbInstanceStatusInfo]
The status of a read replica. If the DB instance isn't a read replica, the value 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 storage_type(&self) -> Option<&str>
pub fn storage_type(&self) -> Option<&str>
The storage type associated with the 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) -> Option<i32>
pub fn db_instance_port(&self) -> Option<i32>
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, indicates the name of the DB cluster that the DB instance is a member of.
Sourcepub fn storage_encrypted(&self) -> Option<bool>
pub fn storage_encrypted(&self) -> Option<bool>
Indicates 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 enabled, 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.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide.
Sourcepub fn domain_memberships(&self) -> &[DomainMembership]
pub fn domain_memberships(&self) -> &[DomainMembership]
The Active Directory Domain membership records associated with the DB instance.
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()
.
Indicates whether tags are copied from the DB instance to snapshots of the DB instance.
This setting doesn't apply to Amazon Aurora DB instances. 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>
The order of priority 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 RDS for Db2 and RDS for SQL Server DB instances that were created with a time zone specified.
Sourcepub fn iam_database_authentication_enabled(&self) -> Option<bool>
pub fn iam_database_authentication_enabled(&self) -> Option<bool>
Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled for the DB instance.
For a list of engine versions that support IAM database authentication, see IAM database authentication in the Amazon RDS User Guide and IAM database authentication in Aurora in the Amazon Aurora User Guide.
Sourcepub fn database_insights_mode(&self) -> Option<&DatabaseInsightsMode>
pub fn database_insights_mode(&self) -> Option<&DatabaseInsightsMode>
The mode of Database Insights that is enabled for the instance.
Sourcepub fn performance_insights_enabled(&self) -> Option<bool>
pub fn performance_insights_enabled(&self) -> Option<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 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.
Valid Values:
-
7
-
month * 31, where month is a number of months from 1-23. Examples:
93
(3 months * 31),341
(11 months * 31),589
(19 months * 31) -
731
Default: 7
days
Sourcepub fn enabled_cloudwatch_logs_exports(&self) -> &[String]
pub fn enabled_cloudwatch_logs_exports(&self) -> &[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 Monitoring Amazon RDS log files in the Amazon RDS User Guide.
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 processor_features(&self) -> &[ProcessorFeature]
pub fn processor_features(&self) -> &[ProcessorFeature]
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .processor_features.is_none()
.
Sourcepub fn deletion_protection(&self) -> Option<bool>
pub fn deletion_protection(&self) -> Option<bool>
Indicates whether 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) -> &[DbInstanceRole]
pub fn associated_roles(&self) -> &[DbInstanceRole]
The Amazon Web Services Identity and Access Management (IAM) roles associated with the DB instance.
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 listener_endpoint(&self) -> Option<&Endpoint>
pub fn listener_endpoint(&self) -> Option<&Endpoint>
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) -> &[Tag]
pub fn tag_list(&self) -> &[Tag]
A list of tags.
For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tag_list.is_none()
.
Sourcepub fn db_instance_automated_backups_replications(
&self,
) -> &[DbInstanceAutomatedBackupsReplication]
pub fn db_instance_automated_backups_replications( &self, ) -> &[DbInstanceAutomatedBackupsReplication]
The list of replicated automated backups associated with the DB instance.
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_instance_automated_backups_replications.is_none()
.
Sourcepub fn customer_owned_ip_enabled(&self) -> Option<bool>
pub fn customer_owned_ip_enabled(&self) -> Option<bool>
Indicates 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>
The location where automated backups and manual snapshots are stored: Dedicated Local Zones, 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.
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.
Valid Values: IPV4 | DUAL
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.
Sourcepub fn storage_throughput(&self) -> Option<i32>
pub fn storage_throughput(&self) -> Option<i32>
The storage throughput for the DB instance.
This setting applies only to the gp3
storage type.
Sourcepub fn db_system_id(&self) -> Option<&str>
pub fn db_system_id(&self) -> Option<&str>
The Oracle system ID (Oracle SID) for a container database (CDB). The Oracle SID is also the name of the CDB. This setting is only valid for RDS Custom DB instances.
Sourcepub fn master_user_secret(&self) -> Option<&MasterUserSecret>
pub fn master_user_secret(&self) -> Option<&MasterUserSecret>
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.
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 read_replica_source_db_cluster_identifier(&self) -> Option<&str>
pub fn read_replica_source_db_cluster_identifier(&self) -> Option<&str>
The identifier of the source DB cluster if this DB instance is a read replica.
Sourcepub fn percent_progress(&self) -> Option<&str>
pub fn percent_progress(&self) -> Option<&str>
The progress of the storage optimization operation as a percentage.
Sourcepub fn dedicated_log_volume(&self) -> Option<bool>
pub fn dedicated_log_volume(&self) -> Option<bool>
Indicates whether the DB instance has a dedicated log volume (DLV) enabled.
Sourcepub fn is_storage_config_upgrade_available(&self) -> Option<bool>
pub fn is_storage_config_upgrade_available(&self) -> Option<bool>
Indicates whether an upgrade is recommended for the storage file system configuration on the DB instance. To migrate to the preferred configuration, you can either create a blue/green deployment, or create a read replica from the DB instance. For more information, see Upgrading the storage file system for a DB instance.
Sourcepub fn multi_tenant(&self) -> Option<bool>
pub fn multi_tenant(&self) -> Option<bool>
Specifies whether the DB instance is in the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).
Sourcepub fn engine_lifecycle_support(&self) -> Option<&str>
pub fn engine_lifecycle_support(&self) -> Option<&str>
The lifecycle type for the DB instance.
For more information, see CreateDBInstance.
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);