Interface CreateComputeNodeGroupRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateComputeNodeGroupRequest

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

Method Summary

Modifier and Type	Method	Description
CreateComputeNodeGroupRequest.Builder	amiId(String amiId)	The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch compute nodes (Amazon EC2 instances).
CreateComputeNodeGroupRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateComputeNodeGroupRequest.Builder	clusterIdentifier(String clusterIdentifier)	The name or ID of the cluster to create a compute node group in.
CreateComputeNodeGroupRequest.Builder	computeNodeGroupName(String computeNodeGroupName)	A name to identify the cluster.
default CreateComputeNodeGroupRequest.Builder	customLaunchTemplate(Consumer<CustomLaunchTemplate.Builder> customLaunchTemplate)	Sets the value of the CustomLaunchTemplate property for this object.
CreateComputeNodeGroupRequest.Builder	customLaunchTemplate(CustomLaunchTemplate customLaunchTemplate)	Sets the value of the CustomLaunchTemplate property for this object.
CreateComputeNodeGroupRequest.Builder	iamInstanceProfileArn(String iamInstanceProfileArn)	The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances.
CreateComputeNodeGroupRequest.Builder	instanceConfigs(Collection<InstanceConfig> instanceConfigs)	A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.
CreateComputeNodeGroupRequest.Builder	instanceConfigs(Consumer<InstanceConfig.Builder>... instanceConfigs)	A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.
CreateComputeNodeGroupRequest.Builder	instanceConfigs(InstanceConfig... instanceConfigs)	A list of EC2 instance configurations that Amazon Web Services PCS can provision in the compute node group.
CreateComputeNodeGroupRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateComputeNodeGroupRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateComputeNodeGroupRequest.Builder	purchaseOption(String purchaseOption)	Specifies how EC2 instances are purchased on your behalf.
CreateComputeNodeGroupRequest.Builder	purchaseOption(PurchaseOption purchaseOption)	Specifies how EC2 instances are purchased on your behalf.
default CreateComputeNodeGroupRequest.Builder	scalingConfiguration(Consumer<ScalingConfigurationRequest.Builder> scalingConfiguration)	Specifies the boundaries of the compute node group auto scaling.
CreateComputeNodeGroupRequest.Builder	scalingConfiguration(ScalingConfigurationRequest scalingConfiguration)	Specifies the boundaries of the compute node group auto scaling.
default CreateComputeNodeGroupRequest.Builder	slurmConfiguration(Consumer<ComputeNodeGroupSlurmConfigurationRequest.Builder> slurmConfiguration)	Additional options related to the Slurm scheduler.
CreateComputeNodeGroupRequest.Builder	slurmConfiguration(ComputeNodeGroupSlurmConfigurationRequest slurmConfiguration)	Additional options related to the Slurm scheduler.
default CreateComputeNodeGroupRequest.Builder	spotOptions(Consumer<SpotOptions.Builder> spotOptions)	Sets the value of the SpotOptions property for this object.
CreateComputeNodeGroupRequest.Builder	spotOptions(SpotOptions spotOptions)	Sets the value of the SpotOptions property for this object.
CreateComputeNodeGroupRequest.Builder	subnetIds(String... subnetIds)	The list of subnet IDs where the compute node group launches instances.
CreateComputeNodeGroupRequest.Builder	subnetIds(Collection<String> subnetIds)	The list of subnet IDs where the compute node group launches instances.
CreateComputeNodeGroupRequest.Builder	tags(Map<String,String> tags)	1 or more tags added to the resource.

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

CreateComputeNodeGroupRequest.Builder clusterIdentifier(String clusterIdentifier)

The name or ID of the cluster to create a compute node group in.

Parameters:

clusterIdentifier - The name or ID of the cluster to create a compute node group in.

Returns:

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

computeNodeGroupName

CreateComputeNodeGroupRequest.Builder computeNodeGroupName(String computeNodeGroupName)

A name to identify the cluster. Example: MyCluster

Parameters:

computeNodeGroupName - A name to identify the cluster. Example: MyCluster

Returns:

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

amiId

CreateComputeNodeGroupRequest.Builder amiId(String amiId)

The ID of the Amazon Machine Image (AMI) that Amazon Web Services PCS uses to launch compute nodes (Amazon EC2 instances). If you don't provide this value, 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 compute nodes (Amazon EC2 instances). If you don't provide this value, 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

CreateComputeNodeGroupRequest.Builder subnetIds(Collection<String> subnetIds)

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

Parameters:

subnetIds - The list of subnet IDs where the compute node group launches instances. 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

CreateComputeNodeGroupRequest.Builder subnetIds(String... subnetIds)

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

Parameters:

subnetIds - The list of subnet IDs where the compute node group launches instances. 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

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

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

customLaunchTemplate

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

iamInstanceProfileArn

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

scalingConfiguration

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

instanceConfigs

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

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

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

• instanceConfigs(java.util.Collection<InstanceConfig>)

spotOptions

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

slurmConfiguration

CreateComputeNodeGroupRequest.Builder slurmConfiguration(ComputeNodeGroupSlurmConfigurationRequest 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 CreateComputeNodeGroupRequest.Builder slurmConfiguration(Consumer<ComputeNodeGroupSlurmConfigurationRequest.Builder> slurmConfiguration)

Additional options related to the Slurm scheduler.

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

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

Parameters:

slurmConfiguration - a consumer that will call methods on ComputeNodeGroupSlurmConfigurationRequest.Builder

Returns:

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

See Also:

• slurmConfiguration(ComputeNodeGroupSlurmConfigurationRequest)

clientToken

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

tags

CreateComputeNodeGroupRequest.Builder tags(Map<String,String> tags)

1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.

Parameters:

tags - 1 or more tags added to the resource. Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.

Returns:

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

overrideConfiguration

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

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