1. Packages
  2. Datadog Provider
  3. API Docs
  4. SyntheticsGlobalVariable
Viewing docs for Datadog v4.68.0
published on Wednesday, Feb 25, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-datadog

datadog.SyntheticsGlobalVariable

datadog logo
Viewing docs for Datadog v4.68.0
published on Wednesday, Feb 25, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-datadog

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

    Example Usage

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

// Basic Usage
const testVariable = new datadog.SyntheticsGlobalVariable("test_variable", {
    name: "EXAMPLE_VARIABLE",
    description: "Description of the variable",
    tags: [
        "foo:bar",
        "env:test",
    ],
    value: "variable-value",
});
// Write-Only Value (Recommended for Terraform 1.11+)
const secureVariable = new datadog.SyntheticsGlobalVariable("secure_variable", {
    name: "SECURE_VARIABLE",
    description: "Secure global variable with write-only value",
    tags: [
        "foo:bar",
        "env:production",
    ],
    secure: true,
    valueWo: secretValue,
    valueWoVersion: "1",
});
const secretKeepers = {
    rotationDate: "2024-02-15",
    environment: "production",
    securityPolicy: "v3.1",
};
// Auto-generate version from keepers
const secretVersion = `rotation-${std.index.substr({
    input: std.index.md5({
        input: JSON.stringify(secretKeepers),
    }).result,
    length: 0,
    offset: 8,
}).result}`;
const automatedRotation = new datadog.SyntheticsGlobalVariable("automated_rotation", {
    name: "AUTO_ROTATED_VARIABLE",
    description: "Variable with automated rotation",
    tags: [
        "foo:bar",
        "env:production",
    ],
    secure: true,
    valueWo: secretValue,
    valueWoVersion: secretVersion,
});

    import pulumi
import json
import pulumi_datadog as datadog
import pulumi_std as std

# Basic Usage
test_variable = datadog.SyntheticsGlobalVariable("test_variable",
    name="EXAMPLE_VARIABLE",
    description="Description of the variable",
    tags=[
        "foo:bar",
        "env:test",
    ],
    value="variable-value")
# Write-Only Value (Recommended for Terraform 1.11+)
secure_variable = datadog.SyntheticsGlobalVariable("secure_variable",
    name="SECURE_VARIABLE",
    description="Secure global variable with write-only value",
    tags=[
        "foo:bar",
        "env:production",
    ],
    secure=True,
    value_wo=secret_value,
    value_wo_version="1")
secret_keepers = {
    "rotationDate": "2024-02-15",
    "environment": "production",
    "securityPolicy": "v3.1",
}
# Auto-generate version from keepers
secret_version = f"rotation-{std.index.substr(input=std.index.md5(input=json.dumps(secret_keepers))['result'],
    length=0,
    offset=8)['result']}"
automated_rotation = datadog.SyntheticsGlobalVariable("automated_rotation",
    name="AUTO_ROTATED_VARIABLE",
    description="Variable with automated rotation",
    tags=[
        "foo:bar",
        "env:production",
    ],
    secure=True,
    value_wo=secret_value,
    value_wo_version=secret_version)

    package main

