CfnCluster

class aws_cdk.aws_pcs.CfnCluster(scope, id, *, networking, scheduler, size, name=None, slurm_configuration=None, tags=None)

Bases: CfnResource

Creates an AWS PCS cluster resource.

For more information, see Creating a cluster in AWS Parallel Computing Service in the AWS PCS User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-cluster.html
CloudformationResource:: AWS::PCS::Cluster
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 = pcs.CfnCluster(self, "MyCfnCluster",
    networking=pcs.CfnCluster.NetworkingProperty(
        network_type="networkType",
        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(
        accounting=pcs.CfnCluster.AccountingProperty(
            mode="mode",

            # the properties below are optional
            default_purge_time_in_days=123
        ),
        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"
    }
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
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. - SMALL : 32 compute nodes and 256 jobs - MEDIUM : 512 compute nodes and 8192 jobs - LARGE : 2048 compute nodes and 16,384 jobs
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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:: target (CfnResource)
Deprecated:: use addDependency
Stability:: deprecated
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::PCS::Cluster'

attr_arn

The unique Amazon Resource Name (ARN) of the cluster.

CloudformationAttribute:: Arn

attr_endpoints

The list of endpoints available for interaction with the scheduler.

CloudformationAttribute:: Endpoints

attr_error_info

The list of errors that occurred during cluster provisioning.

CloudformationAttribute:: ErrorInfo

attr_id

The generated unique ID of the cluster.

CloudformationAttribute:: Id

attr_status

The provisioning status of the cluster.

The provisioning status doesn’t indicate the overall health of the cluster. > The resource enters the SUSPENDING and SUSPENDED states when the scheduler is beyond end of life and we have suspended the cluster. When in these states, you can’t use the cluster. The cluster controller is down and all compute instances are terminated. The resources still count toward your service quotas. You can delete a resource if its status is SUSPENDED . For more information, see Frequently asked questions about Slurm versions in AWS PCS in the AWS PCS User Guide .

CloudformationAttribute:: Status

cdk_tag_manager: Tag Manager which manages the tags for this resource.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

cluster_ref: A reference to a Cluster resource.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name: The name that identifies the cluster.

networking: The networking configuration for the cluster’s control plane.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

scheduler: The cluster management and job scheduling software associated with the cluster.

size: The size of the cluster.

slurm_configuration: Additional options related to the Slurm scheduler.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: 1 or more tags added to the resource.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:: x (Any)
Return type:: bool
Returns:: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:: x (Any)
Return type:: bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

AccountingProperty

class CfnCluster.AccountingProperty(*, mode, default_purge_time_in_days=None)

Bases: object

The accounting configuration includes configurable settings for Slurm accounting.

Parameters:

mode (str) – The default value for mode is STANDARD . A value of STANDARD means Slurm accounting is enabled. Default: - “NONE”
default_purge_time_in_days (Union[int, float, None]) – The default value for all purge settings for slurmdbd.conf . For more information, see the slurmdbd.conf documentation at SchedMD . The default value for defaultPurgeTimeInDays is -1 . A value of -1 means there is no purge time and records persist as long as the cluster exists. .. epigraph:: 0 isn’t a valid value. Default: - -1

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-accounting.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

accounting_property = pcs.CfnCluster.AccountingProperty(
    mode="mode",

    # the properties below are optional
    default_purge_time_in_days=123
)

Attributes

default_purge_time_in_days

The default value for all purge settings for slurmdbd.conf . For more information, see the slurmdbd.conf documentation at SchedMD .

The default value for defaultPurgeTimeInDays is -1 .

A value of -1 means there is no purge time and records persist as long as the cluster exists. .. epigraph:

``0`` isn't a valid value.

Default:

-1

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-accounting.html#cfn-pcs-cluster-accounting-defaultpurgetimeindays

mode

The default value for mode is STANDARD .

A value of STANDARD means Slurm accounting is enabled.

Default:

“NONE”

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-accounting.html#cfn-pcs-cluster-accounting-mode

AuthKeyProperty

class CfnCluster.AuthKeyProperty(*, secret_arn, secret_version)

Bases: object

The shared Slurm key for authentication, also known as the cluster secret .

Parameters:

secret_arn (str) – The Amazon Resource Name (ARN) of the shared Slurm key.
secret_version (str) – The version of the shared Slurm key.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-authkey.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

auth_key_property = pcs.CfnCluster.AuthKeyProperty(
    secret_arn="secretArn",
    secret_version="secretVersion"
)

Attributes

secret_arn

The Amazon Resource Name (ARN) of the shared Slurm key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-authkey.html#cfn-pcs-cluster-authkey-secretarn

secret_version

The version of the shared Slurm key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-authkey.html#cfn-pcs-cluster-authkey-secretversion

EndpointProperty

class CfnCluster.EndpointProperty(*, port, private_ip_address, type, ipv6_address=None, public_ip_address=None)

Bases: object

An endpoint available for interaction with the scheduler.

Parameters:

port (str) – The endpoint’s connection port number. Example: 1234
private_ip_address (str) – For clusters that use IPv4, this is the endpoint’s private IP address. Example: 10.1.2.3 For clusters configured to use IPv6, this is an empty string.
type (str) – Indicates the type of endpoint running at the specific IP address.
ipv6_address (Optional[str]) – The endpoint’s IPv6 address. Example: 2001:db8::1
public_ip_address (Optional[str]) – The endpoint’s public IP address. Example: 192.0.2.1

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-endpoint.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

endpoint_property = pcs.CfnCluster.EndpointProperty(
    port="port",
    private_ip_address="privateIpAddress",
    type="type",

    # the properties below are optional
    ipv6_address="ipv6Address",
    public_ip_address="publicIpAddress"
)

Attributes

ipv6_address

The endpoint’s IPv6 address.

Example: 2001:db8::1

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-endpoint.html#cfn-pcs-cluster-endpoint-ipv6address

port

The endpoint’s connection port number.

Example: 1234

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-endpoint.html#cfn-pcs-cluster-endpoint-port

private_ip_address

For clusters that use IPv4, this is the endpoint’s private IP address.

Example: 10.1.2.3

For clusters configured to use IPv6, this is an empty string.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-endpoint.html#cfn-pcs-cluster-endpoint-privateipaddress

public_ip_address

The endpoint’s public IP address.

Example: 192.0.2.1

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-endpoint.html#cfn-pcs-cluster-endpoint-publicipaddress

type

Indicates the type of endpoint running at the specific IP address.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-endpoint.html#cfn-pcs-cluster-endpoint-type

ErrorInfoProperty

class CfnCluster.ErrorInfoProperty(*, code=None, message=None)

Bases: object

An error that occurred during resource creation.

Parameters:

code (Optional[str]) – The short-form error code.
message (Optional[str]) – The detailed error information.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-errorinfo.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

error_info_property = pcs.CfnCluster.ErrorInfoProperty(
    code="code",
    message="message"
)

Attributes

code

The short-form error code.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-errorinfo.html#cfn-pcs-cluster-errorinfo-code

message

The detailed error information.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-errorinfo.html#cfn-pcs-cluster-errorinfo-message

NetworkingProperty

class CfnCluster.NetworkingProperty(*, network_type=None, security_group_ids=None, subnet_ids=None)

Bases: object

The networking configuration for the cluster’s control plane.

Parameters:

network_type (Optional[str]) – The IP address version the cluster uses. The default is IPV4 .
security_group_ids (Optional[Sequence[str]]) – The list of security group IDs associated with the Elastic Network Interface (ENI) created in subnets. The following rules are required: - Inbound rule 1 - Protocol: All - Ports: All - Source: Self - Outbound rule 1 - Protocol: All - Ports: All - Destination: 0.0.0.0/0 (IPv4) or ::/0 (IPv6) - Outbound rule 2 - Protocol: All - Ports: All - Destination: Self
subnet_ids (Optional[Sequence[str]]) – The ID of the subnet where AWS PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and AWS PCS resources. The subnet must have an available IP address, cannot reside in AWS Outposts , AWS Wavelength , or an AWS Local Zone. Example: subnet-abcd1234

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-networking.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

networking_property = pcs.CfnCluster.NetworkingProperty(
    network_type="networkType",
    security_group_ids=["securityGroupIds"],
    subnet_ids=["subnetIds"]
)

Attributes

network_type

The IP address version the cluster uses.

The default is IPV4 .

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

security_group_ids

The list of security group IDs associated with the Elastic Network Interface (ENI) created in subnets.

The following rules are required:

Inbound rule 1
Protocol: All
Ports: All
Source: Self
Outbound rule 1
Protocol: All
Ports: All
Destination: 0.0.0.0/0 (IPv4) or ::/0 (IPv6)
Outbound rule 2
Protocol: All
Ports: All
Destination: Self

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

subnet_ids

The ID of the subnet where AWS PCS creates an Elastic Network Interface (ENI) to enable communication between managed controllers and AWS PCS resources.

The subnet must have an available IP address, cannot reside in AWS Outposts , AWS Wavelength , or an AWS Local Zone.

Example: subnet-abcd1234

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

SchedulerProperty

class CfnCluster.SchedulerProperty(*, type, version)

Bases: object

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

Parameters:

type (str) – The software AWS PCS uses to manage cluster scaling and job scheduling.
version (str) – The version of the specified scheduling software that AWS PCS uses to manage cluster scaling and job scheduling. For more information, see Slurm versions in AWS PCS in the AWS PCS User Guide . Valid Values: 23.11 | 24.05 | 24.11

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-scheduler.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

scheduler_property = pcs.CfnCluster.SchedulerProperty(
    type="type",
    version="version"
)

Attributes

type

The software AWS PCS uses to manage cluster scaling and job scheduling.

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

version

The version of the specified scheduling software that AWS PCS uses to manage cluster scaling and job scheduling.

For more information, see Slurm versions in AWS PCS in the AWS PCS User Guide .

Valid Values: 23.11 | 24.05 | 24.11

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

SlurmConfigurationProperty

class CfnCluster.SlurmConfigurationProperty(*, accounting=None, auth_key=None, scale_down_idle_time_in_seconds=None, slurm_custom_settings=None)

Bases: object

Additional options related to the Slurm scheduler.

Parameters:

accounting (Union[IResolvable, AccountingProperty, Dict[str, Any], None]) – The accounting configuration includes configurable settings for Slurm accounting.
auth_key (Union[IResolvable, AuthKeyProperty, Dict[str, Any], None]) – The shared Slurm key for authentication, also known as the cluster secret .
scale_down_idle_time_in_seconds (Union[int, float, None]) – The time (in seconds) before an idle node is scaled down. Default: 600
slurm_custom_settings (Union[IResolvable, Sequence[Union[IResolvable, SlurmCustomSettingProperty, Dict[str, Any]]], None]) – Additional Slurm-specific configuration that directly maps to Slurm settings.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmconfiguration.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

slurm_configuration_property = pcs.CfnCluster.SlurmConfigurationProperty(
    accounting=pcs.CfnCluster.AccountingProperty(
        mode="mode",

        # the properties below are optional
        default_purge_time_in_days=123
    ),
    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"
    )]
)

