1. Packages
  2. Datadog
  3. API Docs
  4. SyntheticsTest
Datadog v4.18.1 published on Tuesday, May 23, 2023 by Pulumi

datadog.SyntheticsTest

Explore with Pulumi AI

datadog logo
Datadog v4.18.1 published on Tuesday, May 23, 2023 by Pulumi

    Provides a Datadog synthetics test resource. This can be used to create and manage Datadog synthetics test.

    Warning

    Starting from version 3.1.0+, the direct usage of global variables in the configuration is deprecated, in favor of local variables of type global. As an example, if you were previously using {{ GLOBAL_VAR }} directly in your configuration, add a config_variable of type global with the id matching the id of the global variable GLOBAL_VAR, which can be found in the Synthetics UI or from the output of the datadog.SyntheticsGlobalVariable resource. The name can be chosen freely.

    In practice, it means going from (simplified configuration):

    import * as pulumi from "@pulumi/pulumi";
    
    import pulumi
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    
    return await Deployment.RunAsync(() => 
    {
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    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) {
        }
    }
    
    {}
    

    to

    import * as pulumi from "@pulumi/pulumi";
    
    import pulumi
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    
    return await Deployment.RunAsync(() => 
    {
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    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) {
        }
    }
    
    {}
    

    which you can now use in your request definition:

    import * as pulumi from "@pulumi/pulumi";
    
    import pulumi
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    
    return await Deployment.RunAsync(() => 
    {
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    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) {
        }
    }
    
    {}
    

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Datadog = Pulumi.Datadog;
    
    return await Deployment.RunAsync(() => 
    {
        // Example Usage (Synthetics API test)
        // Create a new Datadog Synthetics API/HTTP test on https://www.example.org
        var testApi = new Datadog.SyntheticsTest("testApi", new()
        {
            Assertions = new[]
            {
                new Datadog.Inputs.SyntheticsTestAssertionArgs
                {
                    Operator = "is",
                    Target = "200",
                    Type = "statusCode",
                },
            },
            Locations = new[]
            {
                "aws:eu-central-1",
            },
            Message = "Notify @pagerduty",
            Name = "An API test on example.org",
            OptionsList = new Datadog.Inputs.SyntheticsTestOptionsListArgs
            {
                MonitorOptions = new Datadog.Inputs.SyntheticsTestOptionsListMonitorOptionsArgs
                {
                    RenotifyInterval = 120,
                },
                Retry = new Datadog.Inputs.SyntheticsTestOptionsListRetryArgs
                {
                    Count = 2,
                    Interval = 300,
                },
                TickEvery = 900,
            },
            RequestDefinition = new Datadog.Inputs.SyntheticsTestRequestDefinitionArgs
            {
                Method = "GET",
                Url = "https://www.example.org",
            },
            RequestHeaders = 
            {
                { "Authentication", "Token: 1234566789" },
                { "Content-Type", "application/json" },
            },
            Status = "live",
            Subtype = "http",
            Tags = new[]
            {
                "foo:bar",
                "foo",
                "env:test",
            },
            Type = "api",
        });
    
        // Example Usage (Synthetics SSL test)
        // Create a new Datadog Synthetics API/SSL test on example.org
        var testSsl = new Datadog.SyntheticsTest("testSsl", new()
        {
            Assertions = new[]
            {
                new Datadog.Inputs.SyntheticsTestAssertionArgs
                {
                    Operator = "isInMoreThan",
                    Target = "30",
                    Type = "certificate",
                },
            },
            Locations = new[]
            {
                "aws:eu-central-1",
            },
            Message = "Notify @pagerduty",
            Name = "An API test on example.org",
            OptionsList = new Datadog.Inputs.SyntheticsTestOptionsListArgs
            {
                AcceptSelfSigned = true,
                TickEvery = 900,
            },
            RequestDefinition = new Datadog.Inputs.SyntheticsTestRequestDefinitionArgs
            {
                Host = "example.org",
                Port = 443,
            },
            Status = "live",
            Subtype = "ssl",
            Tags = new[]
            {
                "foo:bar",
                "foo",
                "env:test",
            },
            Type = "api",
        });
    
        // Example Usage (Synthetics TCP test)
        // Create a new Datadog Synthetics API/TCP test on example.org
        var testTcp = new Datadog.SyntheticsTest("testTcp", new()
        {
            Assertions = new[]
            {
                new Datadog.Inputs.SyntheticsTestAssertionArgs
                {
                    Operator = "lessThan",
                    Target = "2000",
                    Type = "responseTime",
                },
            },
            ConfigVariables = new[]
            {
                new Datadog.Inputs.SyntheticsTestConfigVariableArgs
                {
                    Id = "76636cd1-82e2-4aeb-9cfe-51366a8198a2",
                    Name = "MY_GLOBAL_VAR",
                    Type = "global",
                },
            },
            Locations = new[]
            {
                "aws:eu-central-1",
            },
            Message = "Notify @pagerduty",
            Name = "An API test on example.org",
            OptionsList = new Datadog.Inputs.SyntheticsTestOptionsListArgs
            {
                TickEvery = 900,
            },
            RequestDefinition = new Datadog.Inputs.SyntheticsTestRequestDefinitionArgs
            {
                Host = "example.org",
                Port = 443,
            },
            Status = "live",
            Subtype = "tcp",
            Tags = new[]
            {
                "foo:bar",
                "foo",
                "env:test",
            },
            Type = "api",
        });
    
        // Example Usage (Synthetics DNS test)
        // Create a new Datadog Synthetics API/DNS test on example.org
        var testDns = new Datadog.SyntheticsTest("testDns", new()
        {
            Assertions = new[]
            {
                new Datadog.Inputs.SyntheticsTestAssertionArgs
                {
                    Operator = "is",
                    Property = "A",
                    Target = "0.0.0.0",
                    Type = "recordSome",
                },
            },
            Locations = new[]
            {
                "aws:eu-central-1",
            },
            Message = "Notify @pagerduty",
            Name = "An API test on example.org",
            OptionsList = new Datadog.Inputs.SyntheticsTestOptionsListArgs
            {
                TickEvery = 900,
            },
            RequestDefinition = new Datadog.Inputs.SyntheticsTestRequestDefinitionArgs
            {
                Host = "example.org",
            },
            Status = "live",
            Subtype = "dns",
            Tags = new[]
            {
                "foo:bar",
                "foo",
                "env:test",
            },
            Type = "api",
        });
    
        // Example Usage (Synthetics Multistep API test)
        // Create a new Datadog Synthetics Multistep API test
        var test = new Datadog.SyntheticsTest("test", new()
        {
            ApiSteps = new[]
            {
                new Datadog.Inputs.SyntheticsTestApiStepArgs
                {
                    Assertions = new[]
                    {
                        new Datadog.Inputs.SyntheticsTestApiStepAssertionArgs
                        {
                            Operator = "is",
                            Target = "200",
                            Type = "statusCode",
                        },
                    },
                    Name = "An API test on example.org",
                    RequestDefinition = new Datadog.Inputs.SyntheticsTestApiStepRequestDefinitionArgs
                    {
                        Method = "GET",
                        Url = "https://example.org",
                    },
                    RequestHeaders = 
                    {
                        { "Authentication", "Token: 1234566789" },
                        { "Content-Type", "application/json" },
                    },
                    Subtype = "http",
                },
                new Datadog.Inputs.SyntheticsTestApiStepArgs
                {
                    Assertions = new[]
                    {
                        new Datadog.Inputs.SyntheticsTestApiStepAssertionArgs
                        {
                            Operator = "is",
                            Target = "200",
                            Type = "statusCode",
                        },
                    },
                    Name = "An API test on example.org",
                    RequestDefinition = new Datadog.Inputs.SyntheticsTestApiStepRequestDefinitionArgs
                    {
                        Method = "GET",
                        Url = "http://example.org",
                    },
                    Subtype = "http",
                },
            },
            Locations = new[]
            {
                "aws:eu-central-1",
            },
            Name = "Multistep API test",
            OptionsList = new Datadog.Inputs.SyntheticsTestOptionsListArgs
            {
                AcceptSelfSigned = true,
                TickEvery = 900,
            },
            Status = "live",
            Subtype = "multi",
            Type = "api",
        });
    
        // Example Usage (Synthetics Browser test)
        // Create a new Datadog Synthetics Browser test starting on https://www.example.org
        var testBrowser = new Datadog.SyntheticsTest("testBrowser", new()
        {
            BrowserSteps = new[]
            {
                new Datadog.Inputs.SyntheticsTestBrowserStepArgs
                {
                    Name = "Check current url",
                    Params = new Datadog.Inputs.SyntheticsTestBrowserStepParamsArgs
                    {
                        Check = "contains",
                        Value = "datadoghq",
                    },
                    Type = "assertCurrentUrl",
                },
            },
            BrowserVariables = new[]
            {
                new Datadog.Inputs.SyntheticsTestBrowserVariableArgs
                {
                    Example = "597",
                    Name = "MY_PATTERN_VAR",
                    Pattern = "{{numeric(3)}}",
                    Type = "text",
                },
                new Datadog.Inputs.SyntheticsTestBrowserVariableArgs
                {
                    Example = "jd8-afe-ydv.4546132139@synthetics.dtdg.co",
                    Name = "MY_EMAIL_VAR",
                    Pattern = "jd8-afe-ydv.{{ numeric(10) }}@synthetics.dtdg.co",
                    Type = "email",
                },
                new Datadog.Inputs.SyntheticsTestBrowserVariableArgs
                {
                    Id = "76636cd1-82e2-4aeb-9cfe-51366a8198a2",
                    Name = "MY_GLOBAL_VAR",
                    Type = "global",
                },
            },
            DeviceIds = new[]
            {
                "laptop_large",
            },
            Locations = new[]
            {
                "aws:eu-central-1",
            },
            Message = "Notify @qa",
            Name = "A Browser test on example.org",
            OptionsList = new Datadog.Inputs.SyntheticsTestOptionsListArgs
            {
                TickEvery = 3600,
            },
            RequestDefinition = new Datadog.Inputs.SyntheticsTestRequestDefinitionArgs
            {
                Method = "GET",
                Url = "https://app.datadoghq.com",
            },
            Status = "paused",
            Tags = new[] {},
            Type = "browser",
        });
    
    });
    
    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.NewSyntheticsTest(ctx, "testApi", &datadog.SyntheticsTestArgs{
    			Assertions: datadog.SyntheticsTestAssertionArray{
    				&datadog.SyntheticsTestAssertionArgs{
    					Operator: pulumi.String("is"),
    					Target:   pulumi.String("200"),
    					Type:     pulumi.String("statusCode"),
    				},
    			},
    			Locations: pulumi.StringArray{
    				pulumi.String("aws:eu-central-1"),
    			},
    			Message: pulumi.String("Notify @pagerduty"),
    			Name:    pulumi.String("An API test on example.org"),
    			OptionsList: &datadog.SyntheticsTestOptionsListArgs{
    				MonitorOptions: &datadog.SyntheticsTestOptionsListMonitorOptionsArgs{
    					RenotifyInterval: pulumi.Int(120),
    				},
    				Retry: &datadog.SyntheticsTestOptionsListRetryArgs{
    					Count:    pulumi.Int(2),
    					Interval: pulumi.Int(300),
    				},
    				TickEvery: pulumi.Int(900),
    			},
    			RequestDefinition: &datadog.SyntheticsTestRequestDefinitionArgs{
    				Method: pulumi.String("GET"),
    				Url:    pulumi.String("https://www.example.org"),
    			},
    			RequestHeaders: pulumi.AnyMap{
    				"Authentication": pulumi.Any("Token: 1234566789"),
    				"Content-Type":   pulumi.Any("application/json"),
    			},
    			Status:  pulumi.String("live"),
    			Subtype: pulumi.String("http"),
    			Tags: pulumi.StringArray{
    				pulumi.String("foo:bar"),
    				pulumi.String("foo"),
    				pulumi.String("env:test"),
    			},
    			Type: pulumi.String("api"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = datadog.NewSyntheticsTest(ctx, "testSsl", &datadog.SyntheticsTestArgs{
    			Assertions: datadog.SyntheticsTestAssertionArray{
    				&datadog.SyntheticsTestAssertionArgs{
    					Operator: pulumi.String("isInMoreThan"),
    					Target:   pulumi.String("30"),
    					Type:     pulumi.String("certificate"),
    				},
    			},
    			Locations: pulumi.StringArray{
    				pulumi.String("aws:eu-central-1"),
    			},
    			Message: pulumi.String("Notify @pagerduty"),
    			Name:    pulumi.String("An API test on example.org"),
    			OptionsList: &datadog.SyntheticsTestOptionsListArgs{
    				AcceptSelfSigned: pulumi.Bool(true),
    				TickEvery:        pulumi.Int(900),
    			},
    			RequestDefinition: &datadog.SyntheticsTestRequestDefinitionArgs{
    				Host: pulumi.String("example.org"),
    				Port: pulumi.Int(443),
    			},
    			Status:  pulumi.String("live"),
    			Subtype: pulumi.String("ssl"),
    			Tags: pulumi.StringArray{
    				pulumi.String("foo:bar"),
    				pulumi.String("foo"),
    				pulumi.String("env:test"),
    			},
    			Type: pulumi.String("api"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = datadog.NewSyntheticsTest(ctx, "testTcp", &datadog.SyntheticsTestArgs{
    			Assertions: datadog.SyntheticsTestAssertionArray{
    				&datadog.SyntheticsTestAssertionArgs{
    					Operator: pulumi.String("lessThan"),
    					Target:   pulumi.String("2000"),
    					Type:     pulumi.String("responseTime"),
    				},
    			},
    			ConfigVariables: datadog.SyntheticsTestConfigVariableArray{
    				&datadog.SyntheticsTestConfigVariableArgs{
    					Id:   pulumi.String("76636cd1-82e2-4aeb-9cfe-51366a8198a2"),
    					Name: pulumi.String("MY_GLOBAL_VAR"),
    					Type: pulumi.String("global"),
    				},
    			},
    			Locations: pulumi.StringArray{
    				pulumi.String("aws:eu-central-1"),
    			},
    			Message: pulumi.String("Notify @pagerduty"),
    			Name:    pulumi.String("An API test on example.org"),
    			OptionsList: &datadog.SyntheticsTestOptionsListArgs{
    				TickEvery: pulumi.Int(900),
    			},
    			RequestDefinition: &datadog.SyntheticsTestRequestDefinitionArgs{
    				Host: pulumi.String("example.org"),
    				Port: pulumi.Int(443),
    			},
    			Status:  pulumi.String("live"),
    			Subtype: pulumi.String("tcp"),
    			Tags: pulumi.StringArray{
    				pulumi.String("foo:bar"),
    				pulumi.String("foo"),
    				pulumi.String("env:test"),
    			},
    			Type: pulumi.String("api"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = datadog.NewSyntheticsTest(ctx, "testDns", &datadog.SyntheticsTestArgs{
    			Assertions: datadog.SyntheticsTestAssertionArray{
    				&datadog.SyntheticsTestAssertionArgs{
    					Operator: pulumi.String("is"),
    					Property: pulumi.String("A"),
    					Target:   pulumi.String("0.0.0.0"),
    					Type:     pulumi.String("recordSome"),
    				},
    			},
    			Locations: pulumi.StringArray{
    				pulumi.String("aws:eu-central-1"),
    			},
    			Message: pulumi.String("Notify @pagerduty"),
    			Name:    pulumi.String("An API test on example.org"),
    			OptionsList: &datadog.SyntheticsTestOptionsListArgs{
    				TickEvery: pulumi.Int(900),
    			},
    			RequestDefinition: &datadog.SyntheticsTestRequestDefinitionArgs{
    				Host: pulumi.String("example.org"),
    			},
    			Status:  pulumi.String("live"),
    			Subtype: pulumi.String("dns"),
    			Tags: pulumi.StringArray{
    				pulumi.String("foo:bar"),
    				pulumi.String("foo"),
    				pulumi.String("env:test"),
    			},
    			Type: pulumi.String("api"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = datadog.NewSyntheticsTest(ctx, "test", &datadog.SyntheticsTestArgs{
    			ApiSteps: datadog.SyntheticsTestApiStepArray{
    				&datadog.SyntheticsTestApiStepArgs{
    					Assertions: datadog.SyntheticsTestApiStepAssertionArray{
    						&datadog.SyntheticsTestApiStepAssertionArgs{
    							Operator: pulumi.String("is"),
    							Target:   pulumi.String("200"),
    							Type:     pulumi.String("statusCode"),
    						},
    					},
    					Name: pulumi.String("An API test on example.org"),
    					RequestDefinition: &datadog.SyntheticsTestApiStepRequestDefinitionArgs{
    						Method: pulumi.String("GET"),
    						Url:    pulumi.String("https://example.org"),
    					},
    					RequestHeaders: pulumi.AnyMap{
    						"Authentication": pulumi.Any("Token: 1234566789"),
    						"Content-Type":   pulumi.Any("application/json"),
    					},
    					Subtype: pulumi.String("http"),
    				},
    				&datadog.SyntheticsTestApiStepArgs{
    					Assertions: datadog.SyntheticsTestApiStepAssertionArray{
    						&datadog.SyntheticsTestApiStepAssertionArgs{
    							Operator: pulumi.String("is"),
    							Target:   pulumi.String("200"),
    							Type:     pulumi.String("statusCode"),
    						},
    					},
    					Name: pulumi.String("An API test on example.org"),
    					RequestDefinition: &datadog.SyntheticsTestApiStepRequestDefinitionArgs{
    						Method: pulumi.String("GET"),
    						Url:    pulumi.String("http://example.org"),
    					},
    					Subtype: pulumi.String("http"),
    				},
    			},
    			Locations: pulumi.StringArray{
    				pulumi.String("aws:eu-central-1"),
    			},
    			Name: pulumi.String("Multistep API test"),
    			OptionsList: &datadog.SyntheticsTestOptionsListArgs{
    				AcceptSelfSigned: pulumi.Bool(true),
    				TickEvery:        pulumi.Int(900),
    			},
    			Status:  pulumi.String("live"),
    			Subtype: pulumi.String("multi"),
    			Type:    pulumi.String("api"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = datadog.NewSyntheticsTest(ctx, "testBrowser", &datadog.SyntheticsTestArgs{
    			BrowserSteps: datadog.SyntheticsTestBrowserStepArray{
    				&datadog.SyntheticsTestBrowserStepArgs{
    					Name: pulumi.String("Check current url"),
    					Params: &datadog.SyntheticsTestBrowserStepParamsArgs{
    						Check: pulumi.String("contains"),
    						Value: pulumi.String("datadoghq"),
    					},
    					Type: pulumi.String("assertCurrentUrl"),
    				},
    			},
    			BrowserVariables: datadog.SyntheticsTestBrowserVariableArray{
    				&datadog.SyntheticsTestBrowserVariableArgs{
    					Example: pulumi.String("597"),
    					Name:    pulumi.String("MY_PATTERN_VAR"),
    					Pattern: pulumi.String("{{numeric(3)}}"),
    					Type:    pulumi.String("text"),
    				},
    				&datadog.SyntheticsTestBrowserVariableArgs{
    					Example: pulumi.String("jd8-afe-ydv.4546132139@synthetics.dtdg.co"),
    					Name:    pulumi.String("MY_EMAIL_VAR"),
    					Pattern: pulumi.String("jd8-afe-ydv.{{ numeric(10) }}@synthetics.dtdg.co"),
    					Type:    pulumi.String("email"),
    				},
    				&datadog.SyntheticsTestBrowserVariableArgs{
    					Id:   pulumi.String("76636cd1-82e2-4aeb-9cfe-51366a8198a2"),
    					Name: pulumi.String("MY_GLOBAL_VAR"),
    					Type: pulumi.String("global"),
    				},
    			},
    			DeviceIds: pulumi.StringArray{
    				pulumi.String("laptop_large"),
    			},
    			Locations: pulumi.StringArray{
    				pulumi.String("aws:eu-central-1"),
    			},
    			Message: pulumi.String("Notify @qa"),
    			Name:    pulumi.String("A Browser test on example.org"),
    			OptionsList: &datadog.SyntheticsTestOptionsListArgs{
    				TickEvery: pulumi.Int(3600),
    			},
    			RequestDefinition: &datadog.SyntheticsTestRequestDefinitionArgs{
    				Method: pulumi.String("GET"),
    				Url:    pulumi.String("https://app.datadoghq.com"),
    			},
    			Status: pulumi.String("paused"),
    			Tags:   pulumi.StringArray{},
    			Type:   pulumi.String("browser"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.datadog.SyntheticsTest;
    import com.pulumi.datadog.SyntheticsTestArgs;
    import com.pulumi.datadog.inputs.SyntheticsTestAssertionArgs;
    import com.pulumi.datadog.inputs.SyntheticsTestOptionsListArgs;
    import com.pulumi.datadog.inputs.SyntheticsTestOptionsListMonitorOptionsArgs;
    import com.pulumi.datadog.inputs.SyntheticsTestOptionsListRetryArgs;
    import com.pulumi.datadog.inputs.SyntheticsTestRequestDefinitionArgs;
    import com.pulumi.datadog.inputs.SyntheticsTestConfigVariableArgs;
    import com.pulumi.datadog.inputs.SyntheticsTestApiStepArgs;
    import com.pulumi.datadog.inputs.SyntheticsTestApiStepRequestDefinitionArgs;
    import com.pulumi.datadog.inputs.SyntheticsTestBrowserStepArgs;
    import com.pulumi.datadog.inputs.SyntheticsTestBrowserStepParamsArgs;
    import com.pulumi.datadog.inputs.SyntheticsTestBrowserVariableArgs;
    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 testApi = new SyntheticsTest("testApi", SyntheticsTestArgs.builder()        
                .assertions(SyntheticsTestAssertionArgs.builder()
                    .operator("is")
                    .target("200")
                    .type("statusCode")
                    .build())
                .locations("aws:eu-central-1")
                .message("Notify @pagerduty")
                .name("An API test on example.org")
                .optionsList(SyntheticsTestOptionsListArgs.builder()
                    .monitorOptions(SyntheticsTestOptionsListMonitorOptionsArgs.builder()
                        .renotifyInterval(120)
                        .build())
                    .retry(SyntheticsTestOptionsListRetryArgs.builder()
                        .count(2)
                        .interval(300)
                        .build())
                    .tickEvery(900)
                    .build())
                .requestDefinition(SyntheticsTestRequestDefinitionArgs.builder()
                    .method("GET")
                    .url("https://www.example.org")
                    .build())
                .requestHeaders(Map.ofEntries(
                    Map.entry("Authentication", "Token: 1234566789"),
                    Map.entry("Content-Type", "application/json")
                ))
                .status("live")
                .subtype("http")
                .tags(            
                    "foo:bar",
                    "foo",
                    "env:test")
                .type("api")
                .build());
    
            var testSsl = new SyntheticsTest("testSsl", SyntheticsTestArgs.builder()        
                .assertions(SyntheticsTestAssertionArgs.builder()
                    .operator("isInMoreThan")
                    .target(30)
                    .type("certificate")
                    .build())
                .locations("aws:eu-central-1")
                .message("Notify @pagerduty")
                .name("An API test on example.org")
                .optionsList(SyntheticsTestOptionsListArgs.builder()
                    .acceptSelfSigned(true)
                    .tickEvery(900)
                    .build())
                .requestDefinition(SyntheticsTestRequestDefinitionArgs.builder()
                    .host("example.org")
                    .port(443)
                    .build())
                .status("live")
                .subtype("ssl")
                .tags(            
                    "foo:bar",
                    "foo",
                    "env:test")
                .type("api")
                .build());
    
            var testTcp = new SyntheticsTest("testTcp", SyntheticsTestArgs.builder()        
                .assertions(SyntheticsTestAssertionArgs.builder()
                    .operator("lessThan")
                    .target(2000)
                    .type("responseTime")
                    .build())
                .configVariables(SyntheticsTestConfigVariableArgs.builder()
                    .id("76636cd1-82e2-4aeb-9cfe-51366a8198a2")
                    .name("MY_GLOBAL_VAR")
                    .type("global")
                    .build())
                .locations("aws:eu-central-1")
                .message("Notify @pagerduty")
                .name("An API test on example.org")
                .optionsList(SyntheticsTestOptionsListArgs.builder()
                    .tickEvery(900)
                    .build())
                .requestDefinition(SyntheticsTestRequestDefinitionArgs.builder()
                    .host("example.org")
                    .port(443)
                    .build())
                .status("live")
                .subtype("tcp")
                .tags(            
                    "foo:bar",
                    "foo",
                    "env:test")
                .type("api")
                .build());
    
            var testDns = new SyntheticsTest("testDns", SyntheticsTestArgs.builder()        
                .assertions(SyntheticsTestAssertionArgs.builder()
                    .operator("is")
                    .property("A")
                    .target("0.0.0.0")
                    .type("recordSome")
                    .build())
                .locations("aws:eu-central-1")
                .message("Notify @pagerduty")
                .name("An API test on example.org")
                .optionsList(SyntheticsTestOptionsListArgs.builder()
                    .tickEvery(900)
                    .build())
                .requestDefinition(SyntheticsTestRequestDefinitionArgs.builder()
                    .host("example.org")
                    .build())
                .status("live")
                .subtype("dns")
                .tags(            
                    "foo:bar",
                    "foo",
                    "env:test")
                .type("api")
                .build());
    
            var test = new SyntheticsTest("test", SyntheticsTestArgs.builder()        
                .apiSteps(            
                    SyntheticsTestApiStepArgs.builder()
                        .assertions(SyntheticsTestApiStepAssertionArgs.builder()
                            .operator("is")
                            .target("200")
                            .type("statusCode")
                            .build())
                        .name("An API test on example.org")
                        .requestDefinition(SyntheticsTestApiStepRequestDefinitionArgs.builder()
                            .method("GET")
                            .url("https://example.org")
                            .build())
                        .requestHeaders(Map.ofEntries(
                            Map.entry("Authentication", "Token: 1234566789"),
                            Map.entry("Content-Type", "application/json")
                        ))
                        .subtype("http")
                        .build(),
                    SyntheticsTestApiStepArgs.builder()
                        .assertions(SyntheticsTestApiStepAssertionArgs.builder()
                            .operator("is")
                            .target("200")
                            .type("statusCode")
                            .build())
                        .name("An API test on example.org")
                        .requestDefinition(SyntheticsTestApiStepRequestDefinitionArgs.builder()
                            .method("GET")
                            .url("http://example.org")
                            .build())
                        .subtype("http")
                        .build())
                .locations("aws:eu-central-1")
                .name("Multistep API test")
                .optionsList(SyntheticsTestOptionsListArgs.builder()
                    .acceptSelfSigned(true)
                    .tickEvery(900)
                    .build())
                .status("live")
                .subtype("multi")
                .type("api")
                .build());
    
            var testBrowser = new SyntheticsTest("testBrowser", SyntheticsTestArgs.builder()        
                .browserSteps(SyntheticsTestBrowserStepArgs.builder()
                    .name("Check current url")
                    .params(SyntheticsTestBrowserStepParamsArgs.builder()
                        .check("contains")
                        .value("datadoghq")
                        .build())
                    .type("assertCurrentUrl")
                    .build())
                .browserVariables(            
                    SyntheticsTestBrowserVariableArgs.builder()
                        .example("597")
                        .name("MY_PATTERN_VAR")
                        .pattern("{{numeric(3)}}")
                        .type("text")
                        .build(),
                    SyntheticsTestBrowserVariableArgs.builder()
                        .example("jd8-afe-ydv.4546132139@synthetics.dtdg.co")
                        .name("MY_EMAIL_VAR")
                        .pattern("jd8-afe-ydv.{{ numeric(10) }}@synthetics.dtdg.co")
                        .type("email")
                        .build(),
                    SyntheticsTestBrowserVariableArgs.builder()
                        .id("76636cd1-82e2-4aeb-9cfe-51366a8198a2")
                        .name("MY_GLOBAL_VAR")
                        .type("global")
                        .build())
                .deviceIds("laptop_large")
                .locations("aws:eu-central-1")
                .message("Notify @qa")
                .name("A Browser test on example.org")
                .optionsList(SyntheticsTestOptionsListArgs.builder()
                    .tickEvery(3600)
                    .build())
                .requestDefinition(SyntheticsTestRequestDefinitionArgs.builder()
                    .method("GET")
                    .url("https://app.datadoghq.com")
                    .build())
                .status("paused")
                .tags()
                .type("browser")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_datadog as datadog
    
    # Example Usage (Synthetics API test)
    # Create a new Datadog Synthetics API/HTTP test on https://www.example.org
    test_api = datadog.SyntheticsTest("testApi",
        assertions=[datadog.SyntheticsTestAssertionArgs(
            operator="is",
            target="200",
            type="statusCode",
        )],
        locations=["aws:eu-central-1"],
        message="Notify @pagerduty",
        name="An API test on example.org",
        options_list=datadog.SyntheticsTestOptionsListArgs(
            monitor_options=datadog.SyntheticsTestOptionsListMonitorOptionsArgs(
                renotify_interval=120,
            ),
            retry=datadog.SyntheticsTestOptionsListRetryArgs(
                count=2,
                interval=300,
            ),
            tick_every=900,
        ),
        request_definition=datadog.SyntheticsTestRequestDefinitionArgs(
            method="GET",
            url="https://www.example.org",
        ),
        request_headers={
            "Authentication": "Token: 1234566789",
            "Content-Type": "application/json",
        },
        status="live",
        subtype="http",
        tags=[
            "foo:bar",
            "foo",
            "env:test",
        ],
        type="api")
    # Example Usage (Synthetics SSL test)
    # Create a new Datadog Synthetics API/SSL test on example.org
    test_ssl = datadog.SyntheticsTest("testSsl",
        assertions=[datadog.SyntheticsTestAssertionArgs(
            operator="isInMoreThan",
            target="30",
            type="certificate",
        )],
        locations=["aws:eu-central-1"],
        message="Notify @pagerduty",
        name="An API test on example.org",
        options_list=datadog.SyntheticsTestOptionsListArgs(
            accept_self_signed=True,
            tick_every=900,
        ),
        request_definition=datadog.SyntheticsTestRequestDefinitionArgs(
            host="example.org",
            port=443,
        ),
        status="live",
        subtype="ssl",
        tags=[
            "foo:bar",
            "foo",
            "env:test",
        ],
        type="api")
    # Example Usage (Synthetics TCP test)
    # Create a new Datadog Synthetics API/TCP test on example.org
    test_tcp = datadog.SyntheticsTest("testTcp",
        assertions=[datadog.SyntheticsTestAssertionArgs(
            operator="lessThan",
            target="2000",
            type="responseTime",
        )],
        config_variables=[datadog.SyntheticsTestConfigVariableArgs(
            id="76636cd1-82e2-4aeb-9cfe-51366a8198a2",
            name="MY_GLOBAL_VAR",
            type="global",
        )],
        locations=["aws:eu-central-1"],
        message="Notify @pagerduty",
        name="An API test on example.org",
        options_list=datadog.SyntheticsTestOptionsListArgs(
            tick_every=900,
        ),
        request_definition=datadog.SyntheticsTestRequestDefinitionArgs(
            host="example.org",
            port=443,
        ),
        status="live",
        subtype="tcp",
        tags=[
            "foo:bar",
            "foo",
            "env:test",
        ],
        type="api")
    # Example Usage (Synthetics DNS test)
    # Create a new Datadog Synthetics API/DNS test on example.org
    test_dns = datadog.SyntheticsTest("testDns",
        assertions=[datadog.SyntheticsTestAssertionArgs(
            operator="is",
            property="A",
            target="0.0.0.0",
            type="recordSome",
        )],
        locations=["aws:eu-central-1"],
        message="Notify @pagerduty",
        name="An API test on example.org",
        options_list=datadog.SyntheticsTestOptionsListArgs(
            tick_every=900,
        ),
        request_definition=datadog.SyntheticsTestRequestDefinitionArgs(
            host="example.org",
        ),
        status="live",
        subtype="dns",
        tags=[
            "foo:bar",
            "foo",
            "env:test",
        ],
        type="api")
    # Example Usage (Synthetics Multistep API test)
    # Create a new Datadog Synthetics Multistep API test
    test = datadog.SyntheticsTest("test",
        api_steps=[
            datadog.SyntheticsTestApiStepArgs(
                assertions=[datadog.SyntheticsTestApiStepAssertionArgs(
                    operator="is",
                    target="200",
                    type="statusCode",
                )],
                name="An API test on example.org",
                request_definition=datadog.SyntheticsTestApiStepRequestDefinitionArgs(
                    method="GET",
                    url="https://example.org",
                ),
                request_headers={
                    "Authentication": "Token: 1234566789",
                    "Content-Type": "application/json",
                },
                subtype="http",
            ),
            datadog.SyntheticsTestApiStepArgs(
                assertions=[datadog.SyntheticsTestApiStepAssertionArgs(
                    operator="is",
                    target="200",
                    type="statusCode",
                )],
                name="An API test on example.org",
                request_definition=datadog.SyntheticsTestApiStepRequestDefinitionArgs(
                    method="GET",
                    url="http://example.org",
                ),
                subtype="http",
            ),
        ],
        locations=["aws:eu-central-1"],
        name="Multistep API test",
        options_list=datadog.SyntheticsTestOptionsListArgs(
            accept_self_signed=True,
            tick_every=900,
        ),
        status="live",
        subtype="multi",
        type="api")
    # Example Usage (Synthetics Browser test)
    # Create a new Datadog Synthetics Browser test starting on https://www.example.org
    test_browser = datadog.SyntheticsTest("testBrowser",
        browser_steps=[datadog.SyntheticsTestBrowserStepArgs(
            name="Check current url",
            params=datadog.SyntheticsTestBrowserStepParamsArgs(
                check="contains",
                value="datadoghq",
            ),
            type="assertCurrentUrl",
        )],
        browser_variables=[
            datadog.SyntheticsTestBrowserVariableArgs(
                example="597",
                name="MY_PATTERN_VAR",
                pattern="{{numeric(3)}}",
                type="text",
            ),
            datadog.SyntheticsTestBrowserVariableArgs(
                example="jd8-afe-ydv.4546132139@synthetics.dtdg.co",
                name="MY_EMAIL_VAR",
                pattern="jd8-afe-ydv.{{ numeric(10) }}@synthetics.dtdg.co",
                type="email",
            ),
            datadog.SyntheticsTestBrowserVariableArgs(
                id="76636cd1-82e2-4aeb-9cfe-51366a8198a2",
                name="MY_GLOBAL_VAR",
                type="global",
            ),
        ],
        device_ids=["laptop_large"],
        locations=["aws:eu-central-1"],
        message="Notify @qa",
        name="A Browser test on example.org",
        options_list=datadog.SyntheticsTestOptionsListArgs(
            tick_every=3600,
        ),
        request_definition=datadog.SyntheticsTestRequestDefinitionArgs(
            method="GET",
            url="https://app.datadoghq.com",
        ),
        status="paused",
        tags=[],
        type="browser")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as datadog from "@pulumi/datadog";
    
    // Example Usage (Synthetics API test)
    // Create a new Datadog Synthetics API/HTTP test on https://www.example.org
    const testApi = new datadog.SyntheticsTest("testApi", {
        assertions: [{
            operator: "is",
            target: "200",
            type: "statusCode",
        }],
        locations: ["aws:eu-central-1"],
        message: "Notify @pagerduty",
        name: "An API test on example.org",
        optionsList: {
            monitorOptions: {
                renotifyInterval: 120,
            },
            retry: {
                count: 2,
                interval: 300,
            },
            tickEvery: 900,
        },
        requestDefinition: {
            method: "GET",
            url: "https://www.example.org",
        },
        requestHeaders: {
            Authentication: "Token: 1234566789",
            "Content-Type": "application/json",
        },
        status: "live",
        subtype: "http",
        tags: [
            "foo:bar",
            "foo",
            "env:test",
        ],
        type: "api",
    });
    // Example Usage (Synthetics SSL test)
    // Create a new Datadog Synthetics API/SSL test on example.org
    const testSsl = new datadog.SyntheticsTest("testSsl", {
        assertions: [{
            operator: "isInMoreThan",
            target: "30",
            type: "certificate",
        }],
        locations: ["aws:eu-central-1"],
        message: "Notify @pagerduty",
        name: "An API test on example.org",
        optionsList: {
            acceptSelfSigned: true,
            tickEvery: 900,
        },
        requestDefinition: {
            host: "example.org",
            port: 443,
        },
        status: "live",
        subtype: "ssl",
        tags: [
            "foo:bar",
            "foo",
            "env:test",
        ],
        type: "api",
    });
    // Example Usage (Synthetics TCP test)
    // Create a new Datadog Synthetics API/TCP test on example.org
    const testTcp = new datadog.SyntheticsTest("testTcp", {
        assertions: [{
            operator: "lessThan",
            target: "2000",
            type: "responseTime",
        }],
        configVariables: [{
            id: "76636cd1-82e2-4aeb-9cfe-51366a8198a2",
            name: "MY_GLOBAL_VAR",
            type: "global",
        }],
        locations: ["aws:eu-central-1"],
        message: "Notify @pagerduty",
        name: "An API test on example.org",
        optionsList: {
            tickEvery: 900,
        },
        requestDefinition: {
            host: "example.org",
            port: 443,
        },
        status: "live",
        subtype: "tcp",
        tags: [
            "foo:bar",
            "foo",
            "env:test",
        ],
        type: "api",
    });
    // Example Usage (Synthetics DNS test)
    // Create a new Datadog Synthetics API/DNS test on example.org
    const testDns = new datadog.SyntheticsTest("testDns", {
        assertions: [{
            operator: "is",
            property: "A",
            target: "0.0.0.0",
            type: "recordSome",
        }],
        locations: ["aws:eu-central-1"],
        message: "Notify @pagerduty",
        name: "An API test on example.org",
        optionsList: {
            tickEvery: 900,
        },
        requestDefinition: {
            host: "example.org",
        },
        status: "live",
        subtype: "dns",
        tags: [
            "foo:bar",
            "foo",
            "env:test",
        ],
        type: "api",
    });
    // Example Usage (Synthetics Multistep API test)
    // Create a new Datadog Synthetics Multistep API test
    const test = new datadog.SyntheticsTest("test", {
        apiSteps: [
            {
                assertions: [{
                    operator: "is",
                    target: "200",
                    type: "statusCode",
                }],
                name: "An API test on example.org",
                requestDefinition: {
                    method: "GET",
                    url: "https://example.org",
                },
                requestHeaders: {
                    Authentication: "Token: 1234566789",
                    "Content-Type": "application/json",
                },
                subtype: "http",
            },
            {
                assertions: [{
                    operator: "is",
                    target: "200",
                    type: "statusCode",
                }],
                name: "An API test on example.org",
                requestDefinition: {
                    method: "GET",
                    url: "http://example.org",
                },
                subtype: "http",
            },
        ],
        locations: ["aws:eu-central-1"],
        name: "Multistep API test",
        optionsList: {
            acceptSelfSigned: true,
            tickEvery: 900,
        },
        status: "live",
        subtype: "multi",
        type: "api",
    });
    // Example Usage (Synthetics Browser test)
    // Create a new Datadog Synthetics Browser test starting on https://www.example.org
    const testBrowser = new datadog.SyntheticsTest("testBrowser", {
        browserSteps: [{
            name: "Check current url",
            params: {
                check: "contains",
                value: "datadoghq",
            },
            type: "assertCurrentUrl",
        }],
        browserVariables: [
            {
                example: "597",
                name: "MY_PATTERN_VAR",
                pattern: "{{numeric(3)}}",
                type: "text",
            },
            {
                example: "jd8-afe-ydv.4546132139@synthetics.dtdg.co",
                name: "MY_EMAIL_VAR",
                pattern: "jd8-afe-ydv.{{ numeric(10) }}@synthetics.dtdg.co",
                type: "email",
            },
            {
                id: "76636cd1-82e2-4aeb-9cfe-51366a8198a2",
                name: "MY_GLOBAL_VAR",
                type: "global",
            },
        ],
        deviceIds: ["laptop_large"],
        locations: ["aws:eu-central-1"],
        message: "Notify @qa",
        name: "A Browser test on example.org",
        optionsList: {
            tickEvery: 3600,
        },
        requestDefinition: {
            method: "GET",
            url: "https://app.datadoghq.com",
        },
        status: "paused",
        tags: [],
        type: "browser",
    });
    
    resources:
      # Example Usage (Synthetics API test)
      # // Create a new Datadog Synthetics API/HTTP test on https://www.example.org
      testApi:
        type: datadog:SyntheticsTest
        properties:
          assertions:
            - operator: is
              target: '200'
              type: statusCode
          locations:
            - aws:eu-central-1
          message: Notify @pagerduty
          name: An API test on example.org
          optionsList:
            monitorOptions:
              renotifyInterval: 120
            retry:
              count: 2
              interval: 300
            tickEvery: 900
          requestDefinition:
            method: GET
            url: https://www.example.org
          requestHeaders:
            Authentication: 'Token: 1234566789'
            Content-Type: application/json
          status: live
          subtype: http
          tags:
            - foo:bar
            - foo
            - env:test
          type: api
      # Example Usage (Synthetics SSL test)
      # // Create a new Datadog Synthetics API/SSL test on example.org
      testSsl:
        type: datadog:SyntheticsTest
        properties:
          assertions:
            - operator: isInMoreThan
              target: 30
              type: certificate
          locations:
            - aws:eu-central-1
          message: Notify @pagerduty
          name: An API test on example.org
          optionsList:
            acceptSelfSigned: true
            tickEvery: 900
          requestDefinition:
            host: example.org
            port: 443
          status: live
          subtype: ssl
          tags:
            - foo:bar
            - foo
            - env:test
          type: api
      # Example Usage (Synthetics TCP test)
      # // Create a new Datadog Synthetics API/TCP test on example.org
      testTcp:
        type: datadog:SyntheticsTest
        properties:
          assertions:
            - operator: lessThan
              target: 2000
              type: responseTime
          configVariables:
            - id: 76636cd1-82e2-4aeb-9cfe-51366a8198a2
              name: MY_GLOBAL_VAR
              type: global
          locations:
            - aws:eu-central-1
          message: Notify @pagerduty
          name: An API test on example.org
          optionsList:
            tickEvery: 900
          requestDefinition:
            host: example.org
            port: 443
          status: live
          subtype: tcp
          tags:
            - foo:bar
            - foo
            - env:test
          type: api
      # Example Usage (Synthetics DNS test)
      # // Create a new Datadog Synthetics API/DNS test on example.org
      testDns:
        type: datadog:SyntheticsTest
        properties:
          assertions:
            - operator: is
              property: A
              target: 0.0.0.0
              type: recordSome
          locations:
            - aws:eu-central-1
          message: Notify @pagerduty
          name: An API test on example.org
          optionsList:
            tickEvery: 900
          requestDefinition:
            host: example.org
          status: live
          subtype: dns
          tags:
            - foo:bar
            - foo
            - env:test
          type: api
      # Example Usage (Synthetics Multistep API test)
      # // Create a new Datadog Synthetics Multistep API test
      test:
        type: datadog:SyntheticsTest
        properties:
          apiSteps:
            - assertions:
                - operator: is
                  target: '200'
                  type: statusCode
              name: An API test on example.org
              requestDefinition:
                method: GET
                url: https://example.org
              requestHeaders:
                Authentication: 'Token: 1234566789'
                Content-Type: application/json
              subtype: http
            - assertions:
                - operator: is
                  target: '200'
                  type: statusCode
              name: An API test on example.org
              requestDefinition:
                method: GET
                url: http://example.org
              subtype: http
          locations:
            - aws:eu-central-1
          name: Multistep API test
          optionsList:
            acceptSelfSigned: true
            tickEvery: 900
          status: live
          subtype: multi
          type: api
      # Example Usage (Synthetics Browser test)
      # // Create a new Datadog Synthetics Browser test starting on https://www.example.org
      testBrowser:
        type: datadog:SyntheticsTest
        properties:
          browserSteps:
            - name: Check current url
              params:
                check: contains
                value: datadoghq
              type: assertCurrentUrl
          browserVariables:
            - example: '597'
              name: MY_PATTERN_VAR
              pattern: '{{numeric(3)}}'
              type: text
            - example: jd8-afe-ydv.4546132139@synthetics.dtdg.co
              name: MY_EMAIL_VAR
              pattern: jd8-afe-ydv.{{ numeric(10) }}@synthetics.dtdg.co
              type: email
            - id: 76636cd1-82e2-4aeb-9cfe-51366a8198a2
              name: MY_GLOBAL_VAR
              type: global
          deviceIds:
            - laptop_large
          locations:
            - aws:eu-central-1
          message: Notify @qa
          name: A Browser test on example.org
          optionsList:
            tickEvery: 3600
          requestDefinition:
            method: GET
            url: https://app.datadoghq.com
          status: paused
          tags: []
          type: browser
    

    Create SyntheticsTest Resource

    new SyntheticsTest(name: string, args: SyntheticsTestArgs, opts?: CustomResourceOptions);
    @overload
    def SyntheticsTest(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       api_steps: Optional[Sequence[SyntheticsTestApiStepArgs]] = None,
                       assertions: Optional[Sequence[SyntheticsTestAssertionArgs]] = None,
                       browser_steps: Optional[Sequence[SyntheticsTestBrowserStepArgs]] = None,
                       browser_variables: Optional[Sequence[SyntheticsTestBrowserVariableArgs]] = None,
                       config_variables: Optional[Sequence[SyntheticsTestConfigVariableArgs]] = None,
                       device_ids: Optional[Sequence[str]] = None,
                       locations: Optional[Sequence[str]] = None,
                       message: Optional[str] = None,
                       name: Optional[str] = None,
                       options_list: Optional[SyntheticsTestOptionsListArgs] = None,
                       request_basicauth: Optional[SyntheticsTestRequestBasicauthArgs] = None,
                       request_client_certificate: Optional[SyntheticsTestRequestClientCertificateArgs] = None,
                       request_definition: Optional[SyntheticsTestRequestDefinitionArgs] = None,
                       request_headers: Optional[Mapping[str, Any]] = None,
                       request_proxy: Optional[SyntheticsTestRequestProxyArgs] = None,
                       request_query: Optional[Mapping[str, Any]] = None,
                       set_cookie: Optional[str] = None,
                       status: Optional[str] = None,
                       subtype: Optional[str] = None,
                       tags: Optional[Sequence[str]] = None,
                       type: Optional[str] = None)
    @overload
    def SyntheticsTest(resource_name: str,
                       args: SyntheticsTestArgs,
                       opts: Optional[ResourceOptions] = None)
    func NewSyntheticsTest(ctx *Context, name string, args SyntheticsTestArgs, opts ...ResourceOption) (*SyntheticsTest, error)
    public SyntheticsTest(string name, SyntheticsTestArgs args, CustomResourceOptions? opts = null)
    public SyntheticsTest(String name, SyntheticsTestArgs args)
    public SyntheticsTest(String name, SyntheticsTestArgs args, CustomResourceOptions options)
    
    type: datadog:SyntheticsTest
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args SyntheticsTestArgs
    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 SyntheticsTestArgs
    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 SyntheticsTestArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SyntheticsTestArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SyntheticsTestArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    SyntheticsTest 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 SyntheticsTest resource accepts the following input properties:

    Locations List<string>

    Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.

    Name string

    Name of Datadog synthetics test.

    Status string

    Define whether you want to start (live) or pause (paused) a Synthetic test. Valid values are live, paused.

    Type string

    Synthetics test type. Valid values are api, browser.

    ApiSteps List<SyntheticsTestApiStepArgs>

    Steps for multistep api tests

    Assertions List<SyntheticsTestAssertionArgs>

    Assertions used for the test. Multiple assertion blocks are allowed with the structure below.

    BrowserSteps List<SyntheticsTestBrowserStepArgs>

    Steps for browser tests.

    BrowserVariables List<SyntheticsTestBrowserVariableArgs>

    Variables used for a browser test steps. Multiple variable blocks are allowed with the structure below.

    ConfigVariables List<SyntheticsTestConfigVariableArgs>

    Variables used for the test configuration. Multiple config_variable blocks are allowed with the structure below.

    DeviceIds List<string>

    Required if type = "browser". Array with the different device IDs used to run the test. Valid values are laptop_large, tablet, mobile_small, chrome.laptop_large, chrome.tablet, chrome.mobile_small, firefox.laptop_large, firefox.tablet, firefox.mobile_small, edge.laptop_large, edge.tablet, edge.mobile_small.

    Message string

    A message to include with notifications for this synthetics test. Email notifications can be sent to specific users by using the same @username notation as events.

    OptionsList SyntheticsTestOptionsListArgs
    RequestBasicauth SyntheticsTestRequestBasicauthArgs

    The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.

    RequestClientCertificate SyntheticsTestRequestClientCertificateArgs

    Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.

    RequestDefinition SyntheticsTestRequestDefinitionArgs

    Required if type = "api". The synthetics test request.

    RequestHeaders Dictionary<string, object>

    Header name and value map.

    RequestProxy SyntheticsTestRequestProxyArgs

    The proxy to perform the test.

    RequestQuery Dictionary<string, object>

    Query arguments name and value map.

    SetCookie string

    Cookies to be used for a browser test request, using the Set-Cookie syntax.

    Subtype string

    The subtype of the Synthetic API test. Defaults to http. Valid values are http, ssl, tcp, dns, multi, icmp, udp, websocket, grpc.

    Tags List<string>

    A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list ([]).

    Locations []string

    Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.

    Name string

    Name of Datadog synthetics test.

    Status string

    Define whether you want to start (live) or pause (paused) a Synthetic test. Valid values are live, paused.

    Type string

    Synthetics test type. Valid values are api, browser.

    ApiSteps []SyntheticsTestApiStepArgs

    Steps for multistep api tests

    Assertions []SyntheticsTestAssertionArgs

    Assertions used for the test. Multiple assertion blocks are allowed with the structure below.

    BrowserSteps []SyntheticsTestBrowserStepArgs

    Steps for browser tests.

    BrowserVariables []SyntheticsTestBrowserVariableArgs

    Variables used for a browser test steps. Multiple variable blocks are allowed with the structure below.

    ConfigVariables []SyntheticsTestConfigVariableArgs

    Variables used for the test configuration. Multiple config_variable blocks are allowed with the structure below.

    DeviceIds []string

    Required if type = "browser". Array with the different device IDs used to run the test. Valid values are laptop_large, tablet, mobile_small, chrome.laptop_large, chrome.tablet, chrome.mobile_small, firefox.laptop_large, firefox.tablet, firefox.mobile_small, edge.laptop_large, edge.tablet, edge.mobile_small.

    Message string

    A message to include with notifications for this synthetics test. Email notifications can be sent to specific users by using the same @username notation as events.

    OptionsList SyntheticsTestOptionsListArgs
    RequestBasicauth SyntheticsTestRequestBasicauthArgs

    The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.

    RequestClientCertificate SyntheticsTestRequestClientCertificateArgs

    Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.

    RequestDefinition SyntheticsTestRequestDefinitionArgs

    Required if type = "api". The synthetics test request.

    RequestHeaders map[string]interface{}

    Header name and value map.

    RequestProxy SyntheticsTestRequestProxyArgs

    The proxy to perform the test.

    RequestQuery map[string]interface{}

    Query arguments name and value map.

    SetCookie string

    Cookies to be used for a browser test request, using the Set-Cookie syntax.

    Subtype string

    The subtype of the Synthetic API test. Defaults to http. Valid values are http, ssl, tcp, dns, multi, icmp, udp, websocket, grpc.

    Tags []string

    A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list ([]).

    locations List<String>

    Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.

    name String

    Name of Datadog synthetics test.

    status String

    Define whether you want to start (live) or pause (paused) a Synthetic test. Valid values are live, paused.

    type String

    Synthetics test type. Valid values are api, browser.

    apiSteps List<SyntheticsTestApiStepArgs>

    Steps for multistep api tests

    assertions List<SyntheticsTestAssertionArgs>

    Assertions used for the test. Multiple assertion blocks are allowed with the structure below.

    browserSteps List<SyntheticsTestBrowserStepArgs>

    Steps for browser tests.

    browserVariables List<SyntheticsTestBrowserVariableArgs>

    Variables used for a browser test steps. Multiple variable blocks are allowed with the structure below.

    configVariables List<SyntheticsTestConfigVariableArgs>

    Variables used for the test configuration. Multiple config_variable blocks are allowed with the structure below.

    deviceIds List<String>

    Required if type = "browser". Array with the different device IDs used to run the test. Valid values are laptop_large, tablet, mobile_small, chrome.laptop_large, chrome.tablet, chrome.mobile_small, firefox.laptop_large, firefox.tablet, firefox.mobile_small, edge.laptop_large, edge.tablet, edge.mobile_small.

    message String

    A message to include with notifications for this synthetics test. Email notifications can be sent to specific users by using the same @username notation as events.

    optionsList SyntheticsTestOptionsListArgs
    requestBasicauth SyntheticsTestRequestBasicauthArgs

    The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.

    requestClientCertificate SyntheticsTestRequestClientCertificateArgs

    Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.

    requestDefinition SyntheticsTestRequestDefinitionArgs

    Required if type = "api". The synthetics test request.

    requestHeaders Map<String,Object>

    Header name and value map.

    requestProxy SyntheticsTestRequestProxyArgs

    The proxy to perform the test.

    requestQuery Map<String,Object>

    Query arguments name and value map.

    setCookie String

    Cookies to be used for a browser test request, using the Set-Cookie syntax.

    subtype String

    The subtype of the Synthetic API test. Defaults to http. Valid values are http, ssl, tcp, dns, multi, icmp, udp, websocket, grpc.

    tags List<String>

    A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list ([]).

    locations string[]

    Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.

    name string

    Name of Datadog synthetics test.

    status string

    Define whether you want to start (live) or pause (paused) a Synthetic test. Valid values are live, paused.

    type string

    Synthetics test type. Valid values are api, browser.

    apiSteps SyntheticsTestApiStepArgs[]

    Steps for multistep api tests

    assertions SyntheticsTestAssertionArgs[]

    Assertions used for the test. Multiple assertion blocks are allowed with the structure below.

    browserSteps SyntheticsTestBrowserStepArgs[]

    Steps for browser tests.

    browserVariables SyntheticsTestBrowserVariableArgs[]

    Variables used for a browser test steps. Multiple variable blocks are allowed with the structure below.

    configVariables SyntheticsTestConfigVariableArgs[]

    Variables used for the test configuration. Multiple config_variable blocks are allowed with the structure below.

    deviceIds string[]

    Required if type = "browser". Array with the different device IDs used to run the test. Valid values are laptop_large, tablet, mobile_small, chrome.laptop_large, chrome.tablet, chrome.mobile_small, firefox.laptop_large, firefox.tablet, firefox.mobile_small, edge.laptop_large, edge.tablet, edge.mobile_small.

    message string

    A message to include with notifications for this synthetics test. Email notifications can be sent to specific users by using the same @username notation as events.

    optionsList SyntheticsTestOptionsListArgs
    requestBasicauth SyntheticsTestRequestBasicauthArgs

    The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.

    requestClientCertificate SyntheticsTestRequestClientCertificateArgs

    Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.

    requestDefinition SyntheticsTestRequestDefinitionArgs

    Required if type = "api". The synthetics test request.

    requestHeaders {[key: string]: any}

    Header name and value map.

    requestProxy SyntheticsTestRequestProxyArgs

    The proxy to perform the test.

    requestQuery {[key: string]: any}

    Query arguments name and value map.

    setCookie string

    Cookies to be used for a browser test request, using the Set-Cookie syntax.

    subtype string

    The subtype of the Synthetic API test. Defaults to http. Valid values are http, ssl, tcp, dns, multi, icmp, udp, websocket, grpc.

    tags string[]

    A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list ([]).

    locations Sequence[str]

    Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.

    name str

    Name of Datadog synthetics test.

    status str

    Define whether you want to start (live) or pause (paused) a Synthetic test. Valid values are live, paused.

    type str

    Synthetics test type. Valid values are api, browser.

    api_steps Sequence[SyntheticsTestApiStepArgs]

    Steps for multistep api tests

    assertions Sequence[SyntheticsTestAssertionArgs]

    Assertions used for the test. Multiple assertion blocks are allowed with the structure below.

    browser_steps Sequence[SyntheticsTestBrowserStepArgs]

    Steps for browser tests.

    browser_variables Sequence[SyntheticsTestBrowserVariableArgs]

    Variables used for a browser test steps. Multiple variable blocks are allowed with the structure below.

    config_variables Sequence[SyntheticsTestConfigVariableArgs]

    Variables used for the test configuration. Multiple config_variable blocks are allowed with the structure below.

    device_ids Sequence[str]

    Required if type = "browser". Array with the different device IDs used to run the test. Valid values are laptop_large, tablet, mobile_small, chrome.laptop_large, chrome.tablet, chrome.mobile_small, firefox.laptop_large, firefox.tablet, firefox.mobile_small, edge.laptop_large, edge.tablet, edge.mobile_small.

    message str

    A message to include with notifications for this synthetics test. Email notifications can be sent to specific users by using the same @username notation as events.

    options_list SyntheticsTestOptionsListArgs
    request_basicauth SyntheticsTestRequestBasicauthArgs

    The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.

    request_client_certificate SyntheticsTestRequestClientCertificateArgs

    Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.

    request_definition SyntheticsTestRequestDefinitionArgs

    Required if type = "api". The synthetics test request.

    request_headers Mapping[str, Any]

    Header name and value map.

    request_proxy SyntheticsTestRequestProxyArgs

    The proxy to perform the test.

    request_query Mapping[str, Any]

    Query arguments name and value map.

    set_cookie str

    Cookies to be used for a browser test request, using the Set-Cookie syntax.

    subtype str

    The subtype of the Synthetic API test. Defaults to http. Valid values are http, ssl, tcp, dns, multi, icmp, udp, websocket, grpc.

    tags Sequence[str]

    A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list ([]).

    locations List<String>

    Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.

    name String

    Name of Datadog synthetics test.

    status String

    Define whether you want to start (live) or pause (paused) a Synthetic test. Valid values are live, paused.

    type String

    Synthetics test type. Valid values are api, browser.

    apiSteps List<Property Map>

    Steps for multistep api tests

    assertions List<Property Map>

    Assertions used for the test. Multiple assertion blocks are allowed with the structure below.

    browserSteps List<Property Map>

    Steps for browser tests.

    browserVariables List<Property Map>

    Variables used for a browser test steps. Multiple variable blocks are allowed with the structure below.

    configVariables List<Property Map>

    Variables used for the test configuration. Multiple config_variable blocks are allowed with the structure below.

    deviceIds List<String>

    Required if type = "browser". Array with the different device IDs used to run the test. Valid values are laptop_large, tablet, mobile_small, chrome.laptop_large, chrome.tablet, chrome.mobile_small, firefox.laptop_large, firefox.tablet, firefox.mobile_small, edge.laptop_large, edge.tablet, edge.mobile_small.

    message String

    A message to include with notifications for this synthetics test. Email notifications can be sent to specific users by using the same @username notation as events.

    optionsList Property Map
    requestBasicauth Property Map

    The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.

    requestClientCertificate Property Map

    Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.

    requestDefinition Property Map

    Required if type = "api". The synthetics test request.

    requestHeaders Map<Any>

    Header name and value map.

    requestProxy Property Map

    The proxy to perform the test.

    requestQuery Map<Any>

    Query arguments name and value map.

    setCookie String

    Cookies to be used for a browser test request, using the Set-Cookie syntax.

    subtype String

    The subtype of the Synthetic API test. Defaults to http. Valid values are http, ssl, tcp, dns, multi, icmp, udp, websocket, grpc.

    tags List<String>

    A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list ([]).

    Outputs

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

    Id string

    The provider-assigned unique ID for this managed resource.

    MonitorId int

    ID of the monitor associated with the Datadog synthetics test.

    Id string

    The provider-assigned unique ID for this managed resource.

    MonitorId int

    ID of the monitor associated with the Datadog synthetics test.

    id String

    The provider-assigned unique ID for this managed resource.

    monitorId Integer

    ID of the monitor associated with the Datadog synthetics test.

    id string

    The provider-assigned unique ID for this managed resource.

    monitorId number

    ID of the monitor associated with the Datadog synthetics test.

    id str

    The provider-assigned unique ID for this managed resource.

    monitor_id int

    ID of the monitor associated with the Datadog synthetics test.

    id String

    The provider-assigned unique ID for this managed resource.

    monitorId Number

    ID of the monitor associated with the Datadog synthetics test.

    Look up Existing SyntheticsTest Resource

    Get an existing SyntheticsTest 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?: SyntheticsTestState, opts?: CustomResourceOptions): SyntheticsTest
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_steps: Optional[Sequence[SyntheticsTestApiStepArgs]] = None,
            assertions: Optional[Sequence[SyntheticsTestAssertionArgs]] = None,
            browser_steps: Optional[Sequence[SyntheticsTestBrowserStepArgs]] = None,
            browser_variables: Optional[Sequence[SyntheticsTestBrowserVariableArgs]] = None,
            config_variables: Optional[Sequence[SyntheticsTestConfigVariableArgs]] = None,
            device_ids: Optional[Sequence[str]] = None,
            locations: Optional[Sequence[str]] = None,
            message: Optional[str] = None,
            monitor_id: Optional[int] = None,
            name: Optional[str] = None,
            options_list: Optional[SyntheticsTestOptionsListArgs] = None,
            request_basicauth: Optional[SyntheticsTestRequestBasicauthArgs] = None,
            request_client_certificate: Optional[SyntheticsTestRequestClientCertificateArgs] = None,
            request_definition: Optional[SyntheticsTestRequestDefinitionArgs] = None,
            request_headers: Optional[Mapping[str, Any]] = None,
            request_proxy: Optional[SyntheticsTestRequestProxyArgs] = None,
            request_query: Optional[Mapping[str, Any]] = None,
            set_cookie: Optional[str] = None,
            status: Optional[str] = None,
            subtype: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            type: Optional[str] = None) -> SyntheticsTest
    func GetSyntheticsTest(ctx *Context, name string, id IDInput, state *SyntheticsTestState, opts ...ResourceOption) (*SyntheticsTest, error)
    public static SyntheticsTest Get(string name, Input<string> id, SyntheticsTestState? state, CustomResourceOptions? opts = null)
    public static SyntheticsTest get(String name, Output<String> id, SyntheticsTestState 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:
    ApiSteps List<SyntheticsTestApiStepArgs>

    Steps for multistep api tests

    Assertions List<SyntheticsTestAssertionArgs>

    Assertions used for the test. Multiple assertion blocks are allowed with the structure below.

    BrowserSteps List<SyntheticsTestBrowserStepArgs>

    Steps for browser tests.

    BrowserVariables List<SyntheticsTestBrowserVariableArgs>

    Variables used for a browser test steps. Multiple variable blocks are allowed with the structure below.

    ConfigVariables List<SyntheticsTestConfigVariableArgs>

    Variables used for the test configuration. Multiple config_variable blocks are allowed with the structure below.

    DeviceIds List<string>

    Required if type = "browser". Array with the different device IDs used to run the test. Valid values are laptop_large, tablet, mobile_small, chrome.laptop_large, chrome.tablet, chrome.mobile_small, firefox.laptop_large, firefox.tablet, firefox.mobile_small, edge.laptop_large, edge.tablet, edge.mobile_small.

    Locations List<string>

    Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.

    Message string

    A message to include with notifications for this synthetics test. Email notifications can be sent to specific users by using the same @username notation as events.

    MonitorId int

    ID of the monitor associated with the Datadog synthetics test.

    Name string

    Name of Datadog synthetics test.

    OptionsList SyntheticsTestOptionsListArgs
    RequestBasicauth SyntheticsTestRequestBasicauthArgs

    The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.

    RequestClientCertificate SyntheticsTestRequestClientCertificateArgs

    Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.

    RequestDefinition SyntheticsTestRequestDefinitionArgs

    Required if type = "api". The synthetics test request.

    RequestHeaders Dictionary<string, object>

    Header name and value map.

    RequestProxy SyntheticsTestRequestProxyArgs

    The proxy to perform the test.

    RequestQuery Dictionary<string, object>

    Query arguments name and value map.

    SetCookie string

    Cookies to be used for a browser test request, using the Set-Cookie syntax.

    Status string

    Define whether you want to start (live) or pause (paused) a Synthetic test. Valid values are live, paused.

    Subtype string

    The subtype of the Synthetic API test. Defaults to http. Valid values are http, ssl, tcp, dns, multi, icmp, udp, websocket, grpc.

    Tags List<string>

    A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list ([]).

    Type string

    Synthetics test type. Valid values are api, browser.

    ApiSteps []SyntheticsTestApiStepArgs

    Steps for multistep api tests

    Assertions []SyntheticsTestAssertionArgs

    Assertions used for the test. Multiple assertion blocks are allowed with the structure below.

    BrowserSteps []SyntheticsTestBrowserStepArgs

    Steps for browser tests.

    BrowserVariables []SyntheticsTestBrowserVariableArgs

    Variables used for a browser test steps. Multiple variable blocks are allowed with the structure below.

    ConfigVariables []SyntheticsTestConfigVariableArgs

    Variables used for the test configuration. Multiple config_variable blocks are allowed with the structure below.

    DeviceIds []string

    Required if type = "browser". Array with the different device IDs used to run the test. Valid values are laptop_large, tablet, mobile_small, chrome.laptop_large, chrome.tablet, chrome.mobile_small, firefox.laptop_large, firefox.tablet, firefox.mobile_small, edge.laptop_large, edge.tablet, edge.mobile_small.

    Locations []string

    Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.

    Message string

    A message to include with notifications for this synthetics test. Email notifications can be sent to specific users by using the same @username notation as events.

    MonitorId int

    ID of the monitor associated with the Datadog synthetics test.

    Name string

    Name of Datadog synthetics test.

    OptionsList SyntheticsTestOptionsListArgs
    RequestBasicauth SyntheticsTestRequestBasicauthArgs

    The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.

    RequestClientCertificate SyntheticsTestRequestClientCertificateArgs

    Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.

    RequestDefinition SyntheticsTestRequestDefinitionArgs

    Required if type = "api". The synthetics test request.

    RequestHeaders map[string]interface{}

    Header name and value map.

    RequestProxy SyntheticsTestRequestProxyArgs

    The proxy to perform the test.

    RequestQuery map[string]interface{}

    Query arguments name and value map.

    SetCookie string

    Cookies to be used for a browser test request, using the Set-Cookie syntax.

    Status string

    Define whether you want to start (live) or pause (paused) a Synthetic test. Valid values are live, paused.

    Subtype string

    The subtype of the Synthetic API test. Defaults to http. Valid values are http, ssl, tcp, dns, multi, icmp, udp, websocket, grpc.

    Tags []string

    A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list ([]).

    Type string

    Synthetics test type. Valid values are api, browser.

    apiSteps List<SyntheticsTestApiStepArgs>

    Steps for multistep api tests

    assertions List<SyntheticsTestAssertionArgs>

    Assertions used for the test. Multiple assertion blocks are allowed with the structure below.

    browserSteps List<SyntheticsTestBrowserStepArgs>

    Steps for browser tests.

    browserVariables List<SyntheticsTestBrowserVariableArgs>

    Variables used for a browser test steps. Multiple variable blocks are allowed with the structure below.

    configVariables List<SyntheticsTestConfigVariableArgs>

    Variables used for the test configuration. Multiple config_variable blocks are allowed with the structure below.

    deviceIds List<String>

    Required if type = "browser". Array with the different device IDs used to run the test. Valid values are laptop_large, tablet, mobile_small, chrome.laptop_large, chrome.tablet, chrome.mobile_small, firefox.laptop_large, firefox.tablet, firefox.mobile_small, edge.laptop_large, edge.tablet, edge.mobile_small.

    locations List<String>

    Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.

    message String

    A message to include with notifications for this synthetics test. Email notifications can be sent to specific users by using the same @username notation as events.

    monitorId Integer

    ID of the monitor associated with the Datadog synthetics test.

    name String

    Name of Datadog synthetics test.

    optionsList SyntheticsTestOptionsListArgs
    requestBasicauth SyntheticsTestRequestBasicauthArgs

    The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.

    requestClientCertificate SyntheticsTestRequestClientCertificateArgs

    Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.

    requestDefinition SyntheticsTestRequestDefinitionArgs

    Required if type = "api". The synthetics test request.

    requestHeaders Map<String,Object>

    Header name and value map.

    requestProxy SyntheticsTestRequestProxyArgs

    The proxy to perform the test.

    requestQuery Map<String,Object>

    Query arguments name and value map.

    setCookie String

    Cookies to be used for a browser test request, using the Set-Cookie syntax.

    status String

    Define whether you want to start (live) or pause (paused) a Synthetic test. Valid values are live, paused.

    subtype String

    The subtype of the Synthetic API test. Defaults to http. Valid values are http, ssl, tcp, dns, multi, icmp, udp, websocket, grpc.

    tags List<String>

    A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list ([]).

    type String

    Synthetics test type. Valid values are api, browser.

    apiSteps SyntheticsTestApiStepArgs[]

    Steps for multistep api tests

    assertions SyntheticsTestAssertionArgs[]

    Assertions used for the test. Multiple assertion blocks are allowed with the structure below.

    browserSteps SyntheticsTestBrowserStepArgs[]

    Steps for browser tests.

    browserVariables SyntheticsTestBrowserVariableArgs[]

    Variables used for a browser test steps. Multiple variable blocks are allowed with the structure below.

    configVariables SyntheticsTestConfigVariableArgs[]

    Variables used for the test configuration. Multiple config_variable blocks are allowed with the structure below.

    deviceIds string[]

    Required if type = "browser". Array with the different device IDs used to run the test. Valid values are laptop_large, tablet, mobile_small, chrome.laptop_large, chrome.tablet, chrome.mobile_small, firefox.laptop_large, firefox.tablet, firefox.mobile_small, edge.laptop_large, edge.tablet, edge.mobile_small.

    locations string[]

    Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.

    message string

    A message to include with notifications for this synthetics test. Email notifications can be sent to specific users by using the same @username notation as events.

    monitorId number

    ID of the monitor associated with the Datadog synthetics test.

    name string

    Name of Datadog synthetics test.

    optionsList SyntheticsTestOptionsListArgs
    requestBasicauth SyntheticsTestRequestBasicauthArgs

    The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.

    requestClientCertificate SyntheticsTestRequestClientCertificateArgs

    Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.

    requestDefinition SyntheticsTestRequestDefinitionArgs

    Required if type = "api". The synthetics test request.

    requestHeaders {[key: string]: any}

    Header name and value map.

    requestProxy SyntheticsTestRequestProxyArgs

    The proxy to perform the test.

    requestQuery {[key: string]: any}

    Query arguments name and value map.

    setCookie string

    Cookies to be used for a browser test request, using the Set-Cookie syntax.

    status string

    Define whether you want to start (live) or pause (paused) a Synthetic test. Valid values are live, paused.

    subtype string

    The subtype of the Synthetic API test. Defaults to http. Valid values are http, ssl, tcp, dns, multi, icmp, udp, websocket, grpc.

    tags string[]

    A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list ([]).

    type string

    Synthetics test type. Valid values are api, browser.

    api_steps Sequence[SyntheticsTestApiStepArgs]

    Steps for multistep api tests

    assertions Sequence[SyntheticsTestAssertionArgs]

    Assertions used for the test. Multiple assertion blocks are allowed with the structure below.

    browser_steps Sequence[SyntheticsTestBrowserStepArgs]

    Steps for browser tests.

    browser_variables Sequence[SyntheticsTestBrowserVariableArgs]

    Variables used for a browser test steps. Multiple variable blocks are allowed with the structure below.

    config_variables Sequence[SyntheticsTestConfigVariableArgs]

    Variables used for the test configuration. Multiple config_variable blocks are allowed with the structure below.

    device_ids Sequence[str]

    Required if type = "browser". Array with the different device IDs used to run the test. Valid values are laptop_large, tablet, mobile_small, chrome.laptop_large, chrome.tablet, chrome.mobile_small, firefox.laptop_large, firefox.tablet, firefox.mobile_small, edge.laptop_large, edge.tablet, edge.mobile_small.

    locations Sequence[str]

    Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.

    message str

    A message to include with notifications for this synthetics test. Email notifications can be sent to specific users by using the same @username notation as events.

    monitor_id int

    ID of the monitor associated with the Datadog synthetics test.

    name str

    Name of Datadog synthetics test.

    options_list SyntheticsTestOptionsListArgs
    request_basicauth SyntheticsTestRequestBasicauthArgs

    The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.

    request_client_certificate SyntheticsTestRequestClientCertificateArgs

    Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.

    request_definition SyntheticsTestRequestDefinitionArgs

    Required if type = "api". The synthetics test request.

    request_headers Mapping[str, Any]

    Header name and value map.

    request_proxy SyntheticsTestRequestProxyArgs

    The proxy to perform the test.

    request_query Mapping[str, Any]

    Query arguments name and value map.

    set_cookie str

    Cookies to be used for a browser test request, using the Set-Cookie syntax.

    status str

    Define whether you want to start (live) or pause (paused) a Synthetic test. Valid values are live, paused.

    subtype str

    The subtype of the Synthetic API test. Defaults to http. Valid values are http, ssl, tcp, dns, multi, icmp, udp, websocket, grpc.

    tags Sequence[str]

    A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list ([]).

    type str

    Synthetics test type. Valid values are api, browser.

    apiSteps List<Property Map>

    Steps for multistep api tests

    assertions List<Property Map>

    Assertions used for the test. Multiple assertion blocks are allowed with the structure below.

    browserSteps List<Property Map>

    Steps for browser tests.

    browserVariables List<Property Map>

    Variables used for a browser test steps. Multiple variable blocks are allowed with the structure below.

    configVariables List<Property Map>

    Variables used for the test configuration. Multiple config_variable blocks are allowed with the structure below.

    deviceIds List<String>

    Required if type = "browser". Array with the different device IDs used to run the test. Valid values are laptop_large, tablet, mobile_small, chrome.laptop_large, chrome.tablet, chrome.mobile_small, firefox.laptop_large, firefox.tablet, firefox.mobile_small, edge.laptop_large, edge.tablet, edge.mobile_small.

    locations List<String>

    Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.

    message String

    A message to include with notifications for this synthetics test. Email notifications can be sent to specific users by using the same @username notation as events.

    monitorId Number

    ID of the monitor associated with the Datadog synthetics test.

    name String

    Name of Datadog synthetics test.

    optionsList Property Map
    requestBasicauth Property Map

    The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.

    requestClientCertificate Property Map

    Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.

    requestDefinition Property Map

    Required if type = "api". The synthetics test request.

    requestHeaders Map<Any>

    Header name and value map.

    requestProxy Property Map

    The proxy to perform the test.

    requestQuery Map<Any>

    Query arguments name and value map.

    setCookie String

    Cookies to be used for a browser test request, using the Set-Cookie syntax.

    status String

    Define whether you want to start (live) or pause (paused) a Synthetic test. Valid values are live, paused.

    subtype String

    The subtype of the Synthetic API test. Defaults to http. Valid values are http, ssl, tcp, dns, multi, icmp, udp, websocket, grpc.

    tags List<String>

    A list of tags to associate with your synthetics test. This can help you categorize and filter tests in the manage synthetics page of the UI. Default is an empty list ([]).

    type String

    Synthetics test type. Valid values are api, browser.

    Supporting Types

    SyntheticsTestApiStep

    Name string

    The name of the step.

    AllowFailure bool

    Determines whether or not to continue with test if this step fails.

    Assertions List<SyntheticsTestApiStepAssertion>

    Assertions used for the test. Multiple assertion blocks are allowed with the structure below.

    ExtractedValues List<SyntheticsTestApiStepExtractedValue>

    Values to parse and save as variables from the response.

    IsCritical bool

    Determines whether or not to consider the entire test as failed if this step fails. Can be used only if allow_failure is true.

    RequestBasicauth SyntheticsTestApiStepRequestBasicauth

    The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.

    RequestClientCertificate SyntheticsTestApiStepRequestClientCertificate

    Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.

    RequestDefinition SyntheticsTestApiStepRequestDefinition

    The request for the api step.

    RequestHeaders Dictionary<string, object>

    Header name and value map.

    RequestProxy SyntheticsTestApiStepRequestProxy

    The proxy to perform the test.

    RequestQuery Dictionary<string, object>

    Query arguments name and value map.

    Retry SyntheticsTestApiStepRetry
    Subtype string

    The subtype of the Synthetic multistep API test step. Valid values are http.

    Name string

    The name of the step.

    AllowFailure bool

    Determines whether or not to continue with test if this step fails.

    Assertions []SyntheticsTestApiStepAssertion

    Assertions used for the test. Multiple assertion blocks are allowed with the structure below.

    ExtractedValues []SyntheticsTestApiStepExtractedValue

    Values to parse and save as variables from the response.

    IsCritical bool

    Determines whether or not to consider the entire test as failed if this step fails. Can be used only if allow_failure is true.

    RequestBasicauth SyntheticsTestApiStepRequestBasicauth

    The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.

    RequestClientCertificate SyntheticsTestApiStepRequestClientCertificate

    Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.

    RequestDefinition SyntheticsTestApiStepRequestDefinition

    The request for the api step.

    RequestHeaders map[string]interface{}

    Header name and value map.

    RequestProxy SyntheticsTestApiStepRequestProxy

    The proxy to perform the test.

    RequestQuery map[string]interface{}

    Query arguments name and value map.

    Retry SyntheticsTestApiStepRetry
    Subtype string

    The subtype of the Synthetic multistep API test step. Valid values are http.

    name String

    The name of the step.

    allowFailure Boolean

    Determines whether or not to continue with test if this step fails.

    assertions List<SyntheticsTestApiStepAssertion>

    Assertions used for the test. Multiple assertion blocks are allowed with the structure below.

    extractedValues List<SyntheticsTestApiStepExtractedValue>

    Values to parse and save as variables from the response.

    isCritical Boolean

    Determines whether or not to consider the entire test as failed if this step fails. Can be used only if allow_failure is true.

    requestBasicauth SyntheticsTestApiStepRequestBasicauth

    The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.

    requestClientCertificate SyntheticsTestApiStepRequestClientCertificate

    Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.

    requestDefinition SyntheticsTestApiStepRequestDefinition

    The request for the api step.

    requestHeaders Map<String,Object>

    Header name and value map.

    requestProxy SyntheticsTestApiStepRequestProxy

    The proxy to perform the test.

    requestQuery Map<String,Object>

    Query arguments name and value map.

    retry SyntheticsTestApiStepRetry
    subtype String

    The subtype of the Synthetic multistep API test step. Valid values are http.

    name string

    The name of the step.

    allowFailure boolean

    Determines whether or not to continue with test if this step fails.

    assertions SyntheticsTestApiStepAssertion[]

    Assertions used for the test. Multiple assertion blocks are allowed with the structure below.

    extractedValues SyntheticsTestApiStepExtractedValue[]

    Values to parse and save as variables from the response.

    isCritical boolean

    Determines whether or not to consider the entire test as failed if this step fails. Can be used only if allow_failure is true.

    requestBasicauth SyntheticsTestApiStepRequestBasicauth

    The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.

    requestClientCertificate SyntheticsTestApiStepRequestClientCertificate

    Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.

    requestDefinition SyntheticsTestApiStepRequestDefinition

    The request for the api step.

    requestHeaders {[key: string]: any}

    Header name and value map.

    requestProxy SyntheticsTestApiStepRequestProxy

    The proxy to perform the test.

    requestQuery {[key: string]: any}

    Query arguments name and value map.

    retry SyntheticsTestApiStepRetry
    subtype string

    The subtype of the Synthetic multistep API test step. Valid values are http.

    name str

    The name of the step.

    allow_failure bool

    Determines whether or not to continue with test if this step fails.

    assertions Sequence[SyntheticsTestApiStepAssertion]

    Assertions used for the test. Multiple assertion blocks are allowed with the structure below.

    extracted_values Sequence[SyntheticsTestApiStepExtractedValue]

    Values to parse and save as variables from the response.

    is_critical bool

    Determines whether or not to consider the entire test as failed if this step fails. Can be used only if allow_failure is true.

    request_basicauth SyntheticsTestApiStepRequestBasicauth

    The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.

    request_client_certificate SyntheticsTestApiStepRequestClientCertificate

    Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.

    request_definition SyntheticsTestApiStepRequestDefinition

    The request for the api step.

    request_headers Mapping[str, Any]

    Header name and value map.

    request_proxy SyntheticsTestApiStepRequestProxy

    The proxy to perform the test.

    request_query Mapping[str, Any]

    Query arguments name and value map.

    retry SyntheticsTestApiStepRetry
    subtype str

    The subtype of the Synthetic multistep API test step. Valid values are http.

    name String

    The name of the step.

    allowFailure Boolean

    Determines whether or not to continue with test if this step fails.

    assertions List<Property Map>

    Assertions used for the test. Multiple assertion blocks are allowed with the structure below.

    extractedValues List<Property Map>

    Values to parse and save as variables from the response.

    isCritical Boolean

    Determines whether or not to consider the entire test as failed if this step fails. Can be used only if allow_failure is true.

    requestBasicauth Property Map

    The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.

    requestClientCertificate Property Map

    Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.

    requestDefinition Property Map

    The request for the api step.

    requestHeaders Map<Any>

    Header name and value map.

    requestProxy Property Map

    The proxy to perform the test.

    requestQuery Map<Any>

    Query arguments name and value map.

    retry Property Map
    subtype String

    The subtype of the Synthetic multistep API test step. Valid values are http.

    SyntheticsTestApiStepAssertion

    Operator string

    Assertion operator. Note Only some combinations of type and operator are valid (please refer to Datadog documentation).

    Type string

    Type of assertion. Note Only some combinations of type and operator are valid (please refer to Datadog documentation). Valid values are body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersion, latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection.

    Property string

    If assertion type is header, this is the header name.

    Target string

    Expected value. Depends on the assertion type, refer to Datadog documentation for details.

    Targetjsonpath SyntheticsTestApiStepAssertionTargetjsonpath

    Expected structure if operator is validatesJSONPath. Exactly one nested block is allowed with the structure below.

    Targetxpath SyntheticsTestApiStepAssertionTargetxpath

    Expected structure if operator is validatesXPath. Exactly one nested block is allowed with the structure below.

    Operator string

    Assertion operator. Note Only some combinations of type and operator are valid (please refer to Datadog documentation).

    Type string

    Type of assertion. Note Only some combinations of type and operator are valid (please refer to Datadog documentation). Valid values are body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersion, latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection.

    Property string

    If assertion type is header, this is the header name.

    Target string

    Expected value. Depends on the assertion type, refer to Datadog documentation for details.

    Targetjsonpath SyntheticsTestApiStepAssertionTargetjsonpath

    Expected structure if operator is validatesJSONPath. Exactly one nested block is allowed with the structure below.

    Targetxpath SyntheticsTestApiStepAssertionTargetxpath

    Expected structure if operator is validatesXPath. Exactly one nested block is allowed with the structure below.

    operator String

    Assertion operator. Note Only some combinations of type and operator are valid (please refer to Datadog documentation).

    type String

    Type of assertion. Note Only some combinations of type and operator are valid (please refer to Datadog documentation). Valid values are body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersion, latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection.

    property String

    If assertion type is header, this is the header name.

    target String

    Expected value. Depends on the assertion type, refer to Datadog documentation for details.

    targetjsonpath SyntheticsTestApiStepAssertionTargetjsonpath

    Expected structure if operator is validatesJSONPath. Exactly one nested block is allowed with the structure below.

    targetxpath SyntheticsTestApiStepAssertionTargetxpath

    Expected structure if operator is validatesXPath. Exactly one nested block is allowed with the structure below.

    operator string

    Assertion operator. Note Only some combinations of type and operator are valid (please refer to Datadog documentation).

    type string

    Type of assertion. Note Only some combinations of type and operator are valid (please refer to Datadog documentation). Valid values are body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersion, latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection.

    property string

    If assertion type is header, this is the header name.

    target string

    Expected value. Depends on the assertion type, refer to Datadog documentation for details.

    targetjsonpath SyntheticsTestApiStepAssertionTargetjsonpath

    Expected structure if operator is validatesJSONPath. Exactly one nested block is allowed with the structure below.

    targetxpath SyntheticsTestApiStepAssertionTargetxpath

    Expected structure if operator is validatesXPath. Exactly one nested block is allowed with the structure below.

    operator str

    Assertion operator. Note Only some combinations of type and operator are valid (please refer to Datadog documentation).

    type str

    Type of assertion. Note Only some combinations of type and operator are valid (please refer to Datadog documentation). Valid values are body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersion, latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection.

    property str

    If assertion type is header, this is the header name.

    target str

    Expected value. Depends on the assertion type, refer to Datadog documentation for details.

    targetjsonpath SyntheticsTestApiStepAssertionTargetjsonpath

    Expected structure if operator is validatesJSONPath. Exactly one nested block is allowed with the structure below.

    targetxpath SyntheticsTestApiStepAssertionTargetxpath

    Expected structure if operator is validatesXPath. Exactly one nested block is allowed with the structure below.

    operator String

    Assertion operator. Note Only some combinations of type and operator are valid (please refer to Datadog documentation).

    type String

    Type of assertion. Note Only some combinations of type and operator are valid (please refer to Datadog documentation). Valid values are body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersion, latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection.

    property String

    If assertion type is header, this is the header name.

    target String

    Expected value. Depends on the assertion type, refer to Datadog documentation for details.

    targetjsonpath Property Map

    Expected structure if operator is validatesJSONPath. Exactly one nested block is allowed with the structure below.

    targetxpath Property Map

    Expected structure if operator is validatesXPath. Exactly one nested block is allowed with the structure below.

    SyntheticsTestApiStepAssertionTargetjsonpath

    Jsonpath string
    Operator string
    Targetvalue string
    Jsonpath string
    Operator string
    Targetvalue string
    jsonpath String
    operator String
    targetvalue String
    jsonpath string
    operator string
    targetvalue string
    jsonpath String
    operator String
    targetvalue String

    SyntheticsTestApiStepAssertionTargetxpath

    Operator string
    Xpath string
    Targetvalue string
    Operator string
    Xpath string
    Targetvalue string
    operator String
    xpath String
    targetvalue String
    operator string
    xpath string
    targetvalue string
    operator String
    xpath String
    targetvalue String

    SyntheticsTestApiStepExtractedValue

    Name string

    Name of Datadog synthetics test.

    Parser SyntheticsTestApiStepExtractedValueParser
    Type string

    Synthetics test type. Valid values are api, browser.

    Field string
    Name string

    Name of Datadog synthetics test.

    Parser SyntheticsTestApiStepExtractedValueParser
    Type string

    Synthetics test type. Valid values are api, browser.

    Field string
    name String

    Name of Datadog synthetics test.

    parser SyntheticsTestApiStepExtractedValueParser
    type String

    Synthetics test type. Valid values are api, browser.

    field String
    name string

    Name of Datadog synthetics test.

    parser SyntheticsTestApiStepExtractedValueParser
    type string

    Synthetics test type. Valid values are api, browser.

    field string
    name str

    Name of Datadog synthetics test.

    parser SyntheticsTestApiStepExtractedValueParser
    type str

    Synthetics test type. Valid values are api, browser.

    field str
    name String

    Name of Datadog synthetics test.

    parser Property Map
    type String

    Synthetics test type. Valid values are api, browser.

    field String

    SyntheticsTestApiStepExtractedValueParser

    Type string

    Synthetics test type. Valid values are api, browser.

    Value string
    Type string

    Synthetics test type. Valid values are api, browser.

    Value string
    type String

    Synthetics test type. Valid values are api, browser.

    value String
    type string

    Synthetics test type. Valid values are api, browser.

    value string
    type str

    Synthetics test type. Valid values are api, browser.

    value str
    type String

    Synthetics test type. Valid values are api, browser.

    value String

    SyntheticsTestApiStepRequestBasicauth

    AccessKey string

    Access key for SIGV4 authentication.

    AccessTokenUrl string

    Access token url for oauth-client or oauth-rop authentication.

    Audience string

    Audience for oauth-client or oauth-rop authentication.

    ClientId string

    Client ID for oauth-client or oauth-rop authentication.

    ClientSecret string

    Client secret for oauth-client or oauth-rop authentication.

    Domain string

    Domain for ntlm authentication.

    Password string

    Password for authentication.

    Region string

    Region for SIGV4 authentication.

    Resource string

    Resource for oauth-client or oauth-rop authentication.

    Scope string

    Scope for oauth-client or oauth-rop authentication.

    SecretKey string

    Secret key for SIGV4 authentication.

    ServiceName string

    Service name for SIGV4 authentication.

    SessionToken string

    Session token for SIGV4 authentication.

    TokenApiAuthentication string

    Token API Authentication for oauth-client or oauth-rop authentication. Valid values are header, body.

    Type string

    Type of basic authentication to use when performing the test.

    Username string

    Username for authentication.

    Workstation string

    Workstation for ntlm authentication.

    AccessKey string

    Access key for SIGV4 authentication.

    AccessTokenUrl string

    Access token url for oauth-client or oauth-rop authentication.

    Audience string

    Audience for oauth-client or oauth-rop authentication.

    ClientId string

    Client ID for oauth-client or oauth-rop authentication.

    ClientSecret string

    Client secret for oauth-client or oauth-rop authentication.

    Domain string

    Domain for ntlm authentication.

    Password string

    Password for authentication.

    Region string

    Region for SIGV4 authentication.

    Resource string

    Resource for oauth-client or oauth-rop authentication.

    Scope string

    Scope for oauth-client or oauth-rop authentication.

    SecretKey string

    Secret key for SIGV4 authentication.

    ServiceName string

    Service name for SIGV4 authentication.

    SessionToken string

    Session token for SIGV4 authentication.

    TokenApiAuthentication string

    Token API Authentication for oauth-client or oauth-rop authentication. Valid values are header, body.

    Type string

    Type of basic authentication to use when performing the test.

    Username string

    Username for authentication.

    Workstation string

    Workstation for ntlm authentication.

    accessKey String

    Access key for SIGV4 authentication.

    accessTokenUrl String

    Access token url for oauth-client or oauth-rop authentication.

    audience String

    Audience for oauth-client or oauth-rop authentication.

    clientId String

    Client ID for oauth-client or oauth-rop authentication.

    clientSecret String

    Client secret for oauth-client or oauth-rop authentication.

    domain String

    Domain for ntlm authentication.

    password String

    Password for authentication.

    region String

    Region for SIGV4 authentication.

    resource String

    Resource for oauth-client or oauth-rop authentication.

    scope String

    Scope for oauth-client or oauth-rop authentication.

    secretKey String

    Secret key for SIGV4 authentication.

    serviceName String

    Service name for SIGV4 authentication.

    sessionToken String

    Session token for SIGV4 authentication.

    tokenApiAuthentication String

    Token API Authentication for oauth-client or oauth-rop authentication. Valid values are header, body.

    type String

    Type of basic authentication to use when performing the test.

    username String

    Username for authentication.

    workstation String

    Workstation for ntlm authentication.

    accessKey string

    Access key for SIGV4 authentication.

    accessTokenUrl string

    Access token url for oauth-client or oauth-rop authentication.

    audience string

    Audience for oauth-client or oauth-rop authentication.

    clientId string

    Client ID for oauth-client or oauth-rop authentication.

    clientSecret string

    Client secret for oauth-client or oauth-rop authentication.

    domain string

    Domain for ntlm authentication.

    password string

    Password for authentication.

    region string

    Region for SIGV4 authentication.

    resource string

    Resource for oauth-client or oauth-rop authentication.

    scope string

    Scope for oauth-client or oauth-rop authentication.

    secretKey string

    Secret key for SIGV4 authentication.

    serviceName string

    Service name for SIGV4 authentication.

    sessionToken string

    Session token for SIGV4 authentication.

    tokenApiAuthentication string

    Token API Authentication for oauth-client or oauth-rop authentication. Valid values are header, body.

    type string

    Type of basic authentication to use when performing the test.

    username string

    Username for authentication.

    workstation string

    Workstation for ntlm authentication.

    access_key str

    Access key for SIGV4 authentication.

    access_token_url str

    Access token url for oauth-client or oauth-rop authentication.

    audience str

    Audience for oauth-client or oauth-rop authentication.

    client_id str

    Client ID for oauth-client or oauth-rop authentication.

    client_secret str

    Client secret for oauth-client or oauth-rop authentication.

    domain str

    Domain for ntlm authentication.

    password str

    Password for authentication.

    region str

    Region for SIGV4 authentication.

    resource str

    Resource for oauth-client or oauth-rop authentication.

    scope str

    Scope for oauth-client or oauth-rop authentication.

    secret_key str

    Secret key for SIGV4 authentication.

    service_name str

    Service name for SIGV4 authentication.

    session_token str

    Session token for SIGV4 authentication.

    token_api_authentication str

    Token API Authentication for oauth-client or oauth-rop authentication. Valid values are header, body.

    type str

    Type of basic authentication to use when performing the test.

    username str

    Username for authentication.

    workstation str

    Workstation for ntlm authentication.

    accessKey String

    Access key for SIGV4 authentication.

    accessTokenUrl String

    Access token url for oauth-client or oauth-rop authentication.

    audience String

    Audience for oauth-client or oauth-rop authentication.

    clientId String

    Client ID for oauth-client or oauth-rop authentication.

    clientSecret String

    Client secret for oauth-client or oauth-rop authentication.

    domain String

    Domain for ntlm authentication.

    password String

    Password for authentication.

    region String

    Region for SIGV4 authentication.

    resource String

    Resource for oauth-client or oauth-rop authentication.

    scope String

    Scope for oauth-client or oauth-rop authentication.

    secretKey String

    Secret key for SIGV4 authentication.

    serviceName String

    Service name for SIGV4 authentication.

    sessionToken String

    Session token for SIGV4 authentication.

    tokenApiAuthentication String

    Token API Authentication for oauth-client or oauth-rop authentication. Valid values are header, body.

    type String

    Type of basic authentication to use when performing the test.

    username String

    Username for authentication.

    workstation String

    Workstation for ntlm authentication.

    SyntheticsTestApiStepRequestClientCertificate

    SyntheticsTestApiStepRequestClientCertificateCert

    Content string
    Filename string
    Content string
    Filename string
    content String
    filename String
    content string
    filename string
    content String
    filename String

    SyntheticsTestApiStepRequestClientCertificateKey

    Content string
    Filename string
    Content string
    Filename string
    content String
    filename String
    content string
    filename string
    content String
    filename String

    SyntheticsTestApiStepRequestDefinition

    AllowInsecure bool
    Body string

    The request body.

    BodyType string

    Type of the request body. Valid values are text/plain, application/json, text/xml, text/html, application/x-www-form-urlencoded, graphql.

    CallType string

    The type of gRPC call to perform. Valid values are healthcheck, unary.

    CertificateDomains List<string>

    By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificate_domains.

    DnsServer string

    DNS server to use for DNS tests (subtype = "dns").

    DnsServerPort int

    DNS server port to use for DNS tests.

    FollowRedirects bool
    Host string

    Host name to perform the test with.

    Message string

    For UDP and websocket tests, message to send with the request.

    Method string

    Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

    NoSavingResponseBody bool

    Determines whether or not to save the response body.

    NumberOfPackets int

    Number of pings to use per test for ICMP tests (subtype = "icmp") between 0 and 10.

    Port int

    Port to use when performing the test.

    Servername string

    For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.

    Service string

    The gRPC service on which you want to perform the gRPC call.

    ShouldTrackHops bool

    This will turn on a traceroute probe to discover all gateways along the path to the host destination. For ICMP tests (subtype = "icmp").

    Timeout int

    Timeout in seconds for the test. Defaults to 60.

    Url string

    The URL to send the request to.

    AllowInsecure bool
    Body string

    The request body.

    BodyType string

    Type of the request body. Valid values are text/plain, application/json, text/xml, text/html, application/x-www-form-urlencoded, graphql.

    CallType string

    The type of gRPC call to perform. Valid values are healthcheck, unary.

    CertificateDomains []string

    By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificate_domains.

    DnsServer string

    DNS server to use for DNS tests (subtype = "dns").

    DnsServerPort int

    DNS server port to use for DNS tests.

    FollowRedirects bool
    Host string

    Host name to perform the test with.

    Message string

    For UDP and websocket tests, message to send with the request.

    Method string

    Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

    NoSavingResponseBody bool

    Determines whether or not to save the response body.

    NumberOfPackets int

    Number of pings to use per test for ICMP tests (subtype = "icmp") between 0 and 10.

    Port int

    Port to use when performing the test.

    Servername string

    For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.

    Service string

    The gRPC service on which you want to perform the gRPC call.

    ShouldTrackHops bool

    This will turn on a traceroute probe to discover all gateways along the path to the host destination. For ICMP tests (subtype = "icmp").

    Timeout int

    Timeout in seconds for the test. Defaults to 60.

    Url string

    The URL to send the request to.

    allowInsecure Boolean
    body String

    The request body.

    bodyType String

    Type of the request body. Valid values are text/plain, application/json, text/xml, text/html, application/x-www-form-urlencoded, graphql.

    callType String

    The type of gRPC call to perform. Valid values are healthcheck, unary.

    certificateDomains List<String>

    By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificate_domains.

    dnsServer String

    DNS server to use for DNS tests (subtype = "dns").

    dnsServerPort Integer

    DNS server port to use for DNS tests.

    followRedirects Boolean
    host String

    Host name to perform the test with.

    message String

    For UDP and websocket tests, message to send with the request.

    method String

    Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

    noSavingResponseBody Boolean

    Determines whether or not to save the response body.

    numberOfPackets Integer

    Number of pings to use per test for ICMP tests (subtype = "icmp") between 0 and 10.

    port Integer

    Port to use when performing the test.

    servername String

    For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.

    service String

    The gRPC service on which you want to perform the gRPC call.

    shouldTrackHops Boolean

    This will turn on a traceroute probe to discover all gateways along the path to the host destination. For ICMP tests (subtype = "icmp").

    timeout Integer

    Timeout in seconds for the test. Defaults to 60.

    url String

    The URL to send the request to.

    allowInsecure boolean
    body string

    The request body.

    bodyType string

    Type of the request body. Valid values are text/plain, application/json, text/xml, text/html, application/x-www-form-urlencoded, graphql.

    callType string

    The type of gRPC call to perform. Valid values are healthcheck, unary.

    certificateDomains string[]

    By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificate_domains.

    dnsServer string

    DNS server to use for DNS tests (subtype = "dns").

    dnsServerPort number

    DNS server port to use for DNS tests.

    followRedirects boolean
    host string

    Host name to perform the test with.

    message string

    For UDP and websocket tests, message to send with the request.

    method string

    Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

    noSavingResponseBody boolean

    Determines whether or not to save the response body.

    numberOfPackets number

    Number of pings to use per test for ICMP tests (subtype = "icmp") between 0 and 10.

    port number

    Port to use when performing the test.

    servername string

    For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.

    service string

    The gRPC service on which you want to perform the gRPC call.

    shouldTrackHops boolean

    This will turn on a traceroute probe to discover all gateways along the path to the host destination. For ICMP tests (subtype = "icmp").

    timeout number

    Timeout in seconds for the test. Defaults to 60.

    url string

    The URL to send the request to.

    allow_insecure bool
    body str

    The request body.

    body_type str

    Type of the request body. Valid values are text/plain, application/json, text/xml, text/html, application/x-www-form-urlencoded, graphql.

    call_type str

    The type of gRPC call to perform. Valid values are healthcheck, unary.

    certificate_domains Sequence[str]

    By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificate_domains.

    dns_server str

    DNS server to use for DNS tests (subtype = "dns").

    dns_server_port int

    DNS server port to use for DNS tests.

    follow_redirects bool
    host str

    Host name to perform the test with.

    message str

    For UDP and websocket tests, message to send with the request.

    method str

    Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

    no_saving_response_body bool

    Determines whether or not to save the response body.

    number_of_packets int

    Number of pings to use per test for ICMP tests (subtype = "icmp") between 0 and 10.

    port int

    Port to use when performing the test.

    servername str

    For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.

    service str

    The gRPC service on which you want to perform the gRPC call.

    should_track_hops bool

    This will turn on a traceroute probe to discover all gateways along the path to the host destination. For ICMP tests (subtype = "icmp").

    timeout int

    Timeout in seconds for the test. Defaults to 60.

    url str

    The URL to send the request to.

    allowInsecure Boolean
    body String

    The request body.

    bodyType String

    Type of the request body. Valid values are text/plain, application/json, text/xml, text/html, application/x-www-form-urlencoded, graphql.

    callType String

    The type of gRPC call to perform. Valid values are healthcheck, unary.

    certificateDomains List<String>

    By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificate_domains.

    dnsServer String

    DNS server to use for DNS tests (subtype = "dns").

    dnsServerPort Number

    DNS server port to use for DNS tests.

    followRedirects Boolean
    host String

    Host name to perform the test with.

    message String

    For UDP and websocket tests, message to send with the request.

    method String

    Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

    noSavingResponseBody Boolean

    Determines whether or not to save the response body.

    numberOfPackets Number

    Number of pings to use per test for ICMP tests (subtype = "icmp") between 0 and 10.

    port Number

    Port to use when performing the test.

    servername String

    For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.

    service String

    The gRPC service on which you want to perform the gRPC call.

    shouldTrackHops Boolean

    This will turn on a traceroute probe to discover all gateways along the path to the host destination. For ICMP tests (subtype = "icmp").

    timeout Number

    Timeout in seconds for the test. Defaults to 60.

    url String

    The URL to send the request to.

    SyntheticsTestApiStepRequestProxy

    Url string

    URL of the proxy to perform the test.

    Headers Dictionary<string, object>

    Header name and value map.

    Url string

    URL of the proxy to perform the test.

    Headers map[string]interface{}

    Header name and value map.

    url String

    URL of the proxy to perform the test.

    headers Map<String,Object>

    Header name and value map.

    url string

    URL of the proxy to perform the test.

    headers {[key: string]: any}

    Header name and value map.

    url str

    URL of the proxy to perform the test.

    headers Mapping[str, Any]

    Header name and value map.

    url String

    URL of the proxy to perform the test.

    headers Map<Any>

    Header name and value map.

    SyntheticsTestApiStepRetry

    count Integer
    interval Integer
    count number
    interval number
    count Number
    interval Number

    SyntheticsTestAssertion

    Operator string

    Assertion operator. Note Only some combinations of type and operator are valid (please refer to Datadog documentation).

    Type string

    Type of assertion. Note Only some combinations of type and operator are valid (please refer to Datadog documentation). Valid values are body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersion, latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection.

    Property string

    If assertion type is header, this is the header name.

    Target string

    Expected value. Depends on the assertion type, refer to Datadog documentation for details.

    Targetjsonpath SyntheticsTestAssertionTargetjsonpath

    Expected structure if operator is validatesJSONPath. Exactly one nested block is allowed with the structure below.

    Targetxpath SyntheticsTestAssertionTargetxpath

    Expected structure if operator is validatesXPath. Exactly one nested block is allowed with the structure below.

    Operator string

    Assertion operator. Note Only some combinations of type and operator are valid (please refer to Datadog documentation).

    Type string

    Type of assertion. Note Only some combinations of type and operator are valid (please refer to Datadog documentation). Valid values are body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersion, latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection.

    Property string

    If assertion type is header, this is the header name.

    Target string

    Expected value. Depends on the assertion type, refer to Datadog documentation for details.

    Targetjsonpath SyntheticsTestAssertionTargetjsonpath

    Expected structure if operator is validatesJSONPath. Exactly one nested block is allowed with the structure below.

    Targetxpath SyntheticsTestAssertionTargetxpath

    Expected structure if operator is validatesXPath. Exactly one nested block is allowed with the structure below.

    operator String

    Assertion operator. Note Only some combinations of type and operator are valid (please refer to Datadog documentation).

    type String

    Type of assertion. Note Only some combinations of type and operator are valid (please refer to Datadog documentation). Valid values are body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersion, latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection.

    property String

    If assertion type is header, this is the header name.

    target String

    Expected value. Depends on the assertion type, refer to Datadog documentation for details.

    targetjsonpath SyntheticsTestAssertionTargetjsonpath

    Expected structure if operator is validatesJSONPath. Exactly one nested block is allowed with the structure below.

    targetxpath SyntheticsTestAssertionTargetxpath

    Expected structure if operator is validatesXPath. Exactly one nested block is allowed with the structure below.

    operator string

    Assertion operator. Note Only some combinations of type and operator are valid (please refer to Datadog documentation).

    type string

    Type of assertion. Note Only some combinations of type and operator are valid (please refer to Datadog documentation). Valid values are body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersion, latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection.

    property string

    If assertion type is header, this is the header name.

    target string

    Expected value. Depends on the assertion type, refer to Datadog documentation for details.

    targetjsonpath SyntheticsTestAssertionTargetjsonpath

    Expected structure if operator is validatesJSONPath. Exactly one nested block is allowed with the structure below.

    targetxpath SyntheticsTestAssertionTargetxpath

    Expected structure if operator is validatesXPath. Exactly one nested block is allowed with the structure below.

    operator str

    Assertion operator. Note Only some combinations of type and operator are valid (please refer to Datadog documentation).

    type str

    Type of assertion. Note Only some combinations of type and operator are valid (please refer to Datadog documentation). Valid values are body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersion, latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection.

    property str

    If assertion type is header, this is the header name.

    target str

    Expected value. Depends on the assertion type, refer to Datadog documentation for details.

    targetjsonpath SyntheticsTestAssertionTargetjsonpath

    Expected structure if operator is validatesJSONPath. Exactly one nested block is allowed with the structure below.

    targetxpath SyntheticsTestAssertionTargetxpath

    Expected structure if operator is validatesXPath. Exactly one nested block is allowed with the structure below.

    operator String

    Assertion operator. Note Only some combinations of type and operator are valid (please refer to Datadog documentation).

    type String

    Type of assertion. Note Only some combinations of type and operator are valid (please refer to Datadog documentation). Valid values are body, header, statusCode, certificate, responseTime, property, recordEvery, recordSome, tlsVersion, minTlsVersion, latency, packetLossPercentage, packetsReceived, networkHop, receivedMessage, grpcHealthcheckStatus, grpcMetadata, grpcProto, connection.

    property String

    If assertion type is header, this is the header name.

    target String

    Expected value. Depends on the assertion type, refer to Datadog documentation for details.

    targetjsonpath Property Map

    Expected structure if operator is validatesJSONPath. Exactly one nested block is allowed with the structure below.

    targetxpath Property Map

    Expected structure if operator is validatesXPath. Exactly one nested block is allowed with the structure below.

    SyntheticsTestAssertionTargetjsonpath

    Jsonpath string
    Operator string
    Targetvalue string
    Jsonpath string
    Operator string
    Targetvalue string
    jsonpath String
    operator String
    targetvalue String
    jsonpath string
    operator string
    targetvalue string
    jsonpath String
    operator String
    targetvalue String

    SyntheticsTestAssertionTargetxpath

    Operator string
    Xpath string
    Targetvalue string
    Operator string
    Xpath string
    Targetvalue string
    operator String
    xpath String
    targetvalue String
    operator string
    xpath string
    targetvalue string
    operator String
    xpath String
    targetvalue String

    SyntheticsTestBrowserStep

    Name string

    Name of the step.

    Params SyntheticsTestBrowserStepParams

    Parameters for the step.

    Type string

    Type of the step. Valid values are assertCurrentUrl, assertElementAttribute, assertElementContent, assertElementPresent, assertEmail, assertFileDownload, assertFromJavascript, assertPageContains, assertPageLacks, click, extractFromJavascript, extractVariable, goToEmailLink, goToUrl, goToUrlAndMeasureTti, hover, playSubTest, pressKey, refresh, runApiTest, scroll, selectOption, typeText, uploadFiles, wait.

    AllowFailure bool

    Determines if the step should be allowed to fail.

    ForceElementUpdate bool

    Force update of the "element" parameter for the step

    IsCritical bool

    Determines whether or not to consider the entire test as failed if this step fails. Can be used only if allow_failure is true.

    NoScreenshot bool

    Prevents saving screenshots of the step.

    Timeout int

    Used to override the default timeout of a step.

    Name string

    Name of the step.

    Params SyntheticsTestBrowserStepParams

    Parameters for the step.

    Type string

    Type of the step. Valid values are assertCurrentUrl, assertElementAttribute, assertElementContent, assertElementPresent, assertEmail, assertFileDownload, assertFromJavascript, assertPageContains, assertPageLacks, click, extractFromJavascript, extractVariable, goToEmailLink, goToUrl, goToUrlAndMeasureTti, hover, playSubTest, pressKey, refresh, runApiTest, scroll, selectOption, typeText, uploadFiles, wait.

    AllowFailure bool

    Determines if the step should be allowed to fail.

    ForceElementUpdate bool

    Force update of the "element" parameter for the step

    IsCritical bool

    Determines whether or not to consider the entire test as failed if this step fails. Can be used only if allow_failure is true.

    NoScreenshot bool

    Prevents saving screenshots of the step.

    Timeout int

    Used to override the default timeout of a step.

    name String

    Name of the step.

    params SyntheticsTestBrowserStepParams

    Parameters for the step.

    type String

    Type of the step. Valid values are assertCurrentUrl, assertElementAttribute, assertElementContent, assertElementPresent, assertEmail, assertFileDownload, assertFromJavascript, assertPageContains, assertPageLacks, click, extractFromJavascript, extractVariable, goToEmailLink, goToUrl, goToUrlAndMeasureTti, hover, playSubTest, pressKey, refresh, runApiTest, scroll, selectOption, typeText, uploadFiles, wait.

    allowFailure Boolean

    Determines if the step should be allowed to fail.

    forceElementUpdate Boolean

    Force update of the "element" parameter for the step

    isCritical Boolean

    Determines whether or not to consider the entire test as failed if this step fails. Can be used only if allow_failure is true.

    noScreenshot Boolean

    Prevents saving screenshots of the step.

    timeout Integer

    Used to override the default timeout of a step.

    name string

    Name of the step.

    params SyntheticsTestBrowserStepParams

    Parameters for the step.

    type string

    Type of the step. Valid values are assertCurrentUrl, assertElementAttribute, assertElementContent, assertElementPresent, assertEmail, assertFileDownload, assertFromJavascript, assertPageContains, assertPageLacks, click, extractFromJavascript, extractVariable, goToEmailLink, goToUrl, goToUrlAndMeasureTti, hover, playSubTest, pressKey, refresh, runApiTest, scroll, selectOption, typeText, uploadFiles, wait.

    allowFailure boolean

    Determines if the step should be allowed to fail.

    forceElementUpdate boolean

    Force update of the "element" parameter for the step

    isCritical boolean

    Determines whether or not to consider the entire test as failed if this step fails. Can be used only if allow_failure is true.

    noScreenshot boolean

    Prevents saving screenshots of the step.

    timeout number

    Used to override the default timeout of a step.

    name str

    Name of the step.

    params SyntheticsTestBrowserStepParams

    Parameters for the step.

    type str

    Type of the step. Valid values are assertCurrentUrl, assertElementAttribute, assertElementContent, assertElementPresent, assertEmail, assertFileDownload, assertFromJavascript, assertPageContains, assertPageLacks, click, extractFromJavascript, extractVariable, goToEmailLink, goToUrl, goToUrlAndMeasureTti, hover, playSubTest, pressKey, refresh, runApiTest, scroll, selectOption, typeText, uploadFiles, wait.

    allow_failure bool

    Determines if the step should be allowed to fail.

    force_element_update bool

    Force update of the "element" parameter for the step

    is_critical bool

    Determines whether or not to consider the entire test as failed if this step fails. Can be used only if allow_failure is true.

    no_screenshot bool

    Prevents saving screenshots of the step.

    timeout int

    Used to override the default timeout of a step.

    name String

    Name of the step.

    params Property Map

    Parameters for the step.

    type String

    Type of the step. Valid values are assertCurrentUrl, assertElementAttribute, assertElementContent, assertElementPresent, assertEmail, assertFileDownload, assertFromJavascript, assertPageContains, assertPageLacks, click, extractFromJavascript, extractVariable, goToEmailLink, goToUrl, goToUrlAndMeasureTti, hover, playSubTest, pressKey, refresh, runApiTest, scroll, selectOption, typeText, uploadFiles, wait.

    allowFailure Boolean

    Determines if the step should be allowed to fail.

    forceElementUpdate Boolean

    Force update of the "element" parameter for the step

    isCritical Boolean

    Determines whether or not to consider the entire test as failed if this step fails. Can be used only if allow_failure is true.

    noScreenshot Boolean

    Prevents saving screenshots of the step.

    timeout Number

    Used to override the default timeout of a step.

    SyntheticsTestBrowserStepParams

    attribute String
    check String
    clickType String
    code String
    delay Number
    element String
    elementUserLocator Property Map
    email String
    file String
    files String
    modifiers List<String>
    playingTabId String
    request String
    subtestPublicId String
    value String
    variable Property Map
    withClick Boolean
    x Number
    y Number

    SyntheticsTestBrowserStepParamsElementUserLocator

    SyntheticsTestBrowserStepParamsElementUserLocatorValue

    Value string
    Type string

    Synthetics test type. Valid values are api, browser.

    Value string
    Type string

    Synthetics test type. Valid values are api, browser.

    value String
    type String

    Synthetics test type. Valid values are api, browser.

    value string
    type string

    Synthetics test type. Valid values are api, browser.

    value str
    type str

    Synthetics test type. Valid values are api, browser.

    value String
    type String

    Synthetics test type. Valid values are api, browser.

    SyntheticsTestBrowserStepParamsVariable

    Example string
    Name string

    Name of Datadog synthetics test.

    Example string
    Name string

    Name of Datadog synthetics test.

    example String
    name String

    Name of Datadog synthetics test.

    example string
    name string

    Name of Datadog synthetics test.

    example str
    name str

    Name of Datadog synthetics test.

    example String
    name String

    Name of Datadog synthetics test.

    SyntheticsTestBrowserVariable

    Name string

    Name of the variable.

    Type string

    Type of browser test variable. Valid values are element, email, global, javascript, text.

    Example string

    Example for the variable.

    Id string

    ID of the global variable to use. This is actually only used (and required) in the case of using a variable of type global.

    Pattern string

    Pattern of the variable.

    Name string

    Name of the variable.

    Type string

    Type of browser test variable. Valid values are element, email, global, javascript, text.

    Example string

    Example for the variable.

    Id string

    ID of the global variable to use. This is actually only used (and required) in the case of using a variable of type global.

    Pattern string

    Pattern of the variable.

    name String

    Name of the variable.

    type String

    Type of browser test variable. Valid values are element, email, global, javascript, text.

    example String

    Example for the variable.

    id String

    ID of the global variable to use. This is actually only used (and required) in the case of using a variable of type global.

    pattern String

    Pattern of the variable.

    name string

    Name of the variable.

    type string

    Type of browser test variable. Valid values are element, email, global, javascript, text.

    example string

    Example for the variable.

    id string

    ID of the global variable to use. This is actually only used (and required) in the case of using a variable of type global.

    pattern string

    Pattern of the variable.

    name str

    Name of the variable.

    type str

    Type of browser test variable. Valid values are element, email, global, javascript, text.

    example str

    Example for the variable.

    id str

    ID of the global variable to use. This is actually only used (and required) in the case of using a variable of type global.

    pattern str

    Pattern of the variable.

    name String

    Name of the variable.

    type String

    Type of browser test variable. Valid values are element, email, global, javascript, text.

    example String

    Example for the variable.

    id String

    ID of the global variable to use. This is actually only used (and required) in the case of using a variable of type global.

    pattern String

    Pattern of the variable.

    SyntheticsTestConfigVariable

    Name string

    Name of the variable.

    Type string

    Type of test configuration variable. Valid values are global, text.

    Example string
    Id string

    When type = global, ID of the global variable to use.

    Pattern string
    Secure bool

    Whether the value of this variable will be obfuscated in test results.

    Name string

    Name of the variable.

    Type string

    Type of test configuration variable. Valid values are global, text.

    Example string
    Id string

    When type = global, ID of the global variable to use.

    Pattern string
    Secure bool

    Whether the value of this variable will be obfuscated in test results.

    name String

    Name of the variable.

    type String

    Type of test configuration variable. Valid values are global, text.

    example String
    id String

    When type = global, ID of the global variable to use.

    pattern String
    secure Boolean

    Whether the value of this variable will be obfuscated in test results.

    name string

    Name of the variable.

    type string

    Type of test configuration variable. Valid values are global, text.

    example string
    id string

    When type = global, ID of the global variable to use.

    pattern string
    secure boolean

    Whether the value of this variable will be obfuscated in test results.

    name str

    Name of the variable.

    type str

    Type of test configuration variable. Valid values are global, text.

    example str
    id str

    When type = global, ID of the global variable to use.

    pattern str
    secure bool

    Whether the value of this variable will be obfuscated in test results.

    name String

    Name of the variable.

    type String

    Type of test configuration variable. Valid values are global, text.

    example String
    id String

    When type = global, ID of the global variable to use.

    pattern String
    secure Boolean

    Whether the value of this variable will be obfuscated in test results.

    SyntheticsTestOptionsList

    TickEvery int

    How often the test should run (in seconds).

    AcceptSelfSigned bool

    For SSL test, whether or not the test should allow self signed certificates.

    AllowInsecure bool

    Allows loading insecure content for an HTTP test.

    CheckCertificateRevocation bool

    For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

    Ci SyntheticsTestOptionsListCi

    CI/CD options for a Synthetic test.

    DisableCors bool

    Disable Cross-Origin Resource Sharing for browser tests.

    DisableCsp bool

    Disable Content Security Policy for browser tests.

    FollowRedirects bool

    Determines whether or not the API HTTP test should follow redirects.

    HttpVersion string

    HTTP version to use for a Synthetics API test. Valid values are http1, http2, any.

    IgnoreServerCertificateError bool

    Ignore server certificate error.

    InitialNavigationTimeout int

    Timeout before declaring the initial step as failed (in seconds) for browser tests.

    MinFailureDuration int

    Minimum amount of time in failure required to trigger an alert (in seconds). Default is 0.

    MinLocationFailed int

    Minimum number of locations in failure required to trigger an alert. Default is 1.

    MonitorName string

    The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

    MonitorOptions SyntheticsTestOptionsListMonitorOptions
    MonitorPriority int
    NoScreenshot bool

    Prevents saving screenshots of the steps.

    RestrictedRoles List<string>

    A list of role identifiers pulled from the Roles API to restrict read and write access.

    Retry SyntheticsTestOptionsListRetry
    RumSettings SyntheticsTestOptionsListRumSettings

    The RUM data collection settings for the Synthetic browser test.

    Scheduling SyntheticsTestOptionsListScheduling

    Object containing timeframes and timezone used for advanced scheduling.

    TickEvery int

    How often the test should run (in seconds).

    AcceptSelfSigned bool

    For SSL test, whether or not the test should allow self signed certificates.

    AllowInsecure bool

    Allows loading insecure content for an HTTP test.

    CheckCertificateRevocation bool

    For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

    Ci SyntheticsTestOptionsListCi

    CI/CD options for a Synthetic test.

    DisableCors bool

    Disable Cross-Origin Resource Sharing for browser tests.

    DisableCsp bool

    Disable Content Security Policy for browser tests.

    FollowRedirects bool

    Determines whether or not the API HTTP test should follow redirects.

    HttpVersion string

    HTTP version to use for a Synthetics API test. Valid values are http1, http2, any.

    IgnoreServerCertificateError bool

    Ignore server certificate error.

    InitialNavigationTimeout int

    Timeout before declaring the initial step as failed (in seconds) for browser tests.

    MinFailureDuration int

    Minimum amount of time in failure required to trigger an alert (in seconds). Default is 0.

    MinLocationFailed int

    Minimum number of locations in failure required to trigger an alert. Default is 1.

    MonitorName string

    The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

    MonitorOptions SyntheticsTestOptionsListMonitorOptions
    MonitorPriority int
    NoScreenshot bool

    Prevents saving screenshots of the steps.

    RestrictedRoles []string

    A list of role identifiers pulled from the Roles API to restrict read and write access.

    Retry SyntheticsTestOptionsListRetry
    RumSettings SyntheticsTestOptionsListRumSettings

    The RUM data collection settings for the Synthetic browser test.

    Scheduling SyntheticsTestOptionsListScheduling

    Object containing timeframes and timezone used for advanced scheduling.

    tickEvery Integer

    How often the test should run (in seconds).

    acceptSelfSigned Boolean

    For SSL test, whether or not the test should allow self signed certificates.

    allowInsecure Boolean

    Allows loading insecure content for an HTTP test.

    checkCertificateRevocation Boolean

    For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

    ci SyntheticsTestOptionsListCi

    CI/CD options for a Synthetic test.

    disableCors Boolean

    Disable Cross-Origin Resource Sharing for browser tests.

    disableCsp Boolean

    Disable Content Security Policy for browser tests.

    followRedirects Boolean

    Determines whether or not the API HTTP test should follow redirects.

    httpVersion String

    HTTP version to use for a Synthetics API test. Valid values are http1, http2, any.

    ignoreServerCertificateError Boolean

    Ignore server certificate error.

    initialNavigationTimeout Integer

    Timeout before declaring the initial step as failed (in seconds) for browser tests.

    minFailureDuration Integer

    Minimum amount of time in failure required to trigger an alert (in seconds). Default is 0.

    minLocationFailed Integer

    Minimum number of locations in failure required to trigger an alert. Default is 1.

    monitorName String

    The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

    monitorOptions SyntheticsTestOptionsListMonitorOptions
    monitorPriority Integer
    noScreenshot Boolean

    Prevents saving screenshots of the steps.

    restrictedRoles List<String>

    A list of role identifiers pulled from the Roles API to restrict read and write access.

    retry SyntheticsTestOptionsListRetry
    rumSettings SyntheticsTestOptionsListRumSettings

    The RUM data collection settings for the Synthetic browser test.

    scheduling SyntheticsTestOptionsListScheduling

    Object containing timeframes and timezone used for advanced scheduling.

    tickEvery number

    How often the test should run (in seconds).

    acceptSelfSigned boolean

    For SSL test, whether or not the test should allow self signed certificates.

    allowInsecure boolean

    Allows loading insecure content for an HTTP test.

    checkCertificateRevocation boolean

    For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

    ci SyntheticsTestOptionsListCi

    CI/CD options for a Synthetic test.

    disableCors boolean

    Disable Cross-Origin Resource Sharing for browser tests.

    disableCsp boolean

    Disable Content Security Policy for browser tests.

    followRedirects boolean

    Determines whether or not the API HTTP test should follow redirects.

    httpVersion string

    HTTP version to use for a Synthetics API test. Valid values are http1, http2, any.

    ignoreServerCertificateError boolean

    Ignore server certificate error.

    initialNavigationTimeout number

    Timeout before declaring the initial step as failed (in seconds) for browser tests.

    minFailureDuration number

    Minimum amount of time in failure required to trigger an alert (in seconds). Default is 0.

    minLocationFailed number

    Minimum number of locations in failure required to trigger an alert. Default is 1.

    monitorName string

    The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

    monitorOptions SyntheticsTestOptionsListMonitorOptions
    monitorPriority number
    noScreenshot boolean

    Prevents saving screenshots of the steps.

    restrictedRoles string[]

    A list of role identifiers pulled from the Roles API to restrict read and write access.

    retry SyntheticsTestOptionsListRetry
    rumSettings SyntheticsTestOptionsListRumSettings

    The RUM data collection settings for the Synthetic browser test.

    scheduling SyntheticsTestOptionsListScheduling

    Object containing timeframes and timezone used for advanced scheduling.

    tick_every int

    How often the test should run (in seconds).

    accept_self_signed bool

    For SSL test, whether or not the test should allow self signed certificates.

    allow_insecure bool

    Allows loading insecure content for an HTTP test.

    check_certificate_revocation bool

    For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

    ci SyntheticsTestOptionsListCi

    CI/CD options for a Synthetic test.

    disable_cors bool

    Disable Cross-Origin Resource Sharing for browser tests.

    disable_csp bool

    Disable Content Security Policy for browser tests.

    follow_redirects bool

    Determines whether or not the API HTTP test should follow redirects.

    http_version str

    HTTP version to use for a Synthetics API test. Valid values are http1, http2, any.

    ignore_server_certificate_error bool

    Ignore server certificate error.

    initial_navigation_timeout int

    Timeout before declaring the initial step as failed (in seconds) for browser tests.

    min_failure_duration int

    Minimum amount of time in failure required to trigger an alert (in seconds). Default is 0.

    min_location_failed int

    Minimum number of locations in failure required to trigger an alert. Default is 1.

    monitor_name str

    The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

    monitor_options SyntheticsTestOptionsListMonitorOptions
    monitor_priority int
    no_screenshot bool

    Prevents saving screenshots of the steps.

    restricted_roles Sequence[str]

    A list of role identifiers pulled from the Roles API to restrict read and write access.

    retry SyntheticsTestOptionsListRetry
    rum_settings SyntheticsTestOptionsListRumSettings

    The RUM data collection settings for the Synthetic browser test.

    scheduling SyntheticsTestOptionsListScheduling

    Object containing timeframes and timezone used for advanced scheduling.

    tickEvery Number

    How often the test should run (in seconds).

    acceptSelfSigned Boolean

    For SSL test, whether or not the test should allow self signed certificates.

    allowInsecure Boolean

    Allows loading insecure content for an HTTP test.

    checkCertificateRevocation Boolean

    For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.

    ci Property Map

    CI/CD options for a Synthetic test.

    disableCors Boolean

    Disable Cross-Origin Resource Sharing for browser tests.

    disableCsp Boolean

    Disable Content Security Policy for browser tests.

    followRedirects Boolean

    Determines whether or not the API HTTP test should follow redirects.

    httpVersion String

    HTTP version to use for a Synthetics API test. Valid values are http1, http2, any.

    ignoreServerCertificateError Boolean

    Ignore server certificate error.

    initialNavigationTimeout Number

    Timeout before declaring the initial step as failed (in seconds) for browser tests.

    minFailureDuration Number

    Minimum amount of time in failure required to trigger an alert (in seconds). Default is 0.

    minLocationFailed Number

    Minimum number of locations in failure required to trigger an alert. Default is 1.

    monitorName String

    The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

    monitorOptions Property Map
    monitorPriority Number
    noScreenshot Boolean

    Prevents saving screenshots of the steps.

    restrictedRoles List<String>

    A list of role identifiers pulled from the Roles API to restrict read and write access.

    retry Property Map
    rumSettings Property Map

    The RUM data collection settings for the Synthetic browser test.

    scheduling Property Map

    Object containing timeframes and timezone used for advanced scheduling.

    SyntheticsTestOptionsListCi

    SyntheticsTestOptionsListMonitorOptions

    SyntheticsTestOptionsListRetry

    count Integer
    interval Integer
    count number
    interval number
    count Number
    interval Number

    SyntheticsTestOptionsListRumSettings

    SyntheticsTestOptionsListScheduling

    SyntheticsTestOptionsListSchedulingTimeframe

    Day int
    From string
    To string
    Day int
    From string
    To string
    day Integer
    from String
    to String
    day number
    from string
    to string
    day int
    from_ str
    to str
    day Number
    from String
    to String

    SyntheticsTestRequestBasicauth

    AccessKey string

    Access key for SIGV4 authentication.

    AccessTokenUrl string

    Access token url for oauth-client or oauth-rop authentication.

    Audience string

    Audience for oauth-client or oauth-rop authentication.

    ClientId string

    Client ID for oauth-client or oauth-rop authentication.

    ClientSecret string

    Client secret for oauth-client or oauth-rop authentication.

    Domain string

    Domain for ntlm authentication.

    Password string

    Password for authentication.

    Region string

    Region for SIGV4 authentication.

    Resource string

    Resource for oauth-client or oauth-rop authentication.

    Scope string

    Scope for oauth-client or oauth-rop authentication.

    SecretKey string

    Secret key for SIGV4 authentication.

    ServiceName string

    Service name for SIGV4 authentication.

    SessionToken string

    Session token for SIGV4 authentication.

    TokenApiAuthentication string

    Token API Authentication for oauth-client or oauth-rop authentication. Valid values are header, body.

    Type string

    Type of basic authentication to use when performing the test.

    Username string

    Username for authentication.

    Workstation string

    Workstation for ntlm authentication.

    AccessKey string

    Access key for SIGV4 authentication.

    AccessTokenUrl string

    Access token url for oauth-client or oauth-rop authentication.

    Audience string

    Audience for oauth-client or oauth-rop authentication.

    ClientId string

    Client ID for oauth-client or oauth-rop authentication.

    ClientSecret string

    Client secret for oauth-client or oauth-rop authentication.

    Domain string

    Domain for ntlm authentication.

    Password string

    Password for authentication.

    Region string

    Region for SIGV4 authentication.

    Resource string

    Resource for oauth-client or oauth-rop authentication.

    Scope string

    Scope for oauth-client or oauth-rop authentication.

    SecretKey string

    Secret key for SIGV4 authentication.

    ServiceName string

    Service name for SIGV4 authentication.

    SessionToken string

    Session token for SIGV4 authentication.

    TokenApiAuthentication string

    Token API Authentication for oauth-client or oauth-rop authentication. Valid values are header, body.

    Type string

    Type of basic authentication to use when performing the test.

    Username string

    Username for authentication.

    Workstation string

    Workstation for ntlm authentication.

    accessKey String

    Access key for SIGV4 authentication.

    accessTokenUrl String

    Access token url for oauth-client or oauth-rop authentication.

    audience String

    Audience for oauth-client or oauth-rop authentication.

    clientId String

    Client ID for oauth-client or oauth-rop authentication.

    clientSecret String

    Client secret for oauth-client or oauth-rop authentication.

    domain String

    Domain for ntlm authentication.

    password String

    Password for authentication.

    region String

    Region for SIGV4 authentication.

    resource String

    Resource for oauth-client or oauth-rop authentication.

    scope String

    Scope for oauth-client or oauth-rop authentication.

    secretKey String

    Secret key for SIGV4 authentication.

    serviceName String

    Service name for SIGV4 authentication.

    sessionToken String

    Session token for SIGV4 authentication.

    tokenApiAuthentication String

    Token API Authentication for oauth-client or oauth-rop authentication. Valid values are header, body.

    type String

    Type of basic authentication to use when performing the test.

    username String

    Username for authentication.

    workstation String

    Workstation for ntlm authentication.

    accessKey string

    Access key for SIGV4 authentication.

    accessTokenUrl string

    Access token url for oauth-client or oauth-rop authentication.

    audience string

    Audience for oauth-client or oauth-rop authentication.

    clientId string

    Client ID for oauth-client or oauth-rop authentication.

    clientSecret string

    Client secret for oauth-client or oauth-rop authentication.

    domain string

    Domain for ntlm authentication.

    password string

    Password for authentication.

    region string

    Region for SIGV4 authentication.

    resource string

    Resource for oauth-client or oauth-rop authentication.

    scope string

    Scope for oauth-client or oauth-rop authentication.

    secretKey string

    Secret key for SIGV4 authentication.

    serviceName string

    Service name for SIGV4 authentication.

    sessionToken string

    Session token for SIGV4 authentication.

    tokenApiAuthentication string

    Token API Authentication for oauth-client or oauth-rop authentication. Valid values are header, body.

    type string

    Type of basic authentication to use when performing the test.

    username string

    Username for authentication.

    workstation string

    Workstation for ntlm authentication.

    access_key str

    Access key for SIGV4 authentication.

    access_token_url str

    Access token url for oauth-client or oauth-rop authentication.

    audience str

    Audience for oauth-client or oauth-rop authentication.

    client_id str

    Client ID for oauth-client or oauth-rop authentication.

    client_secret str

    Client secret for oauth-client or oauth-rop authentication.

    domain str

    Domain for ntlm authentication.

    password str

    Password for authentication.

    region str

    Region for SIGV4 authentication.

    resource str

    Resource for oauth-client or oauth-rop authentication.

    scope str

    Scope for oauth-client or oauth-rop authentication.

    secret_key str

    Secret key for SIGV4 authentication.

    service_name str

    Service name for SIGV4 authentication.

    session_token str

    Session token for SIGV4 authentication.

    token_api_authentication str

    Token API Authentication for oauth-client or oauth-rop authentication. Valid values are header, body.

    type str

    Type of basic authentication to use when performing the test.

    username str

    Username for authentication.

    workstation str

    Workstation for ntlm authentication.

    accessKey String

    Access key for SIGV4 authentication.

    accessTokenUrl String

    Access token url for oauth-client or oauth-rop authentication.

    audience String

    Audience for oauth-client or oauth-rop authentication.

    clientId String

    Client ID for oauth-client or oauth-rop authentication.

    clientSecret String

    Client secret for oauth-client or oauth-rop authentication.

    domain String

    Domain for ntlm authentication.

    password String

    Password for authentication.

    region String

    Region for SIGV4 authentication.

    resource String

    Resource for oauth-client or oauth-rop authentication.

    scope String

    Scope for oauth-client or oauth-rop authentication.

    secretKey String

    Secret key for SIGV4 authentication.

    serviceName String

    Service name for SIGV4 authentication.

    sessionToken String

    Session token for SIGV4 authentication.

    tokenApiAuthentication String

    Token API Authentication for oauth-client or oauth-rop authentication. Valid values are header, body.

    type String

    Type of basic authentication to use when performing the test.

    username String

    Username for authentication.

    workstation String

    Workstation for ntlm authentication.

    SyntheticsTestRequestClientCertificate

    SyntheticsTestRequestClientCertificateCert

    Content string
    Filename string
    Content string
    Filename string
    content String
    filename String
    content string
    filename string
    content String
    filename String

    SyntheticsTestRequestClientCertificateKey

    Content string
    Filename string
    Content string
    Filename string
    content String
    filename String
    content string
    filename string
    content String
    filename String

    SyntheticsTestRequestDefinition

    Body string

    The request body.

    BodyType string

    Type of the request body. Valid values are text/plain, application/json, text/xml, text/html, application/x-www-form-urlencoded, graphql.

    CallType string

    The type of gRPC call to perform. Valid values are healthcheck, unary.

    CertificateDomains List<string>

    By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificate_domains.

    DnsServer string

    DNS server to use for DNS tests (subtype = "dns").

    DnsServerPort int

    DNS server port to use for DNS tests.

    Host string

    Host name to perform the test with.

    Message string

    For UDP and websocket tests, message to send with the request.

    Method string

    Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

    NoSavingResponseBody bool

    Determines whether or not to save the response body.

    NumberOfPackets int

    Number of pings to use per test for ICMP tests (subtype = "icmp") between 0 and 10.

    Port int

    Port to use when performing the test.

    Servername string

    For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.

    Service string

    The gRPC service on which you want to perform the gRPC call.

    ShouldTrackHops bool

    This will turn on a traceroute probe to discover all gateways along the path to the host destination. For ICMP tests (subtype = "icmp").

    Timeout int

    Timeout in seconds for the test. Defaults to 60.

    Url string

    The URL to send the request to.

    Body string

    The request body.

    BodyType string

    Type of the request body. Valid values are text/plain, application/json, text/xml, text/html, application/x-www-form-urlencoded, graphql.

    CallType string

    The type of gRPC call to perform. Valid values are healthcheck, unary.

    CertificateDomains []string

    By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificate_domains.

    DnsServer string

    DNS server to use for DNS tests (subtype = "dns").

    DnsServerPort int

    DNS server port to use for DNS tests.

    Host string

    Host name to perform the test with.

    Message string

    For UDP and websocket tests, message to send with the request.

    Method string

    Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

    NoSavingResponseBody bool

    Determines whether or not to save the response body.

    NumberOfPackets int

    Number of pings to use per test for ICMP tests (subtype = "icmp") between 0 and 10.

    Port int

    Port to use when performing the test.

    Servername string

    For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.

    Service string

    The gRPC service on which you want to perform the gRPC call.

    ShouldTrackHops bool

    This will turn on a traceroute probe to discover all gateways along the path to the host destination. For ICMP tests (subtype = "icmp").

    Timeout int

    Timeout in seconds for the test. Defaults to 60.

    Url string

    The URL to send the request to.

    body String

    The request body.

    bodyType String

    Type of the request body. Valid values are text/plain, application/json, text/xml, text/html, application/x-www-form-urlencoded, graphql.

    callType String

    The type of gRPC call to perform. Valid values are healthcheck, unary.

    certificateDomains List<String>

    By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificate_domains.

    dnsServer String

    DNS server to use for DNS tests (subtype = "dns").

    dnsServerPort Integer

    DNS server port to use for DNS tests.

    host String

    Host name to perform the test with.

    message String

    For UDP and websocket tests, message to send with the request.

    method String

    Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

    noSavingResponseBody Boolean

    Determines whether or not to save the response body.

    numberOfPackets Integer

    Number of pings to use per test for ICMP tests (subtype = "icmp") between 0 and 10.

    port Integer

    Port to use when performing the test.

    servername String

    For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.

    service String

    The gRPC service on which you want to perform the gRPC call.

    shouldTrackHops Boolean

    This will turn on a traceroute probe to discover all gateways along the path to the host destination. For ICMP tests (subtype = "icmp").

    timeout Integer

    Timeout in seconds for the test. Defaults to 60.

    url String

    The URL to send the request to.

    body string

    The request body.

    bodyType string

    Type of the request body. Valid values are text/plain, application/json, text/xml, text/html, application/x-www-form-urlencoded, graphql.

    callType string

    The type of gRPC call to perform. Valid values are healthcheck, unary.

    certificateDomains string[]

    By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificate_domains.

    dnsServer string

    DNS server to use for DNS tests (subtype = "dns").

    dnsServerPort number

    DNS server port to use for DNS tests.

    host string

    Host name to perform the test with.

    message string

    For UDP and websocket tests, message to send with the request.

    method string

    Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

    noSavingResponseBody boolean

    Determines whether or not to save the response body.

    numberOfPackets number

    Number of pings to use per test for ICMP tests (subtype = "icmp") between 0 and 10.

    port number

    Port to use when performing the test.

    servername string

    For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.

    service string

    The gRPC service on which you want to perform the gRPC call.

    shouldTrackHops boolean

    This will turn on a traceroute probe to discover all gateways along the path to the host destination. For ICMP tests (subtype = "icmp").

    timeout number

    Timeout in seconds for the test. Defaults to 60.

    url string

    The URL to send the request to.

    body str

    The request body.

    body_type str

    Type of the request body. Valid values are text/plain, application/json, text/xml, text/html, application/x-www-form-urlencoded, graphql.

    call_type str

    The type of gRPC call to perform. Valid values are healthcheck, unary.

    certificate_domains Sequence[str]

    By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificate_domains.

    dns_server str

    DNS server to use for DNS tests (subtype = "dns").

    dns_server_port int

    DNS server port to use for DNS tests.

    host str

    Host name to perform the test with.

    message str

    For UDP and websocket tests, message to send with the request.

    method str

    Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

    no_saving_response_body bool

    Determines whether or not to save the response body.

    number_of_packets int

    Number of pings to use per test for ICMP tests (subtype = "icmp") between 0 and 10.

    port int

    Port to use when performing the test.

    servername str

    For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.

    service str

    The gRPC service on which you want to perform the gRPC call.

    should_track_hops bool

    This will turn on a traceroute probe to discover all gateways along the path to the host destination. For ICMP tests (subtype = "icmp").

    timeout int

    Timeout in seconds for the test. Defaults to 60.

    url str

    The URL to send the request to.

    body String

    The request body.

    bodyType String

    Type of the request body. Valid values are text/plain, application/json, text/xml, text/html, application/x-www-form-urlencoded, graphql.

    callType String

    The type of gRPC call to perform. Valid values are healthcheck, unary.

    certificateDomains List<String>

    By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in certificate_domains.

    dnsServer String

    DNS server to use for DNS tests (subtype = "dns").

    dnsServerPort Number

    DNS server port to use for DNS tests.

    host String

    Host name to perform the test with.

    message String

    For UDP and websocket tests, message to send with the request.

    method String

    Either the HTTP method/verb to use or a gRPC method available on the service set in the service field. Required if subtype is HTTP or if subtype is grpc and callType is unary.

    noSavingResponseBody Boolean

    Determines whether or not to save the response body.

    numberOfPackets Number

    Number of pings to use per test for ICMP tests (subtype = "icmp") between 0 and 10.

    port Number

    Port to use when performing the test.

    servername String

    For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number.

    service String

    The gRPC service on which you want to perform the gRPC call.

    shouldTrackHops Boolean

    This will turn on a traceroute probe to discover all gateways along the path to the host destination. For ICMP tests (subtype = "icmp").

    timeout Number

    Timeout in seconds for the test. Defaults to 60.

    url String

    The URL to send the request to.

    SyntheticsTestRequestProxy

    Url string

    URL of the proxy to perform the test.

    Headers Dictionary<string, object>

    Header name and value map.

    Url string

    URL of the proxy to perform the test.

    Headers map[string]interface{}

    Header name and value map.

    url String

    URL of the proxy to perform the test.

    headers Map<String,Object>

    Header name and value map.

    url string

    URL of the proxy to perform the test.

    headers {[key: string]: any}

    Header name and value map.

    url str

    URL of the proxy to perform the test.

    headers Mapping[str, Any]

    Header name and value map.

    url String

    URL of the proxy to perform the test.

    headers Map<Any>

    Header name and value map.

    Import

    Synthetics tests can be imported using their public string ID, e.g.

     $ pulumi import datadog:index/syntheticsTest:SyntheticsTest fizz abc-123-xyz
    

    Package Details

    Repository
    Datadog pulumi/pulumi-datadog
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the datadog Terraform Provider.

    datadog logo
    Datadog v4.18.1 published on Tuesday, May 23, 2023 by Pulumi