@checkly/pulumi
v2.7.0
Published
A Pulumi package for creating and managing Checkly monitoring resources.
Readme
Checkly Provider for Pulumi
The Checkly provider for Pulumi can be used to provision any of the monitoring resources available in Checkly.
Installation
The Checkly provider is available as a package in most Pulumi languages:
- JavaScript/TypeScript:
@checkly/pulumi - Python:
pulumi-checkly - Go:
github.com/checkly/pulumi-checkly/sdk/v2/go/checkly - .NET:
Pulumi.Checkly
Authentication
The Checkly provider must be configured with an API Key and an Account ID in order to deploy Checkly resources. Sign up for a Checkly account and follow our integration guide to create and configure your credentials.
Example configuration
First, configure your Checkly Account ID:
pulumi config set checkly:accountId YOUR_CHECKLY_ACCOUNT_IDThen, configure you Checkly API key (with --secret):
pulumi config set checkly:apiKey YOUR_CHECKLY_API_KEY --secretYou should now be able to deploy Checkly resources.
Example usage
You can find working JavaScript and TypeScript code samples in the ./examples directory.
Configuration options
The following configuration points are available for the Checkly provider:
checkly:accountId(environment:CHECKLY_ACCOUNT_ID) - your Checkly Account IDcheckly:apiKey(environment:CHECKLY_API_KEY) - your Checkly API Key- If you don't have an API Key, you can create one here.
- Make sure to use the
--secretflag withpulumi config set.
checkly:apiUrl(environment:CHECKLY_API_URL) - for internal development purposes only
Reference
For detailed reference documentation, please visit the Pulumi registry.
