#[non_exhaustive]pub struct ClusterBuilder { /* private fields */ }
Expand description
A builder for Cluster
.
Implementations§
Source§impl ClusterBuilder
impl ClusterBuilder
Sourcepub fn cluster_identifier(self, input: impl Into<String>) -> Self
pub fn cluster_identifier(self, input: impl Into<String>) -> Self
The unique identifier of the cluster.
Sourcepub fn set_cluster_identifier(self, input: Option<String>) -> Self
pub fn set_cluster_identifier(self, input: Option<String>) -> Self
The unique identifier of the cluster.
Sourcepub fn get_cluster_identifier(&self) -> &Option<String>
pub fn get_cluster_identifier(&self) -> &Option<String>
The unique identifier of the cluster.
Sourcepub fn node_type(self, input: impl Into<String>) -> Self
pub fn node_type(self, input: impl Into<String>) -> Self
The node type for the nodes in the cluster.
Sourcepub fn set_node_type(self, input: Option<String>) -> Self
pub fn set_node_type(self, input: Option<String>) -> Self
The node type for the nodes in the cluster.
Sourcepub fn get_node_type(&self) -> &Option<String>
pub fn get_node_type(&self) -> &Option<String>
The node type for the nodes in the cluster.
Sourcepub fn cluster_status(self, input: impl Into<String>) -> Self
pub fn cluster_status(self, input: impl Into<String>) -> Self
The current state of the cluster. Possible values are the following:
-
available
-
available, prep-for-resize
-
available, resize-cleanup
-
cancelling-resize
-
creating
-
deleting
-
final-snapshot
-
hardware-failure
-
incompatible-hsm
-
incompatible-network
-
incompatible-parameters
-
incompatible-restore
-
modifying
-
paused
-
rebooting
-
renaming
-
resizing
-
rotating-keys
-
storage-full
-
updating-hsm
Sourcepub fn set_cluster_status(self, input: Option<String>) -> Self
pub fn set_cluster_status(self, input: Option<String>) -> Self
The current state of the cluster. Possible values are the following:
-
available
-
available, prep-for-resize
-
available, resize-cleanup
-
cancelling-resize
-
creating
-
deleting
-
final-snapshot
-
hardware-failure
-
incompatible-hsm
-
incompatible-network
-
incompatible-parameters
-
incompatible-restore
-
modifying
-
paused
-
rebooting
-
renaming
-
resizing
-
rotating-keys
-
storage-full
-
updating-hsm
Sourcepub fn get_cluster_status(&self) -> &Option<String>
pub fn get_cluster_status(&self) -> &Option<String>
The current state of the cluster. Possible values are the following:
-
available
-
available, prep-for-resize
-
available, resize-cleanup
-
cancelling-resize
-
creating
-
deleting
-
final-snapshot
-
hardware-failure
-
incompatible-hsm
-
incompatible-network
-
incompatible-parameters
-
incompatible-restore
-
modifying
-
paused
-
rebooting
-
renaming
-
resizing
-
rotating-keys
-
storage-full
-
updating-hsm
Sourcepub fn cluster_availability_status(self, input: impl Into<String>) -> Self
pub fn cluster_availability_status(self, input: impl Into<String>) -> Self
The availability status of the cluster for queries. Possible values are the following:
-
Available - The cluster is available for queries.
-
Unavailable - The cluster is not available for queries.
-
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
-
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
-
Failed - The cluster failed and is not available for queries.
Sourcepub fn set_cluster_availability_status(self, input: Option<String>) -> Self
pub fn set_cluster_availability_status(self, input: Option<String>) -> Self
The availability status of the cluster for queries. Possible values are the following:
-
Available - The cluster is available for queries.
-
Unavailable - The cluster is not available for queries.
-
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
-
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
-
Failed - The cluster failed and is not available for queries.
Sourcepub fn get_cluster_availability_status(&self) -> &Option<String>
pub fn get_cluster_availability_status(&self) -> &Option<String>
The availability status of the cluster for queries. Possible values are the following:
-
Available - The cluster is available for queries.
-
Unavailable - The cluster is not available for queries.
-
Maintenance - The cluster is intermittently available for queries due to maintenance activities.
-
Modifying - The cluster is intermittently available for queries due to changes that modify the cluster.
-
Failed - The cluster failed and is not available for queries.
Sourcepub fn modify_status(self, input: impl Into<String>) -> Self
pub fn modify_status(self, input: impl Into<String>) -> Self
The status of a modify operation, if any, initiated for the cluster.
Sourcepub fn set_modify_status(self, input: Option<String>) -> Self
pub fn set_modify_status(self, input: Option<String>) -> Self
The status of a modify operation, if any, initiated for the cluster.
Sourcepub fn get_modify_status(&self) -> &Option<String>
pub fn get_modify_status(&self) -> &Option<String>
The status of a modify operation, if any, initiated for the cluster.
Sourcepub fn master_username(self, input: impl Into<String>) -> Self
pub fn master_username(self, input: impl Into<String>) -> Self
The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
Sourcepub fn set_master_username(self, input: Option<String>) -> Self
pub fn set_master_username(self, input: Option<String>) -> Self
The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
Sourcepub fn get_master_username(&self) -> &Option<String>
pub fn get_master_username(&self) -> &Option<String>
The admin user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.
Sourcepub fn db_name(self, input: impl Into<String>) -> Self
pub fn db_name(self, input: impl Into<String>) -> Self
The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named dev
dev was created by default.
Sourcepub fn set_db_name(self, input: Option<String>) -> Self
pub fn set_db_name(self, input: Option<String>) -> Self
The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named dev
dev was created by default.
Sourcepub fn get_db_name(&self) -> &Option<String>
pub fn get_db_name(&self) -> &Option<String>
The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named dev
dev was created by default.
Sourcepub fn set_endpoint(self, input: Option<Endpoint>) -> Self
pub fn set_endpoint(self, input: Option<Endpoint>) -> Self
The connection endpoint.
Sourcepub fn get_endpoint(&self) -> &Option<Endpoint>
pub fn get_endpoint(&self) -> &Option<Endpoint>
The connection endpoint.
Sourcepub fn cluster_create_time(self, input: DateTime) -> Self
pub fn cluster_create_time(self, input: DateTime) -> Self
The date and time that the cluster was created.
Sourcepub fn set_cluster_create_time(self, input: Option<DateTime>) -> Self
pub fn set_cluster_create_time(self, input: Option<DateTime>) -> Self
The date and time that the cluster was created.
Sourcepub fn get_cluster_create_time(&self) -> &Option<DateTime>
pub fn get_cluster_create_time(&self) -> &Option<DateTime>
The date and time that the cluster was created.
Sourcepub fn automated_snapshot_retention_period(self, input: i32) -> Self
pub fn automated_snapshot_retention_period(self, input: i32) -> Self
The number of days that automatic cluster snapshots are retained.
Sourcepub fn set_automated_snapshot_retention_period(self, input: Option<i32>) -> Self
pub fn set_automated_snapshot_retention_period(self, input: Option<i32>) -> Self
The number of days that automatic cluster snapshots are retained.
Sourcepub fn get_automated_snapshot_retention_period(&self) -> &Option<i32>
pub fn get_automated_snapshot_retention_period(&self) -> &Option<i32>
The number of days that automatic cluster snapshots are retained.
Sourcepub fn manual_snapshot_retention_period(self, input: i32) -> Self
pub fn manual_snapshot_retention_period(self, input: i32) -> Self
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
Sourcepub fn set_manual_snapshot_retention_period(self, input: Option<i32>) -> Self
pub fn set_manual_snapshot_retention_period(self, input: Option<i32>) -> Self
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
Sourcepub fn get_manual_snapshot_retention_period(&self) -> &Option<i32>
pub fn get_manual_snapshot_retention_period(&self) -> &Option<i32>
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots.
The value must be either -1 or an integer between 1 and 3,653.
Sourcepub fn cluster_security_groups(
self,
input: ClusterSecurityGroupMembership,
) -> Self
pub fn cluster_security_groups( self, input: ClusterSecurityGroupMembership, ) -> Self
Appends an item to cluster_security_groups
.
To override the contents of this collection use set_cluster_security_groups
.
A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name
and ClusterSecurityGroup.Status
subelements.
Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
Sourcepub fn set_cluster_security_groups(
self,
input: Option<Vec<ClusterSecurityGroupMembership>>,
) -> Self
pub fn set_cluster_security_groups( self, input: Option<Vec<ClusterSecurityGroupMembership>>, ) -> Self
A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name
and ClusterSecurityGroup.Status
subelements.
Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
Sourcepub fn get_cluster_security_groups(
&self,
) -> &Option<Vec<ClusterSecurityGroupMembership>>
pub fn get_cluster_security_groups( &self, ) -> &Option<Vec<ClusterSecurityGroupMembership>>
A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name
and ClusterSecurityGroup.Status
subelements.
Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.
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
.
A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
Sourcepub fn set_vpc_security_groups(
self,
input: Option<Vec<VpcSecurityGroupMembership>>,
) -> Self
pub fn set_vpc_security_groups( self, input: Option<Vec<VpcSecurityGroupMembership>>, ) -> Self
A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
Sourcepub fn get_vpc_security_groups(
&self,
) -> &Option<Vec<VpcSecurityGroupMembership>>
pub fn get_vpc_security_groups( &self, ) -> &Option<Vec<VpcSecurityGroupMembership>>
A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.
Sourcepub fn cluster_parameter_groups(
self,
input: ClusterParameterGroupStatus,
) -> Self
pub fn cluster_parameter_groups( self, input: ClusterParameterGroupStatus, ) -> Self
Appends an item to cluster_parameter_groups
.
To override the contents of this collection use set_cluster_parameter_groups
.
The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
Sourcepub fn set_cluster_parameter_groups(
self,
input: Option<Vec<ClusterParameterGroupStatus>>,
) -> Self
pub fn set_cluster_parameter_groups( self, input: Option<Vec<ClusterParameterGroupStatus>>, ) -> Self
The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
Sourcepub fn get_cluster_parameter_groups(
&self,
) -> &Option<Vec<ClusterParameterGroupStatus>>
pub fn get_cluster_parameter_groups( &self, ) -> &Option<Vec<ClusterParameterGroupStatus>>
The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.
Sourcepub fn cluster_subnet_group_name(self, input: impl Into<String>) -> Self
pub fn cluster_subnet_group_name(self, input: impl Into<String>) -> Self
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
Sourcepub fn set_cluster_subnet_group_name(self, input: Option<String>) -> Self
pub fn set_cluster_subnet_group_name(self, input: Option<String>) -> Self
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
Sourcepub fn get_cluster_subnet_group_name(&self) -> &Option<String>
pub fn get_cluster_subnet_group_name(&self) -> &Option<String>
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
Sourcepub fn vpc_id(self, input: impl Into<String>) -> Self
pub fn vpc_id(self, input: impl Into<String>) -> Self
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
Sourcepub fn set_vpc_id(self, input: Option<String>) -> Self
pub fn set_vpc_id(self, input: Option<String>) -> Self
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
Sourcepub fn get_vpc_id(&self) -> &Option<String>
pub fn get_vpc_id(&self) -> &Option<String>
The identifier of the VPC the cluster is in, if the cluster is in a VPC.
Sourcepub fn availability_zone(self, input: impl Into<String>) -> Self
pub fn availability_zone(self, input: impl Into<String>) -> Self
The name of the Availability Zone in which the cluster is located.
Sourcepub fn set_availability_zone(self, input: Option<String>) -> Self
pub fn set_availability_zone(self, input: Option<String>) -> Self
The name of the Availability Zone in which the cluster is located.
Sourcepub fn get_availability_zone(&self) -> &Option<String>
pub fn get_availability_zone(&self) -> &Option<String>
The name of the Availability Zone in which the cluster is located.
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, in Universal Coordinated Time (UTC), during which system maintenance can occur.
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, in Universal Coordinated Time (UTC), during which system maintenance can occur.
Sourcepub fn get_preferred_maintenance_window(&self) -> &Option<String>
pub fn get_preferred_maintenance_window(&self) -> &Option<String>
The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
Sourcepub fn pending_modified_values(self, input: PendingModifiedValues) -> Self
pub fn pending_modified_values(self, input: PendingModifiedValues) -> Self
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
Sourcepub fn set_pending_modified_values(
self,
input: Option<PendingModifiedValues>,
) -> Self
pub fn set_pending_modified_values( self, input: Option<PendingModifiedValues>, ) -> Self
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
Sourcepub fn get_pending_modified_values(&self) -> &Option<PendingModifiedValues>
pub fn get_pending_modified_values(&self) -> &Option<PendingModifiedValues>
A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.
Sourcepub fn cluster_version(self, input: impl Into<String>) -> Self
pub fn cluster_version(self, input: impl Into<String>) -> Self
The version ID of the Amazon Redshift engine that is running on the cluster.
Sourcepub fn set_cluster_version(self, input: Option<String>) -> Self
pub fn set_cluster_version(self, input: Option<String>) -> Self
The version ID of the Amazon Redshift engine that is running on the cluster.
Sourcepub fn get_cluster_version(&self) -> &Option<String>
pub fn get_cluster_version(&self) -> &Option<String>
The version ID of the Amazon Redshift engine that is running on the cluster.
Sourcepub fn allow_version_upgrade(self, input: bool) -> Self
pub fn allow_version_upgrade(self, input: bool) -> Self
A boolean value that, if true
, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.
Sourcepub fn set_allow_version_upgrade(self, input: Option<bool>) -> Self
pub fn set_allow_version_upgrade(self, input: Option<bool>) -> Self
A boolean value that, if true
, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.
Sourcepub fn get_allow_version_upgrade(&self) -> &Option<bool>
pub fn get_allow_version_upgrade(&self) -> &Option<bool>
A boolean value that, if true
, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.
Sourcepub fn number_of_nodes(self, input: i32) -> Self
pub fn number_of_nodes(self, input: i32) -> Self
The number of compute nodes in the cluster.
Sourcepub fn set_number_of_nodes(self, input: Option<i32>) -> Self
pub fn set_number_of_nodes(self, input: Option<i32>) -> Self
The number of compute nodes in the cluster.
Sourcepub fn get_number_of_nodes(&self) -> &Option<i32>
pub fn get_number_of_nodes(&self) -> &Option<i32>
The number of compute nodes in the cluster.
Sourcepub fn publicly_accessible(self, input: bool) -> Self
pub fn publicly_accessible(self, input: bool) -> Self
A boolean value that, if true
, indicates that the cluster can be accessed from a public network.
Default: false
Sourcepub fn set_publicly_accessible(self, input: Option<bool>) -> Self
pub fn set_publicly_accessible(self, input: Option<bool>) -> Self
A boolean value that, if true
, indicates that the cluster can be accessed from a public network.
Default: false
Sourcepub fn get_publicly_accessible(&self) -> &Option<bool>
pub fn get_publicly_accessible(&self) -> &Option<bool>
A boolean value that, if true
, indicates that the cluster can be accessed from a public network.
Default: false
Sourcepub fn encrypted(self, input: bool) -> Self
pub fn encrypted(self, input: bool) -> Self
A boolean value that, if true
, indicates that data in the cluster is encrypted at rest.
Sourcepub fn set_encrypted(self, input: Option<bool>) -> Self
pub fn set_encrypted(self, input: Option<bool>) -> Self
A boolean value that, if true
, indicates that data in the cluster is encrypted at rest.
Sourcepub fn get_encrypted(&self) -> &Option<bool>
pub fn get_encrypted(&self) -> &Option<bool>
A boolean value that, if true
, indicates that data in the cluster is encrypted at rest.
Sourcepub fn restore_status(self, input: RestoreStatus) -> Self
pub fn restore_status(self, input: RestoreStatus) -> Self
A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.
Sourcepub fn set_restore_status(self, input: Option<RestoreStatus>) -> Self
pub fn set_restore_status(self, input: Option<RestoreStatus>) -> Self
A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.
Sourcepub fn get_restore_status(&self) -> &Option<RestoreStatus>
pub fn get_restore_status(&self) -> &Option<RestoreStatus>
A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.
Sourcepub fn data_transfer_progress(self, input: DataTransferProgress) -> Self
pub fn data_transfer_progress(self, input: DataTransferProgress) -> Self
Sourcepub fn set_data_transfer_progress(
self,
input: Option<DataTransferProgress>,
) -> Self
pub fn set_data_transfer_progress( self, input: Option<DataTransferProgress>, ) -> Self
Sourcepub fn get_data_transfer_progress(&self) -> &Option<DataTransferProgress>
pub fn get_data_transfer_progress(&self) -> &Option<DataTransferProgress>
Sourcepub fn hsm_status(self, input: HsmStatus) -> Self
pub fn hsm_status(self, input: HsmStatus) -> Self
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM) settings changes specified in a modify cluster command.
Values: active, applying
Sourcepub fn set_hsm_status(self, input: Option<HsmStatus>) -> Self
pub fn set_hsm_status(self, input: Option<HsmStatus>) -> Self
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM) settings changes specified in a modify cluster command.
Values: active, applying
Sourcepub fn get_hsm_status(&self) -> &Option<HsmStatus>
pub fn get_hsm_status(&self) -> &Option<HsmStatus>
A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM) settings changes specified in a modify cluster command.
Values: active, applying
Sourcepub fn cluster_snapshot_copy_status(
self,
input: ClusterSnapshotCopyStatus,
) -> Self
pub fn cluster_snapshot_copy_status( self, input: ClusterSnapshotCopyStatus, ) -> Self
A value that returns the destination region and retention period that are configured for cross-region snapshot copy.
Sourcepub fn set_cluster_snapshot_copy_status(
self,
input: Option<ClusterSnapshotCopyStatus>,
) -> Self
pub fn set_cluster_snapshot_copy_status( self, input: Option<ClusterSnapshotCopyStatus>, ) -> Self
A value that returns the destination region and retention period that are configured for cross-region snapshot copy.
Sourcepub fn get_cluster_snapshot_copy_status(
&self,
) -> &Option<ClusterSnapshotCopyStatus>
pub fn get_cluster_snapshot_copy_status( &self, ) -> &Option<ClusterSnapshotCopyStatus>
A value that returns the destination region and retention period that are configured for cross-region snapshot copy.
Sourcepub fn cluster_public_key(self, input: impl Into<String>) -> Self
pub fn cluster_public_key(self, input: impl Into<String>) -> Self
The public key for the cluster.
Sourcepub fn set_cluster_public_key(self, input: Option<String>) -> Self
pub fn set_cluster_public_key(self, input: Option<String>) -> Self
The public key for the cluster.
Sourcepub fn get_cluster_public_key(&self) -> &Option<String>
pub fn get_cluster_public_key(&self) -> &Option<String>
The public key for the cluster.
Sourcepub fn cluster_nodes(self, input: ClusterNode) -> Self
pub fn cluster_nodes(self, input: ClusterNode) -> Self
Appends an item to cluster_nodes
.
To override the contents of this collection use set_cluster_nodes
.
The nodes in the cluster.
Sourcepub fn set_cluster_nodes(self, input: Option<Vec<ClusterNode>>) -> Self
pub fn set_cluster_nodes(self, input: Option<Vec<ClusterNode>>) -> Self
The nodes in the cluster.
Sourcepub fn get_cluster_nodes(&self) -> &Option<Vec<ClusterNode>>
pub fn get_cluster_nodes(&self) -> &Option<Vec<ClusterNode>>
The nodes in the cluster.
Sourcepub fn elastic_ip_status(self, input: ElasticIpStatus) -> Self
pub fn elastic_ip_status(self, input: ElasticIpStatus) -> Self
The status of the elastic IP (EIP) address.
Sourcepub fn set_elastic_ip_status(self, input: Option<ElasticIpStatus>) -> Self
pub fn set_elastic_ip_status(self, input: Option<ElasticIpStatus>) -> Self
The status of the elastic IP (EIP) address.
Sourcepub fn get_elastic_ip_status(&self) -> &Option<ElasticIpStatus>
pub fn get_elastic_ip_status(&self) -> &Option<ElasticIpStatus>
The status of the elastic IP (EIP) address.
Sourcepub fn cluster_revision_number(self, input: impl Into<String>) -> Self
pub fn cluster_revision_number(self, input: impl Into<String>) -> Self
The specific revision number of the database in the cluster.
Sourcepub fn set_cluster_revision_number(self, input: Option<String>) -> Self
pub fn set_cluster_revision_number(self, input: Option<String>) -> Self
The specific revision number of the database in the cluster.
Sourcepub fn get_cluster_revision_number(&self) -> &Option<String>
pub fn get_cluster_revision_number(&self) -> &Option<String>
The specific revision number of the database in the cluster.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
The list of tags for the cluster.
The list of tags for the cluster.
The list of tags for the cluster.
Sourcepub fn kms_key_id(self, input: impl Into<String>) -> Self
pub fn kms_key_id(self, input: impl Into<String>) -> Self
The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
Sourcepub fn set_kms_key_id(self, input: Option<String>) -> Self
pub fn set_kms_key_id(self, input: Option<String>) -> Self
The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
Sourcepub fn get_kms_key_id(&self) -> &Option<String>
pub fn get_kms_key_id(&self) -> &Option<String>
The Key Management Service (KMS) key ID of the encryption key used to encrypt data in the cluster.
Sourcepub fn enhanced_vpc_routing(self, input: bool) -> Self
pub fn enhanced_vpc_routing(self, input: bool) -> Self
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true
, enhanced VPC routing is enabled.
Default: false
Sourcepub fn set_enhanced_vpc_routing(self, input: Option<bool>) -> Self
pub fn set_enhanced_vpc_routing(self, input: Option<bool>) -> Self
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true
, enhanced VPC routing is enabled.
Default: false
Sourcepub fn get_enhanced_vpc_routing(&self) -> &Option<bool>
pub fn get_enhanced_vpc_routing(&self) -> &Option<bool>
An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.
If this option is true
, enhanced VPC routing is enabled.
Default: false
Sourcepub fn iam_roles(self, input: ClusterIamRole) -> Self
pub fn iam_roles(self, input: ClusterIamRole) -> Self
Appends an item to iam_roles
.
To override the contents of this collection use set_iam_roles
.
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
Sourcepub fn set_iam_roles(self, input: Option<Vec<ClusterIamRole>>) -> Self
pub fn set_iam_roles(self, input: Option<Vec<ClusterIamRole>>) -> Self
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
Sourcepub fn get_iam_roles(&self) -> &Option<Vec<ClusterIamRole>>
pub fn get_iam_roles(&self) -> &Option<Vec<ClusterIamRole>>
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.
Sourcepub fn pending_actions(self, input: impl Into<String>) -> Self
pub fn pending_actions(self, input: impl Into<String>) -> Self
Appends an item to pending_actions
.
To override the contents of this collection use set_pending_actions
.
Cluster operations that are waiting to be started.
Sourcepub fn set_pending_actions(self, input: Option<Vec<String>>) -> Self
pub fn set_pending_actions(self, input: Option<Vec<String>>) -> Self
Cluster operations that are waiting to be started.
Sourcepub fn get_pending_actions(&self) -> &Option<Vec<String>>
pub fn get_pending_actions(&self) -> &Option<Vec<String>>
Cluster operations that are waiting to be started.
Sourcepub fn maintenance_track_name(self, input: impl Into<String>) -> Self
pub fn maintenance_track_name(self, input: impl Into<String>) -> Self
The name of the maintenance track for the cluster.
Sourcepub fn set_maintenance_track_name(self, input: Option<String>) -> Self
pub fn set_maintenance_track_name(self, input: Option<String>) -> Self
The name of the maintenance track for the cluster.
Sourcepub fn get_maintenance_track_name(&self) -> &Option<String>
pub fn get_maintenance_track_name(&self) -> &Option<String>
The name of the maintenance track for the cluster.
Sourcepub fn elastic_resize_number_of_node_options(
self,
input: impl Into<String>,
) -> Self
pub fn elastic_resize_number_of_node_options( self, input: impl Into<String>, ) -> Self
The number of nodes that you can resize the cluster to with the elastic resize method.
Sourcepub fn set_elastic_resize_number_of_node_options(
self,
input: Option<String>,
) -> Self
pub fn set_elastic_resize_number_of_node_options( self, input: Option<String>, ) -> Self
The number of nodes that you can resize the cluster to with the elastic resize method.
Sourcepub fn get_elastic_resize_number_of_node_options(&self) -> &Option<String>
pub fn get_elastic_resize_number_of_node_options(&self) -> &Option<String>
The number of nodes that you can resize the cluster to with the elastic resize method.
Sourcepub fn deferred_maintenance_windows(
self,
input: DeferredMaintenanceWindow,
) -> Self
pub fn deferred_maintenance_windows( self, input: DeferredMaintenanceWindow, ) -> Self
Appends an item to deferred_maintenance_windows
.
To override the contents of this collection use set_deferred_maintenance_windows
.
Describes a group of DeferredMaintenanceWindow
objects.
Sourcepub fn set_deferred_maintenance_windows(
self,
input: Option<Vec<DeferredMaintenanceWindow>>,
) -> Self
pub fn set_deferred_maintenance_windows( self, input: Option<Vec<DeferredMaintenanceWindow>>, ) -> Self
Describes a group of DeferredMaintenanceWindow
objects.
Sourcepub fn get_deferred_maintenance_windows(
&self,
) -> &Option<Vec<DeferredMaintenanceWindow>>
pub fn get_deferred_maintenance_windows( &self, ) -> &Option<Vec<DeferredMaintenanceWindow>>
Describes a group of DeferredMaintenanceWindow
objects.
Sourcepub fn snapshot_schedule_identifier(self, input: impl Into<String>) -> Self
pub fn snapshot_schedule_identifier(self, input: impl Into<String>) -> Self
A unique identifier for the cluster snapshot schedule.
Sourcepub fn set_snapshot_schedule_identifier(self, input: Option<String>) -> Self
pub fn set_snapshot_schedule_identifier(self, input: Option<String>) -> Self
A unique identifier for the cluster snapshot schedule.
Sourcepub fn get_snapshot_schedule_identifier(&self) -> &Option<String>
pub fn get_snapshot_schedule_identifier(&self) -> &Option<String>
A unique identifier for the cluster snapshot schedule.
Sourcepub fn snapshot_schedule_state(self, input: ScheduleState) -> Self
pub fn snapshot_schedule_state(self, input: ScheduleState) -> Self
The current state of the cluster snapshot schedule.
Sourcepub fn set_snapshot_schedule_state(self, input: Option<ScheduleState>) -> Self
pub fn set_snapshot_schedule_state(self, input: Option<ScheduleState>) -> Self
The current state of the cluster snapshot schedule.
Sourcepub fn get_snapshot_schedule_state(&self) -> &Option<ScheduleState>
pub fn get_snapshot_schedule_state(&self) -> &Option<ScheduleState>
The current state of the cluster snapshot schedule.
Sourcepub fn expected_next_snapshot_schedule_time(self, input: DateTime) -> Self
pub fn expected_next_snapshot_schedule_time(self, input: DateTime) -> Self
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
Sourcepub fn set_expected_next_snapshot_schedule_time(
self,
input: Option<DateTime>,
) -> Self
pub fn set_expected_next_snapshot_schedule_time( self, input: Option<DateTime>, ) -> Self
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
Sourcepub fn get_expected_next_snapshot_schedule_time(&self) -> &Option<DateTime>
pub fn get_expected_next_snapshot_schedule_time(&self) -> &Option<DateTime>
The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
Sourcepub fn expected_next_snapshot_schedule_time_status(
self,
input: impl Into<String>,
) -> Self
pub fn expected_next_snapshot_schedule_time_status( self, input: impl Into<String>, ) -> Self
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
-
OnTrack - The next snapshot is expected to be taken on time.
-
Pending - The next snapshot is pending to be taken.
Sourcepub fn set_expected_next_snapshot_schedule_time_status(
self,
input: Option<String>,
) -> Self
pub fn set_expected_next_snapshot_schedule_time_status( self, input: Option<String>, ) -> Self
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
-
OnTrack - The next snapshot is expected to be taken on time.
-
Pending - The next snapshot is pending to be taken.
Sourcepub fn get_expected_next_snapshot_schedule_time_status(&self) -> &Option<String>
pub fn get_expected_next_snapshot_schedule_time_status(&self) -> &Option<String>
The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
-
OnTrack - The next snapshot is expected to be taken on time.
-
Pending - The next snapshot is pending to be taken.
Sourcepub fn next_maintenance_window_start_time(self, input: DateTime) -> Self
pub fn next_maintenance_window_start_time(self, input: DateTime) -> Self
The date and time in UTC when system maintenance can begin.
Sourcepub fn set_next_maintenance_window_start_time(
self,
input: Option<DateTime>,
) -> Self
pub fn set_next_maintenance_window_start_time( self, input: Option<DateTime>, ) -> Self
The date and time in UTC when system maintenance can begin.
Sourcepub fn get_next_maintenance_window_start_time(&self) -> &Option<DateTime>
pub fn get_next_maintenance_window_start_time(&self) -> &Option<DateTime>
The date and time in UTC when system maintenance can begin.
Sourcepub fn resize_info(self, input: ResizeInfo) -> Self
pub fn resize_info(self, input: ResizeInfo) -> Self
Returns the following:
-
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
-
ResizeType: Returns ClassicResize
Sourcepub fn set_resize_info(self, input: Option<ResizeInfo>) -> Self
pub fn set_resize_info(self, input: Option<ResizeInfo>) -> Self
Returns the following:
-
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
-
ResizeType: Returns ClassicResize
Sourcepub fn get_resize_info(&self) -> &Option<ResizeInfo>
pub fn get_resize_info(&self) -> &Option<ResizeInfo>
Returns the following:
-
AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.
-
ResizeType: Returns ClassicResize
Sourcepub fn availability_zone_relocation_status(
self,
input: impl Into<String>,
) -> Self
pub fn availability_zone_relocation_status( self, input: impl Into<String>, ) -> Self
Describes the status of the Availability Zone relocation operation.
Sourcepub fn set_availability_zone_relocation_status(
self,
input: Option<String>,
) -> Self
pub fn set_availability_zone_relocation_status( self, input: Option<String>, ) -> Self
Describes the status of the Availability Zone relocation operation.
Sourcepub fn get_availability_zone_relocation_status(&self) -> &Option<String>
pub fn get_availability_zone_relocation_status(&self) -> &Option<String>
Describes the status of the Availability Zone relocation operation.
Sourcepub fn cluster_namespace_arn(self, input: impl Into<String>) -> Self
pub fn cluster_namespace_arn(self, input: impl Into<String>) -> Self
The namespace Amazon Resource Name (ARN) of the cluster.
Sourcepub fn set_cluster_namespace_arn(self, input: Option<String>) -> Self
pub fn set_cluster_namespace_arn(self, input: Option<String>) -> Self
The namespace Amazon Resource Name (ARN) of the cluster.
Sourcepub fn get_cluster_namespace_arn(&self) -> &Option<String>
pub fn get_cluster_namespace_arn(&self) -> &Option<String>
The namespace Amazon Resource Name (ARN) of the cluster.
Sourcepub fn total_storage_capacity_in_mega_bytes(self, input: i64) -> Self
pub fn total_storage_capacity_in_mega_bytes(self, input: i64) -> Self
The total storage capacity of the cluster in megabytes.
Sourcepub fn set_total_storage_capacity_in_mega_bytes(
self,
input: Option<i64>,
) -> Self
pub fn set_total_storage_capacity_in_mega_bytes( self, input: Option<i64>, ) -> Self
The total storage capacity of the cluster in megabytes.
Sourcepub fn get_total_storage_capacity_in_mega_bytes(&self) -> &Option<i64>
pub fn get_total_storage_capacity_in_mega_bytes(&self) -> &Option<i64>
The total storage capacity of the cluster in megabytes.
Sourcepub fn aqua_configuration(self, input: AquaConfiguration) -> Self
pub fn aqua_configuration(self, input: AquaConfiguration) -> Self
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
Sourcepub fn set_aqua_configuration(self, input: Option<AquaConfiguration>) -> Self
pub fn set_aqua_configuration(self, input: Option<AquaConfiguration>) -> Self
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
Sourcepub fn get_aqua_configuration(&self) -> &Option<AquaConfiguration>
pub fn get_aqua_configuration(&self) -> &Option<AquaConfiguration>
This field is retired. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
Sourcepub fn default_iam_role_arn(self, input: impl Into<String>) -> Self
pub fn default_iam_role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
Sourcepub fn set_default_iam_role_arn(self, input: Option<String>) -> Self
pub fn set_default_iam_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
Sourcepub fn get_default_iam_role_arn(&self) -> &Option<String>
pub fn get_default_iam_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) for the IAM role set as default for the cluster.
Sourcepub fn reserved_node_exchange_status(
self,
input: ReservedNodeExchangeStatus,
) -> Self
pub fn reserved_node_exchange_status( self, input: ReservedNodeExchangeStatus, ) -> Self
The status of the reserved-node exchange request. Statuses include in-progress and requested.
Sourcepub fn set_reserved_node_exchange_status(
self,
input: Option<ReservedNodeExchangeStatus>,
) -> Self
pub fn set_reserved_node_exchange_status( self, input: Option<ReservedNodeExchangeStatus>, ) -> Self
The status of the reserved-node exchange request. Statuses include in-progress and requested.
Sourcepub fn get_reserved_node_exchange_status(
&self,
) -> &Option<ReservedNodeExchangeStatus>
pub fn get_reserved_node_exchange_status( &self, ) -> &Option<ReservedNodeExchangeStatus>
The status of the reserved-node exchange request. Statuses include in-progress and requested.
Sourcepub fn custom_domain_name(self, input: impl Into<String>) -> Self
pub fn custom_domain_name(self, input: impl Into<String>) -> Self
The custom domain name associated with the cluster.
Sourcepub fn set_custom_domain_name(self, input: Option<String>) -> Self
pub fn set_custom_domain_name(self, input: Option<String>) -> Self
The custom domain name associated with the cluster.
Sourcepub fn get_custom_domain_name(&self) -> &Option<String>
pub fn get_custom_domain_name(&self) -> &Option<String>
The custom domain name associated with the cluster.
Sourcepub fn custom_domain_certificate_arn(self, input: impl Into<String>) -> Self
pub fn custom_domain_certificate_arn(self, input: impl Into<String>) -> Self
The certificate Amazon Resource Name (ARN) for the custom domain name.
Sourcepub fn set_custom_domain_certificate_arn(self, input: Option<String>) -> Self
pub fn set_custom_domain_certificate_arn(self, input: Option<String>) -> Self
The certificate Amazon Resource Name (ARN) for the custom domain name.
Sourcepub fn get_custom_domain_certificate_arn(&self) -> &Option<String>
pub fn get_custom_domain_certificate_arn(&self) -> &Option<String>
The certificate Amazon Resource Name (ARN) for the custom domain name.
Sourcepub fn custom_domain_certificate_expiry_date(self, input: DateTime) -> Self
pub fn custom_domain_certificate_expiry_date(self, input: DateTime) -> Self
The expiration date for the certificate associated with the custom domain name.
Sourcepub fn set_custom_domain_certificate_expiry_date(
self,
input: Option<DateTime>,
) -> Self
pub fn set_custom_domain_certificate_expiry_date( self, input: Option<DateTime>, ) -> Self
The expiration date for the certificate associated with the custom domain name.
Sourcepub fn get_custom_domain_certificate_expiry_date(&self) -> &Option<DateTime>
pub fn get_custom_domain_certificate_expiry_date(&self) -> &Option<DateTime>
The expiration date for the certificate associated with the custom domain name.
Sourcepub fn master_password_secret_arn(self, input: impl Into<String>) -> Self
pub fn master_password_secret_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
Sourcepub fn set_master_password_secret_arn(self, input: Option<String>) -> Self
pub fn set_master_password_secret_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
Sourcepub fn get_master_password_secret_arn(&self) -> &Option<String>
pub fn get_master_password_secret_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) for the cluster's admin user credentials secret.
Sourcepub fn master_password_secret_kms_key_id(self, input: impl Into<String>) -> Self
pub fn master_password_secret_kms_key_id(self, input: impl Into<String>) -> Self
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
Sourcepub fn set_master_password_secret_kms_key_id(
self,
input: Option<String>,
) -> Self
pub fn set_master_password_secret_kms_key_id( self, input: Option<String>, ) -> Self
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
Sourcepub fn get_master_password_secret_kms_key_id(&self) -> &Option<String>
pub fn get_master_password_secret_kms_key_id(&self) -> &Option<String>
The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.
Sourcepub fn ip_address_type(self, input: impl Into<String>) -> Self
pub fn ip_address_type(self, input: impl Into<String>) -> Self
The IP address type for the cluster. Possible values are ipv4
and dualstack
.
Sourcepub fn set_ip_address_type(self, input: Option<String>) -> Self
pub fn set_ip_address_type(self, input: Option<String>) -> Self
The IP address type for the cluster. Possible values are ipv4
and dualstack
.
Sourcepub fn get_ip_address_type(&self) -> &Option<String>
pub fn get_ip_address_type(&self) -> &Option<String>
The IP address type for the cluster. Possible values are ipv4
and dualstack
.
Sourcepub fn multi_az(self, input: impl Into<String>) -> Self
pub fn multi_az(self, input: impl Into<String>) -> Self
A boolean value that, if true, indicates that the cluster is deployed in two Availability Zones.
Sourcepub fn set_multi_az(self, input: Option<String>) -> Self
pub fn set_multi_az(self, input: Option<String>) -> Self
A boolean value that, if true, indicates that the cluster is deployed in two Availability Zones.
Sourcepub fn get_multi_az(&self) -> &Option<String>
pub fn get_multi_az(&self) -> &Option<String>
A boolean value that, if true, indicates that the cluster is deployed in two Availability Zones.
Sourcepub fn multi_az_secondary(self, input: SecondaryClusterInfo) -> Self
pub fn multi_az_secondary(self, input: SecondaryClusterInfo) -> Self
The secondary compute unit of a cluster, if Multi-AZ deployment is turned on.
Sourcepub fn set_multi_az_secondary(self, input: Option<SecondaryClusterInfo>) -> Self
pub fn set_multi_az_secondary(self, input: Option<SecondaryClusterInfo>) -> Self
The secondary compute unit of a cluster, if Multi-AZ deployment is turned on.
Sourcepub fn get_multi_az_secondary(&self) -> &Option<SecondaryClusterInfo>
pub fn get_multi_az_secondary(&self) -> &Option<SecondaryClusterInfo>
The secondary compute unit of a cluster, if Multi-AZ deployment is turned on.
Trait Implementations§
Source§impl Clone for ClusterBuilder
impl Clone for ClusterBuilder
Source§fn clone(&self) -> ClusterBuilder
fn clone(&self) -> ClusterBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ClusterBuilder
impl Debug for ClusterBuilder
Source§impl Default for ClusterBuilder
impl Default for ClusterBuilder
Source§fn default() -> ClusterBuilder
fn default() -> ClusterBuilder
Source§impl PartialEq for ClusterBuilder
impl PartialEq for ClusterBuilder
impl StructuralPartialEq for ClusterBuilder
Auto Trait Implementations§
impl Freeze for ClusterBuilder
impl RefUnwindSafe for ClusterBuilder
impl Send for ClusterBuilder
impl Sync for ClusterBuilder
impl Unpin for ClusterBuilder
impl UnwindSafe for ClusterBuilder
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);