Cloud Control

Introduction

Cloud Control API allows you to create, read, update, delete, and list (CRUD-L) resources in AWS. Cloud Control API provides a standardized interface provision and access these resources in a programmatic way.

LocalStack allows you to use the Cloud Control API in your local environment to interact with your emulated resources. The supported APIs are available on our API Coverage section, which provides information on the extent of Cloud Control’s integration with LocalStack.

Getting started

This guide is designed for users new to Cloud Control and assumes basic knowledge of the AWS CLI and our awslocal wrapper script.

Start your LocalStack container using your preferred method. We will demonstrate how to get and list resources using the Cloud Control API.

List resources

You can list resources using the ListResources API.

Create an S3 bucket using the following command:

awslocal s3 mb s3://my-bucket

List the resources using the following command:

awslocal cloudcontrol list-resources --type-name AWS::S3::Bucket

You should see the S3 bucket in the output.

Output

{
    "ResourceDescriptions": [
        {
            "Identifier": "my-bucket",
            "Properties": "{\"BucketName\":\"my-bucket\"}"
        }
    ],
    "TypeName": "AWS::S3::Bucket"
}

Get a resource

You can get a resource using the GetResource API.

awslocal cloudcontrol get-resource --type-name AWS::S3::Bucket --identifier my-bucket

Output

{
    "TypeName": "AWS::S3::Bucket",
    "ResourceDescription": {
        "Identifier": "my-bucket",
        "Properties": "{\"BucketName\":\"my-bucket\"}"
    }
}

Supported Resources

The following resources are supported by Cloud Control:

1. AWS::ApiGateway::RestApi
2. AWS::CloudFormation::Stack
3. AWS::DynamoDB::Table
4. AWS::EC2::VPC
5. AWS::Events::EventBus
6. AWS::IAM::Group
7. AWS::IAM::Role
8. AWS::IAM::User
9. AWS::Lambda::Function
10. AWS::S3::Bucket
11. AWS::SES::EmailIdentity
12. AWS::SNS::Topic
13. AWS::SQS::Queue
14. AWS::SSM::Parameter
15. AWS::SecretsManager::Secret
16. AWS::StepFunctions::StateMachine
17. AWS::CloudFront::Distribution
18. AWS::Pipes::Pipe

API Coverage

Operation ▲	Implemented	Image	Tested on Kubernetes

PreviousPage 1 of 0Next