Package software.amazon.awscdk.services.pcs

Class CfnComputeNodeGroup.Builder

java.lang.Object

software.amazon.awscdk.services.pcs.CfnComputeNodeGroup.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnComputeNodeGroup>

Enclosing class:

CfnComputeNodeGroup

@Stability(Stable)
public static final class CfnComputeNodeGroup.Builder
extends Object
implements software.amazon.jsii.Builder<CfnComputeNodeGroup>

A fluent builder for CfnComputeNodeGroup.

Method Summary

Modifier and Type	Method	Description
CfnComputeNodeGroup.Builder	amiId(String amiId)	The ID of the Amazon Machine Image (AMI) that AWS PCS uses to launch instances.
CfnComputeNodeGroup	build()
CfnComputeNodeGroup.Builder	clusterId(String clusterId)	The ID of the cluster of the compute node group.
static CfnComputeNodeGroup.Builder	create(software.constructs.Construct scope, String id)
CfnComputeNodeGroup.Builder	customLaunchTemplate(IResolvable customLaunchTemplate)	An Amazon EC2 launch template AWS PCS uses to launch compute nodes.
CfnComputeNodeGroup.Builder	customLaunchTemplate(CfnComputeNodeGroup.CustomLaunchTemplateProperty customLaunchTemplate)	An Amazon EC2 launch template AWS PCS uses to launch compute nodes.
CfnComputeNodeGroup.Builder	iamInstanceProfileArn(String iamInstanceProfileArn)	The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances.
CfnComputeNodeGroup.Builder	instanceConfigs(List<? extends Object> instanceConfigs)	A list of EC2 instance configurations that AWS PCS can provision in the compute node group.
CfnComputeNodeGroup.Builder	instanceConfigs(IResolvable instanceConfigs)	A list of EC2 instance configurations that AWS PCS can provision in the compute node group.
CfnComputeNodeGroup.Builder	name(String name)	The name that identifies the compute node group.
CfnComputeNodeGroup.Builder	purchaseOption(String purchaseOption)	Specifies how EC2 instances are purchased on your behalf.
CfnComputeNodeGroup.Builder	scalingConfiguration(IResolvable scalingConfiguration)	Specifies the boundaries of the compute node group auto scaling.
CfnComputeNodeGroup.Builder	scalingConfiguration(CfnComputeNodeGroup.ScalingConfigurationProperty scalingConfiguration)	Specifies the boundaries of the compute node group auto scaling.
CfnComputeNodeGroup.Builder	slurmConfiguration(IResolvable slurmConfiguration)	Additional options related to the Slurm scheduler.
CfnComputeNodeGroup.Builder	slurmConfiguration(CfnComputeNodeGroup.SlurmConfigurationProperty slurmConfiguration)	Additional options related to the Slurm scheduler.
CfnComputeNodeGroup.Builder	spotOptions(IResolvable spotOptions)	Additional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action.
CfnComputeNodeGroup.Builder	spotOptions(CfnComputeNodeGroup.SpotOptionsProperty spotOptions)	Additional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action.
CfnComputeNodeGroup.Builder	subnetIds(List<String> subnetIds)	The list of subnet IDs where instances are provisioned by the compute node group.
CfnComputeNodeGroup.Builder	tags(Map<String,String> tags)	1 or more tags added to the resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnComputeNodeGroup.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnComputeNodeGroup.Builder.

clusterId

@Stability(Stable)
public CfnComputeNodeGroup.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-clusterid

customLaunchTemplate

@Stability(Stable)
public CfnComputeNodeGroup.Builder customLaunchTemplate(IResolvable customLaunchTemplate)

An Amazon EC2 launch template AWS PCS uses to launch compute nodes.

Parameters:

customLaunchTemplate - An Amazon EC2 launch template AWS PCS uses to launch compute nodes. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-customlaunchtemplate

customLaunchTemplate

@Stability(Stable)
public CfnComputeNodeGroup.Builder customLaunchTemplate(CfnComputeNodeGroup.CustomLaunchTemplateProperty customLaunchTemplate)

