AWS parallelcluster documentation change
Summary
Improved grammar and clarity in API deployment documentation, including IAM permission explanations and parameter descriptions
Security assessment
Changes include grammatical fixes and clarification of existing security controls (like IAM admin privileges and API access policies) but do not introduce new security documentation or address specific vulnerabilities. The modifications improve accuracy of existing security documentation but don't indicate a security issue resolution.
Diff
diff --git a/parallelcluster/latest/ug/api-reference-deploy-v3.md b/parallelcluster/latest/ug/api-reference-deploy-v3.md index 9f2fc5c0d..001928087 100644 --- a//parallelcluster/latest/ug/api-reference-deploy-v3.md +++ b//parallelcluster/latest/ug/api-reference-deploy-v3.md @@ -31 +31 @@ You can customize the API deployment by using the AWS CloudFormation parameters -The following parameters optional: +The following parameters are optional: @@ -47 +47 @@ You can configure custom domain settings to enforce a minimum version of Transpo -When `EnableIamAdminAccess` is set to `true` the AWS ParallelCluster API is granted permissions to manage the creation of IAM roles required to deploy clusters or generating custom AMIs. +When `EnableIamAdminAccess` is set to `true` the AWS ParallelCluster API is granted permissions to manage the creation of IAM roles required to deploy clusters or generate custom AMIs. @@ -51 +51 @@ When `EnableIamAdminAccess` is set to `true` the AWS ParallelCluster API is gran -Setting this to true grants IAM admin privileges to the AWS Lambda function processing AWS ParallelCluster operations. +When this is set to true it grants IAM admin privileges to the AWS Lambda function processing AWS ParallelCluster operations. @@ -63 +63 @@ Refer to [PermissionsBoundary mode](./iam-roles-in-parallelcluster-v3.html#iam-r -When `CreateApiUserRole=true` access to the API endpoint is not restricted by Amazon API Gateway resource policies, all IAM roles having unconstrained `execute-api:Invoke` permission can access AWS ParallelCluster features. For more information, see [ Controlling access to an API with API Gateway resource policies](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-resource-policies.html) in the _API Gateway Developer Guide_. +When `CreateApiUserRole=true` access to the API endpoint is not restricted by Amazon API Gateway resource policies, all IAM roles that have unconstrained `execute-api:Invoke` permission can access AWS ParallelCluster features. For more information, see [ Controlling access to an API with API Gateway resource policies](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-resource-policies.html) in the _API Gateway Developer Guide_. @@ -69 +69 @@ The `ParallelClusterApiUserRole` has permission to invoke all AWS ParallelCluste - * **IAMRoleAndPolicyPrefix** \- This optional parameter accepts a max 10 characters string that will be used as prefix for both IAM roles and policies created as part of the PC API infrastructure. + * **IAMRoleAndPolicyPrefix** \- This optional parameter accepts a string containing a maximum of 10 characters that will be used as the prefix for both IAM roles and policies created as part of the PC API infrastructure.