#[non_exhaustive]pub struct CreateClusterInputBuilder { /* private fields */ }
Expand description
A builder for CreateClusterInput
.
Implementations§
Source§impl CreateClusterInputBuilder
impl CreateClusterInputBuilder
Sourcepub fn db_name(self, input: impl Into<String>) -> Self
pub fn db_name(self, input: impl Into<String>) -> Self
The name of the first database to be created when the cluster is created.
To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.
Default: dev
Constraints:
-
Must contain 1 to 64 alphanumeric characters.
-
Must contain only lowercase letters.
-
Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
Sourcepub fn set_db_name(self, input: Option<String>) -> Self
pub fn set_db_name(self, input: Option<String>) -> Self
The name of the first database to be created when the cluster is created.
To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.
Default: dev
Constraints:
-
Must contain 1 to 64 alphanumeric characters.
-
Must contain only lowercase letters.
-
Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
Sourcepub fn get_db_name(&self) -> &Option<String>
pub fn get_db_name(&self) -> &Option<String>
The name of the first database to be created when the cluster is created.
To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.
Default: dev
Constraints:
-
Must contain 1 to 64 alphanumeric characters.
-
Must contain only lowercase letters.
-
Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
Sourcepub fn cluster_identifier(self, input: impl Into<String>) -> Self
pub fn cluster_identifier(self, input: impl Into<String>) -> Self
A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.
Constraints:
-
Must contain from 1 to 63 alphanumeric characters or hyphens.
-
Alphabetic characters must be lowercase.
-
First character must be a letter.
-
Cannot end with a hyphen or contain two consecutive hyphens.
-
Must be unique for all clusters within an Amazon Web Services account.
Example: myexamplecluster
Sourcepub fn set_cluster_identifier(self, input: Option<String>) -> Self
pub fn set_cluster_identifier(self, input: Option<String>) -> Self
A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.
Constraints:
-
Must contain from 1 to 63 alphanumeric characters or hyphens.
-
Alphabetic characters must be lowercase.
-
First character must be a letter.
-
Cannot end with a hyphen or contain two consecutive hyphens.
-
Must be unique for all clusters within an Amazon Web Services account.
Example: myexamplecluster
Sourcepub fn get_cluster_identifier(&self) -> &Option<String>
pub fn get_cluster_identifier(&self) -> &Option<String>
A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.
Constraints:
-
Must contain from 1 to 63 alphanumeric characters or hyphens.
-
Alphabetic characters must be lowercase.
-
First character must be a letter.
-
Cannot end with a hyphen or contain two consecutive hyphens.
-
Must be unique for all clusters within an Amazon Web Services account.
Example: myexamplecluster
Sourcepub fn cluster_type(self, input: impl Into<String>) -> Self
pub fn cluster_type(self, input: impl Into<String>) -> Self
The type of the cluster. When cluster type is specified as
-
single-node
, the NumberOfNodes parameter is not required. -
multi-node
, the NumberOfNodes parameter is required.
Valid Values: multi-node
| single-node
Default: multi-node
Sourcepub fn set_cluster_type(self, input: Option<String>) -> Self
pub fn set_cluster_type(self, input: Option<String>) -> Self
The type of the cluster. When cluster type is specified as
-
single-node
, the NumberOfNodes parameter is not required. -
multi-node
, the NumberOfNodes parameter is required.
Valid Values: multi-node
| single-node
Default: multi-node
Sourcepub fn get_cluster_type(&self) -> &Option<String>
pub fn get_cluster_type(&self) -> &Option<String>
The type of the cluster. When cluster type is specified as
-
single-node
, the NumberOfNodes parameter is not required. -
multi-node
, the NumberOfNodes parameter is required.
Valid Values: multi-node
| single-node
Default: multi-node
Sourcepub fn node_type(self, input: impl Into<String>) -> Self
pub fn node_type(self, input: impl Into<String>) -> Self
The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
Valid Values: dc2.large
| dc2.8xlarge
| ra3.large
| ra3.xlplus
| ra3.4xlarge
| ra3.16xlarge
Sourcepub fn set_node_type(self, input: Option<String>) -> Self
pub fn set_node_type(self, input: Option<String>) -> Self
The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
Valid Values: dc2.large
| dc2.8xlarge
| ra3.large
| ra3.xlplus
| ra3.4xlarge
| ra3.16xlarge
Sourcepub fn get_node_type(&self) -> &Option<String>
pub fn get_node_type(&self) -> &Option<String>
The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
Valid Values: dc2.large
| dc2.8xlarge
| ra3.large
| ra3.xlplus
| ra3.4xlarge
| ra3.16xlarge
Sourcepub fn master_username(self, input: impl Into<String>) -> Self
pub fn master_username(self, input: impl Into<String>) -> Self
The user name associated with the admin user account for the cluster that is being created.
Constraints:
-
Must be 1 - 128 alphanumeric characters or hyphens. The user name can't be
PUBLIC
. -
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
-
The first character must be a letter.
-
Must not contain a colon (:) or a slash (/).
-
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
Sourcepub fn set_master_username(self, input: Option<String>) -> Self
pub fn set_master_username(self, input: Option<String>) -> Self
The user name associated with the admin user account for the cluster that is being created.
Constraints:
-
Must be 1 - 128 alphanumeric characters or hyphens. The user name can't be
PUBLIC
. -
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
-
The first character must be a letter.
-
Must not contain a colon (:) or a slash (/).
-
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
Sourcepub fn get_master_username(&self) -> &Option<String>
pub fn get_master_username(&self) -> &Option<String>
The user name associated with the admin user account for the cluster that is being created.
Constraints:
-
Must be 1 - 128 alphanumeric characters or hyphens. The user name can't be
PUBLIC
. -
Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.
-
The first character must be a letter.
-
Must not contain a colon (:) or a slash (/).
-
Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
Sourcepub fn master_user_password(self, input: impl Into<String>) -> Self
pub fn master_user_password(self, input: impl Into<String>) -> Self
The password associated with the admin user account for the cluster that is being created.
You can't use MasterUserPassword
if ManageMasterPassword
is true
.
Constraints:
-
Must be between 8 and 64 characters in length.
-
Must contain at least one uppercase letter.
-
Must contain at least one lowercase letter.
-
Must contain one number.
-
Can be any printable ASCII character (ASCII code 33-126) except
'
(single quote),"
(double quote),\
,/
, or@
.
Sourcepub fn set_master_user_password(self, input: Option<String>) -> Self
pub fn set_master_user_password(self, input: Option<String>) -> Self
The password associated with the admin user account for the cluster that is being created.
You can't use MasterUserPassword
if ManageMasterPassword
is true
.
Constraints:
-
Must be between 8 and 64 characters in length.
-
Must contain at least one uppercase letter.
-
Must contain at least one lowercase letter.
-
Must contain one number.
-
Can be any printable ASCII character (ASCII code 33-126) except
'
(single quote),"
(double quote),\
,/
, or@
.
Sourcepub fn get_master_user_password(&self) -> &Option<String>
pub fn get_master_user_password(&self) -> &Option<String>
The password associated with the admin user account for the cluster that is being created.
You can't use MasterUserPassword
if ManageMasterPassword
is true
.
Constraints:
-
Must be between 8 and 64 characters in length.
-
Must contain at least one uppercase letter.
-
Must contain at least one lowercase letter.
-
Must contain one number.
-
Can be any printable ASCII character (ASCII code 33-126) except
'
(single quote),"
(double quote),\
,/
, or@
.
Sourcepub fn cluster_security_groups(self, input: impl Into<String>) -> Self
pub fn cluster_security_groups(self, input: impl Into<String>) -> Self
Appends an item to cluster_security_groups
.
To override the contents of this collection use set_cluster_security_groups
.
A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
Sourcepub fn set_cluster_security_groups(self, input: Option<Vec<String>>) -> Self
pub fn set_cluster_security_groups(self, input: Option<Vec<String>>) -> Self
A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
Sourcepub fn get_cluster_security_groups(&self) -> &Option<Vec<String>>
pub fn get_cluster_security_groups(&self) -> &Option<Vec<String>>
A list of security groups to be associated with this cluster.
Default: The default cluster security group for Amazon Redshift.
Sourcepub fn vpc_security_group_ids(self, input: impl Into<String>) -> Self
pub fn vpc_security_group_ids(self, input: impl Into<String>) -> Self
Appends an item to vpc_security_group_ids
.
To override the contents of this collection use set_vpc_security_group_ids
.
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
Default: The default VPC security group is associated with the cluster.
Sourcepub fn set_vpc_security_group_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_vpc_security_group_ids(self, input: Option<Vec<String>>) -> Self
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
Default: The default VPC security group is associated with the cluster.
Sourcepub fn get_vpc_security_group_ids(&self) -> &Option<Vec<String>>
pub fn get_vpc_security_group_ids(&self) -> &Option<Vec<String>>
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
Default: The default VPC security group is associated with the cluster.
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 a cluster subnet group to be associated with this cluster.
If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (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 a cluster subnet group to be associated with this cluster.
If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
Sourcepub fn get_cluster_subnet_group_name(&self) -> &Option<String>
pub fn get_cluster_subnet_group_name(&self) -> &Option<String>
The name of a cluster subnet group to be associated with this cluster.
If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
Sourcepub fn availability_zone(self, input: impl Into<String>) -> Self
pub fn availability_zone(self, input: impl Into<String>) -> Self
The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.
Example: us-east-2d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
Sourcepub fn set_availability_zone(self, input: Option<String>) -> Self
pub fn set_availability_zone(self, input: Option<String>) -> Self
The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.
Example: us-east-2d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
Sourcepub fn get_availability_zone(&self) -> &Option<String>
pub fn get_availability_zone(&self) -> &Option<String>
The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.
Example: us-east-2d
Constraint: The specified Availability Zone must be in the same region as the current endpoint.
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 UTC) during which automated cluster maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
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 UTC) during which automated cluster maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
Sourcepub fn get_preferred_maintenance_window(&self) -> &Option<String>
pub fn get_preferred_maintenance_window(&self) -> &Option<String>
The weekly time range (in UTC) during which automated cluster maintenance can occur.
Format: ddd:hh24:mi-ddd:hh24:mi
Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.
Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun
Constraints: Minimum 30-minute window.
Sourcepub fn cluster_parameter_group_name(self, input: impl Into<String>) -> Self
pub fn cluster_parameter_group_name(self, input: impl Into<String>) -> Self
The name of the parameter group to be associated with this cluster.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
-
Must be 1 to 255 alphanumeric characters or hyphens.
-
First character must be a letter.
-
Cannot end with a hyphen or contain two consecutive hyphens.
Sourcepub fn set_cluster_parameter_group_name(self, input: Option<String>) -> Self
pub fn set_cluster_parameter_group_name(self, input: Option<String>) -> Self
The name of the parameter group to be associated with this cluster.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
-
Must be 1 to 255 alphanumeric characters or hyphens.
-
First character must be a letter.
-
Cannot end with a hyphen or contain two consecutive hyphens.
Sourcepub fn get_cluster_parameter_group_name(&self) -> &Option<String>
pub fn get_cluster_parameter_group_name(&self) -> &Option<String>
The name of the parameter group to be associated with this cluster.
Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups
Constraints:
-
Must be 1 to 255 alphanumeric characters or hyphens.
-
First character must be a letter.
-
Cannot end with a hyphen or contain two consecutive hyphens.
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 automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot
.
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
Default: 1
Constraints: Must be a value from 0 to 35.
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 automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot
.
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
Default: 1
Constraints: Must be a value from 0 to 35.
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 automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with CreateClusterSnapshot
.
You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.
Default: 1
Constraints: Must be a value from 0 to 35.
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 port(self, input: i32) -> Self
pub fn port(self, input: i32) -> Self
The port number on which the cluster accepts incoming connections.
The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.
Default: 5439
Valid Values:
-
For clusters with ra3 nodes - Select a port within the ranges
5431-5455
or8191-8215
. (If you have an existing cluster with ra3 nodes, it isn't required that you change the port to these ranges.) -
For clusters with dc2 nodes - Select a port within the range
1150-65535
.
Sourcepub fn set_port(self, input: Option<i32>) -> Self
pub fn set_port(self, input: Option<i32>) -> Self
The port number on which the cluster accepts incoming connections.
The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.
Default: 5439
Valid Values:
-
For clusters with ra3 nodes - Select a port within the ranges
5431-5455
or8191-8215
. (If you have an existing cluster with ra3 nodes, it isn't required that you change the port to these ranges.) -
For clusters with dc2 nodes - Select a port within the range
1150-65535
.
Sourcepub fn get_port(&self) -> &Option<i32>
pub fn get_port(&self) -> &Option<i32>
The port number on which the cluster accepts incoming connections.
The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections.
Default: 5439
Valid Values:
-
For clusters with ra3 nodes - Select a port within the ranges
5431-5455
or8191-8215
. (If you have an existing cluster with ra3 nodes, it isn't required that you change the port to these ranges.) -
For clusters with dc2 nodes - Select a port within the range
1150-65535
.
Sourcepub fn cluster_version(self, input: impl Into<String>) -> Self
pub fn cluster_version(self, input: impl Into<String>) -> Self
The version of the Amazon Redshift engine software that you want to deploy on the cluster.
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
Sourcepub fn set_cluster_version(self, input: Option<String>) -> Self
pub fn set_cluster_version(self, input: Option<String>) -> Self
The version of the Amazon Redshift engine software that you want to deploy on the cluster.
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
Sourcepub fn get_cluster_version(&self) -> &Option<String>
pub fn get_cluster_version(&self) -> &Option<String>
The version of the Amazon Redshift engine software that you want to deploy on the cluster.
The version selected runs on all the nodes in the cluster.
Constraints: Only version 1.0 is currently available.
Example: 1.0
Sourcepub fn allow_version_upgrade(self, input: bool) -> Self
pub fn allow_version_upgrade(self, input: bool) -> Self
If true
, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.
Default: true
Sourcepub fn set_allow_version_upgrade(self, input: Option<bool>) -> Self
pub fn set_allow_version_upgrade(self, input: Option<bool>) -> Self
If true
, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.
Default: true
Sourcepub fn get_allow_version_upgrade(&self) -> &Option<bool>
pub fn get_allow_version_upgrade(&self) -> &Option<bool>
If true
, major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.
When a new major version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.
Default: true
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. This parameter is required when the ClusterType parameter is specified as multi-node
.
For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.
Default: 1
Constraints: Value must be at least 1 and no more than 100.
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. This parameter is required when the ClusterType parameter is specified as multi-node
.
For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.
Default: 1
Constraints: Value must be at least 1 and no more than 100.
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. This parameter is required when the ClusterType parameter is specified as multi-node
.
For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster Management Guide.
If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.
Default: 1
Constraints: Value must be at least 1 and no more than 100.
Sourcepub fn publicly_accessible(self, input: bool) -> Self
pub fn publicly_accessible(self, input: bool) -> Self
If true
, 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
If true
, 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>
If true
, 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
If true
, the data in the cluster is encrypted at rest. If you set the value on this parameter to false
, the request will fail.
Default: true
Sourcepub fn set_encrypted(self, input: Option<bool>) -> Self
pub fn set_encrypted(self, input: Option<bool>) -> Self
If true
, the data in the cluster is encrypted at rest. If you set the value on this parameter to false
, the request will fail.
Default: true
Sourcepub fn get_encrypted(&self) -> &Option<bool>
pub fn get_encrypted(&self) -> &Option<bool>
If true
, the data in the cluster is encrypted at rest. If you set the value on this parameter to false
, the request will fail.
Default: true
Sourcepub fn hsm_client_certificate_identifier(self, input: impl Into<String>) -> Self
pub fn hsm_client_certificate_identifier(self, input: impl Into<String>) -> Self
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
Sourcepub fn set_hsm_client_certificate_identifier(
self,
input: Option<String>,
) -> Self
pub fn set_hsm_client_certificate_identifier( self, input: Option<String>, ) -> Self
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
Sourcepub fn get_hsm_client_certificate_identifier(&self) -> &Option<String>
pub fn get_hsm_client_certificate_identifier(&self) -> &Option<String>
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
Sourcepub fn hsm_configuration_identifier(self, input: impl Into<String>) -> Self
pub fn hsm_configuration_identifier(self, input: impl Into<String>) -> Self
Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
Sourcepub fn set_hsm_configuration_identifier(self, input: Option<String>) -> Self
pub fn set_hsm_configuration_identifier(self, input: Option<String>) -> Self
Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
Sourcepub fn get_hsm_configuration_identifier(&self) -> &Option<String>
pub fn get_hsm_configuration_identifier(&self) -> &Option<String>
Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
Sourcepub fn elastic_ip(self, input: impl Into<String>) -> Self
pub fn elastic_ip(self, input: impl Into<String>) -> Self
The Elastic IP (EIP) address for the cluster.
Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
Sourcepub fn set_elastic_ip(self, input: Option<String>) -> Self
pub fn set_elastic_ip(self, input: Option<String>) -> Self
The Elastic IP (EIP) address for the cluster.
Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
Sourcepub fn get_elastic_ip(&self) -> &Option<String>
pub fn get_elastic_ip(&self) -> &Option<String>
The Elastic IP (EIP) address for the cluster.
Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
A list of tag instances.
A list of tag instances.
A list of tag instances.
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 that you want to use 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 that you want to use 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 that you want to use 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 additional_info(self, input: impl Into<String>) -> Self
pub fn additional_info(self, input: impl Into<String>) -> Self
Reserved.
Sourcepub fn set_additional_info(self, input: Option<String>) -> Self
pub fn set_additional_info(self, input: Option<String>) -> Self
Reserved.
Sourcepub fn get_additional_info(&self) -> &Option<String>
pub fn get_additional_info(&self) -> &Option<String>
Reserved.
Sourcepub fn iam_roles(self, input: impl Into<String>) -> Self
pub fn iam_roles(self, input: impl Into<String>) -> 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. You must supply the IAM roles in their Amazon Resource Name (ARN) format.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.
Sourcepub fn set_iam_roles(self, input: Option<Vec<String>>) -> Self
pub fn set_iam_roles(self, input: Option<Vec<String>>) -> Self
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.
Sourcepub fn get_iam_roles(&self) -> &Option<Vec<String>>
pub fn get_iam_roles(&self) -> &Option<Vec<String>>
A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.
The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.
Sourcepub fn maintenance_track_name(self, input: impl Into<String>) -> Self
pub fn maintenance_track_name(self, input: impl Into<String>) -> Self
An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current
track.
Sourcepub fn set_maintenance_track_name(self, input: Option<String>) -> Self
pub fn set_maintenance_track_name(self, input: Option<String>) -> Self
An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current
track.
Sourcepub fn get_maintenance_track_name(&self) -> &Option<String>
pub fn get_maintenance_track_name(&self) -> &Option<String>
An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current
track.
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 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 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 snapshot schedule.
Sourcepub fn availability_zone_relocation(self, input: bool) -> Self
pub fn availability_zone_relocation(self, input: bool) -> Self
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
Sourcepub fn set_availability_zone_relocation(self, input: Option<bool>) -> Self
pub fn set_availability_zone_relocation(self, input: Option<bool>) -> Self
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
Sourcepub fn get_availability_zone_relocation(&self) -> &Option<bool>
pub fn get_availability_zone_relocation(&self) -> &Option<bool>
The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.
Sourcepub fn aqua_configuration_status(self, input: AquaConfigurationStatus) -> Self
pub fn aqua_configuration_status(self, input: AquaConfigurationStatus) -> Self
This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
Sourcepub fn set_aqua_configuration_status(
self,
input: Option<AquaConfigurationStatus>,
) -> Self
pub fn set_aqua_configuration_status( self, input: Option<AquaConfigurationStatus>, ) -> Self
This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).
Sourcepub fn get_aqua_configuration_status(&self) -> &Option<AquaConfigurationStatus>
pub fn get_aqua_configuration_status(&self) -> &Option<AquaConfigurationStatus>
This parameter is retired. It does not set the AQUA configuration status. 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 that was set as default for the cluster when the cluster was created.
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 that was set as default for the cluster when the cluster was created.
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 that was set as default for the cluster when the cluster was created.
Sourcepub fn load_sample_data(self, input: impl Into<String>) -> Self
pub fn load_sample_data(self, input: impl Into<String>) -> Self
A flag that specifies whether to load sample data once the cluster is created.
Sourcepub fn set_load_sample_data(self, input: Option<String>) -> Self
pub fn set_load_sample_data(self, input: Option<String>) -> Self
A flag that specifies whether to load sample data once the cluster is created.
Sourcepub fn get_load_sample_data(&self) -> &Option<String>
pub fn get_load_sample_data(&self) -> &Option<String>
A flag that specifies whether to load sample data once the cluster is created.
Sourcepub fn manage_master_password(self, input: bool) -> Self
pub fn manage_master_password(self, input: bool) -> Self
If true
, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You can't use MasterUserPassword
if ManageMasterPassword
is true. If ManageMasterPassword
is false or not set, Amazon Redshift uses MasterUserPassword
for the admin user account's password.
Sourcepub fn set_manage_master_password(self, input: Option<bool>) -> Self
pub fn set_manage_master_password(self, input: Option<bool>) -> Self
If true
, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You can't use MasterUserPassword
if ManageMasterPassword
is true. If ManageMasterPassword
is false or not set, Amazon Redshift uses MasterUserPassword
for the admin user account's password.
Sourcepub fn get_manage_master_password(&self) -> &Option<bool>
pub fn get_manage_master_password(&self) -> &Option<bool>
If true
, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You can't use MasterUserPassword
if ManageMasterPassword
is true. If ManageMasterPassword
is false or not set, Amazon Redshift uses MasterUserPassword
for the admin user account's password.
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. You can only use this parameter if ManageMasterPassword
is true.
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. You can only use this parameter if ManageMasterPassword
is true.
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. You can only use this parameter if ManageMasterPassword
is true.
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 types that the cluster supports. 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 types that the cluster supports. 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 types that the cluster supports. Possible values are ipv4
and dualstack
.
Sourcepub fn multi_az(self, input: bool) -> Self
pub fn multi_az(self, input: bool) -> Self
If true, Amazon Redshift will deploy the cluster in two Availability Zones (AZ).
Sourcepub fn set_multi_az(self, input: Option<bool>) -> Self
pub fn set_multi_az(self, input: Option<bool>) -> Self
If true, Amazon Redshift will deploy the cluster in two Availability Zones (AZ).
Sourcepub fn get_multi_az(&self) -> &Option<bool>
pub fn get_multi_az(&self) -> &Option<bool>
If true, Amazon Redshift will deploy the cluster in two Availability Zones (AZ).
Sourcepub fn redshift_idc_application_arn(self, input: impl Into<String>) -> Self
pub fn redshift_idc_application_arn(self, input: impl Into<String>) -> Self
The Amazon resource name (ARN) of the Amazon Redshift IAM Identity Center application.
Sourcepub fn set_redshift_idc_application_arn(self, input: Option<String>) -> Self
pub fn set_redshift_idc_application_arn(self, input: Option<String>) -> Self
The Amazon resource name (ARN) of the Amazon Redshift IAM Identity Center application.
Sourcepub fn get_redshift_idc_application_arn(&self) -> &Option<String>
pub fn get_redshift_idc_application_arn(&self) -> &Option<String>
The Amazon resource name (ARN) of the Amazon Redshift IAM Identity Center application.
Sourcepub fn build(self) -> Result<CreateClusterInput, BuildError>
pub fn build(self) -> Result<CreateClusterInput, BuildError>
Consumes the builder and constructs a CreateClusterInput
.
Source§impl CreateClusterInputBuilder
impl CreateClusterInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<CreateClusterOutput, SdkError<CreateClusterError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<CreateClusterOutput, SdkError<CreateClusterError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for CreateClusterInputBuilder
impl Clone for CreateClusterInputBuilder
Source§fn clone(&self) -> CreateClusterInputBuilder
fn clone(&self) -> CreateClusterInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateClusterInputBuilder
impl Debug for CreateClusterInputBuilder
Source§impl Default for CreateClusterInputBuilder
impl Default for CreateClusterInputBuilder
Source§fn default() -> CreateClusterInputBuilder
fn default() -> CreateClusterInputBuilder
impl StructuralPartialEq for CreateClusterInputBuilder
Auto Trait Implementations§
impl Freeze for CreateClusterInputBuilder
impl RefUnwindSafe for CreateClusterInputBuilder
impl Send for CreateClusterInputBuilder
impl Sync for CreateClusterInputBuilder
impl Unpin for CreateClusterInputBuilder
impl UnwindSafe for CreateClusterInputBuilder
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);