Interface UpdateComputeNodeGroupRequest.Builder

  • Method Details

    • amiId

      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.

      Parameters:
      amiId - 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:
      Returns a reference to this object so that method calls can be chained together.
    • securityGroupIds

      UpdateComputeNodeGroupRequest.Builder securityGroupIds(Collection<String> securityGroupIds)

      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.

      Parameters:
      securityGroupIds - 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:
      Returns a reference to this object so that method calls can be chained together.
    • securityGroupIds

      UpdateComputeNodeGroupRequest.Builder securityGroupIds(String... securityGroupIds)

      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.

      Parameters:
      securityGroupIds - 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:
      Returns a reference to this object so that method calls can be chained together.
    • sshKeyName

      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.

      Parameters:
      sshKeyName - 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:
      Returns a reference to this object so that method calls can be chained together.
    • clusterIdentifier

      UpdateComputeNodeGroupRequest.Builder clusterIdentifier(String clusterIdentifier)

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

      Parameters:
      clusterIdentifier - The name or ID of the cluster of the compute node group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • computeNodeGroupIdentifier

      UpdateComputeNodeGroupRequest.Builder computeNodeGroupIdentifier(String computeNodeGroupIdentifier)

      The name or ID of the compute node group.

      Parameters:
      computeNodeGroupIdentifier - The name or ID of the compute node group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • subnetIds

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

      Parameters:
      subnetIds - The list of subnet IDs where the compute node group provisions instances. The subnets must be in the same VPC as the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • subnetIds

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

      Parameters:
      subnetIds - The list of subnet IDs where the compute node group provisions instances. The subnets must be in the same VPC as the cluster.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • launchTemplateMode

      UpdateComputeNodeGroupRequest.Builder launchTemplateMode(String launchTemplateMode)

      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.

      Parameters:
      launchTemplateMode - 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • launchTemplateMode

      UpdateComputeNodeGroupRequest.Builder launchTemplateMode(LaunchTemplateMode launchTemplateMode)

      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.

      Parameters:
      launchTemplateMode - 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • customLaunchTemplate

      UpdateComputeNodeGroupRequest.Builder customLaunchTemplate(CustomLaunchTemplate 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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.
    • customLaunchTemplate

      default UpdateComputeNodeGroupRequest.Builder customLaunchTemplate(Consumer<CustomLaunchTemplate.Builder> 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.

      This is a convenience method that creates an instance of the CustomLaunchTemplate.Builder avoiding the need to create one manually via CustomLaunchTemplate.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customLaunchTemplate(CustomLaunchTemplate).

      Parameters:
      customLaunchTemplate - a consumer that will call methods on CustomLaunchTemplate.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • purchaseOption

      UpdateComputeNodeGroupRequest.Builder purchaseOption(String purchaseOption)

      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.

      Parameters:
      purchaseOption - 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • purchaseOption

      UpdateComputeNodeGroupRequest.Builder purchaseOption(PurchaseOption purchaseOption)

      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.

      Parameters:
      purchaseOption - 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • spotOptions

      Sets the value of the SpotOptions property for this object.
      Parameters:
      spotOptions - The new value for the SpotOptions property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • spotOptions

      Sets the value of the SpotOptions property for this object. This is a convenience method that creates an instance of the SpotOptions.Builder avoiding the need to create one manually via SpotOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to spotOptions(SpotOptions).

      Parameters:
      spotOptions - a consumer that will call methods on SpotOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • scalingConfiguration

      UpdateComputeNodeGroupRequest.Builder scalingConfiguration(ScalingConfigurationRequest scalingConfiguration)

      Specifies the boundaries of the compute node group auto scaling.

      Parameters:
      scalingConfiguration - Specifies the boundaries of the compute node group auto scaling.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • scalingConfiguration

      default UpdateComputeNodeGroupRequest.Builder scalingConfiguration(Consumer<ScalingConfigurationRequest.Builder> scalingConfiguration)

      Specifies the boundaries of the compute node group auto scaling.

      This is a convenience method that creates an instance of the ScalingConfigurationRequest.Builder avoiding the need to create one manually via ScalingConfigurationRequest.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scalingConfiguration(ScalingConfigurationRequest).

      Parameters:
      scalingConfiguration - a consumer that will call methods on ScalingConfigurationRequest.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • iamInstanceProfileArn

      UpdateComputeNodeGroupRequest.Builder iamInstanceProfileArn(String iamInstanceProfileArn)

      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.

      Parameters:
      iamInstanceProfileArn - 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:
      Returns a reference to this object so that method calls can be chained together.
    • slurmConfiguration

      Additional options related to the Slurm scheduler.

      Parameters:
      slurmConfiguration - Additional options related to the Slurm scheduler.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • slurmConfiguration

      Additional options related to the Slurm scheduler.

      This is a convenience method that creates an instance of the UpdateComputeNodeGroupSlurmConfigurationRequest.Builder avoiding the need to create one manually via UpdateComputeNodeGroupSlurmConfigurationRequest.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to slurmConfiguration(UpdateComputeNodeGroupSlurmConfigurationRequest).

      Parameters:
      slurmConfiguration - a consumer that will call methods on UpdateComputeNodeGroupSlurmConfigurationRequest.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • nodeLifecycleActions

      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.

      Parameters:
      nodeLifecycleActions - 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:
      Returns a reference to this object so that method calls can be chained together.
    • nodeLifecycleActions

      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.

      This is a convenience method that creates an instance of the UpdateNodeLifecycleActionsRequest.Builder avoiding the need to create one manually via UpdateNodeLifecycleActionsRequest.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to nodeLifecycleActions(UpdateNodeLifecycleActionsRequest).

      Parameters:
      nodeLifecycleActions - a consumer that will call methods on UpdateNodeLifecycleActionsRequest.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • instanceHealthChecks

      The instance health check settings for the compute node group. Instance health checks detect faults on instances in the compute node group and respond with the repair action that you choose. You can configure health monitoring, deep health checks, or both. You can't specify an empty object ({}). Instance health checks require Slurm version 26.05 or later.

      The settings that you specify replace all of the current instance health check settings of the compute node group. Include every setting that you want to keep. If you omit this member, the current settings don't change. If you omit healthMonitoring or deepHealthChecks, that check is turned off. You can also turn off a check: set healthMonitoring.mode or deepHealthChecks.onStart.profile to NONE and omit its repairAction. When you change these settings, PCS drains and replaces the instances in the compute node group.

      Parameters:
      instanceHealthChecks - The instance health check settings for the compute node group. Instance health checks detect faults on instances in the compute node group and respond with the repair action that you choose. You can configure health monitoring, deep health checks, or both. You can't specify an empty object ( {}). Instance health checks require Slurm version 26.05 or later.

      The settings that you specify replace all of the current instance health check settings of the compute node group. Include every setting that you want to keep. If you omit this member, the current settings don't change. If you omit healthMonitoring or deepHealthChecks, that check is turned off. You can also turn off a check: set healthMonitoring.mode or deepHealthChecks.onStart.profile to NONE and omit its repairAction. When you change these settings, PCS drains and replaces the instances in the compute node group.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • instanceHealthChecks

      The instance health check settings for the compute node group. Instance health checks detect faults on instances in the compute node group and respond with the repair action that you choose. You can configure health monitoring, deep health checks, or both. You can't specify an empty object ({}). Instance health checks require Slurm version 26.05 or later.

      The settings that you specify replace all of the current instance health check settings of the compute node group. Include every setting that you want to keep. If you omit this member, the current settings don't change. If you omit healthMonitoring or deepHealthChecks, that check is turned off. You can also turn off a check: set healthMonitoring.mode or deepHealthChecks.onStart.profile to NONE and omit its repairAction. When you change these settings, PCS drains and replaces the instances in the compute node group.

      This is a convenience method that creates an instance of the UpdateInstanceHealthChecksRequest.Builder avoiding the need to create one manually via UpdateInstanceHealthChecksRequest.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to instanceHealthChecks(UpdateInstanceHealthChecksRequest).

      Parameters:
      instanceHealthChecks - a consumer that will call methods on UpdateInstanceHealthChecksRequest.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • clientToken

      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.

      Parameters:
      clientToken - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • overrideConfiguration

      UpdateComputeNodeGroupRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.