Class: Aws::PCS::Types::ComputeNodeGroup

Inherits:

Struct

Object
Struct
Aws::PCS::Types::ComputeNodeGroup

show all

Defined in:: gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb

Overview

A compute node group associated with a cluster.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#ami_id ⇒ String
The ID of the Amazon Machine Image (AMI) that PCS uses to launch instances.
#arn ⇒ String
The unique Amazon Resource Name (ARN) of the compute node group.
#cluster_id ⇒ String
The ID of the cluster of the compute node group.
#created_at ⇒ Time
The date and time the resource was created.
#custom_launch_template ⇒ Types::CustomLaunchTemplate
The custom Amazon EC2 launch template associated with the compute node group.
#error_info ⇒ Array<Types::ErrorInfo>
The list of errors that occurred during compute node group provisioning.
#iam_instance_profile_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances.
#id ⇒ String
The generated unique ID of the compute node group.
#instance_configs ⇒ Array<Types::InstanceConfig>
A list of EC2 instance configurations that PCS can provision in the compute node group.
#launch_template_mode ⇒ String
Indicates whether the compute node group uses a custom launch template or a launch template that PCS manages.
#modified_at ⇒ Time
The date and time the resource was modified.
#name ⇒ String
The name that identifies the compute node group.
#node_lifecycle_actions ⇒ Types::NodeLifecycleActions
The lifecycle actions to run on compute nodes in the compute node group.
#purchase_option ⇒ String
Specifies how EC2 instances are purchased on your behalf.
#scaling_configuration ⇒ Types::ScalingConfiguration
Specifies the boundaries of the compute node group auto scaling.
#security_group_ids ⇒ Array<String>
The IDs of the EC2 security groups configured directly on the compute node group.
#slurm_configuration ⇒ Types::ComputeNodeGroupSlurmConfiguration
Additional options related to the Slurm scheduler.
#spot_options ⇒ Types::SpotOptions
Additional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action.
#ssh_key_name ⇒ String
The name of the EC2 key pair configured directly on the compute node group.
#status ⇒ String
The provisioning status of the compute node group.
#subnet_ids ⇒ Array<String>
The list of subnet IDs where instances are provisioned by the compute node group.

Instance Attribute Details

#ami_id ⇒ `String`

The ID of the Amazon Machine Image (AMI) that PCS uses to launch instances. If not present, PCS uses the AMI ID specified in the custom launch template.

Returns:

(String)

# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb', line 558

class ComputeNodeGroup < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :subnet_ids,
  :purchase_option,
  :launch_template_mode,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :node_lifecycle_actions,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ `String`

The unique Amazon Resource Name (ARN) of the compute node group.

Returns:

(String)

# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb', line 558

class ComputeNodeGroup < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :subnet_ids,
  :purchase_option,
  :launch_template_mode,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :node_lifecycle_actions,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_id ⇒ `String`

The ID of the cluster of the compute node group.

Returns:

(String)

# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb', line 558

class ComputeNodeGroup < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :subnet_ids,
  :purchase_option,
  :launch_template_mode,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :node_lifecycle_actions,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ `Time`

The date and time the resource was created.

Returns:

(Time)

# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb', line 558

class ComputeNodeGroup < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :subnet_ids,
  :purchase_option,
  :launch_template_mode,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :node_lifecycle_actions,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#custom_launch_template ⇒ `Types::CustomLaunchTemplate`

The custom Amazon EC2 launch template associated with the compute node group. This value is present when launchTemplateMode is CUSTOM and isn't present when launchTemplateMode is MANAGED.

Returns:

(Types::CustomLaunchTemplate)

# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb', line 558

class ComputeNodeGroup < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :subnet_ids,
  :purchase_option,
  :launch_template_mode,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :node_lifecycle_actions,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#error_info ⇒ `Array<Types::ErrorInfo>`

The list of errors that occurred during compute node group provisioning.

Returns:

(Array<Types::ErrorInfo>)

# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb', line 558

class ComputeNodeGroup < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :subnet_ids,
  :purchase_option,
  :launch_template_mode,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :node_lifecycle_actions,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#iam_instance_profile_arn ⇒ `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.

Returns:

(String)

# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb', line 558

class ComputeNodeGroup < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :subnet_ids,
  :purchase_option,
  :launch_template_mode,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :node_lifecycle_actions,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ `String`

The generated unique ID of the compute node group.

Returns:

(String)

# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb', line 558

class ComputeNodeGroup < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :subnet_ids,
  :purchase_option,
  :launch_template_mode,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :node_lifecycle_actions,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#instance_configs ⇒ `Array<Types::InstanceConfig>`

A list of EC2 instance configurations that PCS can provision in the compute node group.

Returns:

(Array<Types::InstanceConfig>)

# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb', line 558

class ComputeNodeGroup < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :subnet_ids,
  :purchase_option,
  :launch_template_mode,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :node_lifecycle_actions,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#launch_template_mode ⇒ `String`

Indicates whether the compute node group uses a custom launch template or a launch template that PCS manages. The default value is CUSTOM.

Valid values:

CUSTOM – The compute node group uses the launch template in customLaunchTemplate.
MANAGED – PCS creates and manages the launch template.

Returns:

(String)

# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb', line 558

class ComputeNodeGroup < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :subnet_ids,
  :purchase_option,
  :launch_template_mode,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :node_lifecycle_actions,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#modified_at ⇒ `Time`

The date and time the resource was modified.

Returns:

(Time)

# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb', line 558

class ComputeNodeGroup < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :subnet_ids,
  :purchase_option,
  :launch_template_mode,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :node_lifecycle_actions,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

The name that identifies the compute node group.

Returns:

(String)

# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb', line 558

class ComputeNodeGroup < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :subnet_ids,
  :purchase_option,
  :launch_template_mode,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :node_lifecycle_actions,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#node_lifecycle_actions ⇒ `Types::NodeLifecycleActions`

The lifecycle actions to run on compute nodes in the compute node group. Use lifecycle actions to run custom scripts at defined stages of a compute node's lifecycle, such as when a compute node finishes bootstrapping or becomes ready to accept jobs.

Returns:

(Types::NodeLifecycleActions)

# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb', line 558

class ComputeNodeGroup < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :subnet_ids,
  :purchase_option,
  :launch_template_mode,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :node_lifecycle_actions,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#purchase_option ⇒ `String`

Specifies how EC2 instances are purchased on your behalf. PCS supports On-Demand Instances, Spot Instances, Interruptible Capacity Reservations, On-Demand Capacity Reservations, 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. For more information about PCS support for interruptible capacity reservations, see Using I-ODCRs with PCS in the PCS User Guide. Choose On-Demand if you plan to use an On-Demand Capacity Reservation (ODCR). For more information, see Using ODCRs with PCS. If you don't provide this option, it defaults to On-Demand.

Returns:

(String)

# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb', line 558

class ComputeNodeGroup < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :subnet_ids,
  :purchase_option,
  :launch_template_mode,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :node_lifecycle_actions,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#scaling_configuration ⇒ `Types::ScalingConfiguration`

Specifies the boundaries of the compute node group auto scaling.

Returns:

(Types::ScalingConfiguration)

# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb', line 558

class ComputeNodeGroup < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :subnet_ids,
  :purchase_option,
  :launch_template_mode,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :node_lifecycle_actions,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_ids ⇒ `Array<String>`

The IDs of the EC2 security groups configured directly on the compute node group. PCS uses these security groups instead of the security groups in the custom launch template. This value isn't present if security groups aren't configured directly on the compute node group. In that case, PCS uses the security groups in the custom launch template.

Returns:

(Array<String>)

# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb', line 558

class ComputeNodeGroup < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :subnet_ids,
  :purchase_option,
  :launch_template_mode,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :node_lifecycle_actions,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#slurm_configuration ⇒ `Types::ComputeNodeGroupSlurmConfiguration`

Additional options related to the Slurm scheduler.

Returns:

(Types::ComputeNodeGroupSlurmConfiguration)

# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb', line 558

class ComputeNodeGroup < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :subnet_ids,
  :purchase_option,
  :launch_template_mode,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :node_lifecycle_actions,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#spot_options ⇒ `Types::SpotOptions`

Additional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action.

Returns:

(Types::SpotOptions)

# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb', line 558

class ComputeNodeGroup < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :subnet_ids,
  :purchase_option,
  :launch_template_mode,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :node_lifecycle_actions,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#ssh_key_name ⇒ `String`

The name of the EC2 key pair configured directly on the compute node group. PCS uses this key pair instead of the key pair in the custom launch template. This value isn't present if a key pair isn't configured directly on the compute node group. In that case, PCS uses the key pair in the custom launch template, if one is specified.

Returns:

(String)

# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb', line 558

class ComputeNodeGroup < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :subnet_ids,
  :purchase_option,
  :launch_template_mode,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :node_lifecycle_actions,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb', line 558

class ComputeNodeGroup < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :subnet_ids,
  :purchase_option,
  :launch_template_mode,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :node_lifecycle_actions,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ `Array<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.

Returns:

(Array<String>)

# File 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb', line 558

class ComputeNodeGroup < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :subnet_ids,
  :purchase_option,
  :launch_template_mode,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :node_lifecycle_actions,
  :error_info)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::PCS::Types::ComputeNodeGroup

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#ami_id ⇒ String

#arn ⇒ String

#cluster_id ⇒ String

#created_at ⇒ Time

#custom_launch_template ⇒ Types::CustomLaunchTemplate

#error_info ⇒ Array<Types::ErrorInfo>

#iam_instance_profile_arn ⇒ String

#id ⇒ String

#instance_configs ⇒ Array<Types::InstanceConfig>

#launch_template_mode ⇒ String

#modified_at ⇒ Time

#name ⇒ String

#node_lifecycle_actions ⇒ Types::NodeLifecycleActions

#purchase_option ⇒ String

#scaling_configuration ⇒ Types::ScalingConfiguration

#security_group_ids ⇒ Array<String>

#slurm_configuration ⇒ Types::ComputeNodeGroupSlurmConfiguration

#spot_options ⇒ Types::SpotOptions

#ssh_key_name ⇒ String

#status ⇒ String

#subnet_ids ⇒ Array<String>

#ami_id ⇒ `String`

#arn ⇒ `String`

#cluster_id ⇒ `String`

#created_at ⇒ `Time`

#custom_launch_template ⇒ `Types::CustomLaunchTemplate`

#error_info ⇒ `Array<Types::ErrorInfo>`

#iam_instance_profile_arn ⇒ `String`

#id ⇒ `String`

#instance_configs ⇒ `Array<Types::InstanceConfig>`

#launch_template_mode ⇒ `String`

#modified_at ⇒ `Time`

#name ⇒ `String`

#node_lifecycle_actions ⇒ `Types::NodeLifecycleActions`

#purchase_option ⇒ `String`

#scaling_configuration ⇒ `Types::ScalingConfiguration`

#security_group_ids ⇒ `Array<String>`

#slurm_configuration ⇒ `Types::ComputeNodeGroupSlurmConfiguration`

#spot_options ⇒ `Types::SpotOptions`

#ssh_key_name ⇒ `String`

#status ⇒ `String`

#subnet_ids ⇒ `Array<String>`