

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

# Implemente a AWS ParallelCluster API com AWS CLI
<a name="api-reference-deploy-v3"></a>

Nesta seção, você aprenderá a implantar com AWS CLI o.

Configure AWS as credenciais para serem usadas com a CLI, caso ainda não tenha feito isso.

```
$ aws configure
```

Execute o comando a seguir para implantar a API.

```
$ REGION=<region>
$ API_STACK_NAME=<stack-name>  # This can be any name
$ VERSION=3.15.0
$ aws cloudformation create-stack \
    --region ${REGION} \
    --stack-name ${API_STACK_NAME} \
    --template-url https://${REGION}-aws-parallelcluster.s3.${REGION}.amazonaws.com/parallelcluster/${VERSION}/api/parallelcluster-api.yaml \
    --capabilities CAPABILITY_NAMED_IAM CAPABILITY_AUTO_EXPAND
$ aws cloudformation wait stack-create-complete --stack-name ${API_STACK_NAME} --region ${REGION}
```

**Personalize sua implantação**

Você pode usar os CloudFormation parâmetros expostos pelo modelo para personalizar a implantação da API. Para configurar o valor de um parâmetro ao implantar por meio da CLI, a seguinte opção pode ser usada:. `--parameters ParameterKey=KeyName,ParameterValue=Value` 

Os seguintes parâmetros são opcionais:
+ **Região** - Use o `Region` parâmetro para especificar se a API é capaz de controlar os recursos em todos Regiões da AWS (padrão) ou em um único Região da AWS. Defina esse valor para Região da AWS a API na qual está sendo implantada para restringir o acesso.
+ **ParallelClusterFunctionRole**- Isso substitui a função do IAM que é atribuída à AWS Lambda função que implementa AWS ParallelCluster recursos. O parâmetro aceita o ARN de um perfil do IAM. Essa função precisa ser configurada para ser AWS Lambda a principal do IAM. Além disso, como essa função substituirá a função padrão da função API Lambda, ela deve ter pelo menos as permissões padrão exigidas pela API, conforme listado em. [AWS ParallelCluster exemplo de políticas `pcluster` de usuário](iam-roles-in-parallelcluster-v3.md#iam-roles-in-parallelcluster-v3-example-user-policies)
+ **ParallelClusterFunctionAdditionalPolicies**- ARN da política adicional do IAM a ser anexada à função da AWS ParallelCluster API. Somente uma política pode ser especificada.
+ **CustomDomainName,CustomDomainCertificate, CustomDomainHostedZoneId** - Use esses parâmetros para definir um domínio personalizado para o endpoint do Amazon API Gateway. `CustomDomainName`é o nome do domínio a ser usado, `CustomDomainCertificate` é o ARN de um certificado AWS gerenciado para esse nome de domínio e `CustomDomainHostedZoneId` é o ID da zona hospedada do [Amazon Route 53](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/Welcome.html) na qual você deseja criar registros.
**Atenção**  
Você pode definir configurações de domínio personalizadas para impor uma versão mínima do Transport Layer Security (TLS) para a API. Para obter mais informações, consulte [Escolher uma versão mínima do TLS para um domínio personalizado no API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-custom-domain-tls-version.html).
+ **EnableIamAdminAccess**- Por padrão, a AWS Lambda função que processa as operações AWS ParallelCluster da API é configurada com uma função do IAM que impede qualquer acesso privilegiado do IAM (`EnableIamAdminAccess=false`). Isso faz com que a API não consiga processar operações que exijam a criação de políticas ou perfis do IAM. Por esse motivo, a criação de clusters ou imagens personalizadas só é bem-sucedida quando os perfis do IAM são fornecidos como entrada como parte da configuração do recurso. 

  Quando `EnableIamAdminAccess` configurado para `true` a AWS ParallelCluster API, são concedidas permissões para gerenciar a criação das funções do IAM necessárias para implantar clusters ou gerar funções personalizadas AMIs. 
**Atenção**  
Quando definido como verdadeiro, ele concede privilégios de administrador do IAM à AWS Lambda função que processa AWS ParallelCluster as operações. 

  Consulte [AWS ParallelCluster políticas de exemplo de usuário para gerenciar recursos do IAM](iam-roles-in-parallelcluster-v3.md#iam-roles-in-parallelcluster-v3-user-policy-manage-iam) para obter detalhes adicionais sobre os recursos que podem ser desbloqueados ao ativar esse modo.
+ **PermissionsBoundaryPolicy**- Esse parâmetro opcional aceita um ARN de política do IAM existente que será definido como limite de permissões para todas as funções do IAM criadas pela infraestrutura da API do PC e como uma condição nas permissões administrativas do IAM para que somente funções com essa política possam ser criadas pela API do PC.

  Consulte [Modo `PermissionsBoundary`](iam-roles-in-parallelcluster-v3.md#iam-roles-in-parallelcluster-v3-permissionsboundary-mode) para obter detalhes adicionais sobre as restrições impostas por esse modo.
+ **CreateApiUserRole**- Por padrão, a implantação da AWS ParallelCluster API inclui a criação de uma função do IAM que é definida como a única função autorizada a invocar a API. O endpoint do Amazon API Gateway é configurado com uma política baseada em recursos para conceder permissão de invocação somente ao usuário criado. Para alterar isso, defina `CreateApiUserRole=false` e conceda acesso à API aos usuários selecionados do IAM. Para obter mais informações, consulte [Controlar o acesso para invocar uma API](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-control-access-using-iam-policies-to-invoke-api.html) no *Guia do desenvolvedor do Amazon API Gateway*.
**Atenção**  
Quando o `CreateApiUserRole=true` acesso ao endpoint da API não é restrito pelas políticas de recursos do Amazon API Gateway, todas as funções do IAM que têm `execute-api:Invoke` permissão irrestrita podem acessar os recursos. AWS ParallelCluster Para obter mais informações, consulte Como [controlar o acesso a uma API com as políticas de recursos do API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-resource-policies.html) no *Guia do desenvolvedor do API Gateway*.
**Atenção**  
O `ParallelClusterApiUserRole` tem permissão para invocar todas as operações da API do AWS ParallelCluster . Para restringir o acesso a um subconjunto de recursos da API, consulte [Controlar quem pode chamar um método de API do API Gateway com políticas do IAM](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-control-access-using-iam-policies-to-invoke-api.html#api-gateway-who-can-invoke-an-api-method-using-iam-policies) no *Guia do desenvolvedor do API Gateway*.
+ **IAMRoleAndPolicyPrefix**- Esse parâmetro opcional aceita uma string contendo no máximo 10 caracteres que será usada como prefixo para as funções e políticas do IAM criadas como parte da infraestrutura da API do PC.