AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Updates the specified property values in the resource.

You specify your resource property updates as a list of patch operations contained in a JSON patch document that adheres to the RFC 6902 - JavaScript Object Notation (JSON) Patch standard.

For details on how Cloud Control API performs resource update operations, see Updating a resource in the Amazon Web Services Cloud Control API User Guide.

After you have initiated a resource update request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent returned by UpdateResource.

For more information about the properties of a specific resource, refer to the related topic for the resource in the Resource and property types reference in the CloudFormation Users Guide.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginUpdateResource and EndUpdateResource.

Namespace: Amazon.CloudControlApi
Assembly: AWSSDK.CloudControlApi.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<UpdateResourceResponse> UpdateResourceAsync(
         UpdateResourceRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CloudControlApi.Model.UpdateResourceRequest

Container for the necessary parameters to execute the UpdateResource service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the UpdateResource service method, as returned by CloudControlApi.

Exceptions

ExceptionCondition
AlreadyExistsException The resource with the name requested already exists.
ClientTokenConflictException The specified client token has already been used in another resource request. It's best practice for client tokens to be unique for each resource operation request. However, client token expire after 36 hours.
ConcurrentOperationException Another resource operation is currently being performed on this resource.
GeneralServiceException The resource handler has returned that the downstream service generated an error that doesn't map to any other handler error code.
HandlerFailureException The resource handler has failed without a returning a more specific error code. This can include timeouts.
HandlerInternalFailureException The resource handler has returned that an unexpected error occurred within the resource handler.
InvalidCredentialsException The resource handler has returned that the credentials provided by the user are invalid.
InvalidRequestException The resource handler has returned that invalid input from the user has generated a generic exception.
NetworkFailureException The resource handler has returned that the request couldn't be completed due to networking issues, such as a failure to receive a response from the server.
NotStabilizedException The resource handler has returned that the downstream resource failed to complete all of its ready-state checks.
NotUpdatableException One or more properties included in this resource operation are defined as create-only, and therefore can't be updated.
PrivateTypeException Cloud Control API hasn't received a valid response from the resource handler, due to a configuration error. This includes issues such as the resource handler returning an invalid response, or timing out.
ResourceConflictException The resource is temporarily unavailable to be acted upon. For example, if the resource is currently undergoing an operation and can't be acted upon until that operation is finished.
ResourceNotFoundException A resource with the specified identifier can't be found.
ServiceInternalErrorException The resource handler has returned that the downstream service returned an internal error, typically with a 5XX HTTP status code.
ServiceLimitExceededException The resource handler has returned that a non-transient resource limit was reached on the service side.
ThrottlingException The request was denied due to request throttling.
TypeNotFoundException The specified extension doesn't exist in the CloudFormation registry.
UnsupportedActionException The specified resource doesn't support this resource operation.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also