CloudControlClient

Suggest an Edit

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

Installation

NPM
npm install @aws-sdk/client-cloudcontrol
Yarn
yarn add @aws-sdk/client-cloudcontrol
pnpm
pnpm add @aws-sdk/client-cloudcontrol

CloudControlClient Operations

Command
Summary
CancelResourceRequestCommand

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.

CreateResourceCommand

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.

DeleteResourceCommand

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.

GetResourceCommand

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.

GetResourceRequestStatusCommand

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.

ListResourceRequestsCommand

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

ListResourcesCommand

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.

UpdateResourceCommand

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.

CloudControlClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: CloudControlClientConfig