Checkly

v1.1.2 published on Wednesday, Aug 3, 2022 by checkly

EnvironmentVariable

Example Usage

using Pulumi;
using Checkly = Pulumi.Checkly;

class MyStack : Stack
{
    public MyStack()
    {
        // Simple Enviroment Variable example
        var variable_1 = new Checkly.EnvironmentVariable("variable-1", new Checkly.EnvironmentVariableArgs
        {
            Key = "API_KEY",
            Locked = true,
            Value = "loZd9hOGHDUrGvmW",
        });
        var variable_2 = new Checkly.EnvironmentVariable("variable-2", new Checkly.EnvironmentVariableArgs
        {
            Key = "API_URL",
            Value = "http://localhost:3000",
        });
    }

}
package main

import (
	"github.com/checkly/pulumi-checkly/sdk/go/checkly"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := checkly.NewEnvironmentVariable(ctx, "variable-1", &checkly.EnvironmentVariableArgs{
			Key:    pulumi.String("API_KEY"),
			Locked: pulumi.Bool(true),
			Value:  pulumi.String("loZd9hOGHDUrGvmW"),
		})
		if err != nil {
			return err
		}
		_, err = checkly.NewEnvironmentVariable(ctx, "variable-2", &checkly.EnvironmentVariableArgs{
			Key:   pulumi.String("API_URL"),
			Value: pulumi.String("http://localhost:3000"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_checkly as checkly

# Simple Enviroment Variable example
variable_1 = checkly.EnvironmentVariable("variable-1",
    key="API_KEY",
    locked=True,
    value="loZd9hOGHDUrGvmW")
variable_2 = checkly.EnvironmentVariable("variable-2",
    key="API_URL",
    value="http://localhost:3000")
import * as pulumi from "@pulumi/pulumi";
import * as checkly from "@pulumi/checkly";

// Simple Enviroment Variable example
const variable_1 = new checkly.EnvironmentVariable("variable-1", {
    key: "API_KEY",
    locked: true,
    value: "loZd9hOGHDUrGvmW",
});
const variable_2 = new checkly.EnvironmentVariable("variable-2", {
    key: "API_URL",
    value: "http://localhost:3000",
});

Coming soon!

Create EnvironmentVariable Resource

new EnvironmentVariable(name: string, args: EnvironmentVariableArgs, opts?: CustomResourceOptions);
@overload
def EnvironmentVariable(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        key: Optional[str] = None,
                        locked: Optional[bool] = None,
                        value: Optional[str] = None)
@overload
def EnvironmentVariable(resource_name: str,
                        args: EnvironmentVariableArgs,
                        opts: Optional[ResourceOptions] = None)
func NewEnvironmentVariable(ctx *Context, name string, args EnvironmentVariableArgs, opts ...ResourceOption) (*EnvironmentVariable, error)
public EnvironmentVariable(string name, EnvironmentVariableArgs args, CustomResourceOptions? opts = null)
public EnvironmentVariable(String name, EnvironmentVariableArgs args)
public EnvironmentVariable(String name, EnvironmentVariableArgs args, CustomResourceOptions options)
type: checkly:EnvironmentVariable
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args EnvironmentVariableArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args EnvironmentVariableArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args EnvironmentVariableArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args EnvironmentVariableArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args EnvironmentVariableArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

EnvironmentVariable Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The EnvironmentVariable resource accepts the following input properties:

Key string
Value string
Locked bool
Key string
Value string
Locked bool
key String
value String
locked Boolean
key string
value string
locked boolean
key str
value str
locked bool
key String
value String
locked Boolean

Outputs

All input properties are implicitly available as output properties. Additionally, the EnvironmentVariable resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing EnvironmentVariable Resource

Get an existing EnvironmentVariable resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: EnvironmentVariableState, opts?: CustomResourceOptions): EnvironmentVariable
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        key: Optional[str] = None,
        locked: Optional[bool] = None,
        value: Optional[str] = None) -> EnvironmentVariable
func GetEnvironmentVariable(ctx *Context, name string, id IDInput, state *EnvironmentVariableState, opts ...ResourceOption) (*EnvironmentVariable, error)
public static EnvironmentVariable Get(string name, Input<string> id, EnvironmentVariableState? state, CustomResourceOptions? opts = null)
public static EnvironmentVariable get(String name, Output<String> id, EnvironmentVariableState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Key string
Locked bool
Value string
Key string
Locked bool
Value string
key String
locked Boolean
value String
key string
locked boolean
value string
key str
locked bool
value str
key String
locked Boolean
value String

Package Details

Repository
https://github.com/checkly/pulumi-checkly
License
MIT
Notes

This Pulumi package is based on the checkly Terraform Provider.