|
| 1 | +--- |
| 2 | +title: "Cloud Control" |
| 3 | +description: Get started with Cloud Control on LocalStack |
| 4 | +tags: ["Base"] |
| 5 | +--- |
| 6 | + |
| 7 | +import FeatureCoverage from "../../../../components/feature-coverage/FeatureCoverage"; |
| 8 | + |
| 9 | +## Introduction |
| 10 | + |
| 11 | +Cloud Control API allows you to create, read, update, delete, and list (CRUD-L) resources in AWS. |
| 12 | +Cloud Control API provides a standardized interface provision and access these resources in a programmatic way. |
| 13 | + |
| 14 | +LocalStack allows you to use the Cloud Control API in your local environment to interact with your emulated resources. |
| 15 | +The supported APIs are available on our [API Coverage section](#api-coverage), which provides information on the extent of Cloud Control's integration with LocalStack. |
| 16 | + |
| 17 | +## Getting started |
| 18 | + |
| 19 | +This guide is designed for users new to Cloud Control and assumes basic knowledge of the AWS CLI and our [`awslocal`](https://github.com/localstack/awscli-local) wrapper script. |
| 20 | + |
| 21 | +Start your LocalStack container using your preferred method. |
| 22 | +We will demonstrate how to get and list resources using the Cloud Control API. |
| 23 | + |
| 24 | +### List resources |
| 25 | + |
| 26 | +You can list resources using the [`ListResources`](https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_ListResources.html) API. |
| 27 | + |
| 28 | +Create an S3 bucket using the following command: |
| 29 | + |
| 30 | +```bash |
| 31 | +awslocal s3 mb s3://my-bucket |
| 32 | +``` |
| 33 | + |
| 34 | +List the resources using the following command: |
| 35 | + |
| 36 | +```bash |
| 37 | +awslocal cloudcontrol list-resources --type-name AWS::S3::Bucket |
| 38 | +``` |
| 39 | + |
| 40 | +You should see the S3 bucket in the output. |
| 41 | + |
| 42 | +```bash title="Output" |
| 43 | +{ |
| 44 | + "ResourceDescriptions": [ |
| 45 | + { |
| 46 | + "Identifier": "my-bucket", |
| 47 | + "Properties": "{\"BucketName\":\"my-bucket\"}" |
| 48 | + } |
| 49 | + ], |
| 50 | + "TypeName": "AWS::S3::Bucket" |
| 51 | +} |
| 52 | +``` |
| 53 | + |
| 54 | +### Get a resource |
| 55 | + |
| 56 | +You can get a resource using the [`GetResource`](https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResource.html) API. |
| 57 | + |
| 58 | +```bash |
| 59 | +awslocal cloudcontrol get-resource --type-name AWS::S3::Bucket --identifier my-bucket |
| 60 | +``` |
| 61 | + |
| 62 | +```bash title="Output" |
| 63 | +{ |
| 64 | + "TypeName": "AWS::S3::Bucket", |
| 65 | + "ResourceDescription": { |
| 66 | + "Identifier": "my-bucket", |
| 67 | + "Properties": "{\"BucketName\":\"my-bucket\"}" |
| 68 | + } |
| 69 | +} |
| 70 | +``` |
| 71 | + |
| 72 | +## Supported Resources |
| 73 | + |
| 74 | +The following resources are supported by Cloud Control: |
| 75 | + |
| 76 | +1. [`AWS::ApiGateway::RestApi`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) |
| 77 | +2. [`AWS::CloudFormation::Stack`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html) |
| 78 | +3. [`AWS::DynamoDB::Table`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dynamodb-table.html) |
| 79 | +4. [`AWS::EC2::VPC`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc.html) |
| 80 | +5. [`AWS::Events::EventBus`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-events-eventbus.html) |
| 81 | +6. [`AWS::IAM::Group`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-group.html) |
| 82 | +7. [`AWS::IAM::Role`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html) |
| 83 | +8. [`AWS::IAM::User`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html) |
| 84 | +9. [`AWS::Lambda::Function`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-function.html) |
| 85 | +10. [`AWS::S3::Bucket`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3-bucket.html) |
| 86 | +11. [`AWS::SES::EmailIdentity`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html) |
| 87 | +12. [`AWS::SNS::Topic`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sns-topic.html) |
| 88 | +13. [`AWS::SQS::Queue`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sqs-queue.html) |
| 89 | +14. [`AWS::SSM::Parameter`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html) |
| 90 | +15. [`AWS::SecretsManager::Secret`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html) |
| 91 | +16. [`AWS::StepFunctions::StateMachine`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-stepfunctions-statemachine.html) |
| 92 | +17. [`AWS::CloudFront::Distribution`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-distribution.html) |
| 93 | +18. [`AWS::Pipes::Pipe`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pipes-pi |
| 94 | + |
| 95 | +## API Coverage |
| 96 | + |
| 97 | +<FeatureCoverage service="cloudcontrol" client:load /> |
0 commit comments