Attributes

accounting

The accounting configuration includes configurable settings for Slurm accounting.

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

auth_key

The shared Slurm key for authentication, also known as the cluster secret .

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

scale_down_idle_time_in_seconds

The time (in seconds) before an idle node is scaled down.

Default: 600

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

slurm_custom_settings

Additional Slurm-specific configuration that directly maps to Slurm settings.

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

SlurmCustomSettingProperty

class CfnCluster.SlurmCustomSettingProperty(*, parameter_name, parameter_value)

Bases: object

Additional settings that directly map to Slurm settings.

AWS PCS supports a subset of Slurm settings. For more information, see Configuring custom Slurm settings in AWS PCS in the AWS PCS User Guide .

Parameters:

parameter_name (str) –
AWS PCS supports custom Slurm settings for clusters, compute node groups, and queues. For more information, see Configuring custom Slurm settings in AWS PCS in the AWS PCS User Guide .
parameter_value (str) – The values for the configured Slurm settings.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmcustomsetting.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

slurm_custom_setting_property = pcs.CfnCluster.SlurmCustomSettingProperty(
    parameter_name="parameterName",
    parameter_value="parameterValue"
)

Attributes

parameter_name

AWS PCS supports custom Slurm settings for clusters, compute node groups, and queues.

For more information, see Configuring custom Slurm settings in AWS PCS in the AWS PCS User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmcustomsetting.html#cfn-pcs-cluster-slurmcustomsetting-parametername

parameter_value

The values for the configured Slurm settings.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-cluster-slurmcustomsetting.html#cfn-pcs-cluster-slurmcustomsetting-parametervalue