Interface ComputeNodeGroup.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ComputeNodeGroup.Builder,ComputeNodeGroup>, SdkBuilder<ComputeNodeGroup.Builder,ComputeNodeGroup>, SdkPojo
Enclosing class:
ComputeNodeGroup
@Mutable @NotThreadSafe public static interface ComputeNodeGroup.Builder extends SdkPojo, CopyableBuilder<ComputeNodeGroup.Builder,ComputeNodeGroup>

  • Method Details

    • name

      ComputeNodeGroup.Builder name(String name)

      The name that identifies the compute node group.

      Parameters:
      name - The name that identifies the compute node group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • id

      ComputeNodeGroup.Builder id(String id)

      The generated unique ID of the compute node group.

      Parameters:
      id - The generated unique ID of the compute node group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • arn

      ComputeNodeGroup.Builder arn(String arn)

      The unique Amazon Resource Name (ARN) of the compute node group.

      Parameters:
      arn - The unique Amazon Resource Name (ARN) of the compute node group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterId

      ComputeNodeGroup.Builder clusterId(String clusterId)

      The ID of the cluster of the compute node group.

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

    • createdAt

      ComputeNodeGroup.Builder createdAt(Instant createdAt)

      The date and time the resource was created.

      Parameters:
      createdAt - The date and time the resource was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • modifiedAt

      ComputeNodeGroup.Builder modifiedAt(Instant modifiedAt)

      The date and time the resource was modified.

      Parameters:
      modifiedAt - The date and time the resource was modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      ComputeNodeGroup.Builder status(String status)

      The provisioning status of the compute node group.

      The provisioning status doesn't indicate the overall health of the compute node group.

      The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.

      Parameters:
      status - The provisioning status of the compute node group.

      The provisioning status doesn't indicate the overall health of the compute node group.

      The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.

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

    • status

      ComputeNodeGroup.Builder status(ComputeNodeGroupStatus status)

      The provisioning status of the compute node group.

      The provisioning status doesn't indicate the overall health of the compute node group.

      The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.

      Parameters:
      status - The provisioning status of the compute node group.

      The provisioning status doesn't indicate the overall health of the compute node group.

      The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can't use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED. For more information, see Frequently asked questions about Slurm versions in PCS in the PCS User Guide.

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

    • amiId

      ComputeNodeGroup.Builder amiId(String amiId)

      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.

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

    • subnetIds

      ComputeNodeGroup.Builder subnetIds(Collection<String> subnetIds)

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

      Parameters:
      subnetIds - The list of subnet IDs where instances are provisioned by the compute node group. 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

      ComputeNodeGroup.Builder subnetIds(String... subnetIds)

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

      Parameters:
      subnetIds - The list of subnet IDs where instances are provisioned by the compute node group. 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.

    • purchaseOption

      ComputeNodeGroup.Builder purchaseOption(String purchaseOption)

      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.

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

    • purchaseOption

      ComputeNodeGroup.Builder purchaseOption(PurchaseOption purchaseOption)

      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.

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

    • customLaunchTemplate

      ComputeNodeGroup.Builder customLaunchTemplate(CustomLaunchTemplate customLaunchTemplate)
      Sets the value of the CustomLaunchTemplate property for this object.
      Parameters:
      customLaunchTemplate - The new value for the CustomLaunchTemplate property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customLaunchTemplate

      default ComputeNodeGroup.Builder customLaunchTemplate(Consumer<CustomLaunchTemplate.Builder> customLaunchTemplate)
      Sets the value of the CustomLaunchTemplate property for this object. 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:

    • iamInstanceProfileArn

      ComputeNodeGroup.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. 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

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

    • scalingConfiguration

      ComputeNodeGroup.Builder scalingConfiguration(ScalingConfiguration scalingConfiguration)
      Sets the value of the ScalingConfiguration property for this object.
      Parameters:
      scalingConfiguration - The new value for the ScalingConfiguration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scalingConfiguration

      default ComputeNodeGroup.Builder scalingConfiguration(Consumer<ScalingConfiguration.Builder> scalingConfiguration)
      Sets the value of the ScalingConfiguration property for this object. This is a convenience method that creates an instance of the ScalingConfiguration.Builder avoiding the need to create one manually via ScalingConfiguration.builder().

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

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

    • instanceConfigs

      ComputeNodeGroup.Builder instanceConfigs(Collection<InstanceConfig> instanceConfigs)

      A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.

      Parameters:
      instanceConfigs - A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceConfigs

      ComputeNodeGroup.Builder instanceConfigs(InstanceConfig... instanceConfigs)

      A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.

      Parameters:
      instanceConfigs - A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceConfigs

      ComputeNodeGroup.Builder instanceConfigs(Consumer<InstanceConfig.Builder>... instanceConfigs)

      A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to instanceConfigs(List<InstanceConfig>).

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

    • spotOptions

      ComputeNodeGroup.Builder spotOptions(SpotOptions 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

      default ComputeNodeGroup.Builder spotOptions(Consumer<SpotOptions.Builder> 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:

    • slurmConfiguration

      ComputeNodeGroup.Builder slurmConfiguration(ComputeNodeGroupSlurmConfiguration slurmConfiguration)
      Sets the value of the SlurmConfiguration property for this object.
      Parameters:
      slurmConfiguration - The new value for the SlurmConfiguration property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • slurmConfiguration

      default ComputeNodeGroup.Builder slurmConfiguration(Consumer<ComputeNodeGroupSlurmConfiguration.Builder> slurmConfiguration)
      Sets the value of the SlurmConfiguration property for this object. This is a convenience method that creates an instance of the ComputeNodeGroupSlurmConfiguration.Builder avoiding the need to create one manually via ComputeNodeGroupSlurmConfiguration.builder().

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

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

    • errorInfo

      ComputeNodeGroup.Builder errorInfo(Collection<ErrorInfo> errorInfo)

      The list of errors that occurred during compute node group provisioning.

      Parameters:
      errorInfo - The list of errors that occurred during compute node group provisioning.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • errorInfo

      ComputeNodeGroup.Builder errorInfo(ErrorInfo... errorInfo)

      The list of errors that occurred during compute node group provisioning.

      Parameters:
      errorInfo - The list of errors that occurred during compute node group provisioning.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • errorInfo

      ComputeNodeGroup.Builder errorInfo(Consumer<ErrorInfo.Builder>... errorInfo)

      The list of errors that occurred during compute node group provisioning.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to errorInfo(List<ErrorInfo>).

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