#[non_exhaustive]pub struct ComputeNodeGroupBuilder { /* private fields */ }
Expand description
A builder for ComputeNodeGroup
.
Implementations§
Source§impl ComputeNodeGroupBuilder
impl ComputeNodeGroupBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name that identifies the compute node group.
This field is required.Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
The name that identifies the compute node group.
Sourcepub fn id(self, input: impl Into<String>) -> Self
pub fn id(self, input: impl Into<String>) -> Self
The generated unique ID of the compute node group.
This field is required.Sourcepub fn set_id(self, input: Option<String>) -> Self
pub fn set_id(self, input: Option<String>) -> Self
The generated unique ID of the compute node group.
Sourcepub fn arn(self, input: impl Into<String>) -> Self
pub fn arn(self, input: impl Into<String>) -> Self
The unique Amazon Resource Name (ARN) of the compute node group.
This field is required.Sourcepub fn set_arn(self, input: Option<String>) -> Self
pub fn set_arn(self, input: Option<String>) -> Self
The unique Amazon Resource Name (ARN) of the compute node group.
Sourcepub fn get_arn(&self) -> &Option<String>
pub fn get_arn(&self) -> &Option<String>
The unique Amazon Resource Name (ARN) of the compute node group.
Sourcepub fn cluster_id(self, input: impl Into<String>) -> Self
pub fn cluster_id(self, input: impl Into<String>) -> Self
The ID of the cluster of the compute node group.
This field is required.Sourcepub fn set_cluster_id(self, input: Option<String>) -> Self
pub fn set_cluster_id(self, input: Option<String>) -> Self
The ID of the cluster of the compute node group.
Sourcepub fn get_cluster_id(&self) -> &Option<String>
pub fn get_cluster_id(&self) -> &Option<String>
The ID of the cluster of the compute node group.
Sourcepub fn created_at(self, input: DateTime) -> Self
pub fn created_at(self, input: DateTime) -> Self
The date and time the resource was created.
This field is required.Sourcepub fn set_created_at(self, input: Option<DateTime>) -> Self
pub fn set_created_at(self, input: Option<DateTime>) -> Self
The date and time the resource was created.
Sourcepub fn get_created_at(&self) -> &Option<DateTime>
pub fn get_created_at(&self) -> &Option<DateTime>
The date and time the resource was created.
Sourcepub fn modified_at(self, input: DateTime) -> Self
pub fn modified_at(self, input: DateTime) -> Self
The date and time the resource was modified.
This field is required.Sourcepub fn set_modified_at(self, input: Option<DateTime>) -> Self
pub fn set_modified_at(self, input: Option<DateTime>) -> Self
The date and time the resource was modified.
Sourcepub fn get_modified_at(&self) -> &Option<DateTime>
pub fn get_modified_at(&self) -> &Option<DateTime>
The date and time the resource was modified.
Sourcepub fn status(self, input: ComputeNodeGroupStatus) -> Self
pub fn status(self, input: ComputeNodeGroupStatus) -> Self
The provisioning status of the compute node group.
The provisioning status doesn't indicate the overall health of the compute node group.
The resource enters the SUSPENDING
and SUSPENDED
states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED
. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.
Sourcepub fn set_status(self, input: Option<ComputeNodeGroupStatus>) -> Self
pub fn set_status(self, input: Option<ComputeNodeGroupStatus>) -> Self
The provisioning status of the compute node group.
The provisioning status doesn't indicate the overall health of the compute node group.
The resource enters the SUSPENDING
and SUSPENDED
states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED
. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.
Sourcepub fn get_status(&self) -> &Option<ComputeNodeGroupStatus>
pub fn get_status(&self) -> &Option<ComputeNodeGroupStatus>
The provisioning status of the compute node group.
The provisioning status doesn't indicate the overall health of the compute node group.
The resource enters the SUSPENDING
and SUSPENDED
states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED
. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.
Sourcepub fn ami_id(self, input: impl Into<String>) -> Self
pub fn ami_id(self, input: impl Into<String>) -> Self
The ID of the Amazon Machine Image (AMI) that PCS uses to launch instances. If not provided, PCS uses the AMI ID specified in the custom launch template.
Sourcepub fn set_ami_id(self, input: Option<String>) -> Self
pub fn set_ami_id(self, input: Option<String>) -> Self
The ID of the Amazon Machine Image (AMI) that PCS uses to launch instances. If not provided, PCS uses the AMI ID specified in the custom launch template.
Sourcepub fn get_ami_id(&self) -> &Option<String>
pub fn get_ami_id(&self) -> &Option<String>
The ID of the Amazon Machine Image (AMI) that PCS uses to launch instances. If not provided, PCS uses the AMI ID specified in the custom launch template.
Sourcepub fn subnet_ids(self, input: impl Into<String>) -> Self
pub fn subnet_ids(self, input: impl Into<String>) -> Self
Appends an item to subnet_ids
.
To override the contents of this collection use set_subnet_ids
.
The list of subnet IDs where instances are provisioned by the compute node group. The subnets must be in the same VPC as the cluster.
Sourcepub fn set_subnet_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_subnet_ids(self, input: Option<Vec<String>>) -> Self
The list of subnet IDs where instances are provisioned by the compute node group. The subnets must be in the same VPC as the cluster.
Sourcepub fn get_subnet_ids(&self) -> &Option<Vec<String>>
pub fn get_subnet_ids(&self) -> &Option<Vec<String>>
The list of subnet IDs where instances are provisioned by the compute node group. The subnets must be in the same VPC as the cluster.
Sourcepub fn purchase_option(self, input: PurchaseOption) -> Self
pub fn purchase_option(self, input: PurchaseOption) -> Self
Specifies how EC2 instances are purchased on your behalf. PCS supports On-Demand Instances, Spot Instances, and Amazon EC2 Capacity Blocks for ML. For more information, see Amazon EC2 billing and purchasing options in the Amazon Elastic Compute Cloud User Guide. For more information about PCS support for Capacity Blocks, see Using Amazon EC2 Capacity Blocks for ML with PCS in the PCS User Guide. If you don't provide this option, it defaults to On-Demand.
Sourcepub fn set_purchase_option(self, input: Option<PurchaseOption>) -> Self
pub fn set_purchase_option(self, input: Option<PurchaseOption>) -> Self
Specifies how EC2 instances are purchased on your behalf. PCS supports On-Demand Instances, Spot Instances, and Amazon EC2 Capacity Blocks for ML. For more information, see Amazon EC2 billing and purchasing options in the Amazon Elastic Compute Cloud User Guide. For more information about PCS support for Capacity Blocks, see Using Amazon EC2 Capacity Blocks for ML with PCS in the PCS User Guide. If you don't provide this option, it defaults to On-Demand.
Sourcepub fn get_purchase_option(&self) -> &Option<PurchaseOption>
pub fn get_purchase_option(&self) -> &Option<PurchaseOption>
Specifies how EC2 instances are purchased on your behalf. PCS supports On-Demand Instances, Spot Instances, and Amazon EC2 Capacity Blocks for ML. For more information, see Amazon EC2 billing and purchasing options in the Amazon Elastic Compute Cloud User Guide. For more information about PCS support for Capacity Blocks, see Using Amazon EC2 Capacity Blocks for ML with PCS in the PCS User Guide. If you don't provide this option, it defaults to On-Demand.
Sourcepub fn custom_launch_template(self, input: CustomLaunchTemplate) -> Self
pub fn custom_launch_template(self, input: CustomLaunchTemplate) -> Self
An Amazon EC2 launch template PCS uses to launch compute nodes.
This field is required.Sourcepub fn set_custom_launch_template(
self,
input: Option<CustomLaunchTemplate>,
) -> Self
pub fn set_custom_launch_template( self, input: Option<CustomLaunchTemplate>, ) -> Self
An Amazon EC2 launch template PCS uses to launch compute nodes.
Sourcepub fn get_custom_launch_template(&self) -> &Option<CustomLaunchTemplate>
pub fn get_custom_launch_template(&self) -> &Option<CustomLaunchTemplate>
An Amazon EC2 launch template PCS uses to launch compute nodes.
Sourcepub fn iam_instance_profile_arn(self, input: impl Into<String>) -> Self
pub fn iam_instance_profile_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have the pcs:RegisterComputeNodeGroupInstance
permission and the role name must start with AWSPCS
or must have the path /aws-pcs/
. For more information, see IAM instance profiles for PCS in the PCS User Guide.
Sourcepub fn set_iam_instance_profile_arn(self, input: Option<String>) -> Self
pub fn set_iam_instance_profile_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have the pcs:RegisterComputeNodeGroupInstance
permission and the role name must start with AWSPCS
or must have the path /aws-pcs/
. For more information, see IAM instance profiles for PCS in the PCS User Guide.
Sourcepub fn get_iam_instance_profile_arn(&self) -> &Option<String>
pub fn get_iam_instance_profile_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have the pcs:RegisterComputeNodeGroupInstance
permission and the role name must start with AWSPCS
or must have the path /aws-pcs/
. For more information, see IAM instance profiles for PCS in the PCS User Guide.
Sourcepub fn scaling_configuration(self, input: ScalingConfiguration) -> Self
pub fn scaling_configuration(self, input: ScalingConfiguration) -> Self
Specifies the boundaries of the compute node group auto scaling.
This field is required.Sourcepub fn set_scaling_configuration(
self,
input: Option<ScalingConfiguration>,
) -> Self
pub fn set_scaling_configuration( self, input: Option<ScalingConfiguration>, ) -> Self
Specifies the boundaries of the compute node group auto scaling.
Sourcepub fn get_scaling_configuration(&self) -> &Option<ScalingConfiguration>
pub fn get_scaling_configuration(&self) -> &Option<ScalingConfiguration>
Specifies the boundaries of the compute node group auto scaling.
Sourcepub fn instance_configs(self, input: InstanceConfig) -> Self
pub fn instance_configs(self, input: InstanceConfig) -> Self
Appends an item to instance_configs
.
To override the contents of this collection use set_instance_configs
.
A list of EC2 instance configurations that PCS can provision in the compute node group.
Sourcepub fn set_instance_configs(self, input: Option<Vec<InstanceConfig>>) -> Self
pub fn set_instance_configs(self, input: Option<Vec<InstanceConfig>>) -> Self
A list of EC2 instance configurations that PCS can provision in the compute node group.
Sourcepub fn get_instance_configs(&self) -> &Option<Vec<InstanceConfig>>
pub fn get_instance_configs(&self) -> &Option<Vec<InstanceConfig>>
A list of EC2 instance configurations that PCS can provision in the compute node group.
Sourcepub fn spot_options(self, input: SpotOptions) -> Self
pub fn spot_options(self, input: SpotOptions) -> Self
Additional configuration when you specify SPOT
as the purchaseOption
for the CreateComputeNodeGroup
API action.
Sourcepub fn set_spot_options(self, input: Option<SpotOptions>) -> Self
pub fn set_spot_options(self, input: Option<SpotOptions>) -> Self
Additional configuration when you specify SPOT
as the purchaseOption
for the CreateComputeNodeGroup
API action.
Sourcepub fn get_spot_options(&self) -> &Option<SpotOptions>
pub fn get_spot_options(&self) -> &Option<SpotOptions>
Additional configuration when you specify SPOT
as the purchaseOption
for the CreateComputeNodeGroup
API action.
Sourcepub fn slurm_configuration(
self,
input: ComputeNodeGroupSlurmConfiguration,
) -> Self
pub fn slurm_configuration( self, input: ComputeNodeGroupSlurmConfiguration, ) -> Self
Additional options related to the Slurm scheduler.
Sourcepub fn set_slurm_configuration(
self,
input: Option<ComputeNodeGroupSlurmConfiguration>,
) -> Self
pub fn set_slurm_configuration( self, input: Option<ComputeNodeGroupSlurmConfiguration>, ) -> Self
Additional options related to the Slurm scheduler.
Sourcepub fn get_slurm_configuration(
&self,
) -> &Option<ComputeNodeGroupSlurmConfiguration>
pub fn get_slurm_configuration( &self, ) -> &Option<ComputeNodeGroupSlurmConfiguration>
Additional options related to the Slurm scheduler.
Sourcepub fn error_info(self, input: ErrorInfo) -> Self
pub fn error_info(self, input: ErrorInfo) -> Self
Appends an item to error_info
.
To override the contents of this collection use set_error_info
.
The list of errors that occurred during compute node group provisioning.
Sourcepub fn set_error_info(self, input: Option<Vec<ErrorInfo>>) -> Self
pub fn set_error_info(self, input: Option<Vec<ErrorInfo>>) -> Self
The list of errors that occurred during compute node group provisioning.
Sourcepub fn get_error_info(&self) -> &Option<Vec<ErrorInfo>>
pub fn get_error_info(&self) -> &Option<Vec<ErrorInfo>>
The list of errors that occurred during compute node group provisioning.
Sourcepub fn build(self) -> Result<ComputeNodeGroup, BuildError>
pub fn build(self) -> Result<ComputeNodeGroup, BuildError>
Consumes the builder and constructs a ComputeNodeGroup
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for ComputeNodeGroupBuilder
impl Clone for ComputeNodeGroupBuilder
Source§fn clone(&self) -> ComputeNodeGroupBuilder
fn clone(&self) -> ComputeNodeGroupBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ComputeNodeGroupBuilder
impl Debug for ComputeNodeGroupBuilder
Source§impl Default for ComputeNodeGroupBuilder
impl Default for ComputeNodeGroupBuilder
Source§fn default() -> ComputeNodeGroupBuilder
fn default() -> ComputeNodeGroupBuilder
Source§impl PartialEq for ComputeNodeGroupBuilder
impl PartialEq for ComputeNodeGroupBuilder
impl StructuralPartialEq for ComputeNodeGroupBuilder
Auto Trait Implementations§
impl Freeze for ComputeNodeGroupBuilder
impl RefUnwindSafe for ComputeNodeGroupBuilder
impl Send for ComputeNodeGroupBuilder
impl Sync for ComputeNodeGroupBuilder
impl Unpin for ComputeNodeGroupBuilder
impl UnwindSafe for ComputeNodeGroupBuilder
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);