SyntheticsGlobalVariable

Provides a Datadog synthetics global variable resource. This can be used to create and manage Datadog synthetics global variables.

Example Usage

using Pulumi;
using Datadog = Pulumi.Datadog;

class MyStack : Stack
{
    public MyStack()
    {
        var testVariable = new Datadog.SyntheticsGlobalVariable("testVariable", new Datadog.SyntheticsGlobalVariableArgs
        {
            Description = "Description of the variable",
            Name = "EXAMPLE_VARIABLE",
            Tags = 
            {
                "foo:bar",
                "env:test",
            },
            Value = "variable-value",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-datadog/sdk/v2/go/datadog"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := datadog.NewSyntheticsGlobalVariable(ctx, "testVariable", &datadog.SyntheticsGlobalVariableArgs{
            Description: pulumi.String("Description of the variable"),
            Name:        pulumi.String("EXAMPLE_VARIABLE"),
            Tags: pulumi.StringArray{
                pulumi.String("foo:bar"),
                pulumi.String("env:test"),
            },
            Value: pulumi.String("variable-value"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_datadog as datadog

test_variable = datadog.SyntheticsGlobalVariable("testVariable",
    description="Description of the variable",
    name="EXAMPLE_VARIABLE",
    tags=[
        "foo:bar",
        "env:test",
    ],
    value="variable-value")

import * as pulumi from "@pulumi/pulumi";
import * as datadog from "@pulumi/datadog";

const testVariable = new datadog.SyntheticsGlobalVariable("test_variable", {
    description: "Description of the variable",
    name: "EXAMPLE_VARIABLE",
    tags: [
        "foo:bar",
        "env:test",
    ],
    value: "variable-value",
});

Create a SyntheticsGlobalVariable Resource

new SyntheticsGlobalVariable(name: string, args: SyntheticsGlobalVariableArgs, opts?: CustomResourceOptions);

def SyntheticsGlobalVariable(resource_name: str, opts: Optional[ResourceOptions] = None, description: Optional[str] = None, name: Optional[str] = None, parse_test_id: Optional[str] = None, parse_test_options: Optional[SyntheticsGlobalVariableParseTestOptionsArgs] = None, secure: Optional[bool] = None, tags: Optional[Sequence[str]] = None, value: Optional[str] = None)

func NewSyntheticsGlobalVariable(ctx *Context, name string, args SyntheticsGlobalVariableArgs, opts ...ResourceOption) (*SyntheticsGlobalVariable, error)

public SyntheticsGlobalVariable(string name, SyntheticsGlobalVariableArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args SyntheticsGlobalVariableArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SyntheticsGlobalVariableArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SyntheticsGlobalVariableArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

SyntheticsGlobalVariable Resource Properties

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

Inputs

The SyntheticsGlobalVariable resource accepts the following input properties:

Name string: Synthetics global variable name.
Value string: The value of the global variable.
Description string: Description of the global variable.
ParseTestId string: Id of the Synthetics test to use for a variable from test.
ParseTestOptions SyntheticsGlobalVariableParseTestOptionsArgs: ID of the Synthetics test to use a source of the global variable value.
Secure bool: Sets the variable as secure. Defaults to false.
Tags List<string>: A list of tags to associate with your synthetics global variable.

Name string: Synthetics global variable name.
Value string: The value of the global variable.
Description string: Description of the global variable.
ParseTestId string: Id of the Synthetics test to use for a variable from test.
ParseTestOptions SyntheticsGlobalVariableParseTestOptions: ID of the Synthetics test to use a source of the global variable value.
Secure bool: Sets the variable as secure. Defaults to false.
Tags []string: A list of tags to associate with your synthetics global variable.

name string: Synthetics global variable name.
value string: The value of the global variable.
description string: Description of the global variable.
parseTestId string: Id of the Synthetics test to use for a variable from test.
parseTestOptions SyntheticsGlobalVariableParseTestOptions: ID of the Synthetics test to use a source of the global variable value.
secure boolean: Sets the variable as secure. Defaults to false.
tags string[]: A list of tags to associate with your synthetics global variable.

name str: Synthetics global variable name.
value str: The value of the global variable.
description str: Description of the global variable.
parse_test_id str: Id of the Synthetics test to use for a variable from test.
parse_test_options SyntheticsGlobalVariableParseTestOptionsArgs: ID of the Synthetics test to use a source of the global variable value.
secure bool: Sets the variable as secure. Defaults to false.
tags Sequence[str]: A list of tags to associate with your synthetics global variable.

Outputs

All input properties are implicitly available as output properties. Additionally, the SyntheticsGlobalVariable 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 str: The provider-assigned unique ID for this managed resource.

Look up an Existing SyntheticsGlobalVariable Resource

Get an existing SyntheticsGlobalVariable 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?: SyntheticsGlobalVariableState, opts?: CustomResourceOptions): SyntheticsGlobalVariable

@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, description: Optional[str] = None, name: Optional[str] = None, parse_test_id: Optional[str] = None, parse_test_options: Optional[SyntheticsGlobalVariableParseTestOptionsArgs] = None, secure: Optional[bool] = None, tags: Optional[Sequence[str]] = None, value: Optional[str] = None) -> SyntheticsGlobalVariable

func GetSyntheticsGlobalVariable(ctx *Context, name string, id IDInput, state *SyntheticsGlobalVariableState, opts ...ResourceOption) (*SyntheticsGlobalVariable, error)

public static SyntheticsGlobalVariable Get(string name, Input<string> id, SyntheticsGlobalVariableState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

Description string: Description of the global variable.
Name string: Synthetics global variable name.
ParseTestId string: Id of the Synthetics test to use for a variable from test.
ParseTestOptions SyntheticsGlobalVariableParseTestOptionsArgs: ID of the Synthetics test to use a source of the global variable value.
Secure bool: Sets the variable as secure. Defaults to false.
Tags List<string>: A list of tags to associate with your synthetics global variable.
Value string: The value of the global variable.

Description string: Description of the global variable.
Name string: Synthetics global variable name.
ParseTestId string: Id of the Synthetics test to use for a variable from test.
ParseTestOptions SyntheticsGlobalVariableParseTestOptions: ID of the Synthetics test to use a source of the global variable value.
Secure bool: Sets the variable as secure. Defaults to false.
Tags []string: A list of tags to associate with your synthetics global variable.
Value string: The value of the global variable.

description string: Description of the global variable.
name string: Synthetics global variable name.
parseTestId string: Id of the Synthetics test to use for a variable from test.
parseTestOptions SyntheticsGlobalVariableParseTestOptions: ID of the Synthetics test to use a source of the global variable value.
secure boolean: Sets the variable as secure. Defaults to false.
tags string[]: A list of tags to associate with your synthetics global variable.
value string: The value of the global variable.

description str: Description of the global variable.
name str: Synthetics global variable name.
parse_test_id str: Id of the Synthetics test to use for a variable from test.
parse_test_options SyntheticsGlobalVariableParseTestOptionsArgs: ID of the Synthetics test to use a source of the global variable value.
secure bool: Sets the variable as secure. Defaults to false.
tags Sequence[str]: A list of tags to associate with your synthetics global variable.
value str: The value of the global variable.

Supporting Types

SyntheticsGlobalVariableParseTestOptions

Parser SyntheticsGlobalVariableParseTestOptionsParserArgs
Type string
Field string

Parser SyntheticsGlobalVariableParseTestOptionsParser
Type string
Field string

parser SyntheticsGlobalVariableParseTestOptionsParser
type string
field string

parser SyntheticsGlobalVariableParseTestOptionsParserArgs
type str
field str

SyntheticsGlobalVariableParseTestOptionsParser

Type string
Value string

Type string
Value string

type string
value string

type str
value str

Import

Synthetics global variables can be imported using their string ID, e.g.

 $ pulumi import datadog:index/syntheticsGlobalVariable:SyntheticsGlobalVariable fizz abcde123-fghi-456-jkl-mnopqrstuv

Package Details

Repository: https://github.com/pulumi/pulumi-datadog
License: Apache-2.0
Notes: This Pulumi package is based on the datadog Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud