

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

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

Actualiza el clúster.

**Topics**
+ [Sintaxis de la solicitud](#update-cluster-request)
+ [Cuerpo de la solicitud](#update-cluster-request-body)
+ [Sintaxis de la respuesta](#update-cluster-response)
+ [Cuerpo de respuesta](#update-cluster-response-body)
+ [Ejemplo](#update-cluster-example)

## Sintaxis de la solicitud
<a name="update-cluster-request"></a>

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

## Cuerpo de la solicitud
<a name="update-cluster-request-body"></a>

**clusterConfiguration**  
La configuración del clúster como documento YAML.  
Obligatorio: sí

**clusterName**  
El nombre del clúster.  
Tipo: cadena  
Obligatorio: sí

**dryrun**  
Si se establece en `true`, solo realiza la validación de la solicitud sin crear ningún recurso. Utilice este parámetro para validar la configuración del clúster y los requisitos de actualización. El valor predeterminado es `false`.  
Tipo: booleano  
Obligatorio: no

**forceUpdate**  
Si se establece en `true`, ignora los errores de validación de la actualización y fuerza la actualización. El valor predeterminado es `false`.  
Tipo: booleano  
Obligatorio: no

**region**  
El lugar en el Región de AWS que se encuentra el clúster.  
Tipo: cadena  
Requerido: no

**suppressValidators**  
Identifica uno o más validadores de configuración para suprimirlos.  
Tipo: cadena  
Formato: `(ALL|type:[A-Za-z0-9]+)`  
Obligatorio: no  
Ejemplos de valores válidos: `currentValue`, `requestedValue`, `message`

**validationFailureLevel**  
El nivel mínimo de validación para provocar un error en la actualización.  
Tipo: cadena  
Valores válidos: `INFO | WARNING | ERROR`  
Obligatorio: no

## Sintaxis de la respuesta
<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"
    }
  ]
}
```

## Cuerpo de respuesta
<a name="update-cluster-response-body"></a>

**changeSet**  
El conjunto de cambios para la actualización del clúster.    
**currentValue**  
El valor actual del parámetro que se va a actualizar.  
Tipo: cadena  
**parameter**  
El parámetro que se va a actualizar.  
Tipo: cadena  
**requestedValue**  
El valor solicitado para el parámetro que se va a actualizar.  
Tipo: cadena

**clúster**    
**cloudformationStackArn**  
El nombre de recurso de Amazon (ARN) de la pila principal CloudFormation .  
Tipo: cadena  
**cloudformationStackStatus**  
El estado de la CloudFormation pila.  
Tipo: cadena  
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**  
El nombre del clúster.  
Tipo: cadena  
**clusterStatus**  
El estado del clúster.  
Tipo: cadena  
Valores válidos: `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED`  
**region**  
El Región de AWS lugar en el que se crea el clúster.  
Tipo: cadena  
**programador**    
**metadatos**  
Los metadatos del programador.    
**nombre**  
El nombre del programador.  
Tipo: cadena  
**versión**  
La versión del programador.  
Tipo: cadena  
**type**  
El tipo de programador.  
Tipo: cadena

**versión**  
AWS ParallelCluster versión que se utiliza para crear el clúster.  
Tipo: cadena

**validationMessages**  
Una lista de mensajes con un nivel de validación inferior a `validationFailureLevel`. La lista de mensajes se recopila durante la validación de la configuración.    
**id**  
El identificador del validador.  
Tipo: cadena  
**nivel**  
El nivel de validación.  
Tipo: cadena  
Valores válidos: `INFO | WARNING | ERROR`  
**message**  
El mensaje de validación.  
Tipo: cadena  
**type**  
El tipo de validador.  
Tipo: cadena

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

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

**Solicitud**

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

**Respuesta 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'
  }
}
```

------