An Amazon EC2 launch template AWS PCS uses to launch compute nodes.

Parameters:

customLaunchTemplate - An Amazon EC2 launch template AWS PCS uses to launch compute nodes. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-customlaunchtemplate

iamInstanceProfileArn

@Stability(Stable)
public CfnComputeNodeGroup.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 AWS PCS in the AWS 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-iaminstanceprofilearn

instanceConfigs

@Stability(Stable)
public CfnComputeNodeGroup.Builder instanceConfigs(IResolvable instanceConfigs)

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

Parameters:

instanceConfigs - A list of EC2 instance configurations that AWS PCS can provision in the compute node group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-instanceconfigs

instanceConfigs

@Stability(Stable)
public CfnComputeNodeGroup.Builder instanceConfigs(List<? extends Object> instanceConfigs)

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

Parameters:

instanceConfigs - A list of EC2 instance configurations that AWS PCS can provision in the compute node group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-instanceconfigs

scalingConfiguration

@Stability(Stable)
public CfnComputeNodeGroup.Builder scalingConfiguration(IResolvable scalingConfiguration)

Specifies the boundaries of the compute node group auto scaling.

Parameters:

scalingConfiguration - Specifies the boundaries of the compute node group auto scaling. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-scalingconfiguration

scalingConfiguration

@Stability(Stable)
public CfnComputeNodeGroup.Builder scalingConfiguration(CfnComputeNodeGroup.ScalingConfigurationProperty scalingConfiguration)

Specifies the boundaries of the compute node group auto scaling.

Parameters:

scalingConfiguration - Specifies the boundaries of the compute node group auto scaling. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-scalingconfiguration

subnetIds

@Stability(Stable)
public CfnComputeNodeGroup.Builder subnetIds(List<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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-subnetids

amiId

@Stability(Stable)
public CfnComputeNodeGroup.Builder amiId(String amiId)

The ID of the Amazon Machine Image (AMI) that AWS PCS uses to launch instances.

If not provided, AWS PCS uses the AMI ID specified in the custom launch template.

Parameters:

amiId - The ID of the Amazon Machine Image (AMI) that AWS PCS uses to launch instances. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-amiid

name

@Stability(Stable)
public CfnComputeNodeGroup.Builder name(String name)

The name that identifies the compute node group.

Parameters:

name - The name that identifies the compute node group. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-name

purchaseOption

@Stability(Stable)
public CfnComputeNodeGroup.Builder purchaseOption(String purchaseOption)

Specifies how EC2 instances are purchased on your behalf.

AWS PCS supports On-Demand Instances, Spot Instances, 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 AWS PCS support for Capacity Blocks, see Using Amazon EC2 Capacity Blocks for ML with AWS PCS in the AWS PCS 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-purchaseoption

slurmConfiguration

@Stability(Stable)
public CfnComputeNodeGroup.Builder slurmConfiguration(IResolvable slurmConfiguration)

Additional options related to the Slurm scheduler.

Parameters:

slurmConfiguration - Additional options related to the Slurm scheduler. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-slurmconfiguration

slurmConfiguration

@Stability(Stable)
public CfnComputeNodeGroup.Builder slurmConfiguration(CfnComputeNodeGroup.SlurmConfigurationProperty slurmConfiguration)

Additional options related to the Slurm scheduler.

Parameters:

slurmConfiguration - Additional options related to the Slurm scheduler. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-slurmconfiguration

spotOptions

@Stability(Stable)
public CfnComputeNodeGroup.Builder spotOptions(IResolvable spotOptions)

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

Parameters:

spotOptions - Additional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-spotoptions

spotOptions

@Stability(Stable)
public CfnComputeNodeGroup.Builder spotOptions(CfnComputeNodeGroup.SpotOptionsProperty spotOptions)

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

Parameters:

spotOptions - Additional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-spotoptions

tags

@Stability(Stable)
public CfnComputeNodeGroup.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html#cfn-pcs-computenodegroup-tags

build

@Stability(Stable)
public CfnComputeNodeGroup build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnComputeNodeGroup>

Returns:

a newly built instance of CfnComputeNodeGroup.