2.237.1

interface CfnComputeNodeGroupMixinProps

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.PCS.Mixins.CfnComputeNodeGroupMixinProps
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awspcs/mixins#CfnComputeNodeGroupMixinProps
Javasoftware.amazon.awscdk.mixins.preview.services.pcs.mixins.CfnComputeNodeGroupMixinProps
Pythonaws_cdk.mixins_preview.aws_pcs.mixins.CfnComputeNodeGroupMixinProps
TypeScript @aws-cdk/mixins-preview » aws_pcs » mixins » CfnComputeNodeGroupMixinProps

Properties for CfnComputeNodeGroupPropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-computenodegroup.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as pcs_mixins } from '@aws-cdk/mixins-preview/aws-pcs';
const cfnComputeNodeGroupMixinProps: pcs_mixins.CfnComputeNodeGroupMixinProps = {
  amiId: 'amiId',
  clusterId: 'clusterId',
  customLaunchTemplate: {
    templateId: 'templateId',
    version: 'version',
  },
  iamInstanceProfileArn: 'iamInstanceProfileArn',
  instanceConfigs: [{
    instanceType: 'instanceType',
  }],
  name: 'name',
  purchaseOption: 'purchaseOption',
  scalingConfiguration: {
    maxInstanceCount: 123,
    minInstanceCount: 123,
  },
  slurmConfiguration: {
    slurmCustomSettings: [{
      parameterName: 'parameterName',
      parameterValue: 'parameterValue',
    }],
  },
  spotOptions: {
    allocationStrategy: 'allocationStrategy',
  },
  subnetIds: ['subnetIds'],
  tags: {
    tagsKey: 'tags',
  },
};

Properties

NameTypeDescription
amiId?stringThe ID of the Amazon Machine Image (AMI) that AWS PCS uses to launch instances.
clusterId?stringThe ID of the cluster of the compute node group.
customLaunchTemplate?IResolvable | CustomLaunchTemplatePropertyAn Amazon EC2 launch template AWS PCS uses to launch compute nodes.
iamInstanceProfileArn?stringThe Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances.
instanceConfigs?IResolvable | (IResolvable | InstanceConfigProperty)[]A list of EC2 instance configurations that AWS PCS can provision in the compute node group.
name?stringThe name that identifies the compute node group.
purchaseOption?stringSpecifies how EC2 instances are purchased on your behalf.
scalingConfiguration?IResolvable | ScalingConfigurationPropertySpecifies the boundaries of the compute node group auto scaling.
slurmConfiguration?IResolvable | SlurmConfigurationPropertyAdditional options related to the Slurm scheduler.
spotOptions?IResolvable | SpotOptionsPropertyAdditional configuration when you specify SPOT as the purchaseOption for the CreateComputeNodeGroup API action.
subnetIds?string[]The list of subnet IDs where instances are provisioned by the compute node group.
tags?{ [string]: string }1 or more tags added to the resource.

amiId?

Type: string (optional)

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.

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

clusterId?

Type: string (optional)

The ID of the cluster of the compute node group.

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

customLaunchTemplate?

Type: IResolvable | CustomLaunchTemplateProperty (optional)

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

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

iamInstanceProfileArn?

Type: string (optional)

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 .

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

instanceConfigs?

Type: IResolvable | (IResolvable | InstanceConfigProperty)[] (optional)

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

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

name?

Type: string (optional)

The name that identifies the compute node group.

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

purchaseOption?

Type: string (optional)

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.

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

scalingConfiguration?

Type: IResolvable | ScalingConfigurationProperty (optional)

Specifies the boundaries of the compute node group auto scaling.

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

slurmConfiguration?

Type: IResolvable | SlurmConfigurationProperty (optional)

Additional options related to the Slurm scheduler.

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

spotOptions?

Type: IResolvable | SpotOptionsProperty (optional)

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

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

subnetIds?

Type: string[] (optional)

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.

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

tags?

Type: { [string]: string } (optional)

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.

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

← PreviousNext →