View Source aws_cloudcontrol (aws v0.5.0)

Use Amazon Web Services Cloud Control API to create, read, update, delete, and list (CRUD-L) your cloud resources that belong to a wide range of services--both Amazon Web Services and third-party.

With the Cloud Control API standardized set of application programming interfaces (APIs), you can perform CRUD-L operations on any supported resources in your Amazon Web Services account. Using Cloud Control API, you won't have to generate code or scripts specific to each individual service responsible for those resources.

For more information about Amazon Web Services Cloud Control API, see the Amazon Web Services Cloud Control API User Guide.

Link to this section Summary

Functions

Cancels the specified resource operation request.

Creates the specified resource.

Deletes the specified resource.

Returns information about the current state of the specified resource.

Returns the current status of a resource operation request.

Returns existing resource operation requests.

Returns information about the specified resources.

Updates the specified property values in the resource.

Link to this section Functions

Link to this function

cancel_resource_request(Client, Input)

View Source

Cancels the specified resource operation request.

For more information, see Canceling resource operation requests in the Amazon Web Services Cloud Control API User Guide.

Only resource operations requests with a status of PENDING or IN_PROGRESS can be cancelled.
Link to this function

cancel_resource_request(Client, Input, Options)

View Source
Link to this function

create_resource(Client, Input)

View Source

Creates the specified resource.

For more information, see Creating a resource in the Amazon Web Services Cloud Control API User Guide.

After you have initiated a resource creation request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent type returned by CreateResource.
Link to this function

create_resource(Client, Input, Options)

View Source
Link to this function

delete_resource(Client, Input)

View Source

Deletes the specified resource.

For details, see Deleting a resource in the Amazon Web Services Cloud Control API User Guide.

After you have initiated a resource deletion request, you can monitor the progress of your request by calling GetResourceRequestStatus using the RequestToken of the ProgressEvent returned by DeleteResource.
Link to this function

delete_resource(Client, Input, Options)

View Source
Link to this function

get_resource(Client, Input)

View Source

Returns information about the current state of the specified resource.

For details, see Reading a resource's current state.

You can use this action to return information about an existing resource in your account and Amazon Web Services Region, whether or not those resources were provisioned using Cloud Control API.
Link to this function

get_resource(Client, Input, Options)

View Source
Link to this function

get_resource_request_status(Client, Input)

View Source

Returns the current status of a resource operation request.

For more information, see Tracking the progress of resource operation requests in the Amazon Web Services Cloud Control API User Guide.
Link to this function

get_resource_request_status(Client, Input, Options)

View Source
Link to this function

list_resource_requests(Client, Input)

View Source

Returns existing resource operation requests.

This includes requests of all status types. For more information, see Listing active resource operation requests in the Amazon Web Services Cloud Control API User Guide.

Resource operation requests expire after seven days.
Link to this function

list_resource_requests(Client, Input, Options)

View Source
Link to this function

list_resources(Client, Input)

View Source

Returns information about the specified resources.

For more information, see Discovering resources in the Amazon Web Services Cloud Control API User Guide.

You can use this action to return information about existing resources in your account and Amazon Web Services Region, whether or not those resources were provisioned using Cloud Control API.
Link to this function

list_resources(Client, Input, Options)

View Source
Link to this function

update_resource(Client, Input)

View Source

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 Amazon Web Services CloudFormation Users Guide.
Link to this function

update_resource(Client, Input, Options)

View Source