Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

CloudControl

import { CloudControl } from "https://aws-api.deno.dev/v0.4/services/cloudcontrol.ts?docs=full";
class CloudControl {
constructor(apiFactory: client.ApiFactory);
async cancelResourceRequest(params: CancelResourceRequestInput, opts?: client.RequestOptions): Promise<CancelResourceRequestOutput>;
async createResource(params: CreateResourceInput, opts?: client.RequestOptions): Promise<CreateResourceOutput>;
async deleteResource(params: DeleteResourceInput, opts?: client.RequestOptions): Promise<DeleteResourceOutput>;
async getResource(params: GetResourceInput, opts?: client.RequestOptions): Promise<GetResourceOutput>;
async getResourceRequestStatus(params: GetResourceRequestStatusInput, opts?: client.RequestOptions): Promise<GetResourceRequestStatusOutput>;
async listResourceRequests(params?: ListResourceRequestsInput, opts?: client.RequestOptions): Promise<ListResourceRequestsOutput>;
async listResources(params: ListResourcesInput, opts?: client.RequestOptions): Promise<ListResourcesOutput>;
async updateResource(params: UpdateResourceInput, opts?: client.RequestOptions): Promise<UpdateResourceOutput>;
async waitForResourceRequestSuccess(params: GetResourceRequestStatusInput, opts?: client.RequestOptions): Promise<GetResourceRequestStatusOutput>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new CloudControl(apiFactory: client.ApiFactory)
[src]

§Methods

§

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 canceled.

§
createResource(params: CreateResourceInput, opts?: client.RequestOptions): Promise<CreateResourceOutput>
[src]

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.

§
deleteResource(params: DeleteResourceInput, opts?: client.RequestOptions): Promise<DeleteResourceOutput>
[src]

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.

§
getResource(params: GetResourceInput, opts?: client.RequestOptions): Promise<GetResourceOutput>
[src]

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 those resources were provisioned using Cloud Control API.

§

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.

§

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.

Note: Resource operation requests expire after 7 days.

§
listResources(params: ListResourcesInput, opts?: client.RequestOptions): Promise<ListResourcesOutput>
[src]

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 those resources were provisioned using Cloud Control API.

§
updateResource(params: UpdateResourceInput, opts?: client.RequestOptions): Promise<UpdateResourceOutput>
[src]

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.

§
waitForResourceRequestSuccess(params: GetResourceRequestStatusInput, opts?: client.RequestOptions): Promise<GetResourceRequestStatusOutput>
[src]

Wait until resource operation request is successful Checks state up to 24 times, 5 seconds apart (about 2 minutes max wait time).

§Static Properties