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

Inherits:

Struct

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

show all

Includes:: Structure

Defined in:: 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 Amazon Web Services 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

An Amazon EC2 launch template Amazon Web Services PCS uses to launch compute nodes.
#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 Amazon Web Services PCS can provision in the compute node group.
#modified_at ⇒ Time

The date and time the resource was modified.
#name ⇒ String

The name that identifies 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.
#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.
#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 Amazon Web Services PCS uses to launch instances. If not provided, Amazon Web Services PCS uses the AMI ID specified in the custom launch template.

Returns:

(String)

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

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

#arn ⇒ `String`

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

Returns:

(String)

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

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

#cluster_id ⇒ `String`

The ID of the cluster of the compute node group.

Returns:

(String)

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

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

#created_at ⇒ `Time`

The date and time the resource was created.

Returns:

(Time)

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

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

#custom_launch_template ⇒ `Types::CustomLaunchTemplate`

An Amazon EC2 launch template Amazon Web Services PCS uses to launch compute nodes.

Returns:

(Types::CustomLaunchTemplate)

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

class ComputeNodeGroup < Struct.new(
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :ami_id,
  :subnet_ids,
  :purchase_option,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :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 'lib/aws-sdk-pcs/types.rb', line 316

class ComputeNodeGroup < Struct.new(
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :ami_id,
  :subnet_ids,
  :purchase_option,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :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. The resource identifier of the ARN must start with `AWSPCS` or it must have `/aws-pcs/` in its path.

Examples

‘arn:aws:iam::111122223333:instance-profile/AWSPCS-example-role-1`
‘arn:aws:iam::111122223333:instance-profile/aws-pcs/example-role-2`

Returns:

(String)

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

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

#id ⇒ `String`

The generated unique ID of the compute node group.

Returns:

(String)

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

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

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

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

Returns:

(Array<Types::InstanceConfig>)

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

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

#modified_at ⇒ `Time`

The date and time the resource was modified.

Returns:

(Time)

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

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

#name ⇒ `String`

The name that identifies the compute node group.

Returns:

(String)

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

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

#purchase_option ⇒ `String`

Specifies how EC2 instances are purchased on your behalf. Amazon Web Services PCS supports On-Demand and Spot instances. For more information, see [Instance purchasing options] in the *Amazon Elastic Compute Cloud User Guide*. If you don’t provide this option, it defaults to On-Demand.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-purchasing-options.html

Returns:

(String)

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

class ComputeNodeGroup < Struct.new(
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :ami_id,
  :subnet_ids,
  :purchase_option,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :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 'lib/aws-sdk-pcs/types.rb', line 316

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

#slurm_configuration ⇒ `Types::ComputeNodeGroupSlurmConfiguration`

Additional options related to the Slurm scheduler.

Returns:

(Types::ComputeNodeGroupSlurmConfiguration)

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

class ComputeNodeGroup < Struct.new(
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :ami_id,
  :subnet_ids,
  :purchase_option,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :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 'lib/aws-sdk-pcs/types.rb', line 316

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

#status ⇒ `String`

The provisioning status of the compute node group.

<note markdown=“1”> The provisioning status doesn’t indicate the overall health of the compute node group.

</note>

Returns:

(String)

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

class ComputeNodeGroup < Struct.new(
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :ami_id,
  :subnet_ids,
  :purchase_option,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :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 'lib/aws-sdk-pcs/types.rb', line 316

class ComputeNodeGroup < Struct.new(
  :name,
  :id,
  :arn,
  :cluster_id,
  :created_at,
  :modified_at,
  :status,
  :ami_id,
  :subnet_ids,
  :purchase_option,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :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>

#modified_at ⇒ Time

#name ⇒ String

#purchase_option ⇒ String

#scaling_configuration ⇒ Types::ScalingConfiguration

#slurm_configuration ⇒ Types::ComputeNodeGroupSlurmConfiguration

#spot_options ⇒ Types::SpotOptions

#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>`

#modified_at ⇒ `Time`

#name ⇒ `String`

#purchase_option ⇒ `String`

#scaling_configuration ⇒ `Types::ScalingConfiguration`

#slurm_configuration ⇒ `Types::ComputeNodeGroupSlurmConfiguration`

#spot_options ⇒ `Types::SpotOptions`

#status ⇒ `String`

#subnet_ids ⇒ `Array<String>`