#[non_exhaustive]pub struct ComputeNodeGroup {Show 17 fields
pub name: String,
pub id: String,
pub arn: String,
pub cluster_id: String,
pub created_at: DateTime,
pub modified_at: DateTime,
pub status: ComputeNodeGroupStatus,
pub ami_id: Option<String>,
pub subnet_ids: Vec<String>,
pub purchase_option: Option<PurchaseOption>,
pub custom_launch_template: Option<CustomLaunchTemplate>,
pub iam_instance_profile_arn: String,
pub scaling_configuration: Option<ScalingConfiguration>,
pub instance_configs: Vec<InstanceConfig>,
pub spot_options: Option<SpotOptions>,
pub slurm_configuration: Option<ComputeNodeGroupSlurmConfiguration>,
pub error_info: Option<Vec<ErrorInfo>>,
}Expand description
A compute node group associated with a cluster.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.name: StringThe name that identifies the compute node group.
id: StringThe generated unique ID of the compute node group.
arn: StringThe unique Amazon Resource Name (ARN) of the compute node group.
cluster_id: StringThe ID of the cluster of the compute node group.
created_at: DateTimeThe date and time the resource was created.
modified_at: DateTimeThe date and time the resource was modified.
status: ComputeNodeGroupStatusThe 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.
ami_id: 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.
subnet_ids: 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.
purchase_option: 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.
custom_launch_template: Option<CustomLaunchTemplate>An Amazon EC2 launch template PCS uses to launch compute nodes.
iam_instance_profile_arn: StringThe 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.
scaling_configuration: Option<ScalingConfiguration>Specifies the boundaries of the compute node group auto scaling.
instance_configs: Vec<InstanceConfig>A list of EC2 instance configurations that PCS can provision in the compute node group.
spot_options: Option<SpotOptions>Additional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action.
slurm_configuration: Option<ComputeNodeGroupSlurmConfiguration>Additional options related to the Slurm scheduler.
error_info: Option<Vec<ErrorInfo>>The list of errors that occurred during compute node group provisioning.
Implementations§
Source§impl ComputeNodeGroup
impl ComputeNodeGroup
Sourcepub fn cluster_id(&self) -> &str
pub fn cluster_id(&self) -> &str
The ID of the cluster of the compute node group.
Sourcepub fn created_at(&self) -> &DateTime
pub fn created_at(&self) -> &DateTime
The date and time the resource was created.
Sourcepub fn modified_at(&self) -> &DateTime
pub fn modified_at(&self) -> &DateTime
The date and time the resource was modified.
Sourcepub fn status(&self) -> &ComputeNodeGroupStatus
pub fn status(&self) -> &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) -> Option<&str>
pub fn ami_id(&self) -> Option<&str>
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) -> &[String]
pub fn subnet_ids(&self) -> &[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) -> Option<&PurchaseOption>
pub fn 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) -> Option<&CustomLaunchTemplate>
pub fn custom_launch_template(&self) -> Option<&CustomLaunchTemplate>
An Amazon EC2 launch template PCS uses to launch compute nodes.
Sourcepub fn iam_instance_profile_arn(&self) -> &str
pub fn iam_instance_profile_arn(&self) -> &str
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) -> Option<&ScalingConfiguration>
pub fn scaling_configuration(&self) -> Option<&ScalingConfiguration>
Specifies the boundaries of the compute node group auto scaling.
Sourcepub fn instance_configs(&self) -> &[InstanceConfig]
pub fn instance_configs(&self) -> &[InstanceConfig]
A list of EC2 instance configurations that PCS can provision in the compute node group.
Sourcepub fn spot_options(&self) -> Option<&SpotOptions>
pub fn spot_options(&self) -> Option<&SpotOptions>
Additional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action.
Sourcepub fn slurm_configuration(&self) -> Option<&ComputeNodeGroupSlurmConfiguration>
pub fn slurm_configuration(&self) -> Option<&ComputeNodeGroupSlurmConfiguration>
Additional options related to the Slurm scheduler.
Sourcepub fn error_info(&self) -> &[ErrorInfo]
pub fn error_info(&self) -> &[ErrorInfo]
The list of errors that occurred during compute node group provisioning.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .error_info.is_none().
Source§impl ComputeNodeGroup
impl ComputeNodeGroup
Sourcepub fn builder() -> ComputeNodeGroupBuilder
pub fn builder() -> ComputeNodeGroupBuilder
Creates a new builder-style object to manufacture ComputeNodeGroup.
Trait Implementations§
Source§impl Clone for ComputeNodeGroup
impl Clone for ComputeNodeGroup
Source§fn clone(&self) -> ComputeNodeGroup
fn clone(&self) -> ComputeNodeGroup
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ComputeNodeGroup
impl Debug for ComputeNodeGroup
Source§impl PartialEq for ComputeNodeGroup
impl PartialEq for ComputeNodeGroup
impl StructuralPartialEq for ComputeNodeGroup
Auto Trait Implementations§
impl Freeze for ComputeNodeGroup
impl RefUnwindSafe for ComputeNodeGroup
impl Send for ComputeNodeGroup
impl Sync for ComputeNodeGroup
impl Unpin for ComputeNodeGroup
impl UnwindSafe for ComputeNodeGroup
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);