CfnComputeNodeGroup

class aws_cdk.aws_pcs.CfnComputeNodeGroup(scope, id, *, cluster_id, custom_launch_template, iam_instance_profile_arn, instance_configs, scaling_configuration, subnet_ids, ami_id=None, name=None, purchase_option=None, slurm_configuration=None, spot_options=None, tags=None)

Bases: CfnResource

The AWS::PCS::ComputeNodeGroup resource creates an AWS PCS compute node group.

See:

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

CloudformationResource:

AWS::PCS::ComputeNodeGroup

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_compute_node_group = pcs.CfnComputeNodeGroup(self, "MyCfnComputeNodeGroup",
    cluster_id="clusterId",
    custom_launch_template=pcs.CfnComputeNodeGroup.CustomLaunchTemplateProperty(
        version="version",

        # the properties below are optional
        template_id="templateId"
    ),
    iam_instance_profile_arn="iamInstanceProfileArn",
    instance_configs=[pcs.CfnComputeNodeGroup.InstanceConfigProperty(
        instance_type="instanceType"
    )],
    scaling_configuration=pcs.CfnComputeNodeGroup.ScalingConfigurationProperty(
        max_instance_count=123,
        min_instance_count=123
    ),
    subnet_ids=["subnetIds"],

    # the properties below are optional
    ami_id="amiId",
    name="name",
    purchase_option="purchaseOption",
    slurm_configuration=pcs.CfnComputeNodeGroup.SlurmConfigurationProperty(
        slurm_custom_settings=[pcs.CfnComputeNodeGroup.SlurmCustomSettingProperty(
            parameter_name="parameterName",
            parameter_value="parameterValue"
        )]
    ),
    spot_options=pcs.CfnComputeNodeGroup.SpotOptionsProperty(
        allocation_strategy="allocationStrategy"
    ),
    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).

  • cluster_id (str) – The ID of the cluster of the compute node group.

  • custom_launch_template (Union[IResolvable, CustomLaunchTemplateProperty, Dict[str, Any]]) – An Amazon EC2 launch template AWS PCS uses to launch compute nodes.

  • iam_instance_profile_arn (str) – The Amazon Resource Name (ARN) of the IAM instance profile used to pass an IAM role when launching EC2 instances. The role contained in your instance profile must have pcs:RegisterComputeNodeGroupInstance permissions attached to provision instances correctly.

  • instance_configs (Union[IResolvable, Sequence[Union[IResolvable, InstanceConfigProperty, Dict[str, Any]]]]) – A list of EC2 instance configurations that AWS PCS can provision in the compute node group.

  • scaling_configuration (Union[IResolvable, ScalingConfigurationProperty, Dict[str, Any]]) – Specifies the boundaries of the compute node group auto scaling.

  • subnet_ids (Sequence[str]) – The list of subnet IDs where instances are provisioned by the compute node group. The subnets must be in the same VPC as the cluster.

  • ami_id (Optional[str]) – The ID of the Amazon Machine Image (AMI) that AWS PCS uses to launch instances. If not provided, AWS PCS uses the AMI ID specified in the custom launch template.

  • name (Optional[str]) – The name that identifies the compute node group.

  • purchase_option (Optional[str]) – Specifies how EC2 instances are purchased on your behalf. 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.

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

  • spot_options (Union[IResolvable, SpotOptionsProperty, Dict[str, Any], None]) – Additional configuration when you specify SPOT as the purchaseOption .

  • 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:
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::ComputeNodeGroup'
ami_id

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

attr_arn

The unique Amazon Resource Name (ARN) of the compute node group.

CloudformationAttribute:

Arn

attr_error_info

The list of errors that occurred during compute node group provisioning.

CloudformationAttribute:

ErrorInfo

attr_id

The generated unique ID of the compute node group.

CloudformationAttribute:

Id

attr_status

The provisioning status of the compute node group.

The provisioning status doesn’t indicate the overall health of the compute node group.

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_id

The ID of the cluster of the compute node group.

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.

custom_launch_template

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

iam_instance_profile_arn

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

instance_configs

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

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 compute node group.

node

The tree node.

purchase_option

Specifies how EC2 instances are purchased on your behalf.

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 }).

scaling_configuration

Specifies the boundaries of the compute node group auto scaling.

slurm_configuration

Additional options related to the Slurm scheduler.

spot_options

Additional configuration when you specify SPOT as the purchaseOption .

stack

The stack in which this element is defined.

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

subnet_ids

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

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.

CustomLaunchTemplateProperty

class CfnComputeNodeGroup.CustomLaunchTemplateProperty(*, version, template_id=None)

