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á.

# updateCluster
<a name="update-cluster"></a>

Atualiza um cluster.

**Topics**
+ [Sintaxe da solicitação](#update-cluster-request)
+ [Corpo da solicitação](#update-cluster-request-body)
+ [Sintaxe da resposta](#update-cluster-response)
+ [Corpo da resposta](#update-cluster-response-body)
+ [Exemplo](#update-cluster-example)

## Sintaxe da solicitação
<a name="update-cluster-request"></a>

```
PUT /v3/clusters/{{{clusterName}}}
{
  "clusterConfiguration": "string",
  "dryrun": boolean,
  "forceUpdate": boolean,
  "region": "string",
  "suppressValidators": "string",
  "validationFailureLevel": "string"
}
```

## Corpo da solicitação
<a name="update-cluster-request-body"></a>

**clusterConfiguration**  
A configuração do cluster como um documento YAML.  
Obrigatório: Sim

**clusterName**  
O nome do cluster.  
Tipo: string  
Obrigatório: Sim

**dryrun**  
Se definido como `true`, executa somente a validação da solicitação, sem criar nenhum recurso. Use este parâmetro para validar a configuração do cluster e atualizar os requisitos. O padrão é `false`.  
Tipo: booliano  
Obrigatório: não

**forceUpdate**  
Se definido como `true`, ignora os erros de validação da atualização e força a atualização. O padrão é `false`.  
Tipo: booliano  
Obrigatório: não

**região**  
O em Região da AWS que o cluster está.  
Tipo: string  
Obrigatório: Não

**suppressValidators**  
Identifica um ou mais validadores de configuração a serem suprimidos.  
Tipo: string  
Formato: `(ALL|type:[A-Za-z0-9]+)`  
Obrigatório: Não  
Exemplo de valores válidos: `currentValue`, `requestedValue`, `message`

**validationFailureLevel**  
O nível mínimo de validação que pode causar falha na atualização.  
Tipo: string  
Valores válidos: `INFO | WARNING | ERROR`  
Obrigatório: Não

## Sintaxe da resposta
<a name="update-cluster-response"></a>

```
{
  "cluster": {
    "clusterName": "string",
    "region": "string",
    "version": "string",
    "cloudformationStackArn": "string",
    "cloudformationStackStatus": "UPDATE_IN_PROGRESS",
    "clusterStatus": "UPDATE_IN_PROGRESS",
    "scheduler": {
      "type": "string",
      "metadata": {
        "name": "string",
        "version": "string"
      }
    }
  },
  "validationMessages": [
    {
      "id": "string",
      "type": "string",
      "level": "INFO",
      "message": "string"
    }
  ],
  "changeSet": [
    {
      "parameter": "string",
      "currentValue": "string",
      "requestedValue": "string"
    }
  ]
}
```

## Corpo da resposta
<a name="update-cluster-response-body"></a>

**changeSet**  
O conjunto de alterações para a atualização do cluster.    
**currentValue**  
O valor atual do parâmetro a ser atualizado.  
Tipo: string  
**parameter**  
O parâmetro a ser atualizado.  
Tipo: string  
**requestedValue**  
O valor solicitado para o parâmetro a ser atualizado.  
Tipo: string

**cluster**    
**cloudformationStackArn**  
O Amazon Resource Name (ARN) da pilha principal CloudFormation .  
Tipo: string  
**cloudformationStackStatus**  
O status da CloudFormation pilha.  
Tipo: string  
Valores válidos: `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | ROLLBACK_IN_PROGRESS | ROLLBACK_FAILED | ROLLBACK_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_ROLLBACK_IN_PROGRESS | UPDATE_ROLLBACK_FAILED | UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_ROLLBACK_COMPLETE`  
**clusterName**  
Nome do cluster.  
Tipo: string  
**clusterStatus**  
Status do cluster.  
Tipo: string  
Valores válidos: `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED`  
**região**  
O Região da AWS no qual o cluster é criado.  
Tipo: string  
**scheduler (programador)**    
**metadados**  
Os metadados do programador.    
**nome**  
O nome do programador.  
Tipo: string  
**version**  
A versão do programador.  
Tipo: string  
**type**  
O tipo de programador.  
Tipo: string

**version**  
AWS ParallelCluster versão usada para criar o cluster.  
Tipo: string

**validationMessages**  
Uma lista de mensagens com um nível de validação inferior a `validationFailureLevel`. A lista de mensagens é coletada durante a validação da configuração.    
**id**  
O ID do validador.  
Tipo: string  
**nível**  
O nível de validação.  
Tipo: string  
Valores válidos: `INFO | WARNING | ERROR`  
**message**  
A mensagem de validação.  
Tipo: string  
**type**  
O tipo do validador.  
Tipo: string

## Exemplo
<a name="update-cluster-example"></a>

------
#### [ Python ]

**Solicitação**

```
$ update_cluster({{cluster_name_3x}}, {{path/config-file.yaml}})
```

**Resposta 200**

```
{
  'change_set': [
    {
      'current_value': '10',
      'parameter': 'Scheduling.SlurmQueues[queue1].ComputeResources[t2micro].MaxCount',
      'requested_value': '15'
    }
  ],
  'cluster': {
    'cloudformation_stack_arn': 'arn:aws:cloudformation:us-east-1:123456789012:stack/test-api-cluster/e0462730-50b5-11ed-99a3-0a5ddc4a34c7',
    'cloudformation_stack_status': 'UPDATE_IN_PROGRESS',
    'cluster_name': 'cluster-3x',
    'cluster_status': 'UPDATE_IN_PROGRESS',
    'region': 'us-east-1',
    'scheduler': {
      'type': 'slurm'
    },
    'version': '3.2.1'
  }
}
```

------