Class: Aws::PCS::Types::CreateComputeNodeGroupRequest

Inherits:

Struct

Object
Struct
Aws::PCS::Types::CreateComputeNodeGroupRequest

show all

Includes:: Structure

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

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#ami_id ⇒ String

The ID of the Amazon Machine Image (AMI) that PCS uses to launch compute nodes (Amazon EC2 instances).
#client_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
#cluster_identifier ⇒ String

The name or ID of the cluster to create a compute node group in.
#compute_node_group_name ⇒ String

A name to identify the cluster.
#custom_launch_template ⇒ Types::CustomLaunchTemplate

An Amazon EC2 launch template PCS uses to launch compute nodes.
#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.
#instance_configs ⇒ Array<Types::InstanceConfig>

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

Specifies how EC2 instances are purchased on your behalf.
#scaling_configuration ⇒ Types::ScalingConfigurationRequest

Specifies the boundaries of the compute node group auto scaling.
#slurm_configuration ⇒ Types::ComputeNodeGroupSlurmConfigurationRequest

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

The list of subnet IDs where the compute node group launches instances.
#tags ⇒ Hash<String,String>

1 or more tags added to the resource.

Instance Attribute Details

#ami_id ⇒ `String`

The ID of the Amazon Machine Image (AMI) that PCS uses to launch compute nodes (Amazon EC2 instances). If you don’t provide this value, PCS uses the AMI ID specified in the custom launch template.

Returns:

(String)

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

class CreateComputeNodeGroupRequest < Struct.new(
  :cluster_identifier,
  :compute_node_group_name,
  :ami_id,
  :subnet_ids,
  :purchase_option,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ `String`

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, the subsequent retries with the same client token return the result from the original successful request and they have no additional effect. If you don’t specify a client token, the CLI and SDK automatically generate 1 for you.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

(String)

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

class CreateComputeNodeGroupRequest < Struct.new(
  :cluster_identifier,
  :compute_node_group_name,
  :ami_id,
  :subnet_ids,
  :purchase_option,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_identifier ⇒ `String`

The name or ID of the cluster to create a compute node group in.

Returns:

(String)

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

class CreateComputeNodeGroupRequest < Struct.new(
  :cluster_identifier,
  :compute_node_group_name,
  :ami_id,
  :subnet_ids,
  :purchase_option,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#compute_node_group_name ⇒ `String`

A name to identify the cluster. Example: ‘MyCluster`

Returns:

(String)

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

class CreateComputeNodeGroupRequest < Struct.new(
  :cluster_identifier,
  :compute_node_group_name,
  :ami_id,
  :subnet_ids,
  :purchase_option,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#custom_launch_template ⇒ `Types::CustomLaunchTemplate`

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

Returns:

(Types::CustomLaunchTemplate)

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

class CreateComputeNodeGroupRequest < Struct.new(
  :cluster_identifier,
  :compute_node_group_name,
  :ami_id,
  :subnet_ids,
  :purchase_option,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :client_token,
  :tags)
  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*.

[1]: docs.aws.amazon.com/pcs/latest/userguide/security-instance-profiles.html

Returns:

(String)

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

class CreateComputeNodeGroupRequest < Struct.new(
  :cluster_identifier,
  :compute_node_group_name,
  :ami_id,
  :subnet_ids,
  :purchase_option,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :client_token,
  :tags)
  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 'lib/aws-sdk-pcs/types.rb', line 769

class CreateComputeNodeGroupRequest < Struct.new(
  :cluster_identifier,
  :compute_node_group_name,
  :ami_id,
  :subnet_ids,
  :purchase_option,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#purchase_option ⇒ `String`

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.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-purchasing-options.html [2]: docs.aws.amazon.com/pcs/latest/userguide/capacity-blocks.html

Returns:

(String)

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

class CreateComputeNodeGroupRequest < Struct.new(
  :cluster_identifier,
  :compute_node_group_name,
  :ami_id,
  :subnet_ids,
  :purchase_option,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#scaling_configuration ⇒ `Types::ScalingConfigurationRequest`

Specifies the boundaries of the compute node group auto scaling.

Returns:

(Types::ScalingConfigurationRequest)

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

class CreateComputeNodeGroupRequest < Struct.new(
  :cluster_identifier,
  :compute_node_group_name,
  :ami_id,
  :subnet_ids,
  :purchase_option,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#slurm_configuration ⇒ `Types::ComputeNodeGroupSlurmConfigurationRequest`

Additional options related to the Slurm scheduler.

Returns:

(Types::ComputeNodeGroupSlurmConfigurationRequest)

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

class CreateComputeNodeGroupRequest < Struct.new(
  :cluster_identifier,
  :compute_node_group_name,
  :ami_id,
  :subnet_ids,
  :purchase_option,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :client_token,
  :tags)
  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 769

class CreateComputeNodeGroupRequest < Struct.new(
  :cluster_identifier,
  :compute_node_group_name,
  :ami_id,
  :subnet_ids,
  :purchase_option,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ `Array<String>`

The list of subnet IDs where the compute node group launches instances. Subnets must be in the same VPC as the cluster.

Returns:

(Array<String>)

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

class CreateComputeNodeGroupRequest < Struct.new(
  :cluster_identifier,
  :compute_node_group_name,
  :ami_id,
  :subnet_ids,
  :purchase_option,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Hash<String,String>`

1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.

Returns:

(Hash<String,String>)

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

class CreateComputeNodeGroupRequest < Struct.new(
  :cluster_identifier,
  :compute_node_group_name,
  :ami_id,
  :subnet_ids,
  :purchase_option,
  :custom_launch_template,
  :iam_instance_profile_arn,
  :scaling_configuration,
  :instance_configs,
  :spot_options,
  :slurm_configuration,
  :client_token,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::PCS::Types::CreateComputeNodeGroupRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#ami_id ⇒ String

#client_token ⇒ String

#cluster_identifier ⇒ String

#compute_node_group_name ⇒ String

#custom_launch_template ⇒ Types::CustomLaunchTemplate

#iam_instance_profile_arn ⇒ String

#instance_configs ⇒ Array<Types::InstanceConfig>

#purchase_option ⇒ String

#scaling_configuration ⇒ Types::ScalingConfigurationRequest

#slurm_configuration ⇒ Types::ComputeNodeGroupSlurmConfigurationRequest

#spot_options ⇒ Types::SpotOptions

#subnet_ids ⇒ Array<String>

#tags ⇒ Hash<String,String>

#ami_id ⇒ `String`

#client_token ⇒ `String`

#cluster_identifier ⇒ `String`

#compute_node_group_name ⇒ `String`

#custom_launch_template ⇒ `Types::CustomLaunchTemplate`

#iam_instance_profile_arn ⇒ `String`

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

#purchase_option ⇒ `String`

#scaling_configuration ⇒ `Types::ScalingConfigurationRequest`

#slurm_configuration ⇒ `Types::ComputeNodeGroupSlurmConfigurationRequest`

#spot_options ⇒ `Types::SpotOptions`

#subnet_ids ⇒ `Array<String>`

#tags ⇒ `Hash<String,String>`