#[non_exhaustive]pub struct DbClusterBuilder { /* private fields */ }
Expand description
A builder for DbCluster
.
Implementations§
Source§impl DbClusterBuilder
impl DbClusterBuilder
Sourcepub fn allocated_storage(self, input: i32) -> Self
pub fn allocated_storage(self, input: i32) -> Self
AllocatedStorage
specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage
can vary because Aurora DB cluster storage size adjusts as needed.
Sourcepub fn set_allocated_storage(self, input: Option<i32>) -> Self
pub fn set_allocated_storage(self, input: Option<i32>) -> Self
AllocatedStorage
specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage
can vary because Aurora DB cluster storage size adjusts as needed.
Sourcepub fn get_allocated_storage(&self) -> &Option<i32>
pub fn get_allocated_storage(&self) -> &Option<i32>
AllocatedStorage
specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage
can vary because Aurora DB cluster storage size adjusts as needed.
Sourcepub fn availability_zones(self, input: impl Into<String>) -> Self
pub fn availability_zones(self, input: impl Into<String>) -> Self
Appends an item to availability_zones
.
To override the contents of this collection use set_availability_zones
.
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
Sourcepub fn set_availability_zones(self, input: Option<Vec<String>>) -> Self
pub fn set_availability_zones(self, input: Option<Vec<String>>) -> Self
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
Sourcepub fn get_availability_zones(&self) -> &Option<Vec<String>>
pub fn get_availability_zones(&self) -> &Option<Vec<String>>
The list of Availability Zones (AZs) where instances in the DB cluster can be created.
Sourcepub fn backup_retention_period(self, input: i32) -> Self
pub fn backup_retention_period(self, input: i32) -> Self
The number of days for which automatic DB snapshots are retained.
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 automatic DB snapshots are retained.
Sourcepub fn get_backup_retention_period(&self) -> &Option<i32>
pub fn get_backup_retention_period(&self) -> &Option<i32>
The number of days for which automatic DB snapshots are retained.
Sourcepub fn character_set_name(self, input: impl Into<String>) -> Self
pub fn character_set_name(self, input: impl Into<String>) -> Self
If present, specifies the name of the character set that this cluster 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
If present, specifies the name of the character set that this cluster is associated with.
Sourcepub fn get_character_set_name(&self) -> &Option<String>
pub fn get_character_set_name(&self) -> &Option<String>
If present, specifies the name of the character set that this cluster is associated with.
Sourcepub fn database_name(self, input: impl Into<String>) -> Self
pub fn database_name(self, input: impl Into<String>) -> Self
The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.
Sourcepub fn set_database_name(self, input: Option<String>) -> Self
pub fn set_database_name(self, input: Option<String>) -> Self
The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.
Sourcepub fn get_database_name(&self) -> &Option<String>
pub fn get_database_name(&self) -> &Option<String>
The name of the initial database that was specified for the DB cluster when it was created, if one was provided. This same name is returned for the life of the DB cluster.
Sourcepub fn db_cluster_identifier(self, input: impl Into<String>) -> Self
pub fn db_cluster_identifier(self, input: impl Into<String>) -> Self
The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.
Sourcepub fn set_db_cluster_identifier(self, input: Option<String>) -> Self
pub fn set_db_cluster_identifier(self, input: Option<String>) -> Self
The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.
Sourcepub fn get_db_cluster_identifier(&self) -> &Option<String>
pub fn get_db_cluster_identifier(&self) -> &Option<String>
The user-supplied identifier for the DB cluster. This identifier is the unique key that identifies a DB cluster.
Sourcepub fn db_cluster_parameter_group(self, input: impl Into<String>) -> Self
pub fn db_cluster_parameter_group(self, input: impl Into<String>) -> Self
The name of the DB cluster parameter group for the DB cluster.
Sourcepub fn set_db_cluster_parameter_group(self, input: Option<String>) -> Self
pub fn set_db_cluster_parameter_group(self, input: Option<String>) -> Self
The name of the DB cluster parameter group for the DB cluster.
Sourcepub fn get_db_cluster_parameter_group(&self) -> &Option<String>
pub fn get_db_cluster_parameter_group(&self) -> &Option<String>
The name of the DB cluster parameter group for the DB cluster.
Sourcepub fn db_subnet_group(self, input: impl Into<String>) -> Self
pub fn db_subnet_group(self, input: impl Into<String>) -> Self
Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
Sourcepub fn set_db_subnet_group(self, input: Option<String>) -> Self
pub fn set_db_subnet_group(self, input: Option<String>) -> Self
Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
Sourcepub fn get_db_subnet_group(&self) -> &Option<String>
pub fn get_db_subnet_group(&self) -> &Option<String>
Information about the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
Sourcepub fn set_status(self, input: Option<String>) -> Self
pub fn set_status(self, input: Option<String>) -> Self
The current state of this DB cluster.
Sourcepub fn get_status(&self) -> &Option<String>
pub fn get_status(&self) -> &Option<String>
The current state of this DB cluster.
Sourcepub fn automatic_restart_time(self, input: DateTime) -> Self
pub fn automatic_restart_time(self, input: DateTime) -> Self
The time when a stopped DB cluster is restarted automatically.
Sourcepub fn set_automatic_restart_time(self, input: Option<DateTime>) -> Self
pub fn set_automatic_restart_time(self, input: Option<DateTime>) -> Self
The time when a stopped DB cluster is restarted automatically.
Sourcepub fn get_automatic_restart_time(&self) -> &Option<DateTime>
pub fn get_automatic_restart_time(&self) -> &Option<DateTime>
The time when a stopped DB cluster is restarted automatically.
Sourcepub fn percent_progress(self, input: impl Into<String>) -> Self
pub fn percent_progress(self, input: impl Into<String>) -> Self
The progress of the operation as a percentage.
Sourcepub fn set_percent_progress(self, input: Option<String>) -> Self
pub fn set_percent_progress(self, input: Option<String>) -> Self
The progress of the operation as a percentage.
Sourcepub fn get_percent_progress(&self) -> &Option<String>
pub fn get_percent_progress(&self) -> &Option<String>
The progress of the operation as a percentage.
Sourcepub fn earliest_restorable_time(self, input: DateTime) -> Self
pub fn earliest_restorable_time(self, input: DateTime) -> Self
The earliest time to which a database can be restored with point-in-time restore.
Sourcepub fn set_earliest_restorable_time(self, input: Option<DateTime>) -> Self
pub fn set_earliest_restorable_time(self, input: Option<DateTime>) -> Self
The earliest time to which a database can be restored with point-in-time restore.
Sourcepub fn get_earliest_restorable_time(&self) -> &Option<DateTime>
pub fn get_earliest_restorable_time(&self) -> &Option<DateTime>
The earliest time to which a database can be restored with point-in-time restore.
Sourcepub fn endpoint(self, input: impl Into<String>) -> Self
pub fn endpoint(self, input: impl Into<String>) -> Self
The connection endpoint for the primary instance of the DB cluster.
Sourcepub fn set_endpoint(self, input: Option<String>) -> Self
pub fn set_endpoint(self, input: Option<String>) -> Self
The connection endpoint for the primary instance of the DB cluster.
Sourcepub fn get_endpoint(&self) -> &Option<String>
pub fn get_endpoint(&self) -> &Option<String>
The connection endpoint for the primary instance of the DB cluster.
Sourcepub fn reader_endpoint(self, input: impl Into<String>) -> Self
pub fn reader_endpoint(self, input: impl Into<String>) -> Self
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
Sourcepub fn set_reader_endpoint(self, input: Option<String>) -> Self
pub fn set_reader_endpoint(self, input: Option<String>) -> Self
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
Sourcepub fn get_reader_endpoint(&self) -> &Option<String>
pub fn get_reader_endpoint(&self) -> &Option<String>
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.
If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.
Sourcepub fn custom_endpoints(self, input: impl Into<String>) -> Self
pub fn custom_endpoints(self, input: impl Into<String>) -> Self
Appends an item to custom_endpoints
.
To override the contents of this collection use set_custom_endpoints
.
The custom endpoints associated with the DB cluster.
Sourcepub fn set_custom_endpoints(self, input: Option<Vec<String>>) -> Self
pub fn set_custom_endpoints(self, input: Option<Vec<String>>) -> Self
The custom endpoints associated with the DB cluster.
Sourcepub fn get_custom_endpoints(&self) -> &Option<Vec<String>>
pub fn get_custom_endpoints(&self) -> &Option<Vec<String>>
The custom endpoints associated with the DB cluster.
Sourcepub fn multi_az(self, input: bool) -> Self
pub fn multi_az(self, input: bool) -> Self
Indicates whether the DB cluster has instances in multiple Availability Zones.
Sourcepub fn set_multi_az(self, input: Option<bool>) -> Self
pub fn set_multi_az(self, input: Option<bool>) -> Self
Indicates whether the DB cluster has instances in multiple Availability Zones.
Sourcepub fn get_multi_az(&self) -> &Option<bool>
pub fn get_multi_az(&self) -> &Option<bool>
Indicates whether the DB cluster has instances in multiple Availability Zones.
Sourcepub fn engine(self, input: impl Into<String>) -> Self
pub fn engine(self, input: impl Into<String>) -> Self
The database engine used for this DB cluster.
Sourcepub fn set_engine(self, input: Option<String>) -> Self
pub fn set_engine(self, input: Option<String>) -> Self
The database engine used for this DB cluster.
Sourcepub fn get_engine(&self) -> &Option<String>
pub fn get_engine(&self) -> &Option<String>
The database engine used for this DB cluster.
Sourcepub fn engine_version(self, input: impl Into<String>) -> Self
pub fn engine_version(self, input: impl Into<String>) -> Self
The version of the database engine.
Sourcepub fn set_engine_version(self, input: Option<String>) -> Self
pub fn set_engine_version(self, input: Option<String>) -> Self
The version of the database engine.
Sourcepub fn get_engine_version(&self) -> &Option<String>
pub fn get_engine_version(&self) -> &Option<String>
The version of the database engine.
Sourcepub fn latest_restorable_time(self, input: DateTime) -> Self
pub fn latest_restorable_time(self, input: DateTime) -> Self
The latest time to which a database can be restored with point-in-time restore.
Sourcepub fn set_latest_restorable_time(self, input: Option<DateTime>) -> Self
pub fn set_latest_restorable_time(self, input: Option<DateTime>) -> Self
The latest time to which a database can be restored with point-in-time restore.
Sourcepub fn get_latest_restorable_time(&self) -> &Option<DateTime>
pub fn get_latest_restorable_time(&self) -> &Option<DateTime>
The latest time to which a database can be restored with point-in-time restore.
Sourcepub fn set_port(self, input: Option<i32>) -> Self
pub fn set_port(self, input: Option<i32>) -> Self
The port that the database engine is listening on.
Sourcepub fn master_username(self, input: impl Into<String>) -> Self
pub fn master_username(self, input: impl Into<String>) -> Self
The master username for the DB cluster.
Sourcepub fn set_master_username(self, input: Option<String>) -> Self
pub fn set_master_username(self, input: Option<String>) -> Self
The master username for the DB cluster.
Sourcepub fn get_master_username(&self) -> &Option<String>
pub fn get_master_username(&self) -> &Option<String>
The master username for the DB cluster.
Sourcepub fn db_cluster_option_group_memberships(
self,
input: DbClusterOptionGroupStatus,
) -> Self
pub fn db_cluster_option_group_memberships( self, input: DbClusterOptionGroupStatus, ) -> Self
Appends an item to db_cluster_option_group_memberships
.
To override the contents of this collection use set_db_cluster_option_group_memberships
.
The list of option group memberships for this DB cluster.
Sourcepub fn set_db_cluster_option_group_memberships(
self,
input: Option<Vec<DbClusterOptionGroupStatus>>,
) -> Self
pub fn set_db_cluster_option_group_memberships( self, input: Option<Vec<DbClusterOptionGroupStatus>>, ) -> Self
The list of option group memberships for this DB cluster.
Sourcepub fn get_db_cluster_option_group_memberships(
&self,
) -> &Option<Vec<DbClusterOptionGroupStatus>>
pub fn get_db_cluster_option_group_memberships( &self, ) -> &Option<Vec<DbClusterOptionGroupStatus>>
The list of option group memberships for this DB cluster.
Sourcepub fn preferred_backup_window(self, input: impl Into<String>) -> Self
pub fn preferred_backup_window(self, input: impl Into<String>) -> Self
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod
.
Sourcepub fn set_preferred_backup_window(self, input: Option<String>) -> Self
pub fn set_preferred_backup_window(self, input: Option<String>) -> Self
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod
.
Sourcepub fn get_preferred_backup_window(&self) -> &Option<String>
pub fn get_preferred_backup_window(&self) -> &Option<String>
The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod
.
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).
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).
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).
Sourcepub fn replication_source_identifier(self, input: impl Into<String>) -> Self
pub fn replication_source_identifier(self, input: impl Into<String>) -> Self
The identifier of the source DB cluster if this DB cluster is a read replica.
Sourcepub fn set_replication_source_identifier(self, input: Option<String>) -> Self
pub fn set_replication_source_identifier(self, input: Option<String>) -> Self
The identifier of the source DB cluster if this DB cluster is a read replica.
Sourcepub fn get_replication_source_identifier(&self) -> &Option<String>
pub fn get_replication_source_identifier(&self) -> &Option<String>
The identifier of the source DB cluster if this DB cluster is a read replica.
Sourcepub fn read_replica_identifiers(self, input: impl Into<String>) -> Self
pub fn read_replica_identifiers(self, input: impl Into<String>) -> Self
Appends an item to read_replica_identifiers
.
To override the contents of this collection use set_read_replica_identifiers
.
Contains one or more identifiers of the read replicas associated with this DB cluster.
Sourcepub fn set_read_replica_identifiers(self, input: Option<Vec<String>>) -> Self
pub fn set_read_replica_identifiers(self, input: Option<Vec<String>>) -> Self
Contains one or more identifiers of the read replicas associated with this DB cluster.
Sourcepub fn get_read_replica_identifiers(&self) -> &Option<Vec<String>>
pub fn get_read_replica_identifiers(&self) -> &Option<Vec<String>>
Contains one or more identifiers of the read replicas associated with this DB cluster.
Sourcepub fn status_infos(self, input: DbClusterStatusInfo) -> Self
pub fn status_infos(self, input: DbClusterStatusInfo) -> Self
Appends an item to status_infos
.
To override the contents of this collection use set_status_infos
.
Reserved for future use.
Sourcepub fn set_status_infos(self, input: Option<Vec<DbClusterStatusInfo>>) -> Self
pub fn set_status_infos(self, input: Option<Vec<DbClusterStatusInfo>>) -> Self
Reserved for future use.
Sourcepub fn get_status_infos(&self) -> &Option<Vec<DbClusterStatusInfo>>
pub fn get_status_infos(&self) -> &Option<Vec<DbClusterStatusInfo>>
Reserved for future use.
Sourcepub fn db_cluster_members(self, input: DbClusterMember) -> Self
pub fn db_cluster_members(self, input: DbClusterMember) -> Self
Appends an item to db_cluster_members
.
To override the contents of this collection use set_db_cluster_members
.
The list of DB instances that make up the DB cluster.
Sourcepub fn set_db_cluster_members(self, input: Option<Vec<DbClusterMember>>) -> Self
pub fn set_db_cluster_members(self, input: Option<Vec<DbClusterMember>>) -> Self
The list of DB instances that make up the DB cluster.
Sourcepub fn get_db_cluster_members(&self) -> &Option<Vec<DbClusterMember>>
pub fn get_db_cluster_members(&self) -> &Option<Vec<DbClusterMember>>
The list of DB instances that make up the DB cluster.
Sourcepub fn vpc_security_groups(self, input: VpcSecurityGroupMembership) -> Self
pub fn vpc_security_groups(self, input: VpcSecurityGroupMembership) -> Self
Appends an item to vpc_security_groups
.
To override the contents of this collection use set_vpc_security_groups
.
The list of VPC security groups that the DB cluster belongs to.
Sourcepub fn set_vpc_security_groups(
self,
input: Option<Vec<VpcSecurityGroupMembership>>,
) -> Self
pub fn set_vpc_security_groups( self, input: Option<Vec<VpcSecurityGroupMembership>>, ) -> Self
The list of VPC security groups that the DB cluster belongs to.
Sourcepub fn get_vpc_security_groups(
&self,
) -> &Option<Vec<VpcSecurityGroupMembership>>
pub fn get_vpc_security_groups( &self, ) -> &Option<Vec<VpcSecurityGroupMembership>>
The list of VPC security groups that the DB cluster belongs to.
Sourcepub fn hosted_zone_id(self, input: impl Into<String>) -> Self
pub fn hosted_zone_id(self, input: impl Into<String>) -> Self
The ID that Amazon Route 53 assigns when you create a hosted zone.
Sourcepub fn set_hosted_zone_id(self, input: Option<String>) -> Self
pub fn set_hosted_zone_id(self, input: Option<String>) -> Self
The ID that Amazon Route 53 assigns when you create a hosted zone.
Sourcepub fn get_hosted_zone_id(&self) -> &Option<String>
pub fn get_hosted_zone_id(&self) -> &Option<String>
The ID that Amazon Route 53 assigns when you create a hosted zone.
Sourcepub fn storage_encrypted(self, input: bool) -> Self
pub fn storage_encrypted(self, input: bool) -> Self
Indicates whether the DB cluster is encrypted.
Sourcepub fn set_storage_encrypted(self, input: Option<bool>) -> Self
pub fn set_storage_encrypted(self, input: Option<bool>) -> Self
Indicates whether the DB cluster is encrypted.
Sourcepub fn get_storage_encrypted(&self) -> &Option<bool>
pub fn get_storage_encrypted(&self) -> &Option<bool>
Indicates whether the DB cluster is encrypted.
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 enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
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 enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
Sourcepub fn get_kms_key_id(&self) -> &Option<String>
pub fn get_kms_key_id(&self) -> &Option<String>
If StorageEncrypted
is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.
The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
Sourcepub fn db_cluster_resource_id(self, input: impl Into<String>) -> Self
pub fn db_cluster_resource_id(self, input: impl Into<String>) -> Self
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
Sourcepub fn set_db_cluster_resource_id(self, input: Option<String>) -> Self
pub fn set_db_cluster_resource_id(self, input: Option<String>) -> Self
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
Sourcepub fn get_db_cluster_resource_id(&self) -> &Option<String>
pub fn get_db_cluster_resource_id(&self) -> &Option<String>
The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
Sourcepub fn db_cluster_arn(self, input: impl Into<String>) -> Self
pub fn db_cluster_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) for the DB cluster.
Sourcepub fn set_db_cluster_arn(self, input: Option<String>) -> Self
pub fn set_db_cluster_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) for the DB cluster.
Sourcepub fn get_db_cluster_arn(&self) -> &Option<String>
pub fn get_db_cluster_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) for the DB cluster.
Sourcepub fn associated_roles(self, input: DbClusterRole) -> Self
pub fn associated_roles(self, input: DbClusterRole) -> Self
Appends an item to associated_roles
.
To override the contents of this collection use set_associated_roles
.
A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
Sourcepub fn set_associated_roles(self, input: Option<Vec<DbClusterRole>>) -> Self
pub fn set_associated_roles(self, input: Option<Vec<DbClusterRole>>) -> Self
A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
Sourcepub fn get_associated_roles(&self) -> &Option<Vec<DbClusterRole>>
pub fn get_associated_roles(&self) -> &Option<Vec<DbClusterRole>>
A list of the Amazon Web Services Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
Sourcepub fn iam_database_authentication_enabled(self, input: bool) -> Self
pub fn iam_database_authentication_enabled(self, input: bool) -> Self
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
Sourcepub fn set_iam_database_authentication_enabled(
self,
input: Option<bool>,
) -> Self
pub fn set_iam_database_authentication_enabled( self, input: Option<bool>, ) -> Self
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
Sourcepub fn get_iam_database_authentication_enabled(&self) -> &Option<bool>
pub fn get_iam_database_authentication_enabled(&self) -> &Option<bool>
Indicates whether the mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
Sourcepub fn clone_group_id(self, input: impl Into<String>) -> Self
pub fn clone_group_id(self, input: impl Into<String>) -> Self
The ID of the clone group with which the DB cluster is associated. For newly created clusters, the ID is typically null.
If you clone a DB cluster when the ID is null, the operation populates the ID value for the source cluster and the clone because both clusters become part of the same clone group. Even if you delete the clone cluster, the clone group ID remains for the lifetime of the source cluster to show that it was used in a cloning operation.
For PITR, the clone group ID is inherited from the source cluster. For snapshot restore operations, the clone group ID isn't inherited from the source cluster.
Sourcepub fn set_clone_group_id(self, input: Option<String>) -> Self
pub fn set_clone_group_id(self, input: Option<String>) -> Self
The ID of the clone group with which the DB cluster is associated. For newly created clusters, the ID is typically null.
If you clone a DB cluster when the ID is null, the operation populates the ID value for the source cluster and the clone because both clusters become part of the same clone group. Even if you delete the clone cluster, the clone group ID remains for the lifetime of the source cluster to show that it was used in a cloning operation.
For PITR, the clone group ID is inherited from the source cluster. For snapshot restore operations, the clone group ID isn't inherited from the source cluster.
Sourcepub fn get_clone_group_id(&self) -> &Option<String>
pub fn get_clone_group_id(&self) -> &Option<String>
The ID of the clone group with which the DB cluster is associated. For newly created clusters, the ID is typically null.
If you clone a DB cluster when the ID is null, the operation populates the ID value for the source cluster and the clone because both clusters become part of the same clone group. Even if you delete the clone cluster, the clone group ID remains for the lifetime of the source cluster to show that it was used in a cloning operation.
For PITR, the clone group ID is inherited from the source cluster. For snapshot restore operations, the clone group ID isn't inherited from the source cluster.
Sourcepub fn cluster_create_time(self, input: DateTime) -> Self
pub fn cluster_create_time(self, input: DateTime) -> Self
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
Sourcepub fn set_cluster_create_time(self, input: Option<DateTime>) -> Self
pub fn set_cluster_create_time(self, input: Option<DateTime>) -> Self
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
Sourcepub fn get_cluster_create_time(&self) -> &Option<DateTime>
pub fn get_cluster_create_time(&self) -> &Option<DateTime>
The time when the DB cluster was created, in Universal Coordinated Time (UTC).
Sourcepub fn earliest_backtrack_time(self, input: DateTime) -> Self
pub fn earliest_backtrack_time(self, input: DateTime) -> Self
The earliest time to which a DB cluster can be backtracked.
Sourcepub fn set_earliest_backtrack_time(self, input: Option<DateTime>) -> Self
pub fn set_earliest_backtrack_time(self, input: Option<DateTime>) -> Self
The earliest time to which a DB cluster can be backtracked.
Sourcepub fn get_earliest_backtrack_time(&self) -> &Option<DateTime>
pub fn get_earliest_backtrack_time(&self) -> &Option<DateTime>
The earliest time to which a DB cluster can be backtracked.
Sourcepub fn backtrack_window(self, input: i64) -> Self
pub fn backtrack_window(self, input: i64) -> Self
The target backtrack window, in seconds. If this value is set to 0
, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
Sourcepub fn set_backtrack_window(self, input: Option<i64>) -> Self
pub fn set_backtrack_window(self, input: Option<i64>) -> Self
The target backtrack window, in seconds. If this value is set to 0
, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
Sourcepub fn get_backtrack_window(&self) -> &Option<i64>
pub fn get_backtrack_window(&self) -> &Option<i64>
The target backtrack window, in seconds. If this value is set to 0
, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.
Sourcepub fn backtrack_consumed_change_records(self, input: i64) -> Self
pub fn backtrack_consumed_change_records(self, input: i64) -> Self
The number of change records stored for Backtrack.
Sourcepub fn set_backtrack_consumed_change_records(self, input: Option<i64>) -> Self
pub fn set_backtrack_consumed_change_records(self, input: Option<i64>) -> Self
The number of change records stored for Backtrack.
Sourcepub fn get_backtrack_consumed_change_records(&self) -> &Option<i64>
pub fn get_backtrack_consumed_change_records(&self) -> &Option<i64>
The number of change records stored for Backtrack.
Sourcepub fn enabled_cloudwatch_logs_exports(self, input: impl Into<String>) -> Self
pub fn enabled_cloudwatch_logs_exports(self, input: impl Into<String>) -> Self
Appends an item to enabled_cloudwatch_logs_exports
.
To override the contents of this collection use set_enabled_cloudwatch_logs_exports
.
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
Sourcepub fn set_enabled_cloudwatch_logs_exports(
self,
input: Option<Vec<String>>,
) -> Self
pub fn set_enabled_cloudwatch_logs_exports( self, input: Option<Vec<String>>, ) -> Self
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
Sourcepub fn get_enabled_cloudwatch_logs_exports(&self) -> &Option<Vec<String>>
pub fn get_enabled_cloudwatch_logs_exports(&self) -> &Option<Vec<String>>
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.
Sourcepub fn capacity(self, input: i32) -> Self
pub fn capacity(self, input: i32) -> Self
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0
(zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
Sourcepub fn set_capacity(self, input: Option<i32>) -> Self
pub fn set_capacity(self, input: Option<i32>) -> Self
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0
(zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
Sourcepub fn get_capacity(&self) -> &Option<i32>
pub fn get_capacity(&self) -> &Option<i32>
The current capacity of an Aurora Serverless v1 DB cluster. The capacity is 0
(zero) when the cluster is paused.
For more information about Aurora Serverless v1, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
Sourcepub fn engine_mode(self, input: impl Into<String>) -> Self
pub fn engine_mode(self, input: impl Into<String>) -> Self
The DB engine mode of the DB cluster, either provisioned
or serverless
.
For more information, see CreateDBCluster.
Sourcepub fn set_engine_mode(self, input: Option<String>) -> Self
pub fn set_engine_mode(self, input: Option<String>) -> Self
The DB engine mode of the DB cluster, either provisioned
or serverless
.
For more information, see CreateDBCluster.
Sourcepub fn get_engine_mode(&self) -> &Option<String>
pub fn get_engine_mode(&self) -> &Option<String>
The DB engine mode of the DB cluster, either provisioned
or serverless
.
For more information, see CreateDBCluster.
Sourcepub fn scaling_configuration_info(self, input: ScalingConfigurationInfo) -> Self
pub fn scaling_configuration_info(self, input: ScalingConfigurationInfo) -> Self
The scaling configuration for an Aurora DB cluster in serverless
DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
Sourcepub fn set_scaling_configuration_info(
self,
input: Option<ScalingConfigurationInfo>,
) -> Self
pub fn set_scaling_configuration_info( self, input: Option<ScalingConfigurationInfo>, ) -> Self
The scaling configuration for an Aurora DB cluster in serverless
DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
Sourcepub fn get_scaling_configuration_info(
&self,
) -> &Option<ScalingConfigurationInfo>
pub fn get_scaling_configuration_info( &self, ) -> &Option<ScalingConfigurationInfo>
The scaling configuration for an Aurora DB cluster in serverless
DB engine mode.
For more information, see Using Amazon Aurora Serverless v1 in the Amazon Aurora User Guide.
Sourcepub fn rds_custom_cluster_configuration(
self,
input: RdsCustomClusterConfiguration,
) -> Self
pub fn rds_custom_cluster_configuration( self, input: RdsCustomClusterConfiguration, ) -> Self
Reserved for future use.
Sourcepub fn set_rds_custom_cluster_configuration(
self,
input: Option<RdsCustomClusterConfiguration>,
) -> Self
pub fn set_rds_custom_cluster_configuration( self, input: Option<RdsCustomClusterConfiguration>, ) -> Self
Reserved for future use.
Sourcepub fn get_rds_custom_cluster_configuration(
&self,
) -> &Option<RdsCustomClusterConfiguration>
pub fn get_rds_custom_cluster_configuration( &self, ) -> &Option<RdsCustomClusterConfiguration>
Reserved for future use.
Sourcepub fn deletion_protection(self, input: bool) -> Self
pub fn deletion_protection(self, input: bool) -> Self
Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
Sourcepub fn set_deletion_protection(self, input: Option<bool>) -> Self
pub fn set_deletion_protection(self, input: Option<bool>) -> Self
Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
Sourcepub fn get_deletion_protection(&self) -> &Option<bool>
pub fn get_deletion_protection(&self) -> &Option<bool>
Indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
Sourcepub fn http_endpoint_enabled(self, input: bool) -> Self
pub fn http_endpoint_enabled(self, input: bool) -> Self
Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
Sourcepub fn set_http_endpoint_enabled(self, input: Option<bool>) -> Self
pub fn set_http_endpoint_enabled(self, input: Option<bool>) -> Self
Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
Sourcepub fn get_http_endpoint_enabled(&self) -> &Option<bool>
pub fn get_http_endpoint_enabled(&self) -> &Option<bool>
Indicates whether the HTTP endpoint is enabled for an Aurora DB cluster.
When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
For more information, see Using RDS Data API in the Amazon Aurora User Guide.
Sourcepub fn activity_stream_mode(self, input: ActivityStreamMode) -> Self
pub fn activity_stream_mode(self, input: ActivityStreamMode) -> Self
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
Sourcepub fn set_activity_stream_mode(self, input: Option<ActivityStreamMode>) -> Self
pub fn set_activity_stream_mode(self, input: Option<ActivityStreamMode>) -> Self
The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.
Sourcepub fn get_activity_stream_mode(&self) -> &Option<ActivityStreamMode>
pub fn get_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. The database session can handle these events either synchronously or asynchronously.
Sourcepub fn activity_stream_status(self, input: ActivityStreamStatus) -> Self
pub fn activity_stream_status(self, input: ActivityStreamStatus) -> Self
The status of the database activity stream.
Sourcepub fn set_activity_stream_status(
self,
input: Option<ActivityStreamStatus>,
) -> Self
pub fn set_activity_stream_status( self, input: Option<ActivityStreamStatus>, ) -> Self
The status of the database activity stream.
Sourcepub fn get_activity_stream_status(&self) -> &Option<ActivityStreamStatus>
pub fn get_activity_stream_status(&self) -> &Option<ActivityStreamStatus>
The status of the database activity stream.
Sourcepub fn activity_stream_kms_key_id(self, input: impl Into<String>) -> Self
pub fn activity_stream_kms_key_id(self, input: impl Into<String>) -> Self
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 set_activity_stream_kms_key_id(self, input: Option<String>) -> Self
pub fn set_activity_stream_kms_key_id(self, input: Option<String>) -> Self
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 get_activity_stream_kms_key_id(&self) -> &Option<String>
pub fn get_activity_stream_kms_key_id(&self) -> &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.
Sourcepub fn activity_stream_kinesis_stream_name(
self,
input: impl Into<String>,
) -> Self
pub fn activity_stream_kinesis_stream_name( self, input: impl Into<String>, ) -> Self
The name of the Amazon Kinesis data stream used for the database activity stream.
Sourcepub fn set_activity_stream_kinesis_stream_name(
self,
input: Option<String>,
) -> Self
pub fn set_activity_stream_kinesis_stream_name( self, input: Option<String>, ) -> Self
The name of the Amazon Kinesis data stream used for the database activity stream.
Sourcepub fn get_activity_stream_kinesis_stream_name(&self) -> &Option<String>
pub fn get_activity_stream_kinesis_stream_name(&self) -> &Option<String>
The name of the Amazon Kinesis data stream used for the database activity stream.
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
Indicates whether tags are copied from the DB cluster to snapshots of the DB cluster.
Sourcepub fn cross_account_clone(self, input: bool) -> Self
pub fn cross_account_clone(self, input: bool) -> Self
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
Sourcepub fn set_cross_account_clone(self, input: Option<bool>) -> Self
pub fn set_cross_account_clone(self, input: Option<bool>) -> Self
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
Sourcepub fn get_cross_account_clone(&self) -> &Option<bool>
pub fn get_cross_account_clone(&self) -> &Option<bool>
Indicates whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
Sourcepub fn domain_memberships(self, input: DomainMembership) -> Self
pub fn domain_memberships(self, input: DomainMembership) -> 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 cluster.
Sourcepub fn set_domain_memberships(
self,
input: Option<Vec<DomainMembership>>,
) -> Self
pub fn set_domain_memberships( self, input: Option<Vec<DomainMembership>>, ) -> Self
The Active Directory Domain membership records associated with the DB cluster.
Sourcepub fn get_domain_memberships(&self) -> &Option<Vec<DomainMembership>>
pub fn get_domain_memberships(&self) -> &Option<Vec<DomainMembership>>
The Active Directory Domain membership records associated with the DB cluster.
Sourcepub fn tag_list(self, input: Tag) -> Self
pub fn tag_list(self, input: Tag) -> Self
Appends an item to tag_list
.
To override the contents of this collection use set_tag_list
.
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.
Sourcepub fn set_tag_list(self, input: Option<Vec<Tag>>) -> Self
pub fn set_tag_list(self, input: Option<Vec<Tag>>) -> Self
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.
Sourcepub fn get_tag_list(&self) -> &Option<Vec<Tag>>
pub fn get_tag_list(&self) -> &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.
Sourcepub fn global_cluster_identifier(self, input: impl Into<String>) -> Self
pub fn global_cluster_identifier(self, input: impl Into<String>) -> Self
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
Sourcepub fn set_global_cluster_identifier(self, input: Option<String>) -> Self
pub fn set_global_cluster_identifier(self, input: Option<String>) -> Self
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
Sourcepub fn get_global_cluster_identifier(&self) -> &Option<String>
pub fn get_global_cluster_identifier(&self) -> &Option<String>
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database cluster.
Sourcepub fn global_write_forwarding_status(
self,
input: WriteForwardingStatus,
) -> Self
pub fn global_write_forwarding_status( self, input: WriteForwardingStatus, ) -> Self
The status of write forwarding for a secondary cluster in an Aurora global database.
Sourcepub fn set_global_write_forwarding_status(
self,
input: Option<WriteForwardingStatus>,
) -> Self
pub fn set_global_write_forwarding_status( self, input: Option<WriteForwardingStatus>, ) -> Self
The status of write forwarding for a secondary cluster in an Aurora global database.
Sourcepub fn get_global_write_forwarding_status(
&self,
) -> &Option<WriteForwardingStatus>
pub fn get_global_write_forwarding_status( &self, ) -> &Option<WriteForwardingStatus>
The status of write forwarding for a secondary cluster in an Aurora global database.
Sourcepub fn global_write_forwarding_requested(self, input: bool) -> Self
pub fn global_write_forwarding_requested(self, input: bool) -> Self
Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus
to confirm that the request has completed before using the write forwarding feature for this cluster.
Sourcepub fn set_global_write_forwarding_requested(self, input: Option<bool>) -> Self
pub fn set_global_write_forwarding_requested(self, input: Option<bool>) -> Self
Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus
to confirm that the request has completed before using the write forwarding feature for this cluster.
Sourcepub fn get_global_write_forwarding_requested(&self) -> &Option<bool>
pub fn get_global_write_forwarding_requested(&self) -> &Option<bool>
Indicates whether write forwarding is enabled for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus
to confirm that the request has completed before using the write forwarding feature for this cluster.
Sourcepub fn pending_modified_values(
self,
input: ClusterPendingModifiedValues,
) -> Self
pub fn pending_modified_values( self, input: ClusterPendingModifiedValues, ) -> Self
Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.
Sourcepub fn set_pending_modified_values(
self,
input: Option<ClusterPendingModifiedValues>,
) -> Self
pub fn set_pending_modified_values( self, input: Option<ClusterPendingModifiedValues>, ) -> Self
Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.
Sourcepub fn get_pending_modified_values(
&self,
) -> &Option<ClusterPendingModifiedValues>
pub fn get_pending_modified_values( &self, ) -> &Option<ClusterPendingModifiedValues>
Information about pending changes to the DB cluster. This information is returned only when there are pending changes. Specific changes are identified by subelements.
Sourcepub fn db_cluster_instance_class(self, input: impl Into<String>) -> Self
pub fn db_cluster_instance_class(self, input: impl Into<String>) -> Self
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
Sourcepub fn set_db_cluster_instance_class(self, input: Option<String>) -> Self
pub fn set_db_cluster_instance_class(self, input: Option<String>) -> Self
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
Sourcepub fn get_db_cluster_instance_class(&self) -> &Option<String>
pub fn get_db_cluster_instance_class(&self) -> &Option<String>
The name of the compute and memory capacity class of the DB instance.
This setting is only for non-Aurora Multi-AZ DB clusters.
Sourcepub fn storage_type(self, input: impl Into<String>) -> Self
pub fn storage_type(self, input: impl Into<String>) -> Self
The storage type associated with the DB cluster.
Sourcepub fn set_storage_type(self, input: Option<String>) -> Self
pub fn set_storage_type(self, input: Option<String>) -> Self
The storage type associated with the DB cluster.
Sourcepub fn get_storage_type(&self) -> &Option<String>
pub fn get_storage_type(&self) -> &Option<String>
The storage type associated with the DB cluster.
Sourcepub fn iops(self, input: i32) -> Self
pub fn iops(self, input: i32) -> Self
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
Sourcepub fn set_iops(self, input: Option<i32>) -> Self
pub fn set_iops(self, input: Option<i32>) -> Self
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
Sourcepub fn get_iops(&self) -> &Option<i32>
pub fn get_iops(&self) -> &Option<i32>
The Provisioned IOPS (I/O operations per second) value.
This setting is only for non-Aurora Multi-AZ DB clusters.
Sourcepub fn publicly_accessible(self, input: bool) -> Self
pub fn publicly_accessible(self, input: bool) -> Self
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible and you connect from outside of the DB cluster'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 cluster, 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 cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster
.
This setting is only for non-Aurora Multi-AZ DB clusters.
Sourcepub fn set_publicly_accessible(self, input: Option<bool>) -> Self
pub fn set_publicly_accessible(self, input: Option<bool>) -> Self
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible and you connect from outside of the DB cluster'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 cluster, 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 cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster
.
This setting is only for non-Aurora Multi-AZ DB clusters.
Sourcepub fn get_publicly_accessible(&self) -> &Option<bool>
pub fn get_publicly_accessible(&self) -> &Option<bool>
Indicates whether the DB cluster is publicly accessible.
When the DB cluster is publicly accessible and you connect from outside of the DB cluster'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 cluster, 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 cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
For more information, see CreateDBCluster
.
This setting is only for non-Aurora Multi-AZ DB clusters.
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.
This setting is for Aurora DB clusters and Multi-AZ DB clusters.
For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.
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.
This setting is for Aurora DB clusters and Multi-AZ DB clusters.
For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.
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.
This setting is for Aurora DB clusters and Multi-AZ DB clusters.
For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version.
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 cluster.
This setting is only for -Aurora DB clusters and Multi-AZ DB clusters.
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 cluster.
This setting is only for -Aurora DB clusters and Multi-AZ DB clusters.
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 cluster.
This setting is only for -Aurora DB clusters and Multi-AZ DB clusters.
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 RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
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 RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
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 RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
Sourcepub fn database_insights_mode(self, input: DatabaseInsightsMode) -> Self
pub fn database_insights_mode(self, input: DatabaseInsightsMode) -> Self
The mode of Database Insights that is enabled for the DB cluster.
Sourcepub fn set_database_insights_mode(
self,
input: Option<DatabaseInsightsMode>,
) -> Self
pub fn set_database_insights_mode( self, input: Option<DatabaseInsightsMode>, ) -> Self
The mode of Database Insights that is enabled for the DB cluster.
Sourcepub fn get_database_insights_mode(&self) -> &Option<DatabaseInsightsMode>
pub fn get_database_insights_mode(&self) -> &Option<DatabaseInsightsMode>
The mode of Database Insights that is enabled for the DB cluster.
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 cluster.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
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 cluster.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
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 cluster.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
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 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.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
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 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.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
Sourcepub fn get_performance_insights_kms_key_id(&self) -> &Option<String>
pub fn get_performance_insights_kms_key_id(&self) -> &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.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
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.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
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 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.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
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 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.
This setting is only for Aurora DB clusters and Multi-AZ DB clusters.
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 serverless_v2_scaling_configuration(
self,
input: ServerlessV2ScalingConfigurationInfo,
) -> Self
pub fn serverless_v2_scaling_configuration( self, input: ServerlessV2ScalingConfigurationInfo, ) -> Self
The scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
Sourcepub fn set_serverless_v2_scaling_configuration(
self,
input: Option<ServerlessV2ScalingConfigurationInfo>,
) -> Self
pub fn set_serverless_v2_scaling_configuration( self, input: Option<ServerlessV2ScalingConfigurationInfo>, ) -> Self
The scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
Sourcepub fn get_serverless_v2_scaling_configuration(
&self,
) -> &Option<ServerlessV2ScalingConfigurationInfo>
pub fn get_serverless_v2_scaling_configuration( &self, ) -> &Option<ServerlessV2ScalingConfigurationInfo>
The scaling configuration for an Aurora Serverless v2 DB cluster.
For more information, see Using Amazon Aurora Serverless v2 in the Amazon Aurora User Guide.
Sourcepub fn serverless_v2_platform_version(self, input: impl Into<String>) -> Self
pub fn serverless_v2_platform_version(self, input: impl Into<String>) -> Self
The version of the Aurora Serverless V2 platform used by the DB cluster. For more information, see Using Aurora Serverless v2 in the Amazon Aurora User Guide.
Sourcepub fn set_serverless_v2_platform_version(self, input: Option<String>) -> Self
pub fn set_serverless_v2_platform_version(self, input: Option<String>) -> Self
The version of the Aurora Serverless V2 platform used by the DB cluster. For more information, see Using Aurora Serverless v2 in the Amazon Aurora User Guide.
Sourcepub fn get_serverless_v2_platform_version(&self) -> &Option<String>
pub fn get_serverless_v2_platform_version(&self) -> &Option<String>
The version of the Aurora Serverless V2 platform used by the DB cluster. For more information, see Using Aurora Serverless v2 in the Amazon Aurora User Guide.
Sourcepub fn network_type(self, input: impl Into<String>) -> Self
pub fn network_type(self, input: impl Into<String>) -> Self
The network type of the DB instance.
The network type is determined by the DBSubnetGroup
specified for the DB cluster. 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 Aurora User Guide.
This setting is only for Aurora DB clusters.
Valid Values: IPV4 | DUAL
Sourcepub fn set_network_type(self, input: Option<String>) -> Self
pub fn set_network_type(self, input: Option<String>) -> Self
The network type of the DB instance.
The network type is determined by the DBSubnetGroup
specified for the DB cluster. 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 Aurora User Guide.
This setting is only for Aurora DB clusters.
Valid Values: IPV4 | DUAL
Sourcepub fn get_network_type(&self) -> &Option<String>
pub fn get_network_type(&self) -> &Option<String>
The network type of the DB instance.
The network type is determined by the DBSubnetGroup
specified for the DB cluster. 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 Aurora User Guide.
This setting is only for Aurora DB clusters.
Valid Values: IPV4 | DUAL
Sourcepub fn db_system_id(self, input: impl Into<String>) -> Self
pub fn db_system_id(self, input: impl Into<String>) -> Self
Reserved for future use.
Sourcepub fn set_db_system_id(self, input: Option<String>) -> Self
pub fn set_db_system_id(self, input: Option<String>) -> Self
Reserved for future use.
Sourcepub fn get_db_system_id(&self) -> &Option<String>
pub fn get_db_system_id(&self) -> &Option<String>
Reserved for future use.
Sourcepub fn master_user_secret(self, input: MasterUserSecret) -> Self
pub fn master_user_secret(self, input: MasterUserSecret) -> Self
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 and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Sourcepub fn set_master_user_secret(self, input: Option<MasterUserSecret>) -> Self
pub fn set_master_user_secret(self, input: Option<MasterUserSecret>) -> Self
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 and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Sourcepub fn get_master_user_secret(&self) -> &Option<MasterUserSecret>
pub fn get_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 and Password management with Amazon Web Services Secrets Manager in the Amazon Aurora User Guide.
Sourcepub fn io_optimized_next_allowed_modification_time(
self,
input: DateTime,
) -> Self
pub fn io_optimized_next_allowed_modification_time( self, input: DateTime, ) -> Self
The next time you can modify the DB cluster to use the aurora-iopt1
storage type.
This setting is only for Aurora DB clusters.
Sourcepub fn set_io_optimized_next_allowed_modification_time(
self,
input: Option<DateTime>,
) -> Self
pub fn set_io_optimized_next_allowed_modification_time( self, input: Option<DateTime>, ) -> Self
The next time you can modify the DB cluster to use the aurora-iopt1
storage type.
This setting is only for Aurora DB clusters.
Sourcepub fn get_io_optimized_next_allowed_modification_time(
&self,
) -> &Option<DateTime>
pub fn get_io_optimized_next_allowed_modification_time( &self, ) -> &Option<DateTime>
The next time you can modify the DB cluster to use the aurora-iopt1
storage type.
This setting is only for Aurora DB clusters.
Sourcepub fn local_write_forwarding_status(
self,
input: LocalWriteForwardingStatus,
) -> Self
pub fn local_write_forwarding_status( self, input: LocalWriteForwardingStatus, ) -> Self
Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
Sourcepub fn set_local_write_forwarding_status(
self,
input: Option<LocalWriteForwardingStatus>,
) -> Self
pub fn set_local_write_forwarding_status( self, input: Option<LocalWriteForwardingStatus>, ) -> Self
Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
Sourcepub fn get_local_write_forwarding_status(
&self,
) -> &Option<LocalWriteForwardingStatus>
pub fn get_local_write_forwarding_status( &self, ) -> &Option<LocalWriteForwardingStatus>
Indicates whether an Aurora DB cluster has in-cluster write forwarding enabled, not enabled, requested, or is in the process of enabling it.
Sourcepub fn aws_backup_recovery_point_arn(self, input: impl Into<String>) -> Self
pub fn aws_backup_recovery_point_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
Sourcepub fn set_aws_backup_recovery_point_arn(self, input: Option<String>) -> Self
pub fn set_aws_backup_recovery_point_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
Sourcepub fn get_aws_backup_recovery_point_arn(&self) -> &Option<String>
pub fn get_aws_backup_recovery_point_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
Sourcepub fn limitless_database(self, input: LimitlessDatabase) -> Self
pub fn limitless_database(self, input: LimitlessDatabase) -> Self
The details for Aurora Limitless Database.
Sourcepub fn set_limitless_database(self, input: Option<LimitlessDatabase>) -> Self
pub fn set_limitless_database(self, input: Option<LimitlessDatabase>) -> Self
The details for Aurora Limitless Database.
Sourcepub fn get_limitless_database(&self) -> &Option<LimitlessDatabase>
pub fn get_limitless_database(&self) -> &Option<LimitlessDatabase>
The details for Aurora Limitless Database.
Sourcepub fn storage_throughput(self, input: i32) -> Self
pub fn storage_throughput(self, input: i32) -> Self
The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
Sourcepub fn set_storage_throughput(self, input: Option<i32>) -> Self
pub fn set_storage_throughput(self, input: Option<i32>) -> Self
The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
Sourcepub fn get_storage_throughput(&self) -> &Option<i32>
pub fn get_storage_throughput(&self) -> &Option<i32>
The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
This setting is only for non-Aurora Multi-AZ DB clusters.
Sourcepub fn cluster_scalability_type(self, input: ClusterScalabilityType) -> Self
pub fn cluster_scalability_type(self, input: ClusterScalabilityType) -> Self
The scalability mode of the Aurora DB cluster. When set to limitless
, the cluster operates as an Aurora Limitless Database. When set to standard
(the default), the cluster uses normal DB instance creation.
Sourcepub fn set_cluster_scalability_type(
self,
input: Option<ClusterScalabilityType>,
) -> Self
pub fn set_cluster_scalability_type( self, input: Option<ClusterScalabilityType>, ) -> Self
The scalability mode of the Aurora DB cluster. When set to limitless
, the cluster operates as an Aurora Limitless Database. When set to standard
(the default), the cluster uses normal DB instance creation.
Sourcepub fn get_cluster_scalability_type(&self) -> &Option<ClusterScalabilityType>
pub fn get_cluster_scalability_type(&self) -> &Option<ClusterScalabilityType>
The scalability mode of the Aurora DB cluster. When set to limitless
, the cluster operates as an Aurora Limitless Database. When set to standard
(the default), the cluster uses normal DB instance creation.
Sourcepub fn certificate_details(self, input: CertificateDetails) -> Self
pub fn certificate_details(self, input: CertificateDetails) -> Self
The details of the DB instance’s server certificate.
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 set_certificate_details(self, input: Option<CertificateDetails>) -> Self
pub fn set_certificate_details(self, input: Option<CertificateDetails>) -> Self
The details of the DB instance’s server certificate.
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 get_certificate_details(&self) -> &Option<CertificateDetails>
pub fn get_certificate_details(&self) -> &Option<CertificateDetails>
The details of the DB instance’s server certificate.
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 engine_lifecycle_support(self, input: impl Into<String>) -> Self
pub fn engine_lifecycle_support(self, input: impl Into<String>) -> Self
The lifecycle type for the DB cluster.
For more information, see CreateDBCluster.
Sourcepub fn set_engine_lifecycle_support(self, input: Option<String>) -> Self
pub fn set_engine_lifecycle_support(self, input: Option<String>) -> Self
The lifecycle type for the DB cluster.
For more information, see CreateDBCluster.
Sourcepub fn get_engine_lifecycle_support(&self) -> &Option<String>
pub fn get_engine_lifecycle_support(&self) -> &Option<String>
The lifecycle type for the DB cluster.
For more information, see CreateDBCluster.
Trait Implementations§
Source§impl Clone for DbClusterBuilder
impl Clone for DbClusterBuilder
Source§fn clone(&self) -> DbClusterBuilder
fn clone(&self) -> DbClusterBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DbClusterBuilder
impl Debug for DbClusterBuilder
Source§impl Default for DbClusterBuilder
impl Default for DbClusterBuilder
Source§fn default() -> DbClusterBuilder
fn default() -> DbClusterBuilder
Source§impl PartialEq for DbClusterBuilder
impl PartialEq for DbClusterBuilder
impl StructuralPartialEq for DbClusterBuilder
Auto Trait Implementations§
impl Freeze for DbClusterBuilder
impl RefUnwindSafe for DbClusterBuilder
impl Send for DbClusterBuilder
impl Sync for DbClusterBuilder
impl Unpin for DbClusterBuilder
impl UnwindSafe for DbClusterBuilder
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);