View a markdown version of this page

Provider stack hosted by Amazon ParallelCluster - Amazon ParallelCluster
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Provider stack hosted by Amazon ParallelCluster

The custom resource provider stack is formatted as shown in the following CloudFormation template snippet:

PclusterClusterProvider:
  Type: AWS::CloudFormation::Stack
  Properties:
    Parameters:
      CustomLambdaRole: # (Optional) RoleARN to override default
      AdditionalIamPolicies: # (Optional) comma-separated list of IAM policies to add
    TemplateURL: !Sub
      - https://${AWS::Region}-aws-parallelcluster.s3.${AWS::Region}.${AWS::URLSuffix}/parallelcluster/${Version}/templates/custom_resource/cluster.yaml
      - { Version: 3.15.1 }
Properties:
Parameters:
CustomLambdaRole (optional):

A custom role with permissions to run the Amazon Lambda that creates and manages the cluster. By default, the role uses the same policies defined by default in the Amazon ParallelCluster documentation.

AdditionalIamPolicies (optional):

A comma-separated list of additional IAM Policy Amazon Resource Names (ARNs) to add to the role that the Lambda uses. This is only used if a CustomLambdaRole isn't specified and can be kept blank.

If you need additional policies for the head node, compute nodes, or for access to an Amazon S3 bucket, add them to the CustomLambdaRole or AdditionalIamPolicy property.

If you need to attach additional policies to the head node, you must also grant the necessary permissions to attach or detach those policies to the IAM role associated with the head node. Specifically, you'll need to attach the "iam:AttachRolePolicy" and "iam:DetachRolePolicy" permissions (or their equivalent in a managed policy) to the IAM role used by the head node. For more information, see Amazon ParallelCluster user example policies for managing IAM resources.

For more information about the default policies, see Amazon Identity and Access Management permissions in Amazon ParallelCluster.

TemplateURL (required):

The Amazon ParallelCluster custom resource file URL.

Outputs:
ServiceToken:

A value that can be used as a custom resource ServiceToken property. A custom resource ServiceToken specifies where Amazon CloudFormation sends requests. This is a required input for a cluster resource that you include in your Amazon CloudFormation template.

LogGroupArn:

The ARN of the CloudWatch LogGroup that the underlying resource logs to.

LambdaLayerArn:

The ARN of the Lambda layer that's used for running Amazon ParallelCluster operations.