Interface ICfnComputeNodeGroupProps

Properties for defining a CfnComputeNodeGroup.

Namespace: Amazon.CDK.AwsPcs
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnComputeNodeGroupProps
Syntax (vb)
Public Interface ICfnComputeNodeGroupProps
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Aws_pcs;

var cfnComputeNodeGroupProps = new CfnComputeNodeGroupProps {
    ClusterId = "clusterId",
    CustomLaunchTemplate = new CustomLaunchTemplateProperty {
        Id = "id",
        Version = "version"
    },
    IamInstanceProfileArn = "iamInstanceProfileArn",
    InstanceConfigs = new [] { new InstanceConfigProperty {
        InstanceType = "instanceType"
    } },
    ScalingConfiguration = new ScalingConfigurationProperty {
        MaxInstanceCount = 123,
        MinInstanceCount = 123
    },
    SubnetIds = new [] { "subnetIds" },

    // the properties below are optional
    AmiId = "amiId",
    Name = "name",
    PurchaseOption = "purchaseOption",
    SlurmConfiguration = new SlurmConfigurationProperty {
        SlurmCustomSettings = new [] { new SlurmCustomSettingProperty {
            ParameterName = "parameterName",
            ParameterValue = "parameterValue"
        } }
    },
    SpotOptions = new SpotOptionsProperty {
        AllocationStrategy = "allocationStrategy"
    },
    Tags = new Dictionary<string, string> {
        { "tagsKey", "tags" }
    }
};

Synopsis

Properties

AmiId

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

The ID of the cluster of the compute node group.
CustomLaunchTemplate

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

The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances.
InstanceConfigs

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

The name that identifies the compute node group.
PurchaseOption

Specifies how EC2 instances are purchased on your behalf.
ScalingConfiguration

Specifies the boundaries of the compute node group auto scaling.
SlurmConfiguration

Additional options related to the Slurm scheduler.
SpotOptions

Additional configuration when you specify SPOT as the purchaseOption .
SubnetIds

The list of subnet IDs where instances are provisioned by the compute node group.
Tags

1 or more tags added to the resource.

Properties

AmiId

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

virtual string AmiId { get; }
Property Value

System.String

Remarks

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

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

ClusterId

The ID of the cluster of the compute node group.

string ClusterId { get; }
Property Value

System.String

Remarks

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

CustomLaunchTemplate

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

object CustomLaunchTemplate { get; }
Property Value

System.Object

Remarks

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

IamInstanceProfileArn

The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances.

string IamInstanceProfileArn { get; }
Property Value

System.String

Remarks

The role contained in your instance profile must have pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances correctly.

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

InstanceConfigs

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

object InstanceConfigs { get; }
Property Value

System.Object

Remarks

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

Name

The name that identifies the compute node group.

virtual string Name { get; }
Property Value

System.String

Remarks

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

PurchaseOption

Specifies how EC2 instances are purchased on your behalf.

virtual string PurchaseOption { get; }
Property Value

System.String

Remarks

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

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

ScalingConfiguration

Specifies the boundaries of the compute node group auto scaling.

object ScalingConfiguration { get; }
Property Value

System.Object

Remarks

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

SlurmConfiguration

Additional options related to the Slurm scheduler.

virtual object SlurmConfiguration { get; }
Property Value

System.Object

Remarks

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

SpotOptions

Additional configuration when you specify SPOT as the purchaseOption .

virtual object SpotOptions { get; }
Property Value

System.Object

Remarks

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

SubnetIds

The list of subnet IDs where instances are provisioned by the compute node group.

string[] SubnetIds { get; }
Property Value

System.String[]

Remarks

The subnets must be in the same VPC as the cluster.

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

Tags

1 or more tags added to the resource.

virtual IDictionary<string, string> Tags { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.String>

Remarks

Each tag consists of a tag key and tag value. The tag value is optional and can be an empty string.

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