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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-pcs/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#ami_idString

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)


1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
# File 'lib/aws-sdk-pcs/types.rb', line 1802

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_tokenString

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)


1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
# File 'lib/aws-sdk-pcs/types.rb', line 1802

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_identifierString

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

Returns:

  • (String)


1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
# File 'lib/aws-sdk-pcs/types.rb', line 1802

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_identifierString

The name or ID of the compute node group.

Returns:

  • (String)


1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
# File 'lib/aws-sdk-pcs/types.rb', line 1802

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_templateTypes::CustomLaunchTemplate

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



1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
# File 'lib/aws-sdk-pcs/types.rb', line 1802

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_arnString

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)


1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
# File 'lib/aws-sdk-pcs/types.rb', line 1802

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_optionString

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)


1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
# File 'lib/aws-sdk-pcs/types.rb', line 1802

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

Specifies the boundaries of the compute node group auto scaling.



1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
# File 'lib/aws-sdk-pcs/types.rb', line 1802

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_configurationTypes::UpdateComputeNodeGroupSlurmConfigurationRequest

Additional options related to the Slurm scheduler.



1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
# File 'lib/aws-sdk-pcs/types.rb', line 1802

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_optionsTypes::SpotOptions

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

Returns:



1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
# File 'lib/aws-sdk-pcs/types.rb', line 1802

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_idsArray<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>)


1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
# File 'lib/aws-sdk-pcs/types.rb', line 1802

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