Bases: object

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

Parameters:

  • version (str) – The version of the EC2 launch template to use to provision instances.

  • template_id (Optional[str]) – The ID of the EC2 launch template to use to provision instances.

See:

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

custom_launch_template_property = pcs.CfnComputeNodeGroup.CustomLaunchTemplateProperty(
    version="version",

    # the properties below are optional
    template_id="templateId"
)

Attributes

template_id

The ID of the EC2 launch template to use to provision instances.

See:

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

version

The version of the EC2 launch template to use to provision instances.

See:

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

ErrorInfoProperty

class CfnComputeNodeGroup.ErrorInfoProperty(*, code=None, message=None)

Bases: object

The list of errors that occurred during compute node group provisioning.

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-computenodegroup-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.CfnComputeNodeGroup.ErrorInfoProperty(
    code="code",
    message="message"
)

Attributes

code

The short-form error code.

See:

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

message

The detailed error information.

See:

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

InstanceConfigProperty

class CfnComputeNodeGroup.InstanceConfigProperty(*, instance_type=None)

Bases: object

An EC2 instance configuration AWS PCS uses to launch compute nodes.

Parameters:

instance_type (Optional[str]) – The EC2 instance type that AWS PCS can provision in the compute node group. Example: t2.xlarge

See:

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

instance_config_property = pcs.CfnComputeNodeGroup.InstanceConfigProperty(
    instance_type="instanceType"
)

Attributes

instance_type

The EC2 instance type that AWS PCS can provision in the compute node group.

Example: t2.xlarge

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-instanceconfig.html#cfn-pcs-computenodegroup-instanceconfig-instancetype

ScalingConfigurationProperty

class CfnComputeNodeGroup.ScalingConfigurationProperty(*, max_instance_count, min_instance_count)

Bases: object

Specifies the boundaries of the compute node group auto scaling.

Parameters:

  • max_instance_count (Union[int, float]) – The upper bound of the number of instances allowed in the compute fleet.

  • min_instance_count (Union[int, float]) – The lower bound of the number of instances allowed in the compute fleet.

See:

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

scaling_configuration_property = pcs.CfnComputeNodeGroup.ScalingConfigurationProperty(
    max_instance_count=123,
    min_instance_count=123
)

Attributes

max_instance_count

The upper bound of the number of instances allowed in the compute fleet.

See:

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

min_instance_count

The lower bound of the number of instances allowed in the compute fleet.

See:

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

SlurmConfigurationProperty

class CfnComputeNodeGroup.SlurmConfigurationProperty(*, slurm_custom_settings=None)

Bases: object

Additional options related to the Slurm scheduler.

Parameters:

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-computenodegroup-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.CfnComputeNodeGroup.SlurmConfigurationProperty(
    slurm_custom_settings=[pcs.CfnComputeNodeGroup.SlurmCustomSettingProperty(
        parameter_name="parameterName",
        parameter_value="parameterValue"
    )]
)

Attributes

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-computenodegroup-slurmconfiguration.html#cfn-pcs-computenodegroup-slurmconfiguration-slurmcustomsettings

SlurmCustomSettingProperty

class CfnComputeNodeGroup.SlurmCustomSettingProperty(*, parameter_name, parameter_value)

Bases: object

Additional settings that directly map to Slurm settings.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pcs-computenodegroup-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.CfnComputeNodeGroup.SlurmCustomSettingProperty(
    parameter_name="parameterName",
    parameter_value="parameterValue"
)

Attributes

parameter_name

.

See:

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

Type:

AWS PCS supports configuration of the following Slurm parameters

parameter_value

The values for the configured Slurm settings.

See:

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

SpotOptionsProperty

class CfnComputeNodeGroup.SpotOptionsProperty(*, allocation_strategy=None)

Bases: object

Additional configuration when you specify SPOT as the purchaseOption .

Parameters:

allocation_strategy (Optional[str]) – The Amazon EC2 allocation strategy AWS PCS uses to provision EC2 instances. AWS PCS supports lowest price, capacity optimized, and price capacity optimized. If you don’t provide this option, it defaults to price capacity optimized.

See:

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

spot_options_property = pcs.CfnComputeNodeGroup.SpotOptionsProperty(
    allocation_strategy="allocationStrategy"
)

Attributes

allocation_strategy

The Amazon EC2 allocation strategy AWS PCS uses to provision EC2 instances.

AWS PCS supports lowest price, capacity optimized, and price capacity optimized. If you don’t provide this option, it defaults to price capacity optimized.

See:

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