aws_resource_update
Update an AWS resource by applying RFC 6902 JSON Patch via Cloud Control API; optionally poll until completion.
Instructions
Update an AWS resource via Cloud Control API using RFC 6902 JSON Patch. Async by default: returns a ProgressEvent with OperationStatus=IN_PROGRESS and a top-level requestToken. Pass awaitCompletion: true to have the server poll until terminal. Typical patch: [{op: 'replace', path: '/MemorySize', value: 512}].
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| region | No | Override session region for this call. | |
| profile | No | Override session profile for this call. | |
| typeName | Yes | CloudFormation type name. | |
| maxWaitMs | No | Maximum total wait in ms when awaitCompletion is true (range 1000-1800000). Default 300000. On timeout, returns the last seen status with a hint to keep polling. | |
| timeoutMs | No | Timeout in milliseconds. Default 60000. | |
| identifier | Yes | Primary identifier for the resource. | |
| clientToken | No | Idempotency token (max 128 chars). | |
| patchDocument | Yes | RFC 6902 JSON Patch document (array of operations). At least one entry. 'add' and 'replace' must carry a `value`. | |
| pollIntervalMs | No | Poll interval in ms when awaitCompletion is true (range 500-30000). Default 2000. ProgressEvent.RetryAfter overrides when CCAPI returns one. | |
| awaitCompletion | No | If true, poll get-resource-request-status until the operation reaches SUCCESS / FAILED / CANCEL_COMPLETE and return the final ProgressEvent. Default false (returns immediately with IN_PROGRESS, caller polls via aws_resource_status). |