Skip to content

Latest commit

 

History

History
91 lines (62 loc) · 3.95 KB

README.md

File metadata and controls

91 lines (62 loc) · 3.95 KB
Raw

Pulumi AWS Cloud Control Provider

The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage any AWS resource that's supported by the AWS Cloud Control API. With Pulumi's native provider for AWS Cloud Control, you get same-day access to all new AWS resources and all new properties on existing resources supported by the Cloud Control API. You can use the AWS Cloud Control provider from a Pulumi program written in any Pulumi language: C#, Go, JavaScript/TypeScript, and Python. You'll need to install and configure the Pulumi CLI if you haven't already.

Note

This provider covers all resources as supported by the AWS Cloud Control API. This does not yet include all AWS resources. See the list of supported resources for full details.

For new projects, we recommend starting with our primary AWS Provider and adding AWS Cloud Control resources on an as needed basis.

Configuring credentials

To learn how to configure credentials refer to the AWS configuration options.

Building

Dependencies

  • Go 1.20
  • NodeJS 10.X.X or later
  • Yarn 1.22 or later
  • Python 3.6 or later
  • .NET 6 or greater
  • Gradle 7
  • Pulumi CLI and language plugins
  • pulumictl

You can quickly launch a shell environment with all the required dependencies using devbox:

which devbox || curl -fsSL https://get.jetpack.io/devbox | bash
devbox shell

Alternatively, you can develop in a preconfigured container environment using an editor or service that supports the devcontainer standard such as VS Code or Github Codespaces. Please note that building this project can be fairly memory intensive, if you are having trouble building in a container, please ensure you have at least 12GB of memory available for the container.

Building locally

Run the following commands to install Go modules, generate all SDKs, and build the provider:

make ensure
make build

Add the bin folder to your $PATH or copy the bin/pulumi-resource-aws-native file to another location in your $PATH.

Running tests

To run unittests, use:

make test_provider

Running an example

Navigate to the ECS example and run Pulumi:

cd ./examples/ecs
yarn link @pulumi/aws-native
pulumi config set aws:region us-west-2
pulumi config set aws-native:region us-west-2
pulumi up

Local Development

Additional Build Targets

make build can be a bit slow as it rebuilds the sdks for every language; you can use make provider or make codegen to just rebuild the provider plugin or codegen binaries

Debugging / Logging

Oftentimes, it can be informative to investigate the precise requests this provider makes to upstream AWS APIs. By default, the Pulumi CLI writes all of its logs to files rather than stdout or stderr (though this can be overridden with the --logtostderr flag). This works to our benefit, however, as the AWS SDK used in this provider writes to stderr by default. To view a trace of all HTTP requests and responses between this provider and AWS APIs, run the Pulumi CLI with the following arguments:

pulumi -v 9 --logflow [command]

this will correctly set verbosity to the level that the provider expects to log these requests (via -v 9), as well as flowing that verbosity setting down from the Pulumi CLI to the provider itself (via --logflow).