CfnClusterProps

class aws_cdk.aws_pcs.CfnClusterProps(*, networking, scheduler, size, name=None, slurm_configuration=None, tags=None)

Bases: object

Properties for defining a CfnCluster.

Parameters:
  • networking (Union[IResolvable, NetworkingProperty, Dict[str, Any]]) – The networking configuration for the cluster’s control plane.

  • scheduler (Union[IResolvable, SchedulerProperty, Dict[str, Any]]) – The cluster management and job scheduling software associated with the cluster.

  • size (str) – The size of the cluster.

  • name (Optional[str]) – The name that identifies the cluster.

  • slurm_configuration (Union[IResolvable, SlurmConfigurationProperty, Dict[str, Any], None]) – Additional options related to the Slurm scheduler.

  • tags (Optional[Mapping[str, str]]) – 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:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_pcs as pcs

cfn_cluster_props = pcs.CfnClusterProps(
    networking=pcs.CfnCluster.NetworkingProperty(
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    ),
    scheduler=pcs.CfnCluster.SchedulerProperty(
        type="type",
        version="version"
    ),
    size="size",

    # the properties below are optional
    name="name",
    slurm_configuration=pcs.CfnCluster.SlurmConfigurationProperty(
        auth_key=pcs.CfnCluster.AuthKeyProperty(
            secret_arn="secretArn",
            secret_version="secretVersion"
        ),
        scale_down_idle_time_in_seconds=123,
        slurm_custom_settings=[pcs.CfnCluster.SlurmCustomSettingProperty(
            parameter_name="parameterName",
            parameter_value="parameterValue"
        )]
    ),
    tags={
        "tags_key": "tags"
    }
)

Attributes

name

The name that identifies the cluster.

See:

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

networking

The networking configuration for the cluster’s control plane.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-cluster.html#cfn-pcs-cluster-networking

scheduler

The cluster management and job scheduling software associated with the cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-cluster.html#cfn-pcs-cluster-scheduler

size

The size of the cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-cluster.html#cfn-pcs-cluster-size

slurm_configuration

Additional options related to the Slurm scheduler.

See:

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

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.

See:

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