Class: Aws::PCS::Types::UpdateComputeNodeGroupRequest

Inherits:

Struct

• Object
• Struct
• Aws::PCS::Types::UpdateComputeNodeGroupRequest

Defined in:

gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #ami_id ⇒ String

  The ID of the Amazon Machine Image (AMI) that PCS uses to launch 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 of the compute node group.

• #compute_node_group_identifier ⇒ String

  The name or ID of the compute node group.

• #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.

• #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::UpdateComputeNodeGroupSlurmConfigurationRequest

  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 provisions instances.

Instance Attribute Details

#ami_id ⇒ 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.

Returns:

• (String)

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

class UpdateComputeNodeGroupRequest < Struct.new(
  :cluster_identifier,
  :compute_node_group_identifier,
  :ami_id,
  :subnet_ids,
  :custom_launch_template,
  :purchase_option,
  :spot_options,
  :scaling_configuration,
  :iam_instance_profile_arn,
  :slurm_configuration,
  :client_token)
  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 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb', line 2132

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

#cluster_identifier ⇒ String

The name or ID of the cluster of the compute node group.

Returns:

• (String)

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

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

#compute_node_group_identifier ⇒ String

The name or ID of the compute node group.

Returns:

• (String)

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

class UpdateComputeNodeGroupRequest < Struct.new(
  :cluster_identifier,
  :compute_node_group_identifier,
  :ami_id,
  :subnet_ids,
  :custom_launch_template,
  :purchase_option,
  :spot_options,
  :scaling_configuration,
  :iam_instance_profile_arn,
  :slurm_configuration,
  :client_token)
  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 'gems/aws-sdk-pcs/lib/aws-sdk-pcs/types.rb', line 2132

class UpdateComputeNodeGroupRequest < Struct.new(
  :cluster_identifier,
  :compute_node_group_identifier,
  :ami_id,
  :subnet_ids,
  :custom_launch_template,
  :purchase_option,
  :spot_options,
  :scaling_configuration,
  :iam_instance_profile_arn,
  :slurm_configuration,
  :client_token)
  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 2132

class UpdateComputeNodeGroupRequest < Struct.new(
  :cluster_identifier,
  :compute_node_group_identifier,
  :ami_id,
  :subnet_ids,
  :custom_launch_template,
  :purchase_option,
  :spot_options,
  :scaling_configuration,
  :iam_instance_profile_arn,
  :slurm_configuration,
  :client_token)
  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.

Returns:

• (String)

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

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

#scaling_configuration ⇒ Types::ScalingConfigurationRequest

Specifies the boundaries of the compute node group auto scaling.

Returns:

• (Types::ScalingConfigurationRequest)

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

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

#slurm_configuration ⇒ Types::UpdateComputeNodeGroupSlurmConfigurationRequest

Additional options related to the Slurm scheduler.

Returns:

• (Types::UpdateComputeNodeGroupSlurmConfigurationRequest)

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

class UpdateComputeNodeGroupRequest < Struct.new(
  :cluster_identifier,
  :compute_node_group_identifier,
  :ami_id,
  :subnet_ids,
  :custom_launch_template,
  :purchase_option,
  :spot_options,
  :scaling_configuration,
  :iam_instance_profile_arn,
  :slurm_configuration,
  :client_token)
  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 2132

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

#subnet_ids ⇒ Array<String>

The list of subnet IDs where the compute node group provisions instances. 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 2132

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