Interface UpdateComputeNodeGroupRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateComputeNodeGroupRequest.Builder,UpdateComputeNodeGroupRequest>, PcsRequest.Builder, SdkBuilder<UpdateComputeNodeGroupRequest.Builder,UpdateComputeNodeGroupRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateComputeNodeGroupRequest

@Mutable
@NotThreadSafe
public static interface UpdateComputeNodeGroupRequest.Builder
extends PcsRequest.Builder, SdkPojo, CopyableBuilder<UpdateComputeNodeGroupRequest.Builder,UpdateComputeNodeGroupRequest>

Method Summary

Modifier and Type	Method	Description
UpdateComputeNodeGroupRequest.Builder	amiId(String amiId)	The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch instances.
UpdateComputeNodeGroupRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
UpdateComputeNodeGroupRequest.Builder	clusterIdentifier(String clusterIdentifier)	The name or ID of the cluster of the compute node group.
UpdateComputeNodeGroupRequest.Builder	computeNodeGroupIdentifier(String computeNodeGroupIdentifier)	The name or ID of the compute node group.
default UpdateComputeNodeGroupRequest.Builder	customLaunchTemplate(Consumer<CustomLaunchTemplate.Builder> customLaunchTemplate)	Sets the value of the CustomLaunchTemplate property for this object.
UpdateComputeNodeGroupRequest.Builder	customLaunchTemplate(CustomLaunchTemplate customLaunchTemplate)	Sets the value of the CustomLaunchTemplate property for this object.
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.
UpdateComputeNodeGroupRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateComputeNodeGroupRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
UpdateComputeNodeGroupRequest.Builder	purchaseOption(String purchaseOption)	Specifies how EC2 instances are purchased on your behalf.
UpdateComputeNodeGroupRequest.Builder	purchaseOption(PurchaseOption purchaseOption)	Specifies how EC2 instances are purchased on your behalf.
default UpdateComputeNodeGroupRequest.Builder	scalingConfiguration(Consumer<ScalingConfigurationRequest.Builder> scalingConfiguration)	Specifies the boundaries of the compute node group auto scaling.
UpdateComputeNodeGroupRequest.Builder	scalingConfiguration(ScalingConfigurationRequest scalingConfiguration)	Specifies the boundaries of the compute node group auto scaling.
default UpdateComputeNodeGroupRequest.Builder	slurmConfiguration(Consumer<UpdateComputeNodeGroupSlurmConfigurationRequest.Builder> slurmConfiguration)	Additional options related to the Slurm scheduler.
UpdateComputeNodeGroupRequest.Builder	slurmConfiguration(UpdateComputeNodeGroupSlurmConfigurationRequest slurmConfiguration)	Additional options related to the Slurm scheduler.
default UpdateComputeNodeGroupRequest.Builder	spotOptions(Consumer<SpotOptions.Builder> spotOptions)	Sets the value of the SpotOptions property for this object.
UpdateComputeNodeGroupRequest.Builder	spotOptions(SpotOptions spotOptions)	Sets the value of the SpotOptions property for this object.
UpdateComputeNodeGroupRequest.Builder	subnetIds(String... subnetIds)	The list of subnet IDs where the compute node group provisions instances.
UpdateComputeNodeGroupRequest.Builder	subnetIds(Collection<String> subnetIds)	The list of subnet IDs where the compute node group provisions instances.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.pcs.model.PcsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

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.

amiId

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

UpdateComputeNodeGroupRequest.Builder subnetIds(Collection<String> 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

UpdateComputeNodeGroupRequest.Builder subnetIds(String... 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.

customLaunchTemplate

UpdateComputeNodeGroupRequest.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 UpdateComputeNodeGroupRequest.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:

• customLaunchTemplate(CustomLaunchTemplate)

purchaseOption

UpdateComputeNodeGroupRequest.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
• PurchaseOption

purchaseOption

UpdateComputeNodeGroupRequest.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:

• PurchaseOption
• PurchaseOption

spotOptions

UpdateComputeNodeGroupRequest.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 UpdateComputeNodeGroupRequest.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:

• spotOptions(SpotOptions)

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:

• scalingConfiguration(ScalingConfigurationRequest)

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

slurmConfiguration

UpdateComputeNodeGroupRequest.Builder slurmConfiguration(UpdateComputeNodeGroupSlurmConfigurationRequest 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

default UpdateComputeNodeGroupRequest.Builder slurmConfiguration(Consumer<UpdateComputeNodeGroupSlurmConfigurationRequest.Builder> 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:

• slurmConfiguration(UpdateComputeNodeGroupSlurmConfigurationRequest)

clientToken

UpdateComputeNodeGroupRequest.Builder clientToken(String 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 1 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 1 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

UpdateComputeNodeGroupRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

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.