CfnQueuePropsMixin

class aws_cdk.mixins_preview.aws_pcs.mixins.CfnQueuePropsMixin(props, *, strategy=None)

Bases: Mixin

Creates an AWS PCS queue resource.

For more information, see Creating a queue in AWS PCS in the AWS PCS User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pcs-queue.html
CloudformationResource:: AWS::PCS::Queue
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_pcs import mixins as pcs_mixins

cfn_queue_props_mixin = pcs_mixins.CfnQueuePropsMixin(pcs_mixins.CfnQueueMixinProps(
    cluster_id="clusterId",
    compute_node_group_configurations=[pcs_mixins.CfnQueuePropsMixin.ComputeNodeGroupConfigurationProperty(
        compute_node_group_id="computeNodeGroupId"
    )],
    name="name",
    slurm_configuration=pcs_mixins.CfnQueuePropsMixin.SlurmConfigurationProperty(
        slurm_custom_settings=[pcs_mixins.CfnQueuePropsMixin.SlurmCustomSettingProperty(
            parameter_name="parameterName",
            parameter_value="parameterValue"
        )]
    ),
    tags={
        "tags_key": "tags"
    }
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::PCS::Queue.

Parameters:

props (Union[CfnQueueMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['clusterId', 'computeNodeGroupConfigurations', 'name', 'slurmConfiguration', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

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

ComputeNodeGroupConfigurationProperty

class CfnQueuePropsMixin.ComputeNodeGroupConfigurationProperty(*, compute_node_group_id=None)

Bases: object

The compute node group configuration for a queue.

Parameters:: compute_node_group_id (Optional[str]) – The compute node group ID for the compute node group configuration.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-queue-computenodegroupconfiguration.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.mixins_preview.aws_pcs import mixins as pcs_mixins

compute_node_group_configuration_property = pcs_mixins.CfnQueuePropsMixin.ComputeNodeGroupConfigurationProperty(
    compute_node_group_id="computeNodeGroupId"
)

Attributes

compute_node_group_id

The compute node group ID for the compute node group configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-queue-computenodegroupconfiguration.html#cfn-pcs-queue-computenodegroupconfiguration-computenodegroupid

ErrorInfoProperty

class CfnQueuePropsMixin.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-queue-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.mixins_preview.aws_pcs import mixins as pcs_mixins

error_info_property = pcs_mixins.CfnQueuePropsMixin.ErrorInfoProperty(
    code="code",
    message="message"
)

Attributes

code

The short-form error code.

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

message

The detailed error information.

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

SlurmConfigurationProperty

class CfnQueuePropsMixin.SlurmConfigurationProperty(*, slurm_custom_settings=None)

Bases: object

The Slurm configuration for the queue.

Parameters:: slurm_custom_settings (Union[IResolvable, Sequence[Union[IResolvable, SlurmCustomSettingProperty, Dict[str, Any]]], None]) – Custom Slurm parameters that directly map to Slurm configuration settings.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-queue-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.mixins_preview.aws_pcs import mixins as pcs_mixins

slurm_configuration_property = pcs_mixins.CfnQueuePropsMixin.SlurmConfigurationProperty(
    slurm_custom_settings=[pcs_mixins.CfnQueuePropsMixin.SlurmCustomSettingProperty(
        parameter_name="parameterName",
        parameter_value="parameterValue"
    )]
)

Attributes

slurm_custom_settings

Custom Slurm parameters that directly map to Slurm configuration settings.

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

SlurmCustomSettingProperty

class CfnQueuePropsMixin.SlurmCustomSettingProperty(*, parameter_name=None, parameter_value=None)

Bases: object

Additional settings that directly map to Slurm settings.

Parameters:

parameter_name (Optional[str]) – AWS PCS supports configuration of the Slurm parameters for queues:.
parameter_value (Optional[str]) – The value for the configured Slurm setting.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-queue-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.mixins_preview.aws_pcs import mixins as pcs_mixins

slurm_custom_setting_property = pcs_mixins.CfnQueuePropsMixin.SlurmCustomSettingProperty(
    parameter_name="parameterName",
    parameter_value="parameterValue"
)

Attributes

parameter_name

.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-queue-slurmcustomsetting.html#cfn-pcs-queue-slurmcustomsetting-parametername
Type:: AWS PCS supports configuration of the Slurm parameters for queues

parameter_value

The value for the configured Slurm setting.

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