#[non_exhaustive]pub struct AwsRdsDbInstanceDetailsBuilder { /* private fields */ }
Expand description
A builder for AwsRdsDbInstanceDetails
.
Implementations§
Source§impl AwsRdsDbInstanceDetailsBuilder
impl AwsRdsDbInstanceDetailsBuilder
Sourcepub fn associated_roles(self, input: AwsRdsDbInstanceAssociatedRole) -> Self
pub fn associated_roles(self, input: AwsRdsDbInstanceAssociatedRole) -> Self
Appends an item to associated_roles
.
To override the contents of this collection use set_associated_roles
.
The IAM roles associated with the DB instance.
Sourcepub fn set_associated_roles(
self,
input: Option<Vec<AwsRdsDbInstanceAssociatedRole>>,
) -> Self
pub fn set_associated_roles( self, input: Option<Vec<AwsRdsDbInstanceAssociatedRole>>, ) -> Self
The IAM roles associated with the DB instance.
Sourcepub fn get_associated_roles(
&self,
) -> &Option<Vec<AwsRdsDbInstanceAssociatedRole>>
pub fn get_associated_roles( &self, ) -> &Option<Vec<AwsRdsDbInstanceAssociatedRole>>
The IAM roles associated with the DB instance.
Sourcepub fn ca_certificate_identifier(self, input: impl Into<String>) -> Self
pub fn ca_certificate_identifier(self, input: impl Into<String>) -> Self
The identifier of the CA certificate for this DB instance.
Sourcepub fn set_ca_certificate_identifier(self, input: Option<String>) -> Self
pub fn set_ca_certificate_identifier(self, input: Option<String>) -> Self
The identifier of the CA certificate for this DB instance.
Sourcepub fn get_ca_certificate_identifier(&self) -> &Option<String>
pub fn get_ca_certificate_identifier(&self) -> &Option<String>
The identifier of the CA certificate for this DB instance.
Sourcepub fn db_cluster_identifier(self, input: impl Into<String>) -> Self
pub fn db_cluster_identifier(self, input: impl Into<String>) -> Self
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 set_db_cluster_identifier(self, input: Option<String>) -> Self
pub fn set_db_cluster_identifier(self, input: Option<String>) -> Self
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 get_db_cluster_identifier(&self) -> &Option<String>
pub fn get_db_cluster_identifier(&self) -> &Option<String>
If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
Sourcepub fn db_instance_identifier(self, input: impl Into<String>) -> Self
pub fn db_instance_identifier(self, input: impl Into<String>) -> Self
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
Sourcepub fn set_db_instance_identifier(self, input: Option<String>) -> Self
pub fn set_db_instance_identifier(self, input: Option<String>) -> Self
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
Sourcepub fn get_db_instance_identifier(&self) -> &Option<String>
pub fn get_db_instance_identifier(&self) -> &Option<String>
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
Sourcepub fn db_instance_class(self, input: impl Into<String>) -> Self
pub fn db_instance_class(self, input: impl Into<String>) -> Self
Contains the name of the compute and memory capacity class of the DB instance.
Sourcepub fn set_db_instance_class(self, input: Option<String>) -> Self
pub fn set_db_instance_class(self, input: Option<String>) -> Self
Contains the name of the compute and memory capacity class of the DB instance.
Sourcepub fn get_db_instance_class(&self) -> &Option<String>
pub fn get_db_instance_class(&self) -> &Option<String>
Contains the name of the compute and memory capacity class of the DB instance.
Sourcepub fn db_instance_port(self, input: i32) -> Self
pub fn db_instance_port(self, input: i32) -> Self
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 set_db_instance_port(self, input: Option<i32>) -> Self
pub fn set_db_instance_port(self, input: Option<i32>) -> Self
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 get_db_instance_port(&self) -> &Option<i32>
pub fn get_db_instance_port(&self) -> &Option<i32>
Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
Sourcepub fn dbi_resource_id(self, input: impl Into<String>) -> Self
pub fn dbi_resource_id(self, input: impl Into<String>) -> Self
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in CloudTrail log entries whenever the KMS key for the DB instance is accessed.
Sourcepub fn set_dbi_resource_id(self, input: Option<String>) -> Self
pub fn set_dbi_resource_id(self, input: Option<String>) -> Self
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in CloudTrail log entries whenever the KMS key for the DB instance is accessed.
Sourcepub fn get_dbi_resource_id(&self) -> &Option<String>
pub fn get_dbi_resource_id(&self) -> &Option<String>
The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in CloudTrail log entries whenever the KMS key for the DB instance is accessed.
Sourcepub fn db_name(self, input: impl Into<String>) -> Self
pub fn db_name(self, input: impl Into<String>) -> Self
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters don't apply to an Oracle DB instance.
Sourcepub fn set_db_name(self, input: Option<String>) -> Self
pub fn set_db_name(self, input: Option<String>) -> Self
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters don't apply to an Oracle DB instance.
Sourcepub fn get_db_name(&self) -> &Option<String>
pub fn get_db_name(&self) -> &Option<String>
The meaning of this parameter differs according to the database engine you use.
MySQL, MariaDB, SQL Server, PostgreSQL
Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
Oracle
Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters don't apply to an Oracle DB instance.
Sourcepub fn deletion_protection(self, input: bool) -> Self
pub fn deletion_protection(self, input: bool) -> Self
Indicates whether the DB instance has deletion protection enabled.
When deletion protection is enabled, the database cannot be deleted.
Sourcepub fn set_deletion_protection(self, input: Option<bool>) -> Self
pub fn set_deletion_protection(self, input: Option<bool>) -> Self
Indicates whether the DB instance has deletion protection enabled.
When deletion protection is enabled, the database cannot be deleted.
Sourcepub fn get_deletion_protection(&self) -> &Option<bool>
pub fn get_deletion_protection(&self) -> &Option<bool>
Indicates whether the DB instance has deletion protection enabled.
When deletion protection is enabled, the database cannot be deleted.
Sourcepub fn endpoint(self, input: AwsRdsDbInstanceEndpoint) -> Self
pub fn endpoint(self, input: AwsRdsDbInstanceEndpoint) -> Self
Specifies the connection endpoint.
Sourcepub fn set_endpoint(self, input: Option<AwsRdsDbInstanceEndpoint>) -> Self
pub fn set_endpoint(self, input: Option<AwsRdsDbInstanceEndpoint>) -> Self
Specifies the connection endpoint.
Sourcepub fn get_endpoint(&self) -> &Option<AwsRdsDbInstanceEndpoint>
pub fn get_endpoint(&self) -> &Option<AwsRdsDbInstanceEndpoint>
Specifies the connection endpoint.
Sourcepub fn engine(self, input: impl Into<String>) -> Self
pub fn engine(self, input: impl Into<String>) -> Self
Provides the name of the database engine to use for this DB instance.
Sourcepub fn set_engine(self, input: Option<String>) -> Self
pub fn set_engine(self, input: Option<String>) -> Self
Provides the name of the database engine to use for this DB instance.
Sourcepub fn get_engine(&self) -> &Option<String>
pub fn get_engine(&self) -> &Option<String>
Provides the name of the database engine to use for this DB instance.
Sourcepub fn engine_version(self, input: impl Into<String>) -> Self
pub fn engine_version(self, input: impl Into<String>) -> Self
Indicates the database engine version.
Sourcepub fn set_engine_version(self, input: Option<String>) -> Self
pub fn set_engine_version(self, input: Option<String>) -> Self
Indicates the database engine version.
Sourcepub fn get_engine_version(&self) -> &Option<String>
pub fn get_engine_version(&self) -> &Option<String>
Indicates the database engine version.
Sourcepub fn iam_database_authentication_enabled(self, input: bool) -> Self
pub fn iam_database_authentication_enabled(self, input: bool) -> Self
True if mapping of IAM accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines.
-
For MySQL 5.6, minor version 5.6.34 or higher
-
For MySQL 5.7, minor version 5.7.16 or higher
-
Aurora 5.6 or higher
Sourcepub fn set_iam_database_authentication_enabled(
self,
input: Option<bool>,
) -> Self
pub fn set_iam_database_authentication_enabled( self, input: Option<bool>, ) -> Self
True if mapping of IAM accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines.
-
For MySQL 5.6, minor version 5.6.34 or higher
-
For MySQL 5.7, minor version 5.7.16 or higher
-
Aurora 5.6 or higher
Sourcepub fn get_iam_database_authentication_enabled(&self) -> &Option<bool>
pub fn get_iam_database_authentication_enabled(&self) -> &Option<bool>
True if mapping of IAM accounts to database accounts is enabled, and otherwise false.
IAM database authentication can be enabled for the following database engines.
-
For MySQL 5.6, minor version 5.6.34 or higher
-
For MySQL 5.7, minor version 5.7.16 or higher
-
Aurora 5.6 or higher
Sourcepub fn instance_create_time(self, input: impl Into<String>) -> Self
pub fn instance_create_time(self, input: impl Into<String>) -> Self
Indicates when the DB instance was created.
For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
Sourcepub fn set_instance_create_time(self, input: Option<String>) -> Self
pub fn set_instance_create_time(self, input: Option<String>) -> Self
Indicates when the DB instance was created.
For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
Sourcepub fn get_instance_create_time(&self) -> &Option<String>
pub fn get_instance_create_time(&self) -> &Option<String>
Indicates when the DB instance was created.
For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
Sourcepub fn kms_key_id(self, input: impl Into<String>) -> Self
pub fn kms_key_id(self, input: impl Into<String>) -> Self
If StorageEncrypted
is true, the KMS key identifier for the encrypted DB instance.
Sourcepub fn set_kms_key_id(self, input: Option<String>) -> Self
pub fn set_kms_key_id(self, input: Option<String>) -> Self
If StorageEncrypted
is true, the KMS key identifier for the encrypted DB instance.
Sourcepub fn get_kms_key_id(&self) -> &Option<String>
pub fn get_kms_key_id(&self) -> &Option<String>
If StorageEncrypted
is true, the KMS key identifier for the encrypted DB instance.
Sourcepub fn publicly_accessible(self, input: bool) -> Self
pub fn publicly_accessible(self, input: bool) -> Self
Specifies the accessibility options for the DB instance.
A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address.
A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Sourcepub fn set_publicly_accessible(self, input: Option<bool>) -> Self
pub fn set_publicly_accessible(self, input: Option<bool>) -> Self
Specifies the accessibility options for the DB instance.
A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address.
A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Sourcepub fn get_publicly_accessible(&self) -> &Option<bool>
pub fn get_publicly_accessible(&self) -> &Option<bool>
Specifies the accessibility options for the DB instance.
A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address.
A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
Sourcepub fn storage_encrypted(self, input: bool) -> Self
pub fn storage_encrypted(self, input: bool) -> Self
Specifies whether the DB instance is encrypted.
Sourcepub fn set_storage_encrypted(self, input: Option<bool>) -> Self
pub fn set_storage_encrypted(self, input: Option<bool>) -> Self
Specifies whether the DB instance is encrypted.
Sourcepub fn get_storage_encrypted(&self) -> &Option<bool>
pub fn get_storage_encrypted(&self) -> &Option<bool>
Specifies whether the DB instance is encrypted.
Sourcepub fn tde_credential_arn(self, input: impl Into<String>) -> Self
pub fn tde_credential_arn(self, input: impl Into<String>) -> Self
The ARN from the key store with which the instance is associated for TDE encryption.
Sourcepub fn set_tde_credential_arn(self, input: Option<String>) -> Self
pub fn set_tde_credential_arn(self, input: Option<String>) -> Self
The ARN from the key store with which the instance is associated for TDE encryption.
Sourcepub fn get_tde_credential_arn(&self) -> &Option<String>
pub fn get_tde_credential_arn(&self) -> &Option<String>
The ARN from the key store with which the instance is associated for TDE encryption.
Sourcepub fn vpc_security_groups(
self,
input: AwsRdsDbInstanceVpcSecurityGroup,
) -> Self
pub fn vpc_security_groups( self, input: AwsRdsDbInstanceVpcSecurityGroup, ) -> Self
Appends an item to vpc_security_groups
.
To override the contents of this collection use set_vpc_security_groups
.
A list of VPC security groups that the DB instance belongs to.
Sourcepub fn set_vpc_security_groups(
self,
input: Option<Vec<AwsRdsDbInstanceVpcSecurityGroup>>,
) -> Self
pub fn set_vpc_security_groups( self, input: Option<Vec<AwsRdsDbInstanceVpcSecurityGroup>>, ) -> Self
A list of VPC security groups that the DB instance belongs to.
Sourcepub fn get_vpc_security_groups(
&self,
) -> &Option<Vec<AwsRdsDbInstanceVpcSecurityGroup>>
pub fn get_vpc_security_groups( &self, ) -> &Option<Vec<AwsRdsDbInstanceVpcSecurityGroup>>
A list of VPC security groups that the DB instance belongs to.
Sourcepub fn multi_az(self, input: bool) -> Self
pub fn multi_az(self, input: bool) -> Self
Whether the DB instance is a multiple Availability Zone deployment.
Sourcepub fn set_multi_az(self, input: Option<bool>) -> Self
pub fn set_multi_az(self, input: Option<bool>) -> Self
Whether the DB instance is a multiple Availability Zone deployment.
Sourcepub fn get_multi_az(&self) -> &Option<bool>
pub fn get_multi_az(&self) -> &Option<bool>
Whether the DB instance is a multiple Availability Zone deployment.
Sourcepub fn enhanced_monitoring_resource_arn(self, input: impl Into<String>) -> Self
pub fn enhanced_monitoring_resource_arn(self, input: impl Into<String>) -> Self
The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.
Sourcepub fn set_enhanced_monitoring_resource_arn(self, input: Option<String>) -> Self
pub fn set_enhanced_monitoring_resource_arn(self, input: Option<String>) -> Self
The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.
Sourcepub fn get_enhanced_monitoring_resource_arn(&self) -> &Option<String>
pub fn get_enhanced_monitoring_resource_arn(&self) -> &Option<String>
The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.
Sourcepub fn db_instance_status(self, input: impl Into<String>) -> Self
pub fn db_instance_status(self, input: impl Into<String>) -> Self
The current status of the DB instance.
Sourcepub fn set_db_instance_status(self, input: Option<String>) -> Self
pub fn set_db_instance_status(self, input: Option<String>) -> Self
The current status of the DB instance.
Sourcepub fn get_db_instance_status(&self) -> &Option<String>
pub fn get_db_instance_status(&self) -> &Option<String>
The current status of the DB instance.
Sourcepub fn master_username(self, input: impl Into<String>) -> Self
pub fn master_username(self, input: impl Into<String>) -> Self
The master user name of the DB instance.
Sourcepub fn set_master_username(self, input: Option<String>) -> Self
pub fn set_master_username(self, input: Option<String>) -> Self
The master user name of the DB instance.
Sourcepub fn get_master_username(&self) -> &Option<String>
pub fn get_master_username(&self) -> &Option<String>
The master user name of the DB instance.
Sourcepub fn allocated_storage(self, input: i32) -> Self
pub fn allocated_storage(self, input: i32) -> Self
The amount of storage (in gigabytes) to initially allocate for the DB instance.
Sourcepub fn set_allocated_storage(self, input: Option<i32>) -> Self
pub fn set_allocated_storage(self, input: Option<i32>) -> Self
The amount of storage (in gigabytes) to initially allocate for the DB instance.
Sourcepub fn get_allocated_storage(&self) -> &Option<i32>
pub fn get_allocated_storage(&self) -> &Option<i32>
The amount of storage (in gigabytes) to initially allocate for the DB instance.
Sourcepub fn preferred_backup_window(self, input: impl Into<String>) -> Self
pub fn preferred_backup_window(self, input: impl Into<String>) -> Self
The range of time each day when automated backups are created, if automated backups are enabled.
Uses the format HH:MM-HH:MM
. For example, 04:52-05:22
.
Sourcepub fn set_preferred_backup_window(self, input: Option<String>) -> Self
pub fn set_preferred_backup_window(self, input: Option<String>) -> Self
The range of time each day when automated backups are created, if automated backups are enabled.
Uses the format HH:MM-HH:MM
. For example, 04:52-05:22
.
Sourcepub fn get_preferred_backup_window(&self) -> &Option<String>
pub fn get_preferred_backup_window(&self) -> &Option<String>
The range of time each day when automated backups are created, if automated backups are enabled.
Uses the format HH:MM-HH:MM
. For example, 04:52-05:22
.
Sourcepub fn backup_retention_period(self, input: i32) -> Self
pub fn backup_retention_period(self, input: i32) -> Self
The number of days for which to retain automated backups.
Sourcepub fn set_backup_retention_period(self, input: Option<i32>) -> Self
pub fn set_backup_retention_period(self, input: Option<i32>) -> Self
The number of days for which to retain automated backups.
Sourcepub fn get_backup_retention_period(&self) -> &Option<i32>
pub fn get_backup_retention_period(&self) -> &Option<i32>
The number of days for which to retain automated backups.
Sourcepub fn db_security_groups(self, input: impl Into<String>) -> Self
pub fn db_security_groups(self, input: impl Into<String>) -> Self
Appends an item to db_security_groups
.
To override the contents of this collection use set_db_security_groups
.
A list of the DB security groups to assign to the DB instance.
Sourcepub fn set_db_security_groups(self, input: Option<Vec<String>>) -> Self
pub fn set_db_security_groups(self, input: Option<Vec<String>>) -> Self
A list of the DB security groups to assign to the DB instance.
Sourcepub fn get_db_security_groups(&self) -> &Option<Vec<String>>
pub fn get_db_security_groups(&self) -> &Option<Vec<String>>
A list of the DB security groups to assign to the DB instance.
Sourcepub fn db_parameter_groups(self, input: AwsRdsDbParameterGroup) -> Self
pub fn db_parameter_groups(self, input: AwsRdsDbParameterGroup) -> Self
Appends an item to db_parameter_groups
.
To override the contents of this collection use set_db_parameter_groups
.
A list of the DB parameter groups to assign to the DB instance.
Sourcepub fn set_db_parameter_groups(
self,
input: Option<Vec<AwsRdsDbParameterGroup>>,
) -> Self
pub fn set_db_parameter_groups( self, input: Option<Vec<AwsRdsDbParameterGroup>>, ) -> Self
A list of the DB parameter groups to assign to the DB instance.
Sourcepub fn get_db_parameter_groups(&self) -> &Option<Vec<AwsRdsDbParameterGroup>>
pub fn get_db_parameter_groups(&self) -> &Option<Vec<AwsRdsDbParameterGroup>>
A list of the DB parameter groups to assign to the DB instance.
Sourcepub fn availability_zone(self, input: impl Into<String>) -> Self
pub fn availability_zone(self, input: impl Into<String>) -> Self
The Availability Zone where the DB instance will be created.
Sourcepub fn set_availability_zone(self, input: Option<String>) -> Self
pub fn set_availability_zone(self, input: Option<String>) -> Self
The Availability Zone where the DB instance will be created.
Sourcepub fn get_availability_zone(&self) -> &Option<String>
pub fn get_availability_zone(&self) -> &Option<String>
The Availability Zone where the DB instance will be created.
Sourcepub fn db_subnet_group(self, input: AwsRdsDbSubnetGroup) -> Self
pub fn db_subnet_group(self, input: AwsRdsDbSubnetGroup) -> Self
Information about the subnet group that is associated with the DB instance.
Sourcepub fn set_db_subnet_group(self, input: Option<AwsRdsDbSubnetGroup>) -> Self
pub fn set_db_subnet_group(self, input: Option<AwsRdsDbSubnetGroup>) -> Self
Information about the subnet group that is associated with the DB instance.
Sourcepub fn get_db_subnet_group(&self) -> &Option<AwsRdsDbSubnetGroup>
pub fn get_db_subnet_group(&self) -> &Option<AwsRdsDbSubnetGroup>
Information about the subnet group that is associated with the DB instance.
Sourcepub fn preferred_maintenance_window(self, input: impl Into<String>) -> Self
pub fn preferred_maintenance_window(self, input: impl Into<String>) -> Self
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Uses the format
.
For the day values, use mon
|tue
|wed
|thu
|fri
|sat
|sun
.
For example, sun:09:32-sun:10:02
.
Sourcepub fn set_preferred_maintenance_window(self, input: Option<String>) -> Self
pub fn set_preferred_maintenance_window(self, input: Option<String>) -> Self
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Uses the format
.
For the day values, use mon
|tue
|wed
|thu
|fri
|sat
|sun
.
For example, sun:09:32-sun:10:02
.
Sourcepub fn get_preferred_maintenance_window(&self) -> &Option<String>
pub fn get_preferred_maintenance_window(&self) -> &Option<String>
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Uses the format
.
For the day values, use mon
|tue
|wed
|thu
|fri
|sat
|sun
.
For example, sun:09:32-sun:10:02
.
Sourcepub fn pending_modified_values(
self,
input: AwsRdsDbPendingModifiedValues,
) -> Self
pub fn pending_modified_values( self, input: AwsRdsDbPendingModifiedValues, ) -> Self
Changes to the DB instance that are currently pending.
Sourcepub fn set_pending_modified_values(
self,
input: Option<AwsRdsDbPendingModifiedValues>,
) -> Self
pub fn set_pending_modified_values( self, input: Option<AwsRdsDbPendingModifiedValues>, ) -> Self
Changes to the DB instance that are currently pending.
Sourcepub fn get_pending_modified_values(
&self,
) -> &Option<AwsRdsDbPendingModifiedValues>
pub fn get_pending_modified_values( &self, ) -> &Option<AwsRdsDbPendingModifiedValues>
Changes to the DB instance that are currently pending.
Sourcepub fn latest_restorable_time(self, input: impl Into<String>) -> Self
pub fn latest_restorable_time(self, input: impl Into<String>) -> Self
Specifies the latest time to which a database can be restored with point-in-time restore.
For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
Sourcepub fn set_latest_restorable_time(self, input: Option<String>) -> Self
pub fn set_latest_restorable_time(self, input: Option<String>) -> Self
Specifies the latest time to which a database can be restored with point-in-time restore.
For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
Sourcepub fn get_latest_restorable_time(&self) -> &Option<String>
pub fn get_latest_restorable_time(&self) -> &Option<String>
Specifies the latest time to which a database can be restored with point-in-time restore.
For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.
Sourcepub fn auto_minor_version_upgrade(self, input: bool) -> Self
pub fn auto_minor_version_upgrade(self, input: bool) -> Self
Indicates whether minor version patches are applied automatically.
Sourcepub fn set_auto_minor_version_upgrade(self, input: Option<bool>) -> Self
pub fn set_auto_minor_version_upgrade(self, input: Option<bool>) -> Self
Indicates whether minor version patches are applied automatically.
Sourcepub fn get_auto_minor_version_upgrade(&self) -> &Option<bool>
pub fn get_auto_minor_version_upgrade(&self) -> &Option<bool>
Indicates whether minor version patches are applied automatically.
Sourcepub fn read_replica_source_db_instance_identifier(
self,
input: impl Into<String>,
) -> Self
pub fn read_replica_source_db_instance_identifier( self, input: impl Into<String>, ) -> Self
If this DB instance is a read replica, contains the identifier of the source DB instance.
Sourcepub fn set_read_replica_source_db_instance_identifier(
self,
input: Option<String>,
) -> Self
pub fn set_read_replica_source_db_instance_identifier( self, input: Option<String>, ) -> Self
If this DB instance is a read replica, contains the identifier of the source DB instance.
Sourcepub fn get_read_replica_source_db_instance_identifier(&self) -> &Option<String>
pub fn get_read_replica_source_db_instance_identifier(&self) -> &Option<String>
If this DB instance is a read replica, contains the identifier of the source DB instance.
Sourcepub fn read_replica_db_instance_identifiers(
self,
input: impl Into<String>,
) -> Self
pub fn read_replica_db_instance_identifiers( self, input: impl Into<String>, ) -> Self
Appends an item to read_replica_db_instance_identifiers
.
To override the contents of this collection use set_read_replica_db_instance_identifiers
.
List of identifiers of the read replicas associated with this DB instance.
Sourcepub fn set_read_replica_db_instance_identifiers(
self,
input: Option<Vec<String>>,
) -> Self
pub fn set_read_replica_db_instance_identifiers( self, input: Option<Vec<String>>, ) -> Self
List of identifiers of the read replicas associated with this DB instance.
Sourcepub fn get_read_replica_db_instance_identifiers(&self) -> &Option<Vec<String>>
pub fn get_read_replica_db_instance_identifiers(&self) -> &Option<Vec<String>>
List of identifiers of the read replicas associated with this DB instance.
Sourcepub fn read_replica_db_cluster_identifiers(
self,
input: impl Into<String>,
) -> Self
pub fn read_replica_db_cluster_identifiers( self, input: impl Into<String>, ) -> Self
Appends an item to read_replica_db_cluster_identifiers
.
To override the contents of this collection use set_read_replica_db_cluster_identifiers
.
List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.
Sourcepub fn set_read_replica_db_cluster_identifiers(
self,
input: Option<Vec<String>>,
) -> Self
pub fn set_read_replica_db_cluster_identifiers( self, input: Option<Vec<String>>, ) -> Self
List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.
Sourcepub fn get_read_replica_db_cluster_identifiers(&self) -> &Option<Vec<String>>
pub fn get_read_replica_db_cluster_identifiers(&self) -> &Option<Vec<String>>
List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.
Sourcepub fn license_model(self, input: impl Into<String>) -> Self
pub fn license_model(self, input: impl Into<String>) -> Self
License model information for this DB instance.
Sourcepub fn set_license_model(self, input: Option<String>) -> Self
pub fn set_license_model(self, input: Option<String>) -> Self
License model information for this DB instance.
Sourcepub fn get_license_model(&self) -> &Option<String>
pub fn get_license_model(&self) -> &Option<String>
License model information for this DB instance.
Sourcepub fn iops(self, input: i32) -> Self
pub fn iops(self, input: i32) -> Self
Specifies the provisioned IOPS (I/O operations per second) for this DB instance.
Sourcepub fn set_iops(self, input: Option<i32>) -> Self
pub fn set_iops(self, input: Option<i32>) -> Self
Specifies the provisioned IOPS (I/O operations per second) for this DB instance.
Sourcepub fn get_iops(&self) -> &Option<i32>
pub fn get_iops(&self) -> &Option<i32>
Specifies the provisioned IOPS (I/O operations per second) for this DB instance.
Sourcepub fn option_group_memberships(
self,
input: AwsRdsDbOptionGroupMembership,
) -> Self
pub fn option_group_memberships( self, input: AwsRdsDbOptionGroupMembership, ) -> Self
Appends an item to option_group_memberships
.
To override the contents of this collection use set_option_group_memberships
.
The list of option group memberships for this DB instance.
Sourcepub fn set_option_group_memberships(
self,
input: Option<Vec<AwsRdsDbOptionGroupMembership>>,
) -> Self
pub fn set_option_group_memberships( self, input: Option<Vec<AwsRdsDbOptionGroupMembership>>, ) -> Self
The list of option group memberships for this DB instance.
Sourcepub fn get_option_group_memberships(
&self,
) -> &Option<Vec<AwsRdsDbOptionGroupMembership>>
pub fn get_option_group_memberships( &self, ) -> &Option<Vec<AwsRdsDbOptionGroupMembership>>
The list of option group memberships for this DB instance.
Sourcepub fn character_set_name(self, input: impl Into<String>) -> Self
pub fn character_set_name(self, input: impl Into<String>) -> Self
The name of the character set that this DB instance is associated with.
Sourcepub fn set_character_set_name(self, input: Option<String>) -> Self
pub fn set_character_set_name(self, input: Option<String>) -> Self
The name of the character set that this DB instance is associated with.
Sourcepub fn get_character_set_name(&self) -> &Option<String>
pub fn get_character_set_name(&self) -> &Option<String>
The name of the character set that this DB instance is associated with.
Sourcepub fn secondary_availability_zone(self, input: impl Into<String>) -> Self
pub fn secondary_availability_zone(self, input: impl Into<String>) -> Self
For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.
Sourcepub fn set_secondary_availability_zone(self, input: Option<String>) -> Self
pub fn set_secondary_availability_zone(self, input: Option<String>) -> Self
For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.
Sourcepub fn get_secondary_availability_zone(&self) -> &Option<String>
pub fn get_secondary_availability_zone(&self) -> &Option<String>
For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.
Sourcepub fn status_infos(self, input: AwsRdsDbStatusInfo) -> Self
pub fn status_infos(self, input: AwsRdsDbStatusInfo) -> Self
Appends an item to status_infos
.
To override the contents of this collection use set_status_infos
.
The status of a read replica. If the instance isn't a read replica, this is empty.
Sourcepub fn set_status_infos(self, input: Option<Vec<AwsRdsDbStatusInfo>>) -> Self
pub fn set_status_infos(self, input: Option<Vec<AwsRdsDbStatusInfo>>) -> Self
The status of a read replica. If the instance isn't a read replica, this is empty.
Sourcepub fn get_status_infos(&self) -> &Option<Vec<AwsRdsDbStatusInfo>>
pub fn get_status_infos(&self) -> &Option<Vec<AwsRdsDbStatusInfo>>
The status of a read replica. If the instance isn't a read replica, this is empty.
Sourcepub fn storage_type(self, input: impl Into<String>) -> Self
pub fn storage_type(self, input: impl Into<String>) -> Self
The storage type for the DB instance.
Sourcepub fn set_storage_type(self, input: Option<String>) -> Self
pub fn set_storage_type(self, input: Option<String>) -> Self
The storage type for the DB instance.
Sourcepub fn get_storage_type(&self) -> &Option<String>
pub fn get_storage_type(&self) -> &Option<String>
The storage type for the DB instance.
Sourcepub fn domain_memberships(self, input: AwsRdsDbDomainMembership) -> Self
pub fn domain_memberships(self, input: AwsRdsDbDomainMembership) -> Self
Appends an item to domain_memberships
.
To override the contents of this collection use set_domain_memberships
.
The Active Directory domain membership records associated with the DB instance.
Sourcepub fn set_domain_memberships(
self,
input: Option<Vec<AwsRdsDbDomainMembership>>,
) -> Self
pub fn set_domain_memberships( self, input: Option<Vec<AwsRdsDbDomainMembership>>, ) -> Self
The Active Directory domain membership records associated with the DB instance.
Sourcepub fn get_domain_memberships(&self) -> &Option<Vec<AwsRdsDbDomainMembership>>
pub fn get_domain_memberships(&self) -> &Option<Vec<AwsRdsDbDomainMembership>>
The Active Directory domain membership records associated with the DB instance.
Whether to copy resource tags to snapshots of the DB instance.
Whether to copy resource tags to snapshots of the DB instance.
Whether to copy resource tags to snapshots of the DB instance.
Sourcepub fn monitoring_interval(self, input: i32) -> Self
pub fn monitoring_interval(self, input: i32) -> Self
The interval, in seconds, between points when enhanced monitoring metrics are collected for the DB instance.
Sourcepub fn set_monitoring_interval(self, input: Option<i32>) -> Self
pub fn set_monitoring_interval(self, input: Option<i32>) -> Self
The interval, in seconds, between points when enhanced monitoring metrics are collected for the DB instance.
Sourcepub fn get_monitoring_interval(&self) -> &Option<i32>
pub fn get_monitoring_interval(&self) -> &Option<i32>
The interval, in seconds, between points when enhanced monitoring metrics are collected for the DB instance.
Sourcepub fn monitoring_role_arn(self, input: impl Into<String>) -> Self
pub fn monitoring_role_arn(self, input: impl Into<String>) -> Self
The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.
Sourcepub fn set_monitoring_role_arn(self, input: Option<String>) -> Self
pub fn set_monitoring_role_arn(self, input: Option<String>) -> Self
The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.
Sourcepub fn get_monitoring_role_arn(&self) -> &Option<String>
pub fn get_monitoring_role_arn(&self) -> &Option<String>
The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.
Sourcepub fn promotion_tier(self, input: i32) -> Self
pub fn promotion_tier(self, input: i32) -> Self
The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.
Sourcepub fn set_promotion_tier(self, input: Option<i32>) -> Self
pub fn set_promotion_tier(self, input: Option<i32>) -> Self
The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.
Sourcepub fn get_promotion_tier(&self) -> &Option<i32>
pub fn get_promotion_tier(&self) -> &Option<i32>
The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.
Sourcepub fn set_timezone(self, input: Option<String>) -> Self
pub fn set_timezone(self, input: Option<String>) -> Self
The time zone of the DB instance.
Sourcepub fn get_timezone(&self) -> &Option<String>
pub fn get_timezone(&self) -> &Option<String>
The time zone of the DB instance.
Sourcepub fn performance_insights_enabled(self, input: bool) -> Self
pub fn performance_insights_enabled(self, input: bool) -> Self
Indicates whether Performance Insights is enabled for the DB instance.
Sourcepub fn set_performance_insights_enabled(self, input: Option<bool>) -> Self
pub fn set_performance_insights_enabled(self, input: Option<bool>) -> Self
Indicates whether Performance Insights is enabled for the DB instance.
Sourcepub fn get_performance_insights_enabled(&self) -> &Option<bool>
pub fn get_performance_insights_enabled(&self) -> &Option<bool>
Indicates whether Performance Insights is enabled for the DB instance.
Sourcepub fn performance_insights_kms_key_id(self, input: impl Into<String>) -> Self
pub fn performance_insights_kms_key_id(self, input: impl Into<String>) -> Self
The identifier of the KMS key used to encrypt the Performance Insights data.
Sourcepub fn set_performance_insights_kms_key_id(self, input: Option<String>) -> Self
pub fn set_performance_insights_kms_key_id(self, input: Option<String>) -> Self
The identifier of the KMS key used to encrypt the Performance Insights data.
Sourcepub fn get_performance_insights_kms_key_id(&self) -> &Option<String>
pub fn get_performance_insights_kms_key_id(&self) -> &Option<String>
The identifier of the KMS key used to encrypt the Performance Insights data.
Sourcepub fn performance_insights_retention_period(self, input: i32) -> Self
pub fn performance_insights_retention_period(self, input: i32) -> Self
The number of days to retain Performance Insights data.
Sourcepub fn set_performance_insights_retention_period(
self,
input: Option<i32>,
) -> Self
pub fn set_performance_insights_retention_period( self, input: Option<i32>, ) -> Self
The number of days to retain Performance Insights data.
Sourcepub fn get_performance_insights_retention_period(&self) -> &Option<i32>
pub fn get_performance_insights_retention_period(&self) -> &Option<i32>
The number of days to retain Performance Insights data.
Sourcepub fn enabled_cloud_watch_logs_exports(self, input: impl Into<String>) -> Self
pub fn enabled_cloud_watch_logs_exports(self, input: impl Into<String>) -> Self
Appends an item to enabled_cloud_watch_logs_exports
.
To override the contents of this collection use set_enabled_cloud_watch_logs_exports
.
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Sourcepub fn set_enabled_cloud_watch_logs_exports(
self,
input: Option<Vec<String>>,
) -> Self
pub fn set_enabled_cloud_watch_logs_exports( self, input: Option<Vec<String>>, ) -> Self
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Sourcepub fn get_enabled_cloud_watch_logs_exports(&self) -> &Option<Vec<String>>
pub fn get_enabled_cloud_watch_logs_exports(&self) -> &Option<Vec<String>>
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Sourcepub fn processor_features(self, input: AwsRdsDbProcessorFeature) -> Self
pub fn processor_features(self, input: AwsRdsDbProcessorFeature) -> Self
Appends an item to processor_features
.
To override the contents of this collection use set_processor_features
.
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
Sourcepub fn set_processor_features(
self,
input: Option<Vec<AwsRdsDbProcessorFeature>>,
) -> Self
pub fn set_processor_features( self, input: Option<Vec<AwsRdsDbProcessorFeature>>, ) -> Self
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
Sourcepub fn get_processor_features(&self) -> &Option<Vec<AwsRdsDbProcessorFeature>>
pub fn get_processor_features(&self) -> &Option<Vec<AwsRdsDbProcessorFeature>>
The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
Sourcepub fn listener_endpoint(self, input: AwsRdsDbInstanceEndpoint) -> Self
pub fn listener_endpoint(self, input: AwsRdsDbInstanceEndpoint) -> Self
Specifies the connection endpoint.
Sourcepub fn set_listener_endpoint(
self,
input: Option<AwsRdsDbInstanceEndpoint>,
) -> Self
pub fn set_listener_endpoint( self, input: Option<AwsRdsDbInstanceEndpoint>, ) -> Self
Specifies the connection endpoint.
Sourcepub fn get_listener_endpoint(&self) -> &Option<AwsRdsDbInstanceEndpoint>
pub fn get_listener_endpoint(&self) -> &Option<AwsRdsDbInstanceEndpoint>
Specifies the connection endpoint.
Sourcepub fn max_allocated_storage(self, input: i32) -> Self
pub fn max_allocated_storage(self, input: i32) -> Self
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
Sourcepub fn set_max_allocated_storage(self, input: Option<i32>) -> Self
pub fn set_max_allocated_storage(self, input: Option<i32>) -> Self
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
Sourcepub fn get_max_allocated_storage(&self) -> &Option<i32>
pub fn get_max_allocated_storage(&self) -> &Option<i32>
The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
Sourcepub fn build(self) -> AwsRdsDbInstanceDetails
pub fn build(self) -> AwsRdsDbInstanceDetails
Consumes the builder and constructs a AwsRdsDbInstanceDetails
.
Trait Implementations§
Source§impl Clone for AwsRdsDbInstanceDetailsBuilder
impl Clone for AwsRdsDbInstanceDetailsBuilder
Source§fn clone(&self) -> AwsRdsDbInstanceDetailsBuilder
fn clone(&self) -> AwsRdsDbInstanceDetailsBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for AwsRdsDbInstanceDetailsBuilder
impl Default for AwsRdsDbInstanceDetailsBuilder
Source§fn default() -> AwsRdsDbInstanceDetailsBuilder
fn default() -> AwsRdsDbInstanceDetailsBuilder
Source§impl PartialEq for AwsRdsDbInstanceDetailsBuilder
impl PartialEq for AwsRdsDbInstanceDetailsBuilder
Source§fn eq(&self, other: &AwsRdsDbInstanceDetailsBuilder) -> bool
fn eq(&self, other: &AwsRdsDbInstanceDetailsBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for AwsRdsDbInstanceDetailsBuilder
Auto Trait Implementations§
impl Freeze for AwsRdsDbInstanceDetailsBuilder
impl RefUnwindSafe for AwsRdsDbInstanceDetailsBuilder
impl Send for AwsRdsDbInstanceDetailsBuilder
impl Sync for AwsRdsDbInstanceDetailsBuilder
impl Unpin for AwsRdsDbInstanceDetailsBuilder
impl UnwindSafe for AwsRdsDbInstanceDetailsBuilder
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);