import (
	"encoding/json"
	"fmt"

	"github.com/pulumi/pulumi-datadog/sdk/v4/go/datadog"
	"github.com/pulumi/pulumi-std/sdk/go/std"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Basic Usage
		_, err := datadog.NewSyntheticsGlobalVariable(ctx, "test_variable", &datadog.SyntheticsGlobalVariableArgs{
			Name:        pulumi.String("EXAMPLE_VARIABLE"),
			Description: pulumi.String("Description of the variable"),
			Tags: pulumi.StringArray{
				pulumi.String("foo:bar"),
				pulumi.String("env:test"),
			},
			Value: pulumi.String("variable-value"),
		})
		if err != nil {
			return err
		}
		// Write-Only Value (Recommended for Terraform 1.11+)
		_, err = datadog.NewSyntheticsGlobalVariable(ctx, "secure_variable", &datadog.SyntheticsGlobalVariableArgs{
			Name:        pulumi.String("SECURE_VARIABLE"),
			Description: pulumi.String("Secure global variable with write-only value"),
			Tags: pulumi.StringArray{
				pulumi.String("foo:bar"),
				pulumi.String("env:production"),
			},
			Secure:         pulumi.Bool(true),
			ValueWo:        pulumi.Any(secretValue),
			ValueWoVersion: pulumi.String("1"),
		})
		if err != nil {
			return err
		}
		secretKeepers := map[string]interface{}{
			"rotationDate":   "2024-02-15",
			"environment":    "production",
			"securityPolicy": "v3.1",
		}
		tmpJSON0, err := json.Marshal(secretKeepers)
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		// Auto-generate version from keepers
		secretVersion := fmt.Sprintf("rotation-%v", std.Substr(ctx, map[string]interface{}{
			"input": std.Md5(ctx, map[string]interface{}{
				"input": json0,
			}, nil).Result,
			"length": 0,
			"offset": 8,
		}, nil).Result)
		_, err = datadog.NewSyntheticsGlobalVariable(ctx, "automated_rotation", &datadog.SyntheticsGlobalVariableArgs{
			Name:        pulumi.String("AUTO_ROTATED_VARIABLE"),
			Description: pulumi.String("Variable with automated rotation"),
			Tags: pulumi.StringArray{
				pulumi.String("foo:bar"),
				pulumi.String("env:production"),
			},
			Secure:         pulumi.Bool(true),
			ValueWo:        pulumi.Any(secretValue),
			ValueWoVersion: pulumi.String(secretVersion),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Datadog = Pulumi.Datadog;
using Std = Pulumi.Std;

return await Deployment.RunAsync(() => 
{
    // Basic Usage
    var testVariable = new Datadog.SyntheticsGlobalVariable("test_variable", new()
    {
        Name = "EXAMPLE_VARIABLE",
        Description = "Description of the variable",
        Tags = new[]
        {
            "foo:bar",
            "env:test",
        },
        Value = "variable-value",
    });

    // Write-Only Value (Recommended for Terraform 1.11+)
    var secureVariable = new Datadog.SyntheticsGlobalVariable("secure_variable", new()
    {
        Name = "SECURE_VARIABLE",
        Description = "Secure global variable with write-only value",
        Tags = new[]
        {
            "foo:bar",
            "env:production",
        },
        Secure = true,
        ValueWo = secretValue,
        ValueWoVersion = "1",
    });

    var secretKeepers = 
    {
        { "rotationDate", "2024-02-15" },
        { "environment", "production" },
        { "securityPolicy", "v3.1" },
    };

    // Auto-generate version from keepers
    var secretVersion = $"rotation-{Std.Index.Substr.Invoke(new()
    {
        Input = Std.Index.Md5.Invoke(new()
        {
            Input = JsonSerializer.Serialize(secretKeepers),
        }).Result,
        Length = 0,
        Offset = 8,
    }).Result}";

    var automatedRotation = new Datadog.SyntheticsGlobalVariable("automated_rotation", new()
    {
        Name = "AUTO_ROTATED_VARIABLE",
        Description = "Variable with automated rotation",
        Tags = new[]
        {
            "foo:bar",
            "env:production",
        },
        Secure = true,
        ValueWo = secretValue,
        ValueWoVersion = secretVersion,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.datadog.SyntheticsGlobalVariable;
import com.pulumi.datadog.SyntheticsGlobalVariableArgs;
import com.pulumi.std.StdFunctions;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Basic Usage
        var testVariable = new SyntheticsGlobalVariable("testVariable", SyntheticsGlobalVariableArgs.builder()
            .name("EXAMPLE_VARIABLE")
            .description("Description of the variable")
            .tags(            
                "foo:bar",
                "env:test")
            .value("variable-value")
            .build());

        // Write-Only Value (Recommended for Terraform 1.11+)
        var secureVariable = new SyntheticsGlobalVariable("secureVariable", SyntheticsGlobalVariableArgs.builder()
            .name("SECURE_VARIABLE")
            .description("Secure global variable with write-only value")
            .tags(            
                "foo:bar",
                "env:production")
            .secure(true)
            .valueWo(secretValue)
            .valueWoVersion("1")
            .build());

        final var secretKeepers = Map.ofEntries(
            Map.entry("rotationDate", "2024-02-15"),
            Map.entry("environment", "production"),
            Map.entry("securityPolicy", "v3.1")
        );

        // Auto-generate version from keepers
        final var secretVersion = String.format("rotation-%s", StdFunctions.substr(Map.ofEntries(
            Map.entry("input", StdFunctions.md5(Map.of("input", serializeJson(
                secretKeepers))).result()),
            Map.entry("length", 0),
            Map.entry("offset", 8)
        )).result());

        var automatedRotation = new SyntheticsGlobalVariable("automatedRotation", SyntheticsGlobalVariableArgs.builder()
            .name("AUTO_ROTATED_VARIABLE")
            .description("Variable with automated rotation")
            .tags(            
                "foo:bar",
                "env:production")
            .secure(true)
            .valueWo(secretValue)
            .valueWoVersion(secretVersion)
            .build());

    }
}

    resources:
  # Basic Usage
  testVariable:
    type: datadog:SyntheticsGlobalVariable
    name: test_variable
    properties:
      name: EXAMPLE_VARIABLE
      description: Description of the variable
      tags:
        - foo:bar
        - env:test
      value: variable-value
  # Write-Only Value (Recommended for Terraform 1.11+)
  secureVariable:
    type: datadog:SyntheticsGlobalVariable
    name: secure_variable
    properties:
      name: SECURE_VARIABLE
      description: Secure global variable with write-only value
      tags:
        - foo:bar
        - env:production
      secure: true # Write-only value with version trigger
      valueWo: ${secretValue}
      valueWoVersion: '1'
  automatedRotation:
    type: datadog:SyntheticsGlobalVariable
    name: automated_rotation
    properties:
      name: AUTO_ROTATED_VARIABLE
      description: Variable with automated rotation
      tags:
        - foo:bar
        - env:production
      secure: true # Version automatically updates when any keeper changes
      valueWo: ${secretValue}
      valueWoVersion: ${secretVersion}
variables:
  secretKeepers:
    rotationDate: 2024-02-15
    environment: production
    securityPolicy: v3.1
  # Auto-generate version from keepers
  secretVersion:
    fn::join:
      - ""
      - - rotation-
        - fn::invoke:
            function: std:substr
            arguments:
              input:
                fn::invoke:
                  function: std:md5
                  arguments:
                    input:
                      fn::toJSON: ${secretKeepers}
                  return: result
              length: 0
              offset: 8
            return: result

    Create SyntheticsGlobalVariable Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SyntheticsGlobalVariable(name: string, args: SyntheticsGlobalVariableArgs, opts?: CustomResourceOptions);
    @overload
def SyntheticsGlobalVariable(resource_name: str,
                             args: SyntheticsGlobalVariableArgs,
                             opts: Optional[ResourceOptions] = None)

@overload
def SyntheticsGlobalVariable(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             name: Optional[str] = None,
                             parse_test_options: Optional[SyntheticsGlobalVariableParseTestOptionsArgs] = None,
                             is_totp: Optional[bool] = None,
                             is_fido: Optional[bool] = None,
                             options: Optional[SyntheticsGlobalVariableOptionsArgs] = None,
                             parse_test_id: Optional[str] = None,
                             description: Optional[str] = None,
                             restricted_roles: Optional[Sequence[str]] = None,
                             secure: Optional[bool] = None,
                             tags: Optional[Sequence[str]] = None,
                             value: Optional[str] = None,
                             value_wo: Optional[str] = None,
                             value_wo_version: Optional[str] = None)
    func NewSyntheticsGlobalVariable(ctx *Context, name string, args SyntheticsGlobalVariableArgs, opts ...ResourceOption) (*SyntheticsGlobalVariable, error)
    public SyntheticsGlobalVariable(string name, SyntheticsGlobalVariableArgs args, CustomResourceOptions? opts = null)
    public SyntheticsGlobalVariable(String name, SyntheticsGlobalVariableArgs args)
public SyntheticsGlobalVariable(String name, SyntheticsGlobalVariableArgs args, CustomResourceOptions options)

    type: datadog:SyntheticsGlobalVariable
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.
    args SyntheticsGlobalVariableArgs
    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 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.
    name String
    The unique name of the resource.
    args SyntheticsGlobalVariableArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var syntheticsGlobalVariableResource = new Datadog.SyntheticsGlobalVariable("syntheticsGlobalVariableResource", new()
{
    Name = "string",
    ParseTestOptions = new Datadog.Inputs.SyntheticsGlobalVariableParseTestOptionsArgs
    {
        Type = "string",
        Field = "string",
        LocalVariableName = "string",
        Parser = new Datadog.Inputs.SyntheticsGlobalVariableParseTestOptionsParserArgs
        {
            Type = "string",
            Value = "string",
        },
    },
    IsTotp = false,
    IsFido = false,
    Options = new Datadog.Inputs.SyntheticsGlobalVariableOptionsArgs
    {
        TotpParameters = new Datadog.Inputs.SyntheticsGlobalVariableOptionsTotpParametersArgs
        {
            Digits = 0,
            RefreshInterval = 0,
        },
    },
    ParseTestId = "string",
    Description = "string",
    Secure = false,
    Tags = new[]
    {
        "string",
    },
    Value = "string",
    ValueWo = "string",
    ValueWoVersion = "string",
});

    example, err := datadog.NewSyntheticsGlobalVariable(ctx, "syntheticsGlobalVariableResource", &datadog.SyntheticsGlobalVariableArgs{
	Name: pulumi.String("string"),
	ParseTestOptions: &datadog.SyntheticsGlobalVariableParseTestOptionsArgs{
		Type:              pulumi.String("string"),
		Field:             pulumi.String("string"),
		LocalVariableName: pulumi.String("string"),
		Parser: &datadog.SyntheticsGlobalVariableParseTestOptionsParserArgs{
			Type:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	IsTotp: pulumi.Bool(false),
	IsFido: pulumi.Bool(false),
	Options: &datadog.SyntheticsGlobalVariableOptionsArgs{
		TotpParameters: &datadog.SyntheticsGlobalVariableOptionsTotpParametersArgs{
			Digits:          pulumi.Int(0),
			RefreshInterval: pulumi.Int(0),
		},
	},
	ParseTestId: pulumi.String("string"),
	Description: pulumi.String("string"),
	Secure:      pulumi.Bool(false),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Value:          pulumi.String("string"),
	ValueWo:        pulumi.String("string"),
	ValueWoVersion: pulumi.String("string"),
})

    var syntheticsGlobalVariableResource = new SyntheticsGlobalVariable("syntheticsGlobalVariableResource", SyntheticsGlobalVariableArgs.builder()
    .name("string")
    .parseTestOptions(SyntheticsGlobalVariableParseTestOptionsArgs.builder()
        .type("string")
        .field("string")
        .localVariableName("string")
        .parser(SyntheticsGlobalVariableParseTestOptionsParserArgs.builder()
            .type("string")
            .value("string")
            .build())
        .build())
    .isTotp(false)
    .isFido(false)
    .options(SyntheticsGlobalVariableOptionsArgs.builder()
        .totpParameters(SyntheticsGlobalVariableOptionsTotpParametersArgs.builder()
            .digits(0)
            .refreshInterval(0)
            .build())
        .build())
    .parseTestId("string")
    .description("string")
    .secure(false)
    .tags("string")
    .value("string")
    .valueWo("string")
    .valueWoVersion("string")
    .build());

    synthetics_global_variable_resource = datadog.SyntheticsGlobalVariable("syntheticsGlobalVariableResource",
    name="string",
    parse_test_options={
        "type": "string",
        "field": "string",
        "local_variable_name": "string",
        "parser": {
            "type": "string",
            "value": "string",
        },
    },
    is_totp=False,
    is_fido=False,
    options={
        "totp_parameters": {
            "digits": 0,
            "refresh_interval": 0,
        },
    },
    parse_test_id="string",
    description="string",
    secure=False,
    tags=["string"],
    value="string",
    value_wo="string",
    value_wo_version="string")

    const syntheticsGlobalVariableResource = new datadog.SyntheticsGlobalVariable("syntheticsGlobalVariableResource", {
    name: "string",
    parseTestOptions: {
        type: "string",
        field: "string",
        localVariableName: "string",
        parser: {
            type: "string",
            value: "string",
        },
    },
    isTotp: false,
    isFido: false,
    options: {
        totpParameters: {
            digits: 0,
            refreshInterval: 0,
        },
    },
    parseTestId: "string",
    description: "string",
    secure: false,
    tags: ["string"],
    value: "string",
    valueWo: "string",
    valueWoVersion: "string",
});

    type: datadog:SyntheticsGlobalVariable
properties:
    description: string
    isFido: false
    isTotp: false
    name: string
    options:
        totpParameters:
            digits: 0
            refreshInterval: 0
    parseTestId: string
    parseTestOptions:
        field: string
        localVariableName: string
        parser:
            type: string
            value: string
        type: string
    secure: false
    tags:
        - string
    value: string
    valueWo: string
    valueWoVersion: string

    SyntheticsGlobalVariable Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SyntheticsGlobalVariable resource accepts the following input properties:

    Name string
    Synthetics global variable name. Must be all uppercase with underscores.
    Description string
    Description of the global variable. Defaults to "".
    IsFido bool
    If set to true, the global variable is a FIDO variable. Defaults to false.
    IsTotp bool
    If set to true, the global variable is a TOTP variable. Defaults to false.
    Options SyntheticsGlobalVariableOptions
    Additional options for the variable, such as a MFA token.
    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.
    RestrictedRoles List<string>
    A list of role identifiers to associate with the Synthetics global variable. Deprecated. This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Secure bool
    If set to true, the value of the global variable is hidden. This setting is automatically set to true if is_totp or is_fido is set to true. 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. Required unless is_fido is set to true or value_wo is used
    ValueWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only value of the global variable. Must be used with value_wo_version.
    ValueWoVersion string
    Version associated with the write-only value. Changing this triggers an update. Can be any string (e.g., '1', 'v2.1', '2024-Q1'). String length must be at least 1.
    Name string
    Synthetics global variable name. Must be all uppercase with underscores.
    Description string
    Description of the global variable. Defaults to "".
    IsFido bool
    If set to true, the global variable is a FIDO variable. Defaults to false.
    IsTotp bool
    If set to true, the global variable is a TOTP variable. Defaults to false.
    Options SyntheticsGlobalVariableOptionsArgs
    Additional options for the variable, such as a MFA token.
    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.
    RestrictedRoles []string
    A list of role identifiers to associate with the Synthetics global variable. Deprecated. This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Secure bool
    If set to true, the value of the global variable is hidden. This setting is automatically set to true if is_totp or is_fido is set to true. Defaults to false.
    Tags []string
    A list of tags to associate with your synthetics global variable.
    Value string
    The value of the global variable. Required unless is_fido is set to true or value_wo is used
    ValueWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only value of the global variable. Must be used with value_wo_version.
    ValueWoVersion string
    Version associated with the write-only value. Changing this triggers an update. Can be any string (e.g., '1', 'v2.1', '2024-Q1'). String length must be at least 1.
    name String
    Synthetics global variable name. Must be all uppercase with underscores.
    description String
    Description of the global variable. Defaults to "".
    isFido Boolean
    If set to true, the global variable is a FIDO variable. Defaults to false.
    isTotp Boolean
    If set to true, the global variable is a TOTP variable. Defaults to false.
    options SyntheticsGlobalVariableOptions
    Additional options for the variable, such as a MFA token.
    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.
    restrictedRoles List<String>
    A list of role identifiers to associate with the Synthetics global variable. Deprecated. This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    secure Boolean
    If set to true, the value of the global variable is hidden. This setting is automatically set to true if is_totp or is_fido is set to true. 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. Required unless is_fido is set to true or value_wo is used
    valueWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only value of the global variable. Must be used with value_wo_version.
    valueWoVersion String
    Version associated with the write-only value. Changing this triggers an update. Can be any string (e.g., '1', 'v2.1', '2024-Q1'). String length must be at least 1.
    name string
    Synthetics global variable name. Must be all uppercase with underscores.
    description string
    Description of the global variable. Defaults to "".
    isFido boolean
    If set to true, the global variable is a FIDO variable. Defaults to false.
    isTotp boolean
    If set to true, the global variable is a TOTP variable. Defaults to false.
    options SyntheticsGlobalVariableOptions
    Additional options for the variable, such as a MFA token.
    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.
    restrictedRoles string[]
    A list of role identifiers to associate with the Synthetics global variable. Deprecated. This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    secure boolean
    If set to true, the value of the global variable is hidden. This setting is automatically set to true if is_totp or is_fido is set to true. Defaults to false.
    tags string[]
    A list of tags to associate with your synthetics global variable.
    value string
    The value of the global variable. Required unless is_fido is set to true or value_wo is used
    valueWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only value of the global variable. Must be used with value_wo_version.
    valueWoVersion string
    Version associated with the write-only value. Changing this triggers an update. Can be any string (e.g., '1', 'v2.1', '2024-Q1'). String length must be at least 1.
    name str
    Synthetics global variable name. Must be all uppercase with underscores.
    description str
    Description of the global variable. Defaults to "".
    is_fido bool
    If set to true, the global variable is a FIDO variable. Defaults to false.
    is_totp bool
    If set to true, the global variable is a TOTP variable. Defaults to false.
    options SyntheticsGlobalVariableOptionsArgs
    Additional options for the variable, such as a MFA token.
    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.
    restricted_roles Sequence[str]
    A list of role identifiers to associate with the Synthetics global variable. Deprecated. This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    secure bool
    If set to true, the value of the global variable is hidden. This setting is automatically set to true if is_totp or is_fido is set to true. 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. Required unless is_fido is set to true or value_wo is used
    value_wo str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only value of the global variable. Must be used with value_wo_version.
    value_wo_version str
    Version associated with the write-only value. Changing this triggers an update. Can be any string (e.g., '1', 'v2.1', '2024-Q1'). String length must be at least 1.
    name String
    Synthetics global variable name. Must be all uppercase with underscores.
    description String
    Description of the global variable. Defaults to "".
    isFido Boolean
    If set to true, the global variable is a FIDO variable. Defaults to false.
    isTotp Boolean
    If set to true, the global variable is a TOTP variable. Defaults to false.
    options Property Map
    Additional options for the variable, such as a MFA token.
    parseTestId String
    Id of the Synthetics test to use for a variable from test.
    parseTestOptions Property Map
    ID of the Synthetics test to use a source of the global variable value.
    restrictedRoles List<String>
    A list of role identifiers to associate with the Synthetics global variable. Deprecated. This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    secure Boolean
    If set to true, the value of the global variable is hidden. This setting is automatically set to true if is_totp or is_fido is set to true. 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. Required unless is_fido is set to true or value_wo is used
    valueWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only value of the global variable. Must be used with value_wo_version.
    valueWoVersion String
    Version associated with the write-only value. Changing this triggers an update. Can be any string (e.g., '1', 'v2.1', '2024-Q1'). String length must be at least 1.

    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 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 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,
        is_fido: Optional[bool] = None,
        is_totp: Optional[bool] = None,
        name: Optional[str] = None,
        options: Optional[SyntheticsGlobalVariableOptionsArgs] = None,
        parse_test_id: Optional[str] = None,
        parse_test_options: Optional[SyntheticsGlobalVariableParseTestOptionsArgs] = None,
        restricted_roles: Optional[Sequence[str]] = None,
        secure: Optional[bool] = None,
        tags: Optional[Sequence[str]] = None,
        value: Optional[str] = None,
        value_wo: Optional[str] = None,
        value_wo_version: 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)
    public static SyntheticsGlobalVariable get(String name, Output<String> id, SyntheticsGlobalVariableState state, CustomResourceOptions options)
    resources:  _:    type: datadog:SyntheticsGlobalVariable    get:      id: ${id}
    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:
    Description string
    Description of the global variable. Defaults to "".
    IsFido bool
    If set to true, the global variable is a FIDO variable. Defaults to false.
    IsTotp bool
    If set to true, the global variable is a TOTP variable. Defaults to false.
    Name string
    Synthetics global variable name. Must be all uppercase with underscores.
    Options SyntheticsGlobalVariableOptions
    Additional options for the variable, such as a MFA token.
    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.
    RestrictedRoles List<string>
    A list of role identifiers to associate with the Synthetics global variable. Deprecated. This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Secure bool
    If set to true, the value of the global variable is hidden. This setting is automatically set to true if is_totp or is_fido is set to true. 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. Required unless is_fido is set to true or value_wo is used
    ValueWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only value of the global variable. Must be used with value_wo_version.
    ValueWoVersion string
    Version associated with the write-only value. Changing this triggers an update. Can be any string (e.g., '1', 'v2.1', '2024-Q1'). String length must be at least 1.
    Description string
    Description of the global variable. Defaults to "".
    IsFido bool
    If set to true, the global variable is a FIDO variable. Defaults to false.
    IsTotp bool
    If set to true, the global variable is a TOTP variable. Defaults to false.
    Name string
    Synthetics global variable name. Must be all uppercase with underscores.
    Options SyntheticsGlobalVariableOptionsArgs
    Additional options for the variable, such as a MFA token.
    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.
    RestrictedRoles []string
    A list of role identifiers to associate with the Synthetics global variable. Deprecated. This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Secure bool
    If set to true, the value of the global variable is hidden. This setting is automatically set to true if is_totp or is_fido is set to true. Defaults to false.
    Tags []string
    A list of tags to associate with your synthetics global variable.
    Value string
    The value of the global variable. Required unless is_fido is set to true or value_wo is used
    ValueWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only value of the global variable. Must be used with value_wo_version.
    ValueWoVersion string
    Version associated with the write-only value. Changing this triggers an update. Can be any string (e.g., '1', 'v2.1', '2024-Q1'). String length must be at least 1.
    description String
    Description of the global variable. Defaults to "".
    isFido Boolean
    If set to true, the global variable is a FIDO variable. Defaults to false.
    isTotp Boolean
    If set to true, the global variable is a TOTP variable. Defaults to false.
    name String
    Synthetics global variable name. Must be all uppercase with underscores.
    options SyntheticsGlobalVariableOptions
    Additional options for the variable, such as a MFA token.
    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.
    restrictedRoles List<String>
    A list of role identifiers to associate with the Synthetics global variable. Deprecated. This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    secure Boolean
    If set to true, the value of the global variable is hidden. This setting is automatically set to true if is_totp or is_fido is set to true. 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. Required unless is_fido is set to true or value_wo is used
    valueWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only value of the global variable. Must be used with value_wo_version.
    valueWoVersion String
    Version associated with the write-only value. Changing this triggers an update. Can be any string (e.g., '1', 'v2.1', '2024-Q1'). String length must be at least 1.
    description string
    Description of the global variable. Defaults to "".
    isFido boolean
    If set to true, the global variable is a FIDO variable. Defaults to false.
    isTotp boolean
    If set to true, the global variable is a TOTP variable. Defaults to false.
    name string
    Synthetics global variable name. Must be all uppercase with underscores.
    options SyntheticsGlobalVariableOptions
    Additional options for the variable, such as a MFA token.
    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.
    restrictedRoles string[]
    A list of role identifiers to associate with the Synthetics global variable. Deprecated. This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    secure boolean
    If set to true, the value of the global variable is hidden. This setting is automatically set to true if is_totp or is_fido is set to true. Defaults to false.
    tags string[]
    A list of tags to associate with your synthetics global variable.
    value string
    The value of the global variable. Required unless is_fido is set to true or value_wo is used
    valueWo string
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only value of the global variable. Must be used with value_wo_version.
    valueWoVersion string
    Version associated with the write-only value. Changing this triggers an update. Can be any string (e.g., '1', 'v2.1', '2024-Q1'). String length must be at least 1.
    description str
    Description of the global variable. Defaults to "".
    is_fido bool
    If set to true, the global variable is a FIDO variable. Defaults to false.
    is_totp bool
    If set to true, the global variable is a TOTP variable. Defaults to false.
    name str
    Synthetics global variable name. Must be all uppercase with underscores.
    options SyntheticsGlobalVariableOptionsArgs
    Additional options for the variable, such as a MFA token.
    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.
    restricted_roles Sequence[str]
    A list of role identifiers to associate with the Synthetics global variable. Deprecated. This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    secure bool
    If set to true, the value of the global variable is hidden. This setting is automatically set to true if is_totp or is_fido is set to true. 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. Required unless is_fido is set to true or value_wo is used
    value_wo str
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only value of the global variable. Must be used with value_wo_version.
    value_wo_version str
    Version associated with the write-only value. Changing this triggers an update. Can be any string (e.g., '1', 'v2.1', '2024-Q1'). String length must be at least 1.
    description String
    Description of the global variable. Defaults to "".
    isFido Boolean
    If set to true, the global variable is a FIDO variable. Defaults to false.
    isTotp Boolean
    If set to true, the global variable is a TOTP variable. Defaults to false.
    name String
    Synthetics global variable name. Must be all uppercase with underscores.
    options Property Map
    Additional options for the variable, such as a MFA token.
    parseTestId String
    Id of the Synthetics test to use for a variable from test.
    parseTestOptions Property Map
    ID of the Synthetics test to use a source of the global variable value.
    restrictedRoles List<String>
    A list of role identifiers to associate with the Synthetics global variable. Deprecated. This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    secure Boolean
    If set to true, the value of the global variable is hidden. This setting is automatically set to true if is_totp or is_fido is set to true. 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. Required unless is_fido is set to true or value_wo is used
    valueWo String
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Write-only value of the global variable. Must be used with value_wo_version.
    valueWoVersion String
    Version associated with the write-only value. Changing this triggers an update. Can be any string (e.g., '1', 'v2.1', '2024-Q1'). String length must be at least 1.

    Supporting Types

    SyntheticsGlobalVariableOptions, SyntheticsGlobalVariableOptionsArgs

    totpParameters Property Map
    Parameters needed for MFA/TOTP.

    SyntheticsGlobalVariableOptionsTotpParameters, SyntheticsGlobalVariableOptionsTotpParametersArgs

    Digits int
    Number of digits for the OTP. Value must be between 4 and 10.
    RefreshInterval int
    Interval for which to refresh the token (in seconds). Value must be between 0 and 999.
    Digits int
    Number of digits for the OTP. Value must be between 4 and 10.
    RefreshInterval int
    Interval for which to refresh the token (in seconds). Value must be between 0 and 999.
    digits Integer
    Number of digits for the OTP. Value must be between 4 and 10.
    refreshInterval Integer
    Interval for which to refresh the token (in seconds). Value must be between 0 and 999.
    digits number
    Number of digits for the OTP. Value must be between 4 and 10.
    refreshInterval number
    Interval for which to refresh the token (in seconds). Value must be between 0 and 999.
    digits int
    Number of digits for the OTP. Value must be between 4 and 10.
    refresh_interval int
    Interval for which to refresh the token (in seconds). Value must be between 0 and 999.
    digits Number
    Number of digits for the OTP. Value must be between 4 and 10.
    refreshInterval Number
    Interval for which to refresh the token (in seconds). Value must be between 0 and 999.

    SyntheticsGlobalVariableParseTestOptions, SyntheticsGlobalVariableParseTestOptionsArgs

    Type string
    Defines the source to use to extract the value. Valid values are http_body, http_header, http_status_code, local_variable.
    Field string
    Required when type = http_header. Defines the header to use to extract the value
    LocalVariableName string
    When type is local_variable, name of the local variable to use to extract the value.
    Parser SyntheticsGlobalVariableParseTestOptionsParser
    Type string
    Defines the source to use to extract the value. Valid values are http_body, http_header, http_status_code, local_variable.
    Field string
    Required when type = http_header. Defines the header to use to extract the value
    LocalVariableName string
    When type is local_variable, name of the local variable to use to extract the value.
    Parser SyntheticsGlobalVariableParseTestOptionsParser
    type String
    Defines the source to use to extract the value. Valid values are http_body, http_header, http_status_code, local_variable.
    field String
    Required when type = http_header. Defines the header to use to extract the value
    localVariableName String
    When type is local_variable, name of the local variable to use to extract the value.
    parser SyntheticsGlobalVariableParseTestOptionsParser
    type string
    Defines the source to use to extract the value. Valid values are http_body, http_header, http_status_code, local_variable.
    field string
    Required when type = http_header. Defines the header to use to extract the value
    localVariableName string
    When type is local_variable, name of the local variable to use to extract the value.
    parser SyntheticsGlobalVariableParseTestOptionsParser
    type str
    Defines the source to use to extract the value. Valid values are http_body, http_header, http_status_code, local_variable.
    field str
    Required when type = http_header. Defines the header to use to extract the value
    local_variable_name str
    When type is local_variable, name of the local variable to use to extract the value.
    parser SyntheticsGlobalVariableParseTestOptionsParser
    type String
    Defines the source to use to extract the value. Valid values are http_body, http_header, http_status_code, local_variable.
    field String
    Required when type = http_header. Defines the header to use to extract the value
    localVariableName String
    When type is local_variable, name of the local variable to use to extract the value.
    parser Property Map

    SyntheticsGlobalVariableParseTestOptionsParser, SyntheticsGlobalVariableParseTestOptionsParserArgs

    Type string
    Type of parser to extract the value. Valid values are raw, json_path, regex, x_path.
    Value string
    Value for the parser to use, required for type json_path or regex.
    Type string
    Type of parser to extract the value. Valid values are raw, json_path, regex, x_path.
    Value string
    Value for the parser to use, required for type json_path or regex.
    type String
    Type of parser to extract the value. Valid values are raw, json_path, regex, x_path.
    value String
    Value for the parser to use, required for type json_path or regex.
    type string
    Type of parser to extract the value. Valid values are raw, json_path, regex, x_path.
    value string
    Value for the parser to use, required for type json_path or regex.
    type str
    Type of parser to extract the value. Valid values are raw, json_path, regex, x_path.
    value str
    Value for the parser to use, required for type json_path or regex.
    type String
    Type of parser to extract the value. Valid values are raw, json_path, regex, x_path.
    value String
    Value for the parser to use, required for type json_path or regex.

    Import

    The pulumi import command can be used, for example:

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

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Datadog pulumi/pulumi-datadog
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the datadog Terraform Provider.
    datadog logo
    Viewing docs for Datadog v4.68.0
    published on Wednesday, Feb 25, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-datadog
      Try Pulumi Cloud free. Your team will thank you.