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

  The custom Amazon EC2 launch template to associate with the compute node group.

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

• #launch_template_mode ⇒ String

  Specifies whether the compute node group uses a custom launch template or a launch template that PCS manages.

• #node_lifecycle_actions ⇒ Types::UpdateNodeLifecycleActionsRequest

  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::ScalingConfigurationRequest

  Specifies the boundaries of the compute node group auto scaling.

• #security_group_ids ⇒ Array<String>

  The IDs of the EC2 security groups to configure directly on the compute node group.

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

• #ssh_key_name ⇒ String

  The name of the EC2 key pair to configure directly on the compute node group.

• #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. This value overrides the AMI ID in the custom launch template. Specify an empty string ("") to remove the AMI ID from the compute node group and use the AMI ID specified in the custom launch template. Omit this value to leave the current setting unchanged.

Returns:

• (String)

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

class UpdateComputeNodeGroupRequest < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :cluster_identifier,
  :compute_node_group_identifier,
  :subnet_ids,
  :launch_template_mode,
  :custom_launch_template,
  :purchase_option,
  :spot_options,
  :scaling_configuration,
  :iam_instance_profile_arn,
  :slurm_configuration,
  :node_lifecycle_actions,
  :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 one 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 2772

class UpdateComputeNodeGroupRequest < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :cluster_identifier,
  :compute_node_group_identifier,
  :subnet_ids,
  :launch_template_mode,
  :custom_launch_template,
  :purchase_option,
  :spot_options,
  :scaling_configuration,
  :iam_instance_profile_arn,
  :slurm_configuration,
  :node_lifecycle_actions,
  :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 2772

class UpdateComputeNodeGroupRequest < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :cluster_identifier,
  :compute_node_group_identifier,
  :subnet_ids,
  :launch_template_mode,
  :custom_launch_template,
  :purchase_option,
  :spot_options,
  :scaling_configuration,
  :iam_instance_profile_arn,
  :slurm_configuration,
  :node_lifecycle_actions,
  :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 2772

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

#custom_launch_template ⇒ Types::CustomLaunchTemplate

The custom Amazon EC2 launch template to associate with the compute node group. To set or change the custom launch template, specify id and version. If you provide this value and omit launchTemplateMode, the compute node group must already use CUSTOM mode. To switch from MANAGED to CUSTOM, specify launchTemplateMode as CUSTOM and provide this value. If the compute node group already uses CUSTOM, omit this value while also omitting launchTemplateMode, or while specifying CUSTOM, to keep the existing custom launch template. For more information, see Migrating a compute node group from a custom launch template in the PCS User Guide.

Returns:

• (Types::CustomLaunchTemplate)

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

class UpdateComputeNodeGroupRequest < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :cluster_identifier,
  :compute_node_group_identifier,
  :subnet_ids,
  :launch_template_mode,
  :custom_launch_template,
  :purchase_option,
  :spot_options,
  :scaling_configuration,
  :iam_instance_profile_arn,
  :slurm_configuration,
  :node_lifecycle_actions,
  :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 2772

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

#launch_template_mode ⇒ String

Specifies whether the compute node group uses a custom launch template or a launch template that PCS manages. Omit this value to keep the current mode.

Valid values:

• CUSTOM – Use a custom launch template. To switch from MANAGED, also provide customLaunchTemplate. If the compute node group already uses CUSTOM and you omit customLaunchTemplate, the existing launch template is unchanged.

• MANAGED – Use a launch template created and managed by PCS. Omit customLaunchTemplate. Switching to this mode removes the custom launch template association but doesn't delete the launch template.

When switching to MANAGED, the compute node group must have amiId and securityGroupIds configured. You can set these values in the same request.

Returns:

• (String)

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

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

#node_lifecycle_actions ⇒ Types::UpdateNodeLifecycleActionsRequest

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::UpdateNodeLifecycleActionsRequest)

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

class UpdateComputeNodeGroupRequest < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :cluster_identifier,
  :compute_node_group_identifier,
  :subnet_ids,
  :launch_template_mode,
  :custom_launch_template,
  :purchase_option,
  :spot_options,
  :scaling_configuration,
  :iam_instance_profile_arn,
  :slurm_configuration,
  :node_lifecycle_actions,
  :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, 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 2772

class UpdateComputeNodeGroupRequest < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :cluster_identifier,
  :compute_node_group_identifier,
  :subnet_ids,
  :launch_template_mode,
  :custom_launch_template,
  :purchase_option,
  :spot_options,
  :scaling_configuration,
  :iam_instance_profile_arn,
  :slurm_configuration,
  :node_lifecycle_actions,
  :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 2772

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

#security_group_ids ⇒ Array<String>

The IDs of the EC2 security groups to configure directly on the compute node group. The security groups must be in the same VPC as the cluster. PCS uses these security groups instead of the security groups in the custom launch template. You can't specify this value if the custom launch template defines network interfaces. Specify an empty list ([]) to remove the security groups from the compute node group and use the security groups in the custom launch template. Omit this value to leave the current setting unchanged.

Returns:

• (Array<String>)

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

class UpdateComputeNodeGroupRequest < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :cluster_identifier,
  :compute_node_group_identifier,
  :subnet_ids,
  :launch_template_mode,
  :custom_launch_template,
  :purchase_option,
  :spot_options,
  :scaling_configuration,
  :iam_instance_profile_arn,
  :slurm_configuration,
  :node_lifecycle_actions,
  :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 2772

class UpdateComputeNodeGroupRequest < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :cluster_identifier,
  :compute_node_group_identifier,
  :subnet_ids,
  :launch_template_mode,
  :custom_launch_template,
  :purchase_option,
  :spot_options,
  :scaling_configuration,
  :iam_instance_profile_arn,
  :slurm_configuration,
  :node_lifecycle_actions,
  :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 2772

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

#ssh_key_name ⇒ String

The name of the EC2 key pair to configure directly on the compute node group. The key pair must exist in your account and Amazon Web Services Region. PCS uses this key pair instead of the key pair in the custom launch template. Specify an empty string ("") to remove the key pair from the compute node group and use the key pair in the custom launch template. Omit this value to leave the current setting unchanged. You must have permission for ec2:DescribeKeyPairs to specify a key pair. If you delete the key pair later, future instance launches can fail.

Returns:

• (String)

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

class UpdateComputeNodeGroupRequest < Struct.new(
  :ami_id,
  :security_group_ids,
  :ssh_key_name,
  :cluster_identifier,
  :compute_node_group_identifier,
  :subnet_ids,
  :launch_template_mode,
  :custom_launch_template,
  :purchase_option,
  :spot_options,
  :scaling_configuration,
  :iam_instance_profile_arn,
  :slurm_configuration,
  :node_lifecycle_actions,
  :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 2772

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