翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

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

クラスターを更新します。

**Topics**
+ [リクエスト構文](#update-cluster-request)
+ [リクエスト本文](#update-cluster-request-body)
+ [レスポンスの構文](#update-cluster-response)
+ [レスポンス本文](#update-cluster-response-body)
+ [例](#update-cluster-example)

## リクエスト構文
<a name="update-cluster-request"></a>

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

## リクエスト本文
<a name="update-cluster-request-body"></a>

**clusterConfiguration**  
YAML ドキュメントとしてのクラスター設定。  
必須: はい

**clusterName**  
クラスターの名前。  
タイプ: 文字列  
必須: はい

**dryrun**  
`true` に設定すると、リソースを作成することなく、リクエストの検証のみを行います。このパラメータを使用して、クラスター設定と更新の要件を検証します。デフォルトは `false` です。  
型: ブール値  
必須: いいえ

**forceUpdate**  
`true` に設定すると、更新検証のエラーを無視して、強制的に更新を行います。デフォルトは `false` です。  
型: ブール値  
必須: いいえ

**region**  
クラスター AWS リージョン がある 。  
型: 文字列  
必須: いいえ

**suppressValidators**  
抑制する 1 つまたは複数の設定バリデータを指定します。  
タイプ: 文字列  
形式: `(ALL|type:[A-Za-z0-9]+)`  
必須: いいえ  
有効な値の例: `currentValue`、`requestedValue`、`message`

**validationFailureLevel**  
更新が失敗する最小の検証レベル。  
タイプ: 文字列  
有効な値: `INFO | WARNING | ERROR`  
必須：いいえ

## レスポンスの構文
<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"
    }
  ]
}
```

## レスポンス本文
<a name="update-cluster-response-body"></a>

**changeSet**  
クラスターアップデート用の変更セット。    
**currentValue**  
更新するパラメータの現在の値。  
タイプ: 文字列  
**パラメータ**  
更新するパラメータ。  
タイプ: 文字列  
**requestedValue**  
更新するパラメータの要求された値。  
タイプ: 文字列

**クラスター**    
**cloudformationStackArn**  
メイン CloudFormation スタックの Amazon リソースネーム (ARN)。  
タイプ: 文字列  
**cloudformationStackStatus**  
CloudFormation スタックの状態。  
タイプ: 文字列  
有効な値: `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**  
クラスターの名前。  
タイプ: 文字列  
**clusterStatus**  
クラスターのステータス。  
タイプ: 文字列  
有効な値: `CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED`  
**region**  
クラスターが作成される AWS リージョン 。  
タイプ: 文字列  
**スケジューラ**    
**metadata**  
スケジューラのメタデータ。    
**名前**  
スケジューラの名前。  
タイプ: 文字列  
**version**  
スケジューラのバージョン。  
タイプ: 文字列  
**type**  
スケジューラタイプ。  
タイプ: 文字列

**version**  
AWS ParallelCluster クラスターの作成に使用される バージョン。  
タイプ: 文字列

**validationMessages**  
検証レベルが `validationFailureLevel` 以下のメッセージのリスト。メッセージのリストは設定の検証中に収集されます。    
**id**  
バリデータの ID。  
タイプ: 文字列  
**level**  
検証レベル。  
タイプ: 文字列  
有効な値: `INFO | WARNING | ERROR`  
**message**  
検証メッセージ。  
タイプ: 文字列  
**type**  
バリデータのタイプ。  
タイプ: 文字列

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

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

**リクエスト**

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

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

------