Cloud Control API .com

User Guide

Cloud Control API

Copyright ? 2024 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

Cloud Control API

Cloud Control API: User Guide

User Guide

Copyright ? 2024 Amazon Web Services, Inc. and/or its affiliates. All rights reserved.

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon.

Cloud Control API

Table of Contents

User Guide

What is AWS Cloud Control API? .................................................................................................... 1 Are you a first-time Cloud Control API user? ......................................................................................... 1 Features of Cloud Control API ................................................................................................................... 1 Related services ............................................................................................................................................ 1 Accessing Cloud Control API ...................................................................................................................... 2 How it works ................................................................................................................................................. 3

Setting up ........................................................................................................................................ 5 Sign up for AWS ........................................................................................................................................... 5 Create an IAM user ....................................................................................................................................... 5

Getting started ................................................................................................................................ 7 Create a resource .......................................................................................................................................... 7 Read a resource ............................................................................................................................................ 8 Update a resource ........................................................................................................................................ 9 List resources ............................................................................................................................................... 11 Delete a resource ....................................................................................................................................... 12 Next steps .................................................................................................................................................... 13

Security .......................................................................................................................................... 14 VPC endpoints (AWS PrivateLink) ........................................................................................................... 15 Considerations for Cloud Control API VPC endpoints ................................................................... 16 Creating an interface VPC endpoint for Cloud Control API ......................................................... 16 Creating a VPC endpoint policy for Cloud Control API ................................................................. 16 See also ................................................................................................................................................... 18

Performing resource operations ................................................................................................... 19 Prerequisites ................................................................................................................................................ 19 Specifying credentials ............................................................................................................................... 20 Ensuring requests are unique .................................................................................................................. 21 Considerations ............................................................................................................................................. 21 Creating a resource .................................................................................................................................... 21 Composing the desired state of the resource ................................................................................. 22 Tracking create requests ..................................................................................................................... 22 Updating a resource .................................................................................................................................. 23 Composing the patch document ....................................................................................................... 23 How Cloud Control API updates resources ...................................................................................... 24 Tracking the progress of an update resource request ................................................................... 25

iii

Cloud Control API

User Guide

Deleting a resource .................................................................................................................................... 25 Tracking the progress of a delete resource request ...................................................................... 26

Discovering resources ................................................................................................................................ 26 Resources requiring additional information .................................................................................... 27

Reading a resource .................................................................................................................................... 30 Managing resource requests .................................................................................................................... 31

Listing active resource operation requests ...................................................................................... 31 Tracking request progress ................................................................................................................... 32 Canceling resource operation requests ............................................................................................ 32 Identifying resources ................................................................................................................................. 33 Getting a resource's primary identifier ............................................................................................. 34 Using a resource's primary identifier ................................................................................................ 34 Using resource types ..................................................................................................................... 36 Managing resource types .......................................................................................................................... 37 Determining resource type support ....................................................................................................... 38 Viewing resource type schemas .............................................................................................................. 39 Viewing resource property attributes ............................................................................................... 41 Viewing supported resource operations .......................................................................................... 41 Supported resource types ............................................................................................................. 43 Document history ........................................................................................................................ 112

iv

Cloud Control API

User Guide

What is AWS Cloud Control API?

Use AWS Cloud Control API to create, read, update, delete, and list (CRUD-L) your cloud resources that belong to a wide range of services ? both AWS 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 AWS account. Using Cloud Control API, you won't have to generate code or scripts specific to each individual service responsible for those resources.

Topics ? Are you a first-time Cloud Control API user? ? Features of Cloud Control API ? Related services ? Accessing Cloud Control API ? How Cloud Control API works

Are you a first-time Cloud Control API user?

If you're a first-time user of Cloud Control API, we recommend that you begin by reading the following sections:

? Setting up AWS Cloud Control API ? Getting started with Cloud Control API

Features of Cloud Control API

Cloud Control API provides you with consistent control over the resources in your AWS account by offering a standardized way of accessing and provisioning those resources. It provides a uniform programmatic interface for making calls directly to the various resource types available in your AWS account, without you having to familiarize yourself with APIs of the underlying web services.

Related services

Similar to Cloud Control API, AWS CloudFormation also uses resource types to call underlying web services APIs to provision those resources when you place such a request in your account. However,

Are you a first-time Cloud Control API user?

1

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download