Skip to content
v2.274.0

CfnClusterProps Struct ​

Properties for defining a CfnCluster.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_pcs as pcs } from 'aws-cdk-lib';
const cfnClusterProps: pcs.CfnClusterProps = {
  networking: {
    networkType: 'networkType',
    securityGroupIds: ['securityGroupIds'],
    subnetIds: ['subnetIds'],
  },
  scheduler: {
    type: 'type',
    version: 'version',
  },
  size: 'size',

  // the properties below are optional
  name: 'name',
  slurmConfiguration: {
    accounting: {
      mode: 'mode',

      // the properties below are optional
      defaultPurgeTimeInDays: 123,
    },
    authKey: {
      secretArn: 'secretArn',
      secretVersion: 'secretVersion',
    },
    cgroupCustomSettings: [{
      parameterName: 'parameterName',
      parameterValue: 'parameterValue',
    }],
    jwtAuth: {
      jwtKey: {
        secretArn: 'secretArn',
        secretVersion: 'secretVersion',
      },
    },
    scaleDownIdleTimeInSeconds: 123,
    slurmCustomSettings: [{
      parameterName: 'parameterName',
      parameterValue: 'parameterValue',
    }],
    slurmdbdCustomSettings: [{
      parameterName: 'parameterName',
      parameterValue: 'parameterValue',
    }],
    slurmRest: {
      mode: 'mode',
    },
  },
  tags: {
    tagsKey: 'tags',
  },
};

Properties ​

nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
The name that identifies the cluster.
networkingIResolvable | CfnCluster.NetworkingPropertynetworkingtyping.Union[IResolvable, NetworkingProperty]networkingIResolvableNetworkingIResolvableNetworkinginterface{}required#
The networking configuration for the cluster's control plane.
schedulerIResolvable | CfnCluster.SchedulerPropertyschedulertyping.Union[IResolvable, SchedulerProperty]schedulerIResolvableSchedulerIResolvableSchedulerinterface{}required#
The cluster management and job scheduling software associated with the cluster.
sizestringsizestrsizeStringSizestringSize*stringrequired#
The size of the cluster.
  • SMALL : 32 compute nodes and 256 jobs
  • MEDIUM : 512 compute nodes and 8192 jobs
  • LARGE : 2048 compute nodes and 16,384 jobs
slurmConfigurationoptionalIResolvable | CfnCluster.SlurmConfigurationPropertyslurm_configurationoptionaltyping.Union[IResolvable, SlurmConfigurationProperty]slurmConfigurationoptionalIResolvableSlurmConfigurationoptionalIResolvableSlurmConfigurationoptionalinterface{}#
Additional options related to the Slurm scheduler.
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#
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.