datadog.SyntheticsGlobalVariable
Explore with Pulumi AI
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";
const testVariable = new datadog.SyntheticsGlobalVariable("test_variable", {
name: "EXAMPLE_VARIABLE",
description: "Description of the variable",
tags: [
"foo:bar",
"env:test",
],
value: "variable-value",
});
import pulumi
import pulumi_datadog as datadog
test_variable = datadog.SyntheticsGlobalVariable("test_variable",
name="EXAMPLE_VARIABLE",
description="Description of the variable",
tags=[
"foo:bar",
"env:test",
],
value="variable-value")
package main
import (
"github.com/pulumi/pulumi-datadog/sdk/v4/go/datadog"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, 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
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Datadog = Pulumi.Datadog;
return await Deployment.RunAsync(() =>
{
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",
});
});
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 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) {
var testVariable = new SyntheticsGlobalVariable("testVariable", SyntheticsGlobalVariableArgs.builder()
.name("EXAMPLE_VARIABLE")
.description("Description of the variable")
.tags(
"foo:bar",
"env:test")
.value("variable-value")
.build());
}
}
resources:
testVariable:
type: datadog:SyntheticsGlobalVariable
name: test_variable
properties:
name: EXAMPLE_VARIABLE
description: Description of the variable
tags:
- foo:bar
- env:test
value: variable-value
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,
value: Optional[str] = None,
description: 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)
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",
Value = "string",
Description = "string",
Options = new Datadog.Inputs.SyntheticsGlobalVariableOptionsArgs
{
TotpParameters = new Datadog.Inputs.SyntheticsGlobalVariableOptionsTotpParametersArgs
{
Digits = 0,
RefreshInterval = 0,
},
},
ParseTestId = "string",
ParseTestOptions = new Datadog.Inputs.SyntheticsGlobalVariableParseTestOptionsArgs
{
Type = "string",
Field = "string",
LocalVariableName = "string",
Parser = new Datadog.Inputs.SyntheticsGlobalVariableParseTestOptionsParserArgs
{
Type = "string",
Value = "string",
},
},
RestrictedRoles = new[]
{
"string",
},
Secure = false,
Tags = new[]
{
"string",
},
});
example, err := datadog.NewSyntheticsGlobalVariable(ctx, "syntheticsGlobalVariableResource", &datadog.SyntheticsGlobalVariableArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
Description: pulumi.String("string"),
Options: &datadog.SyntheticsGlobalVariableOptionsArgs{
TotpParameters: &datadog.SyntheticsGlobalVariableOptionsTotpParametersArgs{
Digits: pulumi.Int(0),
RefreshInterval: pulumi.Int(0),
},
},
ParseTestId: 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"),
},
},
RestrictedRoles: pulumi.StringArray{
pulumi.String("string"),
},
Secure: pulumi.Bool(false),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})
var syntheticsGlobalVariableResource = new SyntheticsGlobalVariable("syntheticsGlobalVariableResource", SyntheticsGlobalVariableArgs.builder()
.name("string")
.value("string")
.description("string")
.options(SyntheticsGlobalVariableOptionsArgs.builder()
.totpParameters(SyntheticsGlobalVariableOptionsTotpParametersArgs.builder()
.digits(0)
.refreshInterval(0)
.build())
.build())
.parseTestId("string")
.parseTestOptions(SyntheticsGlobalVariableParseTestOptionsArgs.builder()
.type("string")
.field("string")
.localVariableName("string")
.parser(SyntheticsGlobalVariableParseTestOptionsParserArgs.builder()
.type("string")
.value("string")
.build())
.build())
.restrictedRoles("string")
.secure(false)
.tags("string")
.build());
synthetics_global_variable_resource = datadog.SyntheticsGlobalVariable("syntheticsGlobalVariableResource",
name="string",
value="string",
description="string",
options={
"totp_parameters": {
"digits": 0,
"refresh_interval": 0,
},
},
parse_test_id="string",
parse_test_options={
"type": "string",
"field": "string",
"local_variable_name": "string",
"parser": {
"type": "string",
"value": "string",
},
},
restricted_roles=["string"],
secure=False,
tags=["string"])
const syntheticsGlobalVariableResource = new datadog.SyntheticsGlobalVariable("syntheticsGlobalVariableResource", {
name: "string",
value: "string",
description: "string",
options: {
totpParameters: {
digits: 0,
refreshInterval: 0,
},
},
parseTestId: "string",
parseTestOptions: {
type: "string",
field: "string",
localVariableName: "string",
parser: {
type: "string",
value: "string",
},
},
restrictedRoles: ["string"],
secure: false,
tags: ["string"],
});
type: datadog:SyntheticsGlobalVariable
properties:
description: string
name: string
options:
totpParameters:
digits: 0
refreshInterval: 0
parseTestId: string
parseTestOptions:
field: string
localVariableName: string
parser:
type: string
value: string
type: string
restrictedRoles:
- string
secure: false
tags:
- string
value: 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.
- Value string
- The value of the global variable.
- Description string
- Description of the global variable.
- Options
Synthetics
Global Variable Options - Additional options for the variable, such as a MFA token.
- Parse
Test stringId - Id of the Synthetics test to use for a variable from test.
- Parse
Test SyntheticsOptions Global Variable Parse Test Options - ID of the Synthetics test to use a source of the global variable value.
- Restricted
Roles List<string> - A list of role identifiers to associate with the Synthetics global variable.
- Secure bool
- If set to true, the value of the global variable is hidden. Defaults to
false
. - 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.
- Options
Synthetics
Global Variable Options Args - Additional options for the variable, such as a MFA token.
- Parse
Test stringId - Id of the Synthetics test to use for a variable from test.
- Parse
Test SyntheticsOptions Global Variable Parse Test Options Args - ID of the Synthetics test to use a source of the global variable value.
- Restricted
Roles []string - A list of role identifiers to associate with the Synthetics global variable.
- Secure bool
- If set to true, the value of the global variable is hidden. Defaults to
false
. - []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.
- options
Synthetics
Global Variable Options - Additional options for the variable, such as a MFA token.
- parse
Test StringId - Id of the Synthetics test to use for a variable from test.
- parse
Test SyntheticsOptions Global Variable Parse Test Options - ID of the Synthetics test to use a source of the global variable value.
- restricted
Roles List<String> - A list of role identifiers to associate with the Synthetics global variable.
- secure Boolean
- If set to true, the value of the global variable is hidden. Defaults to
false
. - 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.
- options
Synthetics
Global Variable Options - Additional options for the variable, such as a MFA token.
- parse
Test stringId - Id of the Synthetics test to use for a variable from test.
- parse
Test SyntheticsOptions Global Variable Parse Test Options - ID of the Synthetics test to use a source of the global variable value.
- restricted
Roles string[] - A list of role identifiers to associate with the Synthetics global variable.
- secure boolean
- If set to true, the value of the global variable is hidden. Defaults to
false
. - 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.
- options
Synthetics
Global Variable Options Args - Additional options for the variable, such as a MFA token.
- parse_
test_ strid - Id of the Synthetics test to use for a variable from test.
- parse_
test_ Syntheticsoptions Global Variable Parse Test Options Args - 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.
- secure bool
- If set to true, the value of the global variable is hidden. Defaults to
false
. - Sequence[str]
- 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.
- options Property Map
- Additional options for the variable, such as a MFA token.
- parse
Test StringId - Id of the Synthetics test to use for a variable from test.
- parse
Test Property MapOptions - ID of the Synthetics test to use a source of the global variable value.
- restricted
Roles List<String> - A list of role identifiers to associate with the Synthetics global variable.
- secure Boolean
- If set to true, the value of the global variable is hidden. Defaults to
false
. - List<String>
- 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 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,
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) -> 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)
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.
- Description string
- Description of the global variable.
- Name string
- Synthetics global variable name.
- Options
Synthetics
Global Variable Options - Additional options for the variable, such as a MFA token.
- Parse
Test stringId - Id of the Synthetics test to use for a variable from test.
- Parse
Test SyntheticsOptions Global Variable Parse Test Options - ID of the Synthetics test to use a source of the global variable value.
- Restricted
Roles List<string> - A list of role identifiers to associate with the Synthetics global variable.
- Secure bool
- If set to true, the value of the global variable is hidden. Defaults to
false
. - 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.
- Options
Synthetics
Global Variable Options Args - Additional options for the variable, such as a MFA token.
- Parse
Test stringId - Id of the Synthetics test to use for a variable from test.
- Parse
Test SyntheticsOptions Global Variable Parse Test Options Args - ID of the Synthetics test to use a source of the global variable value.
- Restricted
Roles []string - A list of role identifiers to associate with the Synthetics global variable.
- Secure bool
- If set to true, the value of the global variable is hidden. Defaults to
false
. - []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.
- options
Synthetics
Global Variable Options - Additional options for the variable, such as a MFA token.
- parse
Test StringId - Id of the Synthetics test to use for a variable from test.
- parse
Test SyntheticsOptions Global Variable Parse Test Options - ID of the Synthetics test to use a source of the global variable value.
- restricted
Roles List<String> - A list of role identifiers to associate with the Synthetics global variable.
- secure Boolean
- If set to true, the value of the global variable is hidden. Defaults to
false
. - 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.
- options
Synthetics
Global Variable Options - Additional options for the variable, such as a MFA token.
- parse
Test stringId - Id of the Synthetics test to use for a variable from test.
- parse
Test SyntheticsOptions Global Variable Parse Test Options - ID of the Synthetics test to use a source of the global variable value.
- restricted
Roles string[] - A list of role identifiers to associate with the Synthetics global variable.
- secure boolean
- If set to true, the value of the global variable is hidden. Defaults to
false
. - 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.
- options
Synthetics
Global Variable Options Args - Additional options for the variable, such as a MFA token.
- parse_
test_ strid - Id of the Synthetics test to use for a variable from test.
- parse_
test_ Syntheticsoptions Global Variable Parse Test Options Args - 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.
- secure bool
- If set to true, the value of the global variable is hidden. Defaults to
false
. - Sequence[str]
- A list of tags to associate with your synthetics global variable.
- value str
- The value of the global variable.
- description String
- Description of the global variable.
- name String
- Synthetics global variable name.
- options Property Map
- Additional options for the variable, such as a MFA token.
- parse
Test StringId - Id of the Synthetics test to use for a variable from test.
- parse
Test Property MapOptions - ID of the Synthetics test to use a source of the global variable value.
- restricted
Roles List<String> - A list of role identifiers to associate with the Synthetics global variable.
- secure Boolean
- If set to true, the value of the global variable is hidden. Defaults to
false
. - List<String>
- A list of tags to associate with your synthetics global variable.
- value String
- The value of the global variable.
Supporting Types
SyntheticsGlobalVariableOptions, SyntheticsGlobalVariableOptionsArgs
- Totp
Parameters SyntheticsGlobal Variable Options Totp Parameters - Parameters needed for MFA/TOTP.
- Totp
Parameters SyntheticsGlobal Variable Options Totp Parameters - Parameters needed for MFA/TOTP.
- totp
Parameters SyntheticsGlobal Variable Options Totp Parameters - Parameters needed for MFA/TOTP.
- totp
Parameters SyntheticsGlobal Variable Options Totp Parameters - Parameters needed for MFA/TOTP.
- totp_
parameters SyntheticsGlobal Variable Options Totp Parameters - Parameters needed for MFA/TOTP.
- totp
Parameters Property Map - Parameters needed for MFA/TOTP.
SyntheticsGlobalVariableOptionsTotpParameters, SyntheticsGlobalVariableOptionsTotpParametersArgs
- Digits int
- Number of digits for the OTP.
- Refresh
Interval int - Interval for which to refresh the token (in seconds).
- Digits int
- Number of digits for the OTP.
- Refresh
Interval int - Interval for which to refresh the token (in seconds).
- digits Integer
- Number of digits for the OTP.
- refresh
Interval Integer - Interval for which to refresh the token (in seconds).
- digits number
- Number of digits for the OTP.
- refresh
Interval number - Interval for which to refresh the token (in seconds).
- digits int
- Number of digits for the OTP.
- refresh_
interval int - Interval for which to refresh the token (in seconds).
- digits Number
- Number of digits for the OTP.
- refresh
Interval Number - Interval for which to refresh the token (in seconds).
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 - Local
Variable stringName - When type is
local_variable
, name of the local variable to use to extract the value. - Parser
Synthetics
Global Variable Parse Test Options Parser
- 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 - Local
Variable stringName - When type is
local_variable
, name of the local variable to use to extract the value. - Parser
Synthetics
Global Variable Parse Test Options Parser
- 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 - local
Variable StringName - When type is
local_variable
, name of the local variable to use to extract the value. - parser
Synthetics
Global Variable Parse Test Options Parser
- 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 - local
Variable stringName - When type is
local_variable
, name of the local variable to use to extract the value. - parser
Synthetics
Global Variable Parse Test Options Parser
- 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_ strname - When type is
local_variable
, name of the local variable to use to extract the value. - parser
Synthetics
Global Variable Parse Test Options Parser
- 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 - local
Variable StringName - When type is
local_variable
, name of the local variable to use to extract the value. - parser Property Map
SyntheticsGlobalVariableParseTestOptionsParser, SyntheticsGlobalVariableParseTestOptionsParserArgs
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
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.