Docs
PackagesDatadog v4.28.1 published on Monday, Jun 24, 2024 by Pulumi
datadog.SyntheticsTest
Explore with Pulumi AI
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):
url = https://{{ GLOBAL_VAR }}
to
config_variable {
name = "LOCAL_VAR"
id = [your_global_variable_id]
type = "global"
}
which you can now use in your request definition:
url = https://{{ LOCAL_VAR }}
Example Usage
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 testUptime = new datadog.SyntheticsTest("test_uptime", {
name: "An Uptime test on example.org",
type: "api",
subtype: "http",
status: "live",
message: "Notify @pagerduty",
locations: ["aws:eu-central-1"],
tags: [
"foo:bar",
"foo",
"env:test",
],
requestDefinition: {
method: "GET",
url: "https://www.example.org",
},
requestHeaders: {
"Content-Type": "application/json",
},
assertions: [{
type: "statusCode",
operator: "is",
target: "200",
}],
optionsList: {
tickEvery: 900,
retry: {
count: 2,
interval: 300,
},
monitorOptions: {
renotifyInterval: 120,
},
},
});
// Example Usage (Authenticated API test)
// Create a new Datadog Synthetics API/HTTP test on https://www.example.org
const testApi = new datadog.SyntheticsTest("test_api", {
name: "An API test on example.org",
type: "api",
subtype: "http",
status: "live",
message: "Notify @pagerduty",
locations: ["aws:eu-central-1"],
tags: [
"foo:bar",
"foo",
"env:test",
],
requestDefinition: {
method: "GET",
url: "https://www.example.org",
},
requestHeaders: {
"Content-Type": "application/json",
Authentication: "Token: 1234566789",
},
assertions: [{
type: "statusCode",
operator: "is",
target: "200",
}],
optionsList: {
tickEvery: 900,
retry: {
count: 2,
interval: 300,
},
monitorOptions: {
renotifyInterval: 120,
},
},
});
// Example Usage (Synthetics SSL test)
// Create a new Datadog Synthetics API/SSL test on example.org
const testSsl = new datadog.SyntheticsTest("test_ssl", {
name: "An API test on example.org",
type: "api",
subtype: "ssl",
status: "live",
message: "Notify @pagerduty",
locations: ["aws:eu-central-1"],
tags: [
"foo:bar",
"foo",
"env:test",
],
requestDefinition: {
host: "example.org",
port: 443,
},
assertions: [{
type: "certificate",
operator: "isInMoreThan",
target: "30",
}],
optionsList: {
tickEvery: 900,
acceptSelfSigned: true,
},
});
// Example Usage (Synthetics TCP test)
// Create a new Datadog Synthetics API/TCP test on example.org
const testTcp = new datadog.SyntheticsTest("test_tcp", {
name: "An API test on example.org",
type: "api",
subtype: "tcp",
status: "live",
message: "Notify @pagerduty",
locations: ["aws:eu-central-1"],
tags: [
"foo:bar",
"foo",
"env:test",
],
requestDefinition: {
host: "example.org",
port: 443,
},
assertions: [{
type: "responseTime",
operator: "lessThan",
target: "2000",
}],
configVariables: [{
type: "global",
name: "MY_GLOBAL_VAR",
id: "76636cd1-82e2-4aeb-9cfe-51366a8198a2",
}],
optionsList: {
tickEvery: 900,
},
});
// Example Usage (Synthetics DNS test)
// Create a new Datadog Synthetics API/DNS test on example.org
const testDns = new datadog.SyntheticsTest("test_dns", {
name: "An API test on example.org",
type: "api",
subtype: "dns",
status: "live",
message: "Notify @pagerduty",
locations: ["aws:eu-central-1"],
tags: [
"foo:bar",
"foo",
"env:test",
],
requestDefinition: {
host: "example.org",
},
assertions: [{
type: "recordSome",
operator: "is",
property: "A",
target: "0.0.0.0",
}],
optionsList: {
tickEvery: 900,
},
});
// Example Usage (Synthetics Multistep API test)
// Create a new Datadog Synthetics Multistep API test
const testMultiStep = new datadog.SyntheticsTest("test_multi_step", {
name: "Multistep API test",
type: "api",
subtype: "multi",
status: "live",
locations: ["aws:eu-central-1"],
tags: [
"foo:bar",
"foo",
"env:test",
],
apiSteps: [
{
name: "An API test on example.org",
subtype: "http",
assertions: [{
type: "statusCode",
operator: "is",
target: "200",
}],
requestDefinition: {
method: "GET",
url: "https://example.org",
},
requestHeaders: {
"Content-Type": "application/json",
Authentication: "Token: 1234566789",
},
},
{
name: "An API test on example.org",
subtype: "http",
assertions: [{
type: "statusCode",
operator: "is",
target: "200",
}],
requestDefinition: {
method: "GET",
url: "http://example.org",
},
},
],
optionsList: {
tickEvery: 900,
acceptSelfSigned: true,
},
});
// Example Usage (Synthetics Browser test)
// Create a new Datadog Synthetics Browser test starting on https://www.example.org
const testBrowser = new datadog.SyntheticsTest("test_browser", {
name: "A Browser test on example.org",
type: "browser",
status: "paused",
message: "Notify @qa",
deviceIds: ["laptop_large"],
locations: ["aws:eu-central-1"],
tags: [],
requestDefinition: {
method: "GET",
url: "https://app.datadoghq.com",
},
browserSteps: [
{
name: "Check current url",
type: "assertCurrentUrl",
params: {
check: "contains",
value: "datadoghq",
},
},
{
name: "Test a downloaded file",
type: "assertFileDownload",
params: {
file: JSON.stringify({
md5: "abcdef1234567890",
sizeCheck: {
type: "equals",
value: 1,
},
nameCheck: {
type: "contains",
value: ".xls",
},
}),
},
},
],
browserVariables: [
{
type: "text",
name: "MY_PATTERN_VAR",
pattern: "{{numeric(3)}}",
example: "597",
},
{
type: "email",
name: "MY_EMAIL_VAR",
pattern: "jd8-afe-ydv.{{ numeric(10) }}@synthetics.dtdg.co",
example: "jd8-afe-ydv.4546132139@synthetics.dtdg.co",
},
{
type: "global",
name: "MY_GLOBAL_VAR",
id: "76636cd1-82e2-4aeb-9cfe-51366a8198a2",
},
],
optionsList: {
tickEvery: 3600,
},
});
// Example Usage (GRPC API test)
// Create a new Datadog GRPC API test starting on google.org:50050
const grpc = new datadog.SyntheticsTest("grpc", {
type: "api",
subtype: "grpc",
requestDefinition: {
method: "GET",
host: "google.com",
port: 50050,
service: "Hello",
plainProtoFile: `syntax = "proto3";
option java_multiple_files = true;
option java_package = "io.grpc.examples.helloworld";
option java_outer_classname = "HelloWorldProto";
option objc_class_prefix = "HLW";
package helloworld;
// The greeting service definition.
service Greeter {
\x09// Sends a greeting
\x09rpc SayHello (HelloRequest) returns (HelloReply) {}
}
// The request message containing the user's name.
message HelloRequest {
\x09string name = 1;
}
// The response message containing the greetings
message HelloReply {
\x09string message = 1;
}
`,
},
requestMetadata: {
header: "value",
},
assertions: [
{
type: "responseTime",
operator: "lessThan",
target: "2000",
},
{
operator: "is",
type: "grpcHealthcheckStatus",
target: "1",
},
{
operator: "is",
target: "proto target",
type: "grpcProto",
},
{
operator: "is",
target: "123",
property: "property",
type: "grpcMetadata",
},
],
locations: ["aws:eu-central-1"],
optionsList: {
tickEvery: 60,
},
name: "GRPC API test",
message: "Notify @datadog.user",
tags: [
"foo:bar",
"baz",
],
status: "paused",
});
import pulumi
import json
import pulumi_datadog as datadog
# Example Usage (Synthetics API test)
# Create a new Datadog Synthetics API/HTTP test on https://www.example.org
test_uptime = datadog.SyntheticsTest("test_uptime",
name="An Uptime test on example.org",
type="api",
subtype="http",
status="live",
message="Notify @pagerduty",
locations=["aws:eu-central-1"],
tags=[
"foo:bar",
"foo",
"env:test",
],
request_definition=datadog.SyntheticsTestRequestDefinitionArgs(
method="GET",
url="https://www.example.org",
),
request_headers={
"Content-Type": "application/json",
},
assertions=[datadog.SyntheticsTestAssertionArgs(
type="statusCode",
operator="is",
target="200",
)],
options_list=datadog.SyntheticsTestOptionsListArgs(
tick_every=900,
retry=datadog.SyntheticsTestOptionsListRetryArgs(
count=2,
interval=300,
),
monitor_options=datadog.SyntheticsTestOptionsListMonitorOptionsArgs(
renotify_interval=120,
),
))
# Example Usage (Authenticated API test)
# Create a new Datadog Synthetics API/HTTP test on https://www.example.org
test_api = datadog.SyntheticsTest("test_api",
name="An API test on example.org",
type="api",
subtype="http",
status="live",
message="Notify @pagerduty",
locations=["aws:eu-central-1"],
tags=[
"foo:bar",
"foo",
"env:test",
],
request_definition=datadog.SyntheticsTestRequestDefinitionArgs(
method="GET",
url="https://www.example.org",
),
request_headers={
"Content-Type": "application/json",
"Authentication": "Token: 1234566789",
},
assertions=[datadog.SyntheticsTestAssertionArgs(
type="statusCode",
operator="is",
target="200",
)],
options_list=datadog.SyntheticsTestOptionsListArgs(
tick_every=900,
retry=datadog.SyntheticsTestOptionsListRetryArgs(
count=2,
interval=300,
),
monitor_options=datadog.SyntheticsTestOptionsListMonitorOptionsArgs(
renotify_interval=120,
),
))
# Example Usage (Synthetics SSL test)
# Create a new Datadog Synthetics API/SSL test on example.org
test_ssl = datadog.SyntheticsTest("test_ssl",
name="An API test on example.org",
type="api",
subtype="ssl",
status="live",
message="Notify @pagerduty",
locations=["aws:eu-central-1"],
tags=[
"foo:bar",
"foo",
"env:test",
],
request_definition=datadog.SyntheticsTestRequestDefinitionArgs(
host="example.org",
port=443,
),
assertions=[datadog.SyntheticsTestAssertionArgs(
type="certificate",
operator="isInMoreThan",
target="30",
)],
options_list=datadog.SyntheticsTestOptionsListArgs(
tick_every=900,
accept_self_signed=True,
))
# Example Usage (Synthetics TCP test)
# Create a new Datadog Synthetics API/TCP test on example.org
test_tcp = datadog.SyntheticsTest("test_tcp",
name="An API test on example.org",
type="api",
subtype="tcp",
status="live",
message="Notify @pagerduty",
locations=["aws:eu-central-1"],
tags=[
"foo:bar",
"foo",
"env:test",
],
request_definition=datadog.SyntheticsTestRequestDefinitionArgs(
host="example.org",
port=443,
),
assertions=[datadog.SyntheticsTestAssertionArgs(
type="responseTime",
operator="lessThan",
target="2000",
)],
config_variables=[datadog.SyntheticsTestConfigVariableArgs(
type="global",
name="MY_GLOBAL_VAR",
id="76636cd1-82e2-4aeb-9cfe-51366a8198a2",
)],
options_list=datadog.SyntheticsTestOptionsListArgs(
tick_every=900,
))
# Example Usage (Synthetics DNS test)
# Create a new Datadog Synthetics API/DNS test on example.org
test_dns = datadog.SyntheticsTest("test_dns",
name="An API test on example.org",
type="api",
subtype="dns",
status="live",
message="Notify @pagerduty",
locations=["aws:eu-central-1"],
tags=[
"foo:bar",
"foo",
"env:test",
],
request_definition=datadog.SyntheticsTestRequestDefinitionArgs(
host="example.org",
),
assertions=[datadog.SyntheticsTestAssertionArgs(
type="recordSome",
operator="is",
property="A",
target="0.0.0.0",
)],
options_list=datadog.SyntheticsTestOptionsListArgs(
tick_every=900,
))
# Example Usage (Synthetics Multistep API test)
# Create a new Datadog Synthetics Multistep API test
test_multi_step = datadog.SyntheticsTest("test_multi_step",
name="Multistep API test",
type="api",
subtype="multi",
status="live",
locations=["aws:eu-central-1"],
tags=[
"foo:bar",
"foo",
"env:test",
],
api_steps=[
datadog.SyntheticsTestApiStepArgs(
name="An API test on example.org",
subtype="http",
assertions=[datadog.SyntheticsTestApiStepAssertionArgs(
type="statusCode",
operator="is",
target="200",
)],
request_definition=datadog.SyntheticsTestApiStepRequestDefinitionArgs(
method="GET",
url="https://example.org",
),
request_headers={
"Content-Type": "application/json",
"Authentication": "Token: 1234566789",
},
),
datadog.SyntheticsTestApiStepArgs(
name="An API test on example.org",
subtype="http",
assertions=[datadog.SyntheticsTestApiStepAssertionArgs(
type="statusCode",
operator="is",
target="200",
)],
request_definition=datadog.SyntheticsTestApiStepRequestDefinitionArgs(
method="GET",
url="http://example.org",
),
),
],
options_list=datadog.SyntheticsTestOptionsListArgs(
tick_every=900,
accept_self_signed=True,
))
# Example Usage (Synthetics Browser test)
# Create a new Datadog Synthetics Browser test starting on https://www.example.org
test_browser = datadog.SyntheticsTest("test_browser",
name="A Browser test on example.org",
type="browser",
status="paused",
message="Notify @qa",
device_ids=["laptop_large"],
locations=["aws:eu-central-1"],
tags=[],
request_definition=datadog.SyntheticsTestRequestDefinitionArgs(
method="GET",
url="https://app.datadoghq.com",
),
browser_steps=[
datadog.SyntheticsTestBrowserStepArgs(
name="Check current url",
type="assertCurrentUrl",
params=datadog.SyntheticsTestBrowserStepParamsArgs(
check="contains",
value="datadoghq",
),
),
datadog.SyntheticsTestBrowserStepArgs(
name="Test a downloaded file",
type="assertFileDownload",
params=datadog.SyntheticsTestBrowserStepParamsArgs(
file=json.dumps({
"md5": "abcdef1234567890",
"sizeCheck": {
"type": "equals",
"value": 1,
},
"nameCheck": {
"type": "contains",
"value": ".xls",
},
}),
),
),
],
browser_variables=[
datadog.SyntheticsTestBrowserVariableArgs(
type="text",
name="MY_PATTERN_VAR",
pattern="{{numeric(3)}}",
example="597",
),
datadog.SyntheticsTestBrowserVariableArgs(
type="email",
name="MY_EMAIL_VAR",
pattern="jd8-afe-ydv.{{ numeric(10) }}@synthetics.dtdg.co",
example="jd8-afe-ydv.4546132139@synthetics.dtdg.co",
),
datadog.SyntheticsTestBrowserVariableArgs(
type="global",
name="MY_GLOBAL_VAR",
id="76636cd1-82e2-4aeb-9cfe-51366a8198a2",
),
],
options_list=datadog.SyntheticsTestOptionsListArgs(
tick_every=3600,
))
# Example Usage (GRPC API test)
# Create a new Datadog GRPC API test starting on google.org:50050
grpc = datadog.SyntheticsTest("grpc",
type="api",
subtype="grpc",
request_definition=datadog.SyntheticsTestRequestDefinitionArgs(
method="GET",
host="google.com",
port=50050,
service="Hello",
plain_proto_file="""syntax = "proto3";
option java_multiple_files = true;
option java_package = "io.grpc.examples.helloworld";
option java_outer_classname = "HelloWorldProto";
option objc_class_prefix = "HLW";
package helloworld;
// The greeting service definition.
service Greeter {
\x09// Sends a greeting
\x09rpc SayHello (HelloRequest) returns (HelloReply) {}
}
// The request message containing the user's name.
message HelloRequest {
\x09string name = 1;
}
// The response message containing the greetings
message HelloReply {
\x09string message = 1;
}
""",
),
request_metadata={
"header": "value",
},
assertions=[
datadog.SyntheticsTestAssertionArgs(
type="responseTime",
operator="lessThan",
target="2000",
),
datadog.SyntheticsTestAssertionArgs(
operator="is",
type="grpcHealthcheckStatus",
target="1",
),
datadog.SyntheticsTestAssertionArgs(
operator="is",
target="proto target",
type="grpcProto",
),
datadog.SyntheticsTestAssertionArgs(
operator="is",
target="123",
property="property",
type="grpcMetadata",
),
],
locations=["aws:eu-central-1"],
options_list=datadog.SyntheticsTestOptionsListArgs(
tick_every=60,
),
name="GRPC API test",
message="Notify @datadog.user",
tags=[
"foo:bar",
"baz",
],
status="paused")
package main
import (
"encoding/json"
"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 {
// Example Usage (Synthetics API test)
// Create a new Datadog Synthetics API/HTTP test on https://www.example.org
_, err := datadog.NewSyntheticsTest(ctx, "test_uptime", &datadog.SyntheticsTestArgs{
Name: pulumi.String("An Uptime test on example.org"),
Type: pulumi.String("api"),
Subtype: pulumi.String("http"),
Status: pulumi.String("live"),
Message: pulumi.String("Notify @pagerduty"),
Locations: pulumi.StringArray{
pulumi.String("aws:eu-central-1"),
},
Tags: pulumi.StringArray{
pulumi.String("foo:bar"),
pulumi.String("foo"),
pulumi.String("env:test"),
},
RequestDefinition: &datadog.SyntheticsTestRequestDefinitionArgs{
Method: pulumi.String("GET"),
Url: pulumi.String("https://www.example.org"),
},
RequestHeaders: pulumi.Map{
"Content-Type": pulumi.Any("application/json"),
},
Assertions: datadog.SyntheticsTestAssertionArray{
&datadog.SyntheticsTestAssertionArgs{
Type: pulumi.String("statusCode"),
Operator: pulumi.String("is"),
Target: pulumi.String("200"),
},
},
OptionsList: &datadog.SyntheticsTestOptionsListArgs{
TickEvery: pulumi.Int(900),
Retry: &datadog.SyntheticsTestOptionsListRetryArgs{
Count: pulumi.Int(2),
Interval: pulumi.Int(300),
},
MonitorOptions: &datadog.SyntheticsTestOptionsListMonitorOptionsArgs{
RenotifyInterval: pulumi.Int(120),
},
},
})
if err != nil {
return err
}
// Example Usage (Authenticated API test)
// Create a new Datadog Synthetics API/HTTP test on https://www.example.org
_, err = datadog.NewSyntheticsTest(ctx, "test_api", &datadog.SyntheticsTestArgs{
Name: pulumi.String("An API test on example.org"),
Type: pulumi.String("api"),
Subtype: pulumi.String("http"),
Status: pulumi.String("live"),
Message: pulumi.String("Notify @pagerduty"),
Locations: pulumi.StringArray{
pulumi.String("aws:eu-central-1"),
},
Tags: pulumi.StringArray{
pulumi.String("foo:bar"),
pulumi.String("foo"),
pulumi.String("env:test"),
},
RequestDefinition: &datadog.SyntheticsTestRequestDefinitionArgs{
Method: pulumi.String("GET"),
Url: pulumi.String("https://www.example.org"),
},
RequestHeaders: pulumi.Map{
"Content-Type": pulumi.Any("application/json"),
"Authentication": pulumi.Any("Token: 1234566789"),
},
Assertions: datadog.SyntheticsTestAssertionArray{
&datadog.SyntheticsTestAssertionArgs{
Type: pulumi.String("statusCode"),
Operator: pulumi.String("is"),
Target: pulumi.String("200"),
},
},
OptionsList: &datadog.SyntheticsTestOptionsListArgs{
TickEvery: pulumi.Int(900),
Retry: &datadog.SyntheticsTestOptionsListRetryArgs{
Count: pulumi.Int(2),
Interval: pulumi.Int(300),
},
MonitorOptions: &datadog.SyntheticsTestOptionsListMonitorOptionsArgs{
RenotifyInterval: pulumi.Int(120),
},
},
})
if err != nil {
return err
}
// Example Usage (Synthetics SSL test)
// Create a new Datadog Synthetics API/SSL test on example.org
_, err = datadog.NewSyntheticsTest(ctx, "test_ssl", &datadog.SyntheticsTestArgs{
Name: pulumi.String("An API test on example.org"),
Type: pulumi.String("api"),
Subtype: pulumi.String("ssl"),
Status: pulumi.String("live"),
Message: pulumi.String("Notify @pagerduty"),
Locations: pulumi.StringArray{
pulumi.String("aws:eu-central-1"),
},
Tags: pulumi.StringArray{
pulumi.String("foo:bar"),
pulumi.String("foo"),
pulumi.String("env:test"),
},
RequestDefinition: &datadog.SyntheticsTestRequestDefinitionArgs{
Host: pulumi.String("example.org"),
Port: pulumi.Int(443),
},
Assertions: datadog.SyntheticsTestAssertionArray{
&datadog.SyntheticsTestAssertionArgs{
Type: pulumi.String("certificate"),
Operator: pulumi.String("isInMoreThan"),
Target: pulumi.String("30"),
},
},
OptionsList: &datadog.SyntheticsTestOptionsListArgs{
TickEvery: pulumi.Int(900),
AcceptSelfSigned: pulumi.Bool(true),
},
})
if err != nil {
return err
}
// Example Usage (Synthetics TCP test)
// Create a new Datadog Synthetics API/TCP test on example.org
_, err = datadog.NewSyntheticsTest(ctx, "test_tcp", &datadog.SyntheticsTestArgs{
Name: pulumi.String("An API test on example.org"),
Type: pulumi.String("api"),
Subtype: pulumi.String("tcp"),
Status: pulumi.String("live"),
Message: pulumi.String("Notify @pagerduty"),
Locations: pulumi.StringArray{
pulumi.String("aws:eu-central-1"),
},
Tags: pulumi.StringArray{
pulumi.String("foo:bar"),
pulumi.String("foo"),
pulumi.String("env:test"),
},
RequestDefinition: &datadog.SyntheticsTestRequestDefinitionArgs{
Host: pulumi.String("example.org"),
Port: pulumi.Int(443),
},
Assertions: datadog.SyntheticsTestAssertionArray{
&datadog.SyntheticsTestAssertionArgs{
Type: pulumi.String("responseTime"),
Operator: pulumi.String("lessThan"),
Target: pulumi.String("2000"),
},
},
ConfigVariables: datadog.SyntheticsTestConfigVariableArray{
&datadog.SyntheticsTestConfigVariableArgs{
Type: pulumi.String("global"),
Name: pulumi.String("MY_GLOBAL_VAR"),
Id: pulumi.String("76636cd1-82e2-4aeb-9cfe-51366a8198a2"),
},
},
OptionsList: &datadog.SyntheticsTestOptionsListArgs{
TickEvery: pulumi.Int(900),
},
})
if err != nil {
return err
}
// Example Usage (Synthetics DNS test)
// Create a new Datadog Synthetics API/DNS test on example.org
_, err = datadog.NewSyntheticsTest(ctx, "test_dns", &datadog.SyntheticsTestArgs{
Name: pulumi.String("An API test on example.org"),
Type: pulumi.String("api"),
Subtype: pulumi.String("dns"),
Status: pulumi.String("live"),
Message: pulumi.String("Notify @pagerduty"),
Locations: pulumi.StringArray{
pulumi.String("aws:eu-central-1"),
},
Tags: pulumi.StringArray{
pulumi.String("foo:bar"),
pulumi.String("foo"),
pulumi.String("env:test"),
},
RequestDefinition: &datadog.SyntheticsTestRequestDefinitionArgs{
Host: pulumi.String("example.org"),
},
Assertions: datadog.SyntheticsTestAssertionArray{
&datadog.SyntheticsTestAssertionArgs{
Type: pulumi.String("recordSome"),
Operator: pulumi.String("is"),
Property: pulumi.String("A"),
Target: pulumi.String("0.0.0.0"),
},
},
OptionsList: &datadog.SyntheticsTestOptionsListArgs{
TickEvery: pulumi.Int(900),
},
})
if err != nil {
return err
}
// Example Usage (Synthetics Multistep API test)
// Create a new Datadog Synthetics Multistep API test
_, err = datadog.NewSyntheticsTest(ctx, "test_multi_step", &datadog.SyntheticsTestArgs{
Name: pulumi.String("Multistep API test"),
Type: pulumi.String("api"),
Subtype: pulumi.String("multi"),
Status: pulumi.String("live"),
Locations: pulumi.StringArray{
pulumi.String("aws:eu-central-1"),
},
Tags: pulumi.StringArray{
pulumi.String("foo:bar"),
pulumi.String("foo"),
pulumi.String("env:test"),
},
ApiSteps: datadog.SyntheticsTestApiStepArray{
&datadog.SyntheticsTestApiStepArgs{
Name: pulumi.String("An API test on example.org"),
Subtype: pulumi.String("http"),
Assertions: datadog.SyntheticsTestApiStepAssertionArray{
&datadog.SyntheticsTestApiStepAssertionArgs{
Type: pulumi.String("statusCode"),
Operator: pulumi.String("is"),
Target: pulumi.String("200"),
},
},
RequestDefinition: &datadog.SyntheticsTestApiStepRequestDefinitionArgs{
Method: pulumi.String("GET"),
Url: pulumi.String("https://example.org"),
},
RequestHeaders: pulumi.Map{
"Content-Type": pulumi.Any("application/json"),
"Authentication": pulumi.Any("Token: 1234566789"),
},
},
&datadog.SyntheticsTestApiStepArgs{
Name: pulumi.String("An API test on example.org"),
Subtype: pulumi.String("http"),
Assertions: datadog.SyntheticsTestApiStepAssertionArray{
&datadog.SyntheticsTestApiStepAssertionArgs{
Type: pulumi.String("statusCode"),
Operator: pulumi.String("is"),
Target: pulumi.String("200"),
},
},
RequestDefinition: &datadog.SyntheticsTestApiStepRequestDefinitionArgs{
Method: pulumi.String("GET"),
Url: pulumi.String("http://example.org"),
},
},
},
OptionsList: &datadog.SyntheticsTestOptionsListArgs{
TickEvery: pulumi.Int(900),
AcceptSelfSigned: pulumi.Bool(true),
},
})
if err != nil {
return err
}
tmpJSON0, err := json.Marshal(map[string]interface{}{
"md5": "abcdef1234567890",
"sizeCheck": map[string]interface{}{
"type": "equals",
"value": 1,
},
"nameCheck": map[string]interface{}{
"type": "contains",
"value": ".xls",
},
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
// Example Usage (Synthetics Browser test)
// Create a new Datadog Synthetics Browser test starting on https://www.example.org
_, err = datadog.NewSyntheticsTest(ctx, "test_browser", &datadog.SyntheticsTestArgs{
Name: pulumi.String("A Browser test on example.org"),
Type: pulumi.String("browser"),
Status: pulumi.String("paused"),
Message: pulumi.String("Notify @qa"),
DeviceIds: pulumi.StringArray{
pulumi.String("laptop_large"),
},
Locations: pulumi.StringArray{
pulumi.String("aws:eu-central-1"),
},
Tags: pulumi.StringArray{},
RequestDefinition: &datadog.SyntheticsTestRequestDefinitionArgs{
Method: pulumi.String("GET"),
Url: pulumi.String("https://app.datadoghq.com"),
},
BrowserSteps: datadog.SyntheticsTestBrowserStepArray{
&datadog.SyntheticsTestBrowserStepArgs{
Name: pulumi.String("Check current url"),
Type: pulumi.String("assertCurrentUrl"),
Params: &datadog.SyntheticsTestBrowserStepParamsArgs{
Check: pulumi.String("contains"),
Value: pulumi.String("datadoghq"),
},
},
&datadog.SyntheticsTestBrowserStepArgs{
Name: pulumi.String("Test a downloaded file"),
Type: pulumi.String("assertFileDownload"),
Params: &datadog.SyntheticsTestBrowserStepParamsArgs{
File: pulumi.String(json0),
},
},
},
BrowserVariables: datadog.SyntheticsTestBrowserVariableArray{
&datadog.SyntheticsTestBrowserVariableArgs{
Type: pulumi.String("text"),
Name: pulumi.String("MY_PATTERN_VAR"),
Pattern: pulumi.String("{{numeric(3)}}"),
Example: pulumi.String("597"),
},
&datadog.SyntheticsTestBrowserVariableArgs{
Type: pulumi.String("email"),
Name: pulumi.String("MY_EMAIL_VAR"),
Pattern: pulumi.String("jd8-afe-ydv.{{ numeric(10) }}@synthetics.dtdg.co"),
Example: pulumi.String("jd8-afe-ydv.4546132139@synthetics.dtdg.co"),
},
&datadog.SyntheticsTestBrowserVariableArgs{
Type: pulumi.String("global"),
Name: pulumi.String("MY_GLOBAL_VAR"),
Id: pulumi.String("76636cd1-82e2-4aeb-9cfe-51366a8198a2"),
},
},
OptionsList: &datadog.SyntheticsTestOptionsListArgs{
TickEvery: pulumi.Int(3600),
},
})
if err != nil {
return err
}
// Example Usage (GRPC API test)
// Create a new Datadog GRPC API test starting on google.org:50050
_, err = datadog.NewSyntheticsTest(ctx, "grpc", &datadog.SyntheticsTestArgs{
Type: pulumi.String("api"),
Subtype: pulumi.String("grpc"),
RequestDefinition: &datadog.SyntheticsTestRequestDefinitionArgs{
Method: pulumi.String("GET"),
Host: pulumi.String("google.com"),
Port: pulumi.Int(50050),
Service: pulumi.String("Hello"),
PlainProtoFile: pulumi.String(`syntax = "proto3";
option java_multiple_files = true;
option java_package = "io.grpc.examples.helloworld";
option java_outer_classname = "HelloWorldProto";
option objc_class_prefix = "HLW";
package helloworld;
// The greeting service definition.
service Greeter {
// Sends a greeting
rpc SayHello (HelloRequest) returns (HelloReply) {}
}
// The request message containing the user's name.
message HelloRequest {
string name = 1;
}
// The response message containing the greetings
message HelloReply {
string message = 1;
}
`),
},
RequestMetadata: pulumi.Map{
"header": pulumi.Any("value"),
},
Assertions: datadog.SyntheticsTestAssertionArray{
&datadog.SyntheticsTestAssertionArgs{
Type: pulumi.String("responseTime"),
Operator: pulumi.String("lessThan"),
Target: pulumi.String("2000"),
},
&datadog.SyntheticsTestAssertionArgs{
Operator: pulumi.String("is"),
Type: pulumi.String("grpcHealthcheckStatus"),
Target: pulumi.String("1"),
},
&datadog.SyntheticsTestAssertionArgs{
Operator: pulumi.String("is"),
Target: pulumi.String("proto target"),
Type: pulumi.String("grpcProto"),
},
&datadog.SyntheticsTestAssertionArgs{
Operator: pulumi.String("is"),
Target: pulumi.String("123"),
Property: pulumi.String("property"),
Type: pulumi.String("grpcMetadata"),
},
},
Locations: pulumi.StringArray{
pulumi.String("aws:eu-central-1"),
},
OptionsList: &datadog.SyntheticsTestOptionsListArgs{
TickEvery: pulumi.Int(60),
},
Name: pulumi.String("GRPC API test"),
Message: pulumi.String("Notify @datadog.user"),
Tags: pulumi.StringArray{
pulumi.String("foo:bar"),
pulumi.String("baz"),
},
Status: pulumi.String("paused"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
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 testUptime = new Datadog.SyntheticsTest("test_uptime", new()
{
Name = "An Uptime test on example.org",
Type = "api",
Subtype = "http",
Status = "live",
Message = "Notify @pagerduty",
Locations = new[]
{
"aws:eu-central-1",
},
Tags = new[]
{
"foo:bar",
"foo",
"env:test",
},
RequestDefinition = new Datadog.Inputs.SyntheticsTestRequestDefinitionArgs
{
Method = "GET",
Url = "https://www.example.org",
},
RequestHeaders =
{
{ "Content-Type", "application/json" },
},
Assertions = new[]
{
new Datadog.Inputs.SyntheticsTestAssertionArgs
{
Type = "statusCode",
Operator = "is",
Target = "200",
},
},
OptionsList = new Datadog.Inputs.SyntheticsTestOptionsListArgs
{
TickEvery = 900,
Retry = new Datadog.Inputs.SyntheticsTestOptionsListRetryArgs
{
Count = 2,
Interval = 300,
},
MonitorOptions = new Datadog.Inputs.SyntheticsTestOptionsListMonitorOptionsArgs
{
RenotifyInterval = 120,
},
},
});
// Example Usage (Authenticated API test)
// Create a new Datadog Synthetics API/HTTP test on https://www.example.org
var testApi = new Datadog.SyntheticsTest("test_api", new()
{
Name = "An API test on example.org",
Type = "api",
Subtype = "http",
Status = "live",
Message = "Notify @pagerduty",
Locations = new[]
{
"aws:eu-central-1",
},
Tags = new[]
{
"foo:bar",
"foo",
"env:test",
},
RequestDefinition = new Datadog.Inputs.SyntheticsTestRequestDefinitionArgs
{
Method = "GET",
Url = "https://www.example.org",
},
RequestHeaders =
{
{ "Content-Type", "application/json" },
{ "Authentication", "Token: 1234566789" },
},
Assertions = new[]
{
new Datadog.Inputs.SyntheticsTestAssertionArgs
{
Type = "statusCode",
Operator = "is",
Target = "200",
},
},
OptionsList = new Datadog.Inputs.SyntheticsTestOptionsListArgs
{
TickEvery = 900,
Retry = new Datadog.Inputs.SyntheticsTestOptionsListRetryArgs
{
Count = 2,
Interval = 300,
},
MonitorOptions = new Datadog.Inputs.SyntheticsTestOptionsListMonitorOptionsArgs
{
RenotifyInterval = 120,
},
},
});
// Example Usage (Synthetics SSL test)
// Create a new Datadog Synthetics API/SSL test on example.org
var testSsl = new Datadog.SyntheticsTest("test_ssl", new()
{
Name = "An API test on example.org",
Type = "api",
Subtype = "ssl",
Status = "live",
Message = "Notify @pagerduty",
Locations = new[]
{
"aws:eu-central-1",
},
Tags = new[]
{
"foo:bar",
"foo",
"env:test",
},
RequestDefinition = new Datadog.Inputs.SyntheticsTestRequestDefinitionArgs
{
Host = "example.org",
Port = 443,
},
Assertions = new[]
{
new Datadog.Inputs.SyntheticsTestAssertionArgs
{
Type = "certificate",
Operator = "isInMoreThan",
Target = "30",
},
},
OptionsList = new Datadog.Inputs.SyntheticsTestOptionsListArgs
{
TickEvery = 900,
AcceptSelfSigned = true,
},
});
// Example Usage (Synthetics TCP test)
// Create a new Datadog Synthetics API/TCP test on example.org
var testTcp = new Datadog.SyntheticsTest("test_tcp", new()
{
Name = "An API test on example.org",
Type = "api",
Subtype = "tcp",
Status = "live",
Message = "Notify @pagerduty",
Locations = new[]
{
"aws:eu-central-1",
},
Tags = new[]
{
"foo:bar",
"foo",
"env:test",
},
RequestDefinition = new Datadog.Inputs.SyntheticsTestRequestDefinitionArgs
{
Host = "example.org",
Port = 443,
},
Assertions = new[]
{
new Datadog.Inputs.SyntheticsTestAssertionArgs
{
Type = "responseTime",
Operator = "lessThan",
Target = "2000",
},
},
ConfigVariables = new[]
{
new Datadog.Inputs.SyntheticsTestConfigVariableArgs
{
Type = "global",
Name = "MY_GLOBAL_VAR",
Id = "76636cd1-82e2-4aeb-9cfe-51366a8198a2",
},
},
OptionsList = new Datadog.Inputs.SyntheticsTestOptionsListArgs
{
TickEvery = 900,
},
});
// Example Usage (Synthetics DNS test)
// Create a new Datadog Synthetics API/DNS test on example.org
var testDns = new Datadog.SyntheticsTest("test_dns", new()
{
Name = "An API test on example.org",
Type = "api",
Subtype = "dns",
Status = "live",
Message = "Notify @pagerduty",
Locations = new[]
{
"aws:eu-central-1",
},
Tags = new[]
{
"foo:bar",
"foo",
"env:test",
},
RequestDefinition = new Datadog.Inputs.SyntheticsTestRequestDefinitionArgs
{
Host = "example.org",
},
Assertions = new[]
{
new Datadog.Inputs.SyntheticsTestAssertionArgs
{
Type = "recordSome",
Operator = "is",
Property = "A",
Target = "0.0.0.0",
},
},
OptionsList = new Datadog.Inputs.SyntheticsTestOptionsListArgs
{
TickEvery = 900,
},
});
// Example Usage (Synthetics Multistep API test)
// Create a new Datadog Synthetics Multistep API test
var testMultiStep = new Datadog.SyntheticsTest("test_multi_step", new()
{
Name = "Multistep API test",
Type = "api",
Subtype = "multi",
Status = "live",
Locations = new[]
{
"aws:eu-central-1",
},
Tags = new[]
{
"foo:bar",
"foo",
"env:test",
},
ApiSteps = new[]
{
new Datadog.Inputs.SyntheticsTestApiStepArgs
{
Name = "An API test on example.org",
Subtype = "http",
Assertions = new[]
{
new Datadog.Inputs.SyntheticsTestApiStepAssertionArgs
{
Type = "statusCode",
Operator = "is",
Target = "200",
},
},
RequestDefinition = new Datadog.Inputs.SyntheticsTestApiStepRequestDefinitionArgs
{
Method = "GET",
Url = "https://example.org",
},
RequestHeaders =
{
{ "Content-Type", "application/json" },
{ "Authentication", "Token: 1234566789" },
},
},
new Datadog.Inputs.SyntheticsTestApiStepArgs
{
Name = "An API test on example.org",
Subtype = "http",
Assertions = new[]
{
new Datadog.Inputs.SyntheticsTestApiStepAssertionArgs
{
Type = "statusCode",
Operator = "is",
Target = "200",
},
},
RequestDefinition = new Datadog.Inputs.SyntheticsTestApiStepRequestDefinitionArgs
{
Method = "GET",
Url = "http://example.org",
},
},
},
OptionsList = new Datadog.Inputs.SyntheticsTestOptionsListArgs
{
TickEvery = 900,
AcceptSelfSigned = true,
},
});
// Example Usage (Synthetics Browser test)
// Create a new Datadog Synthetics Browser test starting on https://www.example.org
var testBrowser = new Datadog.SyntheticsTest("test_browser", new()
{
Name = "A Browser test on example.org",
Type = "browser",
Status = "paused",
Message = "Notify @qa",
DeviceIds = new[]
{
"laptop_large",
},
Locations = new[]
{
"aws:eu-central-1",
},
Tags = new[] {},
RequestDefinition = new Datadog.Inputs.SyntheticsTestRequestDefinitionArgs
{
Method = "GET",
Url = "https://app.datadoghq.com",
},
BrowserSteps = new[]
{
new Datadog.Inputs.SyntheticsTestBrowserStepArgs
{
Name = "Check current url",
Type = "assertCurrentUrl",
Params = new Datadog.Inputs.SyntheticsTestBrowserStepParamsArgs
{
Check = "contains",
Value = "datadoghq",
},
},
new Datadog.Inputs.SyntheticsTestBrowserStepArgs
{
Name = "Test a downloaded file",
Type = "assertFileDownload",
Params = new Datadog.Inputs.SyntheticsTestBrowserStepParamsArgs
{
File = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["md5"] = "abcdef1234567890",
["sizeCheck"] = new Dictionary<string, object?>
{
["type"] = "equals",
["value"] = 1,
},
["nameCheck"] = new Dictionary<string, object?>
{
["type"] = "contains",
["value"] = ".xls",
},
}),
},
},
},
BrowserVariables = new[]
{
new Datadog.Inputs.SyntheticsTestBrowserVariableArgs
{
Type = "text",
Name = "MY_PATTERN_VAR",
Pattern = "{{numeric(3)}}",
Example = "597",
},
new Datadog.Inputs.SyntheticsTestBrowserVariableArgs
{
Type = "email",
Name = "MY_EMAIL_VAR",
Pattern = "jd8-afe-ydv.{{ numeric(10) }}@synthetics.dtdg.co",
Example = "jd8-afe-ydv.4546132139@synthetics.dtdg.co",
},
new Datadog.Inputs.SyntheticsTestBrowserVariableArgs
{
Type = "global",
Name = "MY_GLOBAL_VAR",
Id = "76636cd1-82e2-4aeb-9cfe-51366a8198a2",
},
},
OptionsList = new Datadog.Inputs.SyntheticsTestOptionsListArgs
{
TickEvery = 3600,
},
});
// Example Usage (GRPC API test)
// Create a new Datadog GRPC API test starting on google.org:50050
var grpc = new Datadog.SyntheticsTest("grpc", new()
{
Type = "api",
Subtype = "grpc",
RequestDefinition = new Datadog.Inputs.SyntheticsTestRequestDefinitionArgs
{
Method = "GET",
Host = "google.com",
Port = 50050,
Service = "Hello",
PlainProtoFile = @"syntax = ""proto3"";
option java_multiple_files = true;
option java_package = ""io.grpc.examples.helloworld"";
option java_outer_classname = ""HelloWorldProto"";
option objc_class_prefix = ""HLW"";
package helloworld;
// The greeting service definition.
service Greeter {
// Sends a greeting
rpc SayHello (HelloRequest) returns (HelloReply) {}
}
// The request message containing the user's name.
message HelloRequest {
string name = 1;
}
// The response message containing the greetings
message HelloReply {
string message = 1;
}
",
},
RequestMetadata =
{
{ "header", "value" },
},
Assertions = new[]
{
new Datadog.Inputs.SyntheticsTestAssertionArgs
{
Type = "responseTime",
Operator = "lessThan",
Target = "2000",
},
new Datadog.Inputs.SyntheticsTestAssertionArgs
{
Operator = "is",
Type = "grpcHealthcheckStatus",
Target = "1",
},
new Datadog.Inputs.SyntheticsTestAssertionArgs
{
Operator = "is",
Target = "proto target",
Type = "grpcProto",
},
new Datadog.Inputs.SyntheticsTestAssertionArgs
{
Operator = "is",
Target = "123",
Property = "property",
Type = "grpcMetadata",
},
},
Locations = new[]
{
"aws:eu-central-1",
},
OptionsList = new Datadog.Inputs.SyntheticsTestOptionsListArgs
{
TickEvery = 60,
},
Name = "GRPC API test",
Message = "Notify @datadog.user",
Tags = new[]
{
"foo:bar",
"baz",
},
Status = "paused",
});
});
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.SyntheticsTestRequestDefinitionArgs;
import com.pulumi.datadog.inputs.SyntheticsTestAssertionArgs;
import com.pulumi.datadog.inputs.SyntheticsTestOptionsListArgs;
import com.pulumi.datadog.inputs.SyntheticsTestOptionsListRetryArgs;
import com.pulumi.datadog.inputs.SyntheticsTestOptionsListMonitorOptionsArgs;
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 static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
// Example Usage (Synthetics API test)
// Create a new Datadog Synthetics API/HTTP test on https://www.example.org
var testUptime = new SyntheticsTest("testUptime", SyntheticsTestArgs.builder()
.name("An Uptime test on example.org")
.type("api")
.subtype("http")
.status("live")
.message("Notify @pagerduty")
.locations("aws:eu-central-1")
.tags(
"foo:bar",
"foo",
"env:test")
.requestDefinition(SyntheticsTestRequestDefinitionArgs.builder()
.method("GET")
.url("https://www.example.org")
.build())
.requestHeaders(Map.of("Content-Type", "application/json"))
.assertions(SyntheticsTestAssertionArgs.builder()
.type("statusCode")
.operator("is")
.target("200")
.build())
.optionsList(SyntheticsTestOptionsListArgs.builder()
.tickEvery(900)
.retry(SyntheticsTestOptionsListRetryArgs.builder()
.count(2)
.interval(300)
.build())
.monitorOptions(SyntheticsTestOptionsListMonitorOptionsArgs.builder()
.renotifyInterval(120)
.build())
.build())
.build());
// Example Usage (Authenticated API test)
// Create a new Datadog Synthetics API/HTTP test on https://www.example.org
var testApi = new SyntheticsTest("testApi", SyntheticsTestArgs.builder()
.name("An API test on example.org")
.type("api")
.subtype("http")
.status("live")
.message("Notify @pagerduty")
.locations("aws:eu-central-1")
.tags(
"foo:bar",
"foo",
"env:test")
.requestDefinition(SyntheticsTestRequestDefinitionArgs.builder()
.method("GET")
.url("https://www.example.org")
.build())
.requestHeaders(Map.ofEntries(
Map.entry("Content-Type", "application/json"),
Map.entry("Authentication", "Token: 1234566789")
))
.assertions(SyntheticsTestAssertionArgs.builder()
.type("statusCode")
.operator("is")
.target("200")
.build())
.optionsList(SyntheticsTestOptionsListArgs.builder()
.tickEvery(900)
.retry(SyntheticsTestOptionsListRetryArgs.builder()
.count(2)
.interval(300)
.build())
.monitorOptions(SyntheticsTestOptionsListMonitorOptionsArgs.builder()
.renotifyInterval(120)
.build())
.build())
.build());
// Example Usage (Synthetics SSL test)
// Create a new Datadog Synthetics API/SSL test on example.org
var testSsl = new SyntheticsTest("testSsl", SyntheticsTestArgs.builder()
.name("An API test on example.org")
.type("api")
.subtype("ssl")
.status("live")
.message("Notify @pagerduty")
.locations("aws:eu-central-1")
.tags(
"foo:bar",
"foo",
"env:test")
.requestDefinition(SyntheticsTestRequestDefinitionArgs.builder()
.host("example.org")
.port(443)
.build())
.assertions(SyntheticsTestAssertionArgs.builder()
.type("certificate")
.operator("isInMoreThan")
.target(30)
.build())
.optionsList(SyntheticsTestOptionsListArgs.builder()
.tickEvery(900)
.acceptSelfSigned(true)
.build())
.build());
// Example Usage (Synthetics TCP test)
// Create a new Datadog Synthetics API/TCP test on example.org
var testTcp = new SyntheticsTest("testTcp", SyntheticsTestArgs.builder()
.name("An API test on example.org")
.type("api")
.subtype("tcp")
.status("live")
.message("Notify @pagerduty")
.locations("aws:eu-central-1")
.tags(
"foo:bar",
"foo",
"env:test")
.requestDefinition(SyntheticsTestRequestDefinitionArgs.builder()
.host("example.org")
.port(443)
.build())
.assertions(SyntheticsTestAssertionArgs.builder()
.type("responseTime")
.operator("lessThan")
.target(2000)
.build())
.configVariables(SyntheticsTestConfigVariableArgs.builder()
.type("global")
.name("MY_GLOBAL_VAR")
.id("76636cd1-82e2-4aeb-9cfe-51366a8198a2")
.build())
.optionsList(SyntheticsTestOptionsListArgs.builder()
.tickEvery(900)
.build())
.build());
// Example Usage (Synthetics DNS test)
// Create a new Datadog Synthetics API/DNS test on example.org
var testDns = new SyntheticsTest("testDns", SyntheticsTestArgs.builder()
.name("An API test on example.org")
.type("api")
.subtype("dns")
.status("live")
.message("Notify @pagerduty")
.locations("aws:eu-central-1")
.tags(
"foo:bar",
"foo",
"env:test")
.requestDefinition(SyntheticsTestRequestDefinitionArgs.builder()
.host("example.org")
.build())
.assertions(SyntheticsTestAssertionArgs.builder()
.type("recordSome")
.operator("is")
.property("A")
.target("0.0.0.0")
.build())
.optionsList(SyntheticsTestOptionsListArgs.builder()
.tickEvery(900)
.build())
.build());
// Example Usage (Synthetics Multistep API test)
// Create a new Datadog Synthetics Multistep API test
var testMultiStep = new SyntheticsTest("testMultiStep", SyntheticsTestArgs.builder()
.name("Multistep API test")
.type("api")
.subtype("multi")
.status("live")
.locations("aws:eu-central-1")
.tags(
"foo:bar",
"foo",
"env:test")
.apiSteps(
SyntheticsTestApiStepArgs.builder()
.name("An API test on example.org")
.subtype("http")
.assertions(SyntheticsTestApiStepAssertionArgs.builder()
.type("statusCode")
.operator("is")
.target("200")
.build())
.requestDefinition(SyntheticsTestApiStepRequestDefinitionArgs.builder()
.method("GET")
.url("https://example.org")
.build())
.requestHeaders(Map.ofEntries(
Map.entry("Content-Type", "application/json"),
Map.entry("Authentication", "Token: 1234566789")
))
.build(),
SyntheticsTestApiStepArgs.builder()
.name("An API test on example.org")
.subtype("http")
.assertions(SyntheticsTestApiStepAssertionArgs.builder()
.type("statusCode")
.operator("is")
.target("200")
.build())
.requestDefinition(SyntheticsTestApiStepRequestDefinitionArgs.builder()
.method("GET")
.url("http://example.org")
.build())
.build())
.optionsList(SyntheticsTestOptionsListArgs.builder()
.tickEvery(900)
.acceptSelfSigned(true)
.build())
.build());
// Example Usage (Synthetics Browser test)
// Create a new Datadog Synthetics Browser test starting on https://www.example.org
var testBrowser = new SyntheticsTest("testBrowser", SyntheticsTestArgs.builder()
.name("A Browser test on example.org")
.type("browser")
.status("paused")
.message("Notify @qa")
.deviceIds("laptop_large")
.locations("aws:eu-central-1")
.tags()
.requestDefinition(SyntheticsTestRequestDefinitionArgs.builder()
.method("GET")
.url("https://app.datadoghq.com")
.build())
.browserSteps(
SyntheticsTestBrowserStepArgs.builder()
.name("Check current url")
.type("assertCurrentUrl")
.params(SyntheticsTestBrowserStepParamsArgs.builder()
.check("contains")
.value("datadoghq")
.build())
.build(),
SyntheticsTestBrowserStepArgs.builder()
.name("Test a downloaded file")
.type("assertFileDownload")
.params(SyntheticsTestBrowserStepParamsArgs.builder()
.file(serializeJson(
jsonObject(
jsonProperty("md5", "abcdef1234567890"),
jsonProperty("sizeCheck", jsonObject(
jsonProperty("type", "equals"),
jsonProperty("value", 1)
)),
jsonProperty("nameCheck", jsonObject(
jsonProperty("type", "contains"),
jsonProperty("value", ".xls")
))
)))
.build())
.build())
.browserVariables(
SyntheticsTestBrowserVariableArgs.builder()
.type("text")
.name("MY_PATTERN_VAR")
.pattern("{{numeric(3)}}")
.example("597")
.build(),
SyntheticsTestBrowserVariableArgs.builder()
.type("email")
.name("MY_EMAIL_VAR")
.pattern("jd8-afe-ydv.{{ numeric(10) }}@synthetics.dtdg.co")
.example("jd8-afe-ydv.4546132139@synthetics.dtdg.co")
.build(),
SyntheticsTestBrowserVariableArgs.builder()
.type("global")
.name("MY_GLOBAL_VAR")
.id("76636cd1-82e2-4aeb-9cfe-51366a8198a2")
.build())
.optionsList(SyntheticsTestOptionsListArgs.builder()
.tickEvery(3600)
.build())
.build());
// Example Usage (GRPC API test)
// Create a new Datadog GRPC API test starting on google.org:50050
var grpc = new SyntheticsTest("grpc", SyntheticsTestArgs.builder()
.type("api")
.subtype("grpc")
.requestDefinition(SyntheticsTestRequestDefinitionArgs.builder()
.method("GET")
.host("google.com")
.port(50050)
.service("Hello")
.plainProtoFile("""
syntax = "proto3";
option java_multiple_files = true;
option java_package = "io.grpc.examples.helloworld";
option java_outer_classname = "HelloWorldProto";
option objc_class_prefix = "HLW";
package helloworld;
// The greeting service definition.
service Greeter {
// Sends a greeting
rpc SayHello (HelloRequest) returns (HelloReply) {}
}
// The request message containing the user's name.
message HelloRequest {
string name = 1;
}
// The response message containing the greetings
message HelloReply {
string message = 1;
}
""")
.build())
.requestMetadata(Map.of("header", "value"))
.assertions(
SyntheticsTestAssertionArgs.builder()
.type("responseTime")
.operator("lessThan")
.target("2000")
.build(),
SyntheticsTestAssertionArgs.builder()
.operator("is")
.type("grpcHealthcheckStatus")
.target(1)
.build(),
SyntheticsTestAssertionArgs.builder()
.operator("is")
.target("proto target")
.type("grpcProto")
.build(),
SyntheticsTestAssertionArgs.builder()
.operator("is")
.target("123")
.property("property")
.type("grpcMetadata")
.build())
.locations("aws:eu-central-1")
.optionsList(SyntheticsTestOptionsListArgs.builder()
.tickEvery(60)
.build())
.name("GRPC API test")
.message("Notify @datadog.user")
.tags(
"foo:bar",
"baz")
.status("paused")
.build());
}
}
resources:
# Example Usage (Synthetics API test)
# Create a new Datadog Synthetics API/HTTP test on https://www.example.org
testUptime:
type: datadog:SyntheticsTest
name: test_uptime
properties:
name: An Uptime test on example.org
type: api
subtype: http
status: live
message: Notify @pagerduty
locations:
- aws:eu-central-1
tags:
- foo:bar
- foo
- env:test
requestDefinition:
method: GET
url: https://www.example.org
requestHeaders:
Content-Type: application/json
assertions:
- type: statusCode
operator: is
target: '200'
optionsList:
tickEvery: 900
retry:
count: 2
interval: 300
monitorOptions:
renotifyInterval: 120
# Example Usage (Authenticated API test)
# Create a new Datadog Synthetics API/HTTP test on https://www.example.org
testApi:
type: datadog:SyntheticsTest
name: test_api
properties:
name: An API test on example.org
type: api
subtype: http
status: live
message: Notify @pagerduty
locations:
- aws:eu-central-1
tags:
- foo:bar
- foo
- env:test
requestDefinition:
method: GET
url: https://www.example.org
requestHeaders:
Content-Type: application/json
Authentication: 'Token: 1234566789'
assertions:
- type: statusCode
operator: is
target: '200'
optionsList:
tickEvery: 900
retry:
count: 2
interval: 300
monitorOptions:
renotifyInterval: 120
# Example Usage (Synthetics SSL test)
# Create a new Datadog Synthetics API/SSL test on example.org
testSsl:
type: datadog:SyntheticsTest
name: test_ssl
properties:
name: An API test on example.org
type: api
subtype: ssl
status: live
message: Notify @pagerduty
locations:
- aws:eu-central-1
tags:
- foo:bar
- foo
- env:test
requestDefinition:
host: example.org
port: 443
assertions:
- type: certificate
operator: isInMoreThan
target: 30
optionsList:
tickEvery: 900
acceptSelfSigned: true
# Example Usage (Synthetics TCP test)
# Create a new Datadog Synthetics API/TCP test on example.org
testTcp:
type: datadog:SyntheticsTest
name: test_tcp
properties:
name: An API test on example.org
type: api
subtype: tcp
status: live
message: Notify @pagerduty
locations:
- aws:eu-central-1
tags:
- foo:bar
- foo
- env:test
requestDefinition:
host: example.org
port: 443
assertions:
- type: responseTime
operator: lessThan
target: 2000
configVariables:
- type: global
name: MY_GLOBAL_VAR
id: 76636cd1-82e2-4aeb-9cfe-51366a8198a2
optionsList:
tickEvery: 900
# Example Usage (Synthetics DNS test)
# Create a new Datadog Synthetics API/DNS test on example.org
testDns:
type: datadog:SyntheticsTest
name: test_dns
properties:
name: An API test on example.org
type: api
subtype: dns
status: live
message: Notify @pagerduty
locations:
- aws:eu-central-1
tags:
- foo:bar
- foo
- env:test
requestDefinition:
host: example.org
assertions:
- type: recordSome
operator: is
property: A
target: 0.0.0.0
optionsList:
tickEvery: 900
# Example Usage (Synthetics Multistep API test)
# Create a new Datadog Synthetics Multistep API test
testMultiStep:
type: datadog:SyntheticsTest
name: test_multi_step
properties:
name: Multistep API test
type: api
subtype: multi
status: live
locations:
- aws:eu-central-1
tags:
- foo:bar
- foo
- env:test
apiSteps:
- name: An API test on example.org
subtype: http
assertions:
- type: statusCode
operator: is
target: '200'
requestDefinition:
method: GET
url: https://example.org
requestHeaders:
Content-Type: application/json
Authentication: 'Token: 1234566789'
- name: An API test on example.org
subtype: http
assertions:
- type: statusCode
operator: is
target: '200'
requestDefinition:
method: GET
url: http://example.org
optionsList:
tickEvery: 900
acceptSelfSigned: true
# Example Usage (Synthetics Browser test)
# Create a new Datadog Synthetics Browser test starting on https://www.example.org
testBrowser:
type: datadog:SyntheticsTest
name: test_browser
properties:
name: A Browser test on example.org
type: browser
status: paused
message: Notify @qa
deviceIds:
- laptop_large
locations:
- aws:eu-central-1
tags: []
requestDefinition:
method: GET
url: https://app.datadoghq.com
browserSteps:
- name: Check current url
type: assertCurrentUrl
params:
check: contains
value: datadoghq
- name: Test a downloaded file
type: assertFileDownload
params:
file:
fn::toJSON:
md5: abcdef1234567890
sizeCheck:
type: equals
value: 1
nameCheck:
type: contains
value: .xls
browserVariables:
- type: text
name: MY_PATTERN_VAR
pattern: '{{numeric(3)}}'
example: '597'
- type: email
name: MY_EMAIL_VAR
pattern: jd8-afe-ydv.{{ numeric(10) }}@synthetics.dtdg.co
example: jd8-afe-ydv.4546132139@synthetics.dtdg.co
- type: global
name: MY_GLOBAL_VAR
id: 76636cd1-82e2-4aeb-9cfe-51366a8198a2
optionsList:
tickEvery: 3600
# Example Usage (GRPC API test)
# Create a new Datadog GRPC API test starting on google.org:50050
grpc:
type: datadog:SyntheticsTest
properties:
type: api
subtype: grpc
requestDefinition:
method: GET
host: google.com
port: 50050
service: Hello
plainProtoFile: |
syntax = "proto3";
option java_multiple_files = true;
option java_package = "io.grpc.examples.helloworld";
option java_outer_classname = "HelloWorldProto";
option objc_class_prefix = "HLW";
package helloworld;
// The greeting service definition.
service Greeter {
// Sends a greeting
rpc SayHello (HelloRequest) returns (HelloReply) {}
}
// The request message containing the user's name.
message HelloRequest {
string name = 1;
}
// The response message containing the greetings
message HelloReply {
string message = 1;
}
requestMetadata:
header: value
assertions:
- type: responseTime
operator: lessThan
target: '2000'
- operator: is
type: grpcHealthcheckStatus
target: 1
- operator: is
target: proto target
type: grpcProto
- operator: is
target: '123'
property: property
type: grpcMetadata
locations:
- aws:eu-central-1
optionsList:
tickEvery: 60
name: GRPC API test
message: Notify @datadog.user
tags:
- foo:bar
- baz
status: paused
Create SyntheticsTest Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SyntheticsTest(name: string, args: SyntheticsTestArgs, opts?: CustomResourceOptions);@overload
def SyntheticsTest(resource_name: str,
args: SyntheticsTestArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SyntheticsTest(resource_name: str,
opts: Optional[ResourceOptions] = None,
locations: Optional[Sequence[str]] = None,
type: Optional[str] = None,
status: Optional[str] = None,
name: Optional[str] = None,
request_basicauth: Optional[SyntheticsTestRequestBasicauthArgs] = None,
request_headers: Optional[Mapping[str, Any]] = None,
config_variables: Optional[Sequence[SyntheticsTestConfigVariableArgs]] = None,
message: Optional[str] = None,
browser_variables: Optional[Sequence[SyntheticsTestBrowserVariableArgs]] = None,
options_list: Optional[SyntheticsTestOptionsListArgs] = None,
api_steps: Optional[Sequence[SyntheticsTestApiStepArgs]] = None,
request_client_certificate: Optional[SyntheticsTestRequestClientCertificateArgs] = None,
request_definition: Optional[SyntheticsTestRequestDefinitionArgs] = None,
device_ids: Optional[Sequence[str]] = None,
request_metadata: Optional[Mapping[str, Any]] = None,
request_proxy: Optional[SyntheticsTestRequestProxyArgs] = None,
request_query: Optional[Mapping[str, Any]] = None,
set_cookie: Optional[str] = None,
browser_steps: Optional[Sequence[SyntheticsTestBrowserStepArgs]] = None,
subtype: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
assertions: Optional[Sequence[SyntheticsTestAssertionArgs]] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var syntheticsTestResource = new Datadog.SyntheticsTest("syntheticsTestResource", new()
{
Locations = new[]
{
"string",
},
Type = "string",
Status = "string",
Name = "string",
RequestBasicauth = new Datadog.Inputs.SyntheticsTestRequestBasicauthArgs
{
AccessKey = "string",
AccessTokenUrl = "string",
Audience = "string",
ClientId = "string",
ClientSecret = "string",
Domain = "string",
Password = "string",
Region = "string",
Resource = "string",
Scope = "string",
SecretKey = "string",
ServiceName = "string",
SessionToken = "string",
TokenApiAuthentication = "string",
Type = "string",
Username = "string",
Workstation = "string",
},
RequestHeaders =
{
{ "string", "any" },
},
ConfigVariables = new[]
{
new Datadog.Inputs.SyntheticsTestConfigVariableArgs
{
Name = "string",
Type = "string",
Example = "string",
Id = "string",
Pattern = "string",
Secure = false,
},
},
Message = "string",
BrowserVariables = new[]
{
new Datadog.Inputs.SyntheticsTestBrowserVariableArgs
{
Name = "string",
Type = "string",
Example = "string",
Id = "string",
Pattern = "string",
Secure = false,
},
},
OptionsList = new Datadog.Inputs.SyntheticsTestOptionsListArgs
{
TickEvery = 0,
MinFailureDuration = 0,
RumSettings = new Datadog.Inputs.SyntheticsTestOptionsListRumSettingsArgs
{
IsEnabled = false,
ApplicationId = "string",
ClientTokenId = 0,
},
Ci = new Datadog.Inputs.SyntheticsTestOptionsListCiArgs
{
ExecutionRule = "string",
},
DisableCors = false,
DisableCsp = false,
FollowRedirects = false,
HttpVersion = "string",
MinLocationFailed = 0,
AllowInsecure = false,
CheckCertificateRevocation = false,
IgnoreServerCertificateError = false,
MonitorName = "string",
MonitorOptions = new Datadog.Inputs.SyntheticsTestOptionsListMonitorOptionsArgs
{
RenotifyInterval = 0,
},
MonitorPriority = 0,
NoScreenshot = false,
RestrictedRoles = new[]
{
"string",
},
Retry = new Datadog.Inputs.SyntheticsTestOptionsListRetryArgs
{
Count = 0,
Interval = 0,
},
AcceptSelfSigned = false,
Scheduling = new Datadog.Inputs.SyntheticsTestOptionsListSchedulingArgs
{
Timeframes = new[]
{
new Datadog.Inputs.SyntheticsTestOptionsListSchedulingTimeframeArgs
{
Day = 0,
From = "string",
To = "string",
},
},
Timezone = "string",
},
InitialNavigationTimeout = 0,
},
ApiSteps = new[]
{
new Datadog.Inputs.SyntheticsTestApiStepArgs
{
Name = "string",
RequestClientCertificate = new Datadog.Inputs.SyntheticsTestApiStepRequestClientCertificateArgs
{
Cert = new Datadog.Inputs.SyntheticsTestApiStepRequestClientCertificateCertArgs
{
Content = "string",
Filename = "string",
},
Key = new Datadog.Inputs.SyntheticsTestApiStepRequestClientCertificateKeyArgs
{
Content = "string",
Filename = "string",
},
},
ExtractedValues = new[]
{
new Datadog.Inputs.SyntheticsTestApiStepExtractedValueArgs
{
Name = "string",
Parser = new Datadog.Inputs.SyntheticsTestApiStepExtractedValueParserArgs
{
Type = "string",
Value = "string",
},
Type = "string",
Field = "string",
Secure = false,
},
},
IsCritical = false,
Assertions = new[]
{
new Datadog.Inputs.SyntheticsTestApiStepAssertionArgs
{
Operator = "string",
Type = "string",
Property = "string",
Target = "string",
Targetjsonpath = new Datadog.Inputs.SyntheticsTestApiStepAssertionTargetjsonpathArgs
{
Jsonpath = "string",
Operator = "string",
Targetvalue = "string",
},
Targetxpath = new Datadog.Inputs.SyntheticsTestApiStepAssertionTargetxpathArgs
{
Operator = "string",
Xpath = "string",
Targetvalue = "string",
},
TimingsScope = "string",
},
},
RequestBasicauth = new Datadog.Inputs.SyntheticsTestApiStepRequestBasicauthArgs
{
AccessKey = "string",
AccessTokenUrl = "string",
Audience = "string",
ClientId = "string",
ClientSecret = "string",
Domain = "string",
Password = "string",
Region = "string",
Resource = "string",
Scope = "string",
SecretKey = "string",
ServiceName = "string",
SessionToken = "string",
TokenApiAuthentication = "string",
Type = "string",
Username = "string",
Workstation = "string",
},
AllowFailure = false,
RequestDefinition = new Datadog.Inputs.SyntheticsTestApiStepRequestDefinitionArgs
{
AllowInsecure = false,
Body = "string",
BodyType = "string",
CallType = "string",
CertificateDomains = new[]
{
"string",
},
DnsServer = "string",
DnsServerPort = 0,
FollowRedirects = false,
Host = "string",
HttpVersion = "string",
Message = "string",
Method = "string",
NoSavingResponseBody = false,
NumberOfPackets = 0,
PersistCookies = false,
PlainProtoFile = "string",
Port = 0,
Servername = "string",
Service = "string",
ShouldTrackHops = false,
Timeout = 0,
Url = "string",
},
RequestHeaders =
{
{ "string", "any" },
},
RequestProxy = new Datadog.Inputs.SyntheticsTestApiStepRequestProxyArgs
{
Url = "string",
Headers =
{
{ "string", "any" },
},
},
RequestQuery =
{
{ "string", "any" },
},
Retry = new Datadog.Inputs.SyntheticsTestApiStepRetryArgs
{
Count = 0,
Interval = 0,
},
Subtype = "string",
},
},
RequestClientCertificate = new Datadog.Inputs.SyntheticsTestRequestClientCertificateArgs
{
Cert = new Datadog.Inputs.SyntheticsTestRequestClientCertificateCertArgs
{
Content = "string",
Filename = "string",
},
Key = new Datadog.Inputs.SyntheticsTestRequestClientCertificateKeyArgs
{
Content = "string",
Filename = "string",
},
},
RequestDefinition = new Datadog.Inputs.SyntheticsTestRequestDefinitionArgs
{
Body = "string",
BodyType = "string",
CallType = "string",
CertificateDomains = new[]
{
"string",
},
DnsServer = "string",
DnsServerPort = 0,
Host = "string",
HttpVersion = "string",
Message = "string",
Method = "string",
NoSavingResponseBody = false,
NumberOfPackets = 0,
PersistCookies = false,
PlainProtoFile = "string",
Port = 0,
Servername = "string",
Service = "string",
ShouldTrackHops = false,
Timeout = 0,
Url = "string",
},
DeviceIds = new[]
{
"string",
},
RequestMetadata =
{
{ "string", "any" },
},
RequestProxy = new Datadog.Inputs.SyntheticsTestRequestProxyArgs
{
Url = "string",
Headers =
{
{ "string", "any" },
},
},
RequestQuery =
{
{ "string", "any" },
},
SetCookie = "string",
BrowserSteps = new[]
{
new Datadog.Inputs.SyntheticsTestBrowserStepArgs
{
Name = "string",
Params = new Datadog.Inputs.SyntheticsTestBrowserStepParamsArgs
{
Attribute = "string",
Check = "string",
ClickType = "string",
Code = "string",
Delay = 0,
Element = "string",
ElementUserLocator = new Datadog.Inputs.SyntheticsTestBrowserStepParamsElementUserLocatorArgs
{
Value = new Datadog.Inputs.SyntheticsTestBrowserStepParamsElementUserLocatorValueArgs
{
Value = "string",
Type = "string",
},
FailTestOnCannotLocate = false,
},
Email = "string",
File = "string",
Files = "string",
Modifiers = new[]
{
"string",
},
PlayingTabId = "string",
Request = "string",
SubtestPublicId = "string",
Value = "string",
Variable = new Datadog.Inputs.SyntheticsTestBrowserStepParamsVariableArgs
{
Example = "string",
Name = "string",
},
WithClick = false,
X = 0,
Y = 0,
},
Type = "string",
AllowFailure = false,
ForceElementUpdate = false,
IsCritical = false,
NoScreenshot = false,
Timeout = 0,
},
},
Subtype = "string",
Tags = new[]
{
"string",
},
Assertions = new[]
{
new Datadog.Inputs.SyntheticsTestAssertionArgs
{
Operator = "string",
Type = "string",
Property = "string",
Target = "string",
Targetjsonpath = new Datadog.Inputs.SyntheticsTestAssertionTargetjsonpathArgs
{
Jsonpath = "string",
Operator = "string",
Targetvalue = "string",
},
Targetxpath = new Datadog.Inputs.SyntheticsTestAssertionTargetxpathArgs
{
Operator = "string",
Xpath = "string",
Targetvalue = "string",
},
TimingsScope = "string",
},
},
});
example, err := datadog.NewSyntheticsTest(ctx, "syntheticsTestResource", &datadog.SyntheticsTestArgs{
Locations: pulumi.StringArray{
pulumi.String("string"),
},
Type: pulumi.String("string"),
Status: pulumi.String("string"),
Name: pulumi.String("string"),
RequestBasicauth: &datadog.SyntheticsTestRequestBasicauthArgs{
AccessKey: pulumi.String("string"),
AccessTokenUrl: pulumi.String("string"),
Audience: pulumi.String("string"),
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
Domain: pulumi.String("string"),
Password: pulumi.String("string"),
Region: pulumi.String("string"),
Resource: pulumi.String("string"),
Scope: pulumi.String("string"),
SecretKey: pulumi.String("string"),
ServiceName: pulumi.String("string"),
SessionToken: pulumi.String("string"),
TokenApiAuthentication: pulumi.String("string"),
Type: pulumi.String("string"),
Username: pulumi.String("string"),
Workstation: pulumi.String("string"),
},
RequestHeaders: pulumi.Map{
"string": pulumi.Any("any"),
},
ConfigVariables: datadog.SyntheticsTestConfigVariableArray{
&datadog.SyntheticsTestConfigVariableArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
Example: pulumi.String("string"),
Id: pulumi.String("string"),
Pattern: pulumi.String("string"),
Secure: pulumi.Bool(false),
},
},
Message: pulumi.String("string"),
BrowserVariables: datadog.SyntheticsTestBrowserVariableArray{
&datadog.SyntheticsTestBrowserVariableArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
Example: pulumi.String("string"),
Id: pulumi.String("string"),
Pattern: pulumi.String("string"),
Secure: pulumi.Bool(false),
},
},
OptionsList: &datadog.SyntheticsTestOptionsListArgs{
TickEvery: pulumi.Int(0),
MinFailureDuration: pulumi.Int(0),
RumSettings: &datadog.SyntheticsTestOptionsListRumSettingsArgs{
IsEnabled: pulumi.Bool(false),
ApplicationId: pulumi.String("string"),
ClientTokenId: pulumi.Int(0),
},
Ci: &datadog.SyntheticsTestOptionsListCiArgs{
ExecutionRule: pulumi.String("string"),
},
DisableCors: pulumi.Bool(false),
DisableCsp: pulumi.Bool(false),
FollowRedirects: pulumi.Bool(false),
HttpVersion: pulumi.String("string"),
MinLocationFailed: pulumi.Int(0),
AllowInsecure: pulumi.Bool(false),
CheckCertificateRevocation: pulumi.Bool(false),
IgnoreServerCertificateError: pulumi.Bool(false),
MonitorName: pulumi.String("string"),
MonitorOptions: &datadog.SyntheticsTestOptionsListMonitorOptionsArgs{
RenotifyInterval: pulumi.Int(0),
},
MonitorPriority: pulumi.Int(0),
NoScreenshot: pulumi.Bool(false),
RestrictedRoles: pulumi.StringArray{
pulumi.String("string"),
},
Retry: &datadog.SyntheticsTestOptionsListRetryArgs{
Count: pulumi.Int(0),
Interval: pulumi.Int(0),
},
AcceptSelfSigned: pulumi.Bool(false),
Scheduling: &datadog.SyntheticsTestOptionsListSchedulingArgs{
Timeframes: datadog.SyntheticsTestOptionsListSchedulingTimeframeArray{
&datadog.SyntheticsTestOptionsListSchedulingTimeframeArgs{
Day: pulumi.Int(0),
From: pulumi.String("string"),
To: pulumi.String("string"),
},
},
Timezone: pulumi.String("string"),
},
InitialNavigationTimeout: pulumi.Int(0),
},
ApiSteps: datadog.SyntheticsTestApiStepArray{
&datadog.SyntheticsTestApiStepArgs{
Name: pulumi.String("string"),
RequestClientCertificate: &datadog.SyntheticsTestApiStepRequestClientCertificateArgs{
Cert: &datadog.SyntheticsTestApiStepRequestClientCertificateCertArgs{
Content: pulumi.String("string"),
Filename: pulumi.String("string"),
},
Key: &datadog.SyntheticsTestApiStepRequestClientCertificateKeyArgs{
Content: pulumi.String("string"),
Filename: pulumi.String("string"),
},
},
ExtractedValues: datadog.SyntheticsTestApiStepExtractedValueArray{
&datadog.SyntheticsTestApiStepExtractedValueArgs{
Name: pulumi.String("string"),
Parser: &datadog.SyntheticsTestApiStepExtractedValueParserArgs{
Type: pulumi.String("string"),
Value: pulumi.String("string"),
},
Type: pulumi.String("string"),
Field: pulumi.String("string"),
Secure: pulumi.Bool(false),
},
},
IsCritical: pulumi.Bool(false),
Assertions: datadog.SyntheticsTestApiStepAssertionArray{
&datadog.SyntheticsTestApiStepAssertionArgs{
Operator: pulumi.String("string"),
Type: pulumi.String("string"),
Property: pulumi.String("string"),
Target: pulumi.String("string"),
Targetjsonpath: &datadog.SyntheticsTestApiStepAssertionTargetjsonpathArgs{
Jsonpath: pulumi.String("string"),
Operator: pulumi.String("string"),
Targetvalue: pulumi.String("string"),
},
Targetxpath: &datadog.SyntheticsTestApiStepAssertionTargetxpathArgs{
Operator: pulumi.String("string"),
Xpath: pulumi.String("string"),
Targetvalue: pulumi.String("string"),
},
TimingsScope: pulumi.String("string"),
},
},
RequestBasicauth: &datadog.SyntheticsTestApiStepRequestBasicauthArgs{
AccessKey: pulumi.String("string"),
AccessTokenUrl: pulumi.String("string"),
Audience: pulumi.String("string"),
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
Domain: pulumi.String("string"),
Password: pulumi.String("string"),
Region: pulumi.String("string"),
Resource: pulumi.String("string"),
Scope: pulumi.String("string"),
SecretKey: pulumi.String("string"),
ServiceName: pulumi.String("string"),
SessionToken: pulumi.String("string"),
TokenApiAuthentication: pulumi.String("string"),
Type: pulumi.String("string"),
Username: pulumi.String("string"),
Workstation: pulumi.String("string"),
},
AllowFailure: pulumi.Bool(false),
RequestDefinition: &datadog.SyntheticsTestApiStepRequestDefinitionArgs{
AllowInsecure: pulumi.Bool(false),
Body: pulumi.String("string"),
BodyType: pulumi.String("string"),
CallType: pulumi.String("string"),
CertificateDomains: pulumi.StringArray{
pulumi.String("string"),
},
DnsServer: pulumi.String("string"),
DnsServerPort: pulumi.Int(0),
FollowRedirects: pulumi.Bool(false),
Host: pulumi.String("string"),
HttpVersion: pulumi.String("string"),
Message: pulumi.String("string"),
Method: pulumi.String("string"),
NoSavingResponseBody: pulumi.Bool(false),
NumberOfPackets: pulumi.Int(0),
PersistCookies: pulumi.Bool(false),
PlainProtoFile: pulumi.String("string"),
Port: pulumi.Int(0),
Servername: pulumi.String("string"),
Service: pulumi.String("string"),
ShouldTrackHops: pulumi.Bool(false),
Timeout: pulumi.Int(0),
Url: pulumi.String("string"),
},
RequestHeaders: pulumi.Map{
"string": pulumi.Any("any"),
},
RequestProxy: &datadog.SyntheticsTestApiStepRequestProxyArgs{
Url: pulumi.String("string"),
Headers: pulumi.Map{
"string": pulumi.Any("any"),
},
},
RequestQuery: pulumi.Map{
"string": pulumi.Any("any"),
},
Retry: &datadog.SyntheticsTestApiStepRetryArgs{
Count: pulumi.Int(0),
Interval: pulumi.Int(0),
},
Subtype: pulumi.String("string"),
},
},
RequestClientCertificate: &datadog.SyntheticsTestRequestClientCertificateArgs{
Cert: &datadog.SyntheticsTestRequestClientCertificateCertArgs{
Content: pulumi.String("string"),
Filename: pulumi.String("string"),
},
Key: &datadog.SyntheticsTestRequestClientCertificateKeyArgs{
Content: pulumi.String("string"),
Filename: pulumi.String("string"),
},
},
RequestDefinition: &datadog.SyntheticsTestRequestDefinitionArgs{
Body: pulumi.String("string"),
BodyType: pulumi.String("string"),
CallType: pulumi.String("string"),
CertificateDomains: pulumi.StringArray{
pulumi.String("string"),
},
DnsServer: pulumi.String("string"),
DnsServerPort: pulumi.Int(0),
Host: pulumi.String("string"),
HttpVersion: pulumi.String("string"),
Message: pulumi.String("string"),
Method: pulumi.String("string"),
NoSavingResponseBody: pulumi.Bool(false),
NumberOfPackets: pulumi.Int(0),
PersistCookies: pulumi.Bool(false),
PlainProtoFile: pulumi.String("string"),
Port: pulumi.Int(0),
Servername: pulumi.String("string"),
Service: pulumi.String("string"),
ShouldTrackHops: pulumi.Bool(false),
Timeout: pulumi.Int(0),
Url: pulumi.String("string"),
},
DeviceIds: pulumi.StringArray{
pulumi.String("string"),
},
RequestMetadata: pulumi.Map{
"string": pulumi.Any("any"),
},
RequestProxy: &datadog.SyntheticsTestRequestProxyArgs{
Url: pulumi.String("string"),
Headers: pulumi.Map{
"string": pulumi.Any("any"),
},
},
RequestQuery: pulumi.Map{
"string": pulumi.Any("any"),
},
SetCookie: pulumi.String("string"),
BrowserSteps: datadog.SyntheticsTestBrowserStepArray{
&datadog.SyntheticsTestBrowserStepArgs{
Name: pulumi.String("string"),
Params: &datadog.SyntheticsTestBrowserStepParamsArgs{
Attribute: pulumi.String("string"),
Check: pulumi.String("string"),
ClickType: pulumi.String("string"),
Code: pulumi.String("string"),
Delay: pulumi.Int(0),
Element: pulumi.String("string"),
ElementUserLocator: &datadog.SyntheticsTestBrowserStepParamsElementUserLocatorArgs{
Value: &datadog.SyntheticsTestBrowserStepParamsElementUserLocatorValueArgs{
Value: pulumi.String("string"),
Type: pulumi.String("string"),
},
FailTestOnCannotLocate: pulumi.Bool(false),
},
Email: pulumi.String("string"),
File: pulumi.String("string"),
Files: pulumi.String("string"),
Modifiers: pulumi.StringArray{
pulumi.String("string"),
},
PlayingTabId: pulumi.String("string"),
Request: pulumi.String("string"),
SubtestPublicId: pulumi.String("string"),
Value: pulumi.String("string"),
Variable: &datadog.SyntheticsTestBrowserStepParamsVariableArgs{
Example: pulumi.String("string"),
Name: pulumi.String("string"),
},
WithClick: pulumi.Bool(false),
X: pulumi.Int(0),
Y: pulumi.Int(0),
},
Type: pulumi.String("string"),
AllowFailure: pulumi.Bool(false),
ForceElementUpdate: pulumi.Bool(false),
IsCritical: pulumi.Bool(false),
NoScreenshot: pulumi.Bool(false),
Timeout: pulumi.Int(0),
},
},
Subtype: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Assertions: datadog.SyntheticsTestAssertionArray{
&datadog.SyntheticsTestAssertionArgs{
Operator: pulumi.String("string"),
Type: pulumi.String("string"),
Property: pulumi.String("string"),
Target: pulumi.String("string"),
Targetjsonpath: &datadog.SyntheticsTestAssertionTargetjsonpathArgs{
Jsonpath: pulumi.String("string"),
Operator: pulumi.String("string"),
Targetvalue: pulumi.String("string"),
},
Targetxpath: &datadog.SyntheticsTestAssertionTargetxpathArgs{
Operator: pulumi.String("string"),
Xpath: pulumi.String("string"),
Targetvalue: pulumi.String("string"),
},
TimingsScope: pulumi.String("string"),
},
},
})
var syntheticsTestResource = new SyntheticsTest("syntheticsTestResource", SyntheticsTestArgs.builder()
.locations("string")
.type("string")
.status("string")
.name("string")
.requestBasicauth(SyntheticsTestRequestBasicauthArgs.builder()
.accessKey("string")
.accessTokenUrl("string")
.audience("string")
.clientId("string")
.clientSecret("string")
.domain("string")
.password("string")
.region("string")
.resource("string")
.scope("string")
.secretKey("string")
.serviceName("string")
.sessionToken("string")
.tokenApiAuthentication("string")
.type("string")
.username("string")
.workstation("string")
.build())
.requestHeaders(Map.of("string", "any"))
.configVariables(SyntheticsTestConfigVariableArgs.builder()
.name("string")
.type("string")
.example("string")
.id("string")
.pattern("string")
.secure(false)
.build())
.message("string")
.browserVariables(SyntheticsTestBrowserVariableArgs.builder()
.name("string")
.type("string")
.example("string")
.id("string")
.pattern("string")
.secure(false)
.build())
.optionsList(SyntheticsTestOptionsListArgs.builder()
.tickEvery(0)
.minFailureDuration(0)
.rumSettings(SyntheticsTestOptionsListRumSettingsArgs.builder()
.isEnabled(false)
.applicationId("string")
.clientTokenId(0)
.build())
.ci(SyntheticsTestOptionsListCiArgs.builder()
.executionRule("string")
.build())
.disableCors(false)
.disableCsp(false)
.followRedirects(false)
.httpVersion("string")
.minLocationFailed(0)
.allowInsecure(false)
.checkCertificateRevocation(false)
.ignoreServerCertificateError(false)
.monitorName("string")
.monitorOptions(SyntheticsTestOptionsListMonitorOptionsArgs.builder()
.renotifyInterval(0)
.build())
.monitorPriority(0)
.noScreenshot(false)
.restrictedRoles("string")
.retry(SyntheticsTestOptionsListRetryArgs.builder()
.count(0)
.interval(0)
.build())
.acceptSelfSigned(false)
.scheduling(SyntheticsTestOptionsListSchedulingArgs.builder()
.timeframes(SyntheticsTestOptionsListSchedulingTimeframeArgs.builder()
.day(0)
.from("string")
.to("string")
.build())
.timezone("string")
.build())
.initialNavigationTimeout(0)
.build())
.apiSteps(SyntheticsTestApiStepArgs.builder()
.name("string")
.requestClientCertificate(SyntheticsTestApiStepRequestClientCertificateArgs.builder()
.cert(SyntheticsTestApiStepRequestClientCertificateCertArgs.builder()
.content("string")
.filename("string")
.build())
.key(SyntheticsTestApiStepRequestClientCertificateKeyArgs.builder()
.content("string")
.filename("string")
.build())
.build())
.extractedValues(SyntheticsTestApiStepExtractedValueArgs.builder()
.name("string")
.parser(SyntheticsTestApiStepExtractedValueParserArgs.builder()
.type("string")
.value("string")
.build())
.type("string")
.field("string")
.secure(false)
.build())
.isCritical(false)
.assertions(SyntheticsTestApiStepAssertionArgs.builder()
.operator("string")
.type("string")
.property("string")
.target("string")
.targetjsonpath(SyntheticsTestApiStepAssertionTargetjsonpathArgs.builder()
.jsonpath("string")
.operator("string")
.targetvalue("string")
.build())
.targetxpath(SyntheticsTestApiStepAssertionTargetxpathArgs.builder()
.operator("string")
.xpath("string")
.targetvalue("string")
.build())
.timingsScope("string")
.build())
.requestBasicauth(SyntheticsTestApiStepRequestBasicauthArgs.builder()
.accessKey("string")
.accessTokenUrl("string")
.audience("string")
.clientId("string")
.clientSecret("string")
.domain("string")
.password("string")
.region("string")
.resource("string")
.scope("string")
.secretKey("string")
.serviceName("string")
.sessionToken("string")
.tokenApiAuthentication("string")
.type("string")
.username("string")
.workstation("string")
.build())
.allowFailure(false)
.requestDefinition(SyntheticsTestApiStepRequestDefinitionArgs.builder()
.allowInsecure(false)
.body("string")
.bodyType("string")
.callType("string")
.certificateDomains("string")
.dnsServer("string")
.dnsServerPort(0)
.followRedirects(false)
.host("string")
.httpVersion("string")
.message("string")
.method("string")
.noSavingResponseBody(false)
.numberOfPackets(0)
.persistCookies(false)
.plainProtoFile("string")
.port(0)
.servername("string")
.service("string")
.shouldTrackHops(false)
.timeout(0)
.url("string")
.build())
.requestHeaders(Map.of("string", "any"))
.requestProxy(SyntheticsTestApiStepRequestProxyArgs.builder()
.url("string")
.headers(Map.of("string", "any"))
.build())
.requestQuery(Map.of("string", "any"))
.retry(SyntheticsTestApiStepRetryArgs.builder()
.count(0)
.interval(0)
.build())
.subtype("string")
.build())
.requestClientCertificate(SyntheticsTestRequestClientCertificateArgs.builder()
.cert(SyntheticsTestRequestClientCertificateCertArgs.builder()
.content("string")
.filename("string")
.build())
.key(SyntheticsTestRequestClientCertificateKeyArgs.builder()
.content("string")
.filename("string")
.build())
.build())
.requestDefinition(SyntheticsTestRequestDefinitionArgs.builder()
.body("string")
.bodyType("string")
.callType("string")
.certificateDomains("string")
.dnsServer("string")
.dnsServerPort(0)
.host("string")
.httpVersion("string")
.message("string")
.method("string")
.noSavingResponseBody(false)
.numberOfPackets(0)
.persistCookies(false)
.plainProtoFile("string")
.port(0)
.servername("string")
.service("string")
.shouldTrackHops(false)
.timeout(0)
.url("string")
.build())
.deviceIds("string")
.requestMetadata(Map.of("string", "any"))
.requestProxy(SyntheticsTestRequestProxyArgs.builder()
.url("string")
.headers(Map.of("string", "any"))
.build())
.requestQuery(Map.of("string", "any"))
.setCookie("string")
.browserSteps(SyntheticsTestBrowserStepArgs.builder()
.name("string")
.params(SyntheticsTestBrowserStepParamsArgs.builder()
.attribute("string")
.check("string")
.clickType("string")
.code("string")
.delay(0)
.element("string")
.elementUserLocator(SyntheticsTestBrowserStepParamsElementUserLocatorArgs.builder()
.value(SyntheticsTestBrowserStepParamsElementUserLocatorValueArgs.builder()
.value("string")
.type("string")
.build())
.failTestOnCannotLocate(false)
.build())
.email("string")
.file("string")
.files("string")
.modifiers("string")
.playingTabId("string")
.request("string")
.subtestPublicId("string")
.value("string")
.variable(SyntheticsTestBrowserStepParamsVariableArgs.builder()
.example("string")
.name("string")
.build())
.withClick(false)
.x(0)
.y(0)
.build())
.type("string")
.allowFailure(false)
.forceElementUpdate(false)
.isCritical(false)
.noScreenshot(false)
.timeout(0)
.build())
.subtype("string")
.tags("string")
.assertions(SyntheticsTestAssertionArgs.builder()
.operator("string")
.type("string")
.property("string")
.target("string")
.targetjsonpath(SyntheticsTestAssertionTargetjsonpathArgs.builder()
.jsonpath("string")
.operator("string")
.targetvalue("string")
.build())
.targetxpath(SyntheticsTestAssertionTargetxpathArgs.builder()
.operator("string")
.xpath("string")
.targetvalue("string")
.build())
.timingsScope("string")
.build())
.build());
synthetics_test_resource = datadog.SyntheticsTest("syntheticsTestResource",
locations=["string"],
type="string",
status="string",
name="string",
request_basicauth=datadog.SyntheticsTestRequestBasicauthArgs(
access_key="string",
access_token_url="string",
audience="string",
client_id="string",
client_secret="string",
domain="string",
password="string",
region="string",
resource="string",
scope="string",
secret_key="string",
service_name="string",
session_token="string",
token_api_authentication="string",
type="string",
username="string",
workstation="string",
),
request_headers={
"string": "any",
},
config_variables=[datadog.SyntheticsTestConfigVariableArgs(
name="string",
type="string",
example="string",
id="string",
pattern="string",
secure=False,
)],
message="string",
browser_variables=[datadog.SyntheticsTestBrowserVariableArgs(
name="string",
type="string",
example="string",
id="string",
pattern="string",
secure=False,
)],
options_list=datadog.SyntheticsTestOptionsListArgs(
tick_every=0,
min_failure_duration=0,
rum_settings=datadog.SyntheticsTestOptionsListRumSettingsArgs(
is_enabled=False,
application_id="string",
client_token_id=0,
),
ci=datadog.SyntheticsTestOptionsListCiArgs(
execution_rule="string",
),
disable_cors=False,
disable_csp=False,
follow_redirects=False,
http_version="string",
min_location_failed=0,
allow_insecure=False,
check_certificate_revocation=False,
ignore_server_certificate_error=False,
monitor_name="string",
monitor_options=datadog.SyntheticsTestOptionsListMonitorOptionsArgs(
renotify_interval=0,
),
monitor_priority=0,
no_screenshot=False,
restricted_roles=["string"],
retry=datadog.SyntheticsTestOptionsListRetryArgs(
count=0,
interval=0,
),
accept_self_signed=False,
scheduling=datadog.SyntheticsTestOptionsListSchedulingArgs(
timeframes=[datadog.SyntheticsTestOptionsListSchedulingTimeframeArgs(
day=0,
from_="string",
to="string",
)],
timezone="string",
),
initial_navigation_timeout=0,
),
api_steps=[datadog.SyntheticsTestApiStepArgs(
name="string",
request_client_certificate=datadog.SyntheticsTestApiStepRequestClientCertificateArgs(
cert=datadog.SyntheticsTestApiStepRequestClientCertificateCertArgs(
content="string",
filename="string",
),
key=datadog.SyntheticsTestApiStepRequestClientCertificateKeyArgs(
content="string",
filename="string",
),
),
extracted_values=[datadog.SyntheticsTestApiStepExtractedValueArgs(
name="string",
parser=datadog.SyntheticsTestApiStepExtractedValueParserArgs(
type="string",
value="string",
),
type="string",
field="string",
secure=False,
)],
is_critical=False,
assertions=[datadog.SyntheticsTestApiStepAssertionArgs(
operator="string",
type="string",
property="string",
target="string",
targetjsonpath=datadog.SyntheticsTestApiStepAssertionTargetjsonpathArgs(
jsonpath="string",
operator="string",
targetvalue="string",
),
targetxpath=datadog.SyntheticsTestApiStepAssertionTargetxpathArgs(
operator="string",
xpath="string",
targetvalue="string",
),
timings_scope="string",
)],
request_basicauth=datadog.SyntheticsTestApiStepRequestBasicauthArgs(
access_key="string",
access_token_url="string",
audience="string",
client_id="string",
client_secret="string",
domain="string",
password="string",
region="string",
resource="string",
scope="string",
secret_key="string",
service_name="string",
session_token="string",
token_api_authentication="string",
type="string",
username="string",
workstation="string",
),
allow_failure=False,
request_definition=datadog.SyntheticsTestApiStepRequestDefinitionArgs(
allow_insecure=False,
body="string",
body_type="string",
call_type="string",
certificate_domains=["string"],
dns_server="string",
dns_server_port=0,
follow_redirects=False,
host="string",
http_version="string",
message="string",
method="string",
no_saving_response_body=False,
number_of_packets=0,
persist_cookies=False,
plain_proto_file="string",
port=0,
servername="string",
service="string",
should_track_hops=False,
timeout=0,
url="string",
),
request_headers={
"string": "any",
},
request_proxy=datadog.SyntheticsTestApiStepRequestProxyArgs(
url="string",
headers={
"string": "any",
},
),
request_query={
"string": "any",
},
retry=datadog.SyntheticsTestApiStepRetryArgs(
count=0,
interval=0,
),
subtype="string",
)],
request_client_certificate=datadog.SyntheticsTestRequestClientCertificateArgs(
cert=datadog.SyntheticsTestRequestClientCertificateCertArgs(
content="string",
filename="string",
),
key=datadog.SyntheticsTestRequestClientCertificateKeyArgs(
content="string",
filename="string",
),
),
request_definition=datadog.SyntheticsTestRequestDefinitionArgs(
body="string",
body_type="string",
call_type="string",
certificate_domains=["string"],
dns_server="string",
dns_server_port=0,
host="string",
http_version="string",
message="string",
method="string",
no_saving_response_body=False,
number_of_packets=0,
persist_cookies=False,
plain_proto_file="string",
port=0,
servername="string",
service="string",
should_track_hops=False,
timeout=0,
url="string",
),
device_ids=["string"],
request_metadata={
"string": "any",
},
request_proxy=datadog.SyntheticsTestRequestProxyArgs(
url="string",
headers={
"string": "any",
},
),
request_query={
"string": "any",
},
set_cookie="string",
browser_steps=[datadog.SyntheticsTestBrowserStepArgs(
name="string",
params=datadog.SyntheticsTestBrowserStepParamsArgs(
attribute="string",
check="string",
click_type="string",
code="string",
delay=0,
element="string",
element_user_locator=datadog.SyntheticsTestBrowserStepParamsElementUserLocatorArgs(
value=datadog.SyntheticsTestBrowserStepParamsElementUserLocatorValueArgs(
value="string",
type="string",
),
fail_test_on_cannot_locate=False,
),
email="string",
file="string",
files="string",
modifiers=["string"],
playing_tab_id="string",
request="string",
subtest_public_id="string",
value="string",
variable=datadog.SyntheticsTestBrowserStepParamsVariableArgs(
example="string",
name="string",
),
with_click=False,
x=0,
y=0,
),
type="string",
allow_failure=False,
force_element_update=False,
is_critical=False,
no_screenshot=False,
timeout=0,
)],
subtype="string",
tags=["string"],
assertions=[datadog.SyntheticsTestAssertionArgs(
operator="string",
type="string",
property="string",
target="string",
targetjsonpath=datadog.SyntheticsTestAssertionTargetjsonpathArgs(
jsonpath="string",
operator="string",
targetvalue="string",
),
targetxpath=datadog.SyntheticsTestAssertionTargetxpathArgs(
operator="string",
xpath="string",
targetvalue="string",
),
timings_scope="string",
)])
const syntheticsTestResource = new datadog.SyntheticsTest("syntheticsTestResource", {
locations: ["string"],
type: "string",
status: "string",
name: "string",
requestBasicauth: {
accessKey: "string",
accessTokenUrl: "string",
audience: "string",
clientId: "string",
clientSecret: "string",
domain: "string",
password: "string",
region: "string",
resource: "string",
scope: "string",
secretKey: "string",
serviceName: "string",
sessionToken: "string",
tokenApiAuthentication: "string",
type: "string",
username: "string",
workstation: "string",
},
requestHeaders: {
string: "any",
},
configVariables: [{
name: "string",
type: "string",
example: "string",
id: "string",
pattern: "string",
secure: false,
}],
message: "string",
browserVariables: [{
name: "string",
type: "string",
example: "string",
id: "string",
pattern: "string",
secure: false,
}],
optionsList: {
tickEvery: 0,
minFailureDuration: 0,
rumSettings: {
isEnabled: false,
applicationId: "string",
clientTokenId: 0,
},
ci: {
executionRule: "string",
},
disableCors: false,
disableCsp: false,
followRedirects: false,
httpVersion: "string",
minLocationFailed: 0,
allowInsecure: false,
checkCertificateRevocation: false,
ignoreServerCertificateError: false,
monitorName: "string",
monitorOptions: {
renotifyInterval: 0,
},
monitorPriority: 0,
noScreenshot: false,
restrictedRoles: ["string"],
retry: {
count: 0,
interval: 0,
},
acceptSelfSigned: false,
scheduling: {
timeframes: [{
day: 0,
from: "string",
to: "string",
}],
timezone: "string",
},
initialNavigationTimeout: 0,
},
apiSteps: [{
name: "string",
requestClientCertificate: {
cert: {
content: "string",
filename: "string",
},
key: {
content: "string",
filename: "string",
},
},
extractedValues: [{
name: "string",
parser: {
type: "string",
value: "string",
},
type: "string",
field: "string",
secure: false,
}],
isCritical: false,
assertions: [{
operator: "string",
type: "string",
property: "string",
target: "string",
targetjsonpath: {
jsonpath: "string",
operator: "string",
targetvalue: "string",
},
targetxpath: {
operator: "string",
xpath: "string",
targetvalue: "string",
},
timingsScope: "string",
}],
requestBasicauth: {
accessKey: "string",
accessTokenUrl: "string",
audience: "string",
clientId: "string",
clientSecret: "string",
domain: "string",
password: "string",
region: "string",
resource: "string",
scope: "string",
secretKey: "string",
serviceName: "string",
sessionToken: "string",
tokenApiAuthentication: "string",
type: "string",
username: "string",
workstation: "string",
},
allowFailure: false,
requestDefinition: {
allowInsecure: false,
body: "string",
bodyType: "string",
callType: "string",
certificateDomains: ["string"],
dnsServer: "string",
dnsServerPort: 0,
followRedirects: false,
host: "string",
httpVersion: "string",
message: "string",
method: "string",
noSavingResponseBody: false,
numberOfPackets: 0,
persistCookies: false,
plainProtoFile: "string",
port: 0,
servername: "string",
service: "string",
shouldTrackHops: false,
timeout: 0,
url: "string",
},
requestHeaders: {
string: "any",
},
requestProxy: {
url: "string",
headers: {
string: "any",
},
},
requestQuery: {
string: "any",
},
retry: {
count: 0,
interval: 0,
},
subtype: "string",
}],
requestClientCertificate: {
cert: {
content: "string",
filename: "string",
},
key: {
content: "string",
filename: "string",
},
},
requestDefinition: {
body: "string",
bodyType: "string",
callType: "string",
certificateDomains: ["string"],
dnsServer: "string",
dnsServerPort: 0,
host: "string",
httpVersion: "string",
message: "string",
method: "string",
noSavingResponseBody: false,
numberOfPackets: 0,
persistCookies: false,
plainProtoFile: "string",
port: 0,
servername: "string",
service: "string",
shouldTrackHops: false,
timeout: 0,
url: "string",
},
deviceIds: ["string"],
requestMetadata: {
string: "any",
},
requestProxy: {
url: "string",
headers: {
string: "any",
},
},
requestQuery: {
string: "any",
},
setCookie: "string",
browserSteps: [{
name: "string",
params: {
attribute: "string",
check: "string",
clickType: "string",
code: "string",
delay: 0,
element: "string",
elementUserLocator: {
value: {
value: "string",
type: "string",
},
failTestOnCannotLocate: false,
},
email: "string",
file: "string",
files: "string",
modifiers: ["string"],
playingTabId: "string",
request: "string",
subtestPublicId: "string",
value: "string",
variable: {
example: "string",
name: "string",
},
withClick: false,
x: 0,
y: 0,
},
type: "string",
allowFailure: false,
forceElementUpdate: false,
isCritical: false,
noScreenshot: false,
timeout: 0,
}],
subtype: "string",
tags: ["string"],
assertions: [{
operator: "string",
type: "string",
property: "string",
target: "string",
targetjsonpath: {
jsonpath: "string",
operator: "string",
targetvalue: "string",
},
targetxpath: {
operator: "string",
xpath: "string",
targetvalue: "string",
},
timingsScope: "string",
}],
});
type: datadog:SyntheticsTest
properties:
apiSteps:
- allowFailure: false
assertions:
- operator: string
property: string
target: string
targetjsonpath:
jsonpath: string
operator: string
targetvalue: string
targetxpath:
operator: string
targetvalue: string
xpath: string
timingsScope: string
type: string
extractedValues:
- field: string
name: string
parser:
type: string
value: string
secure: false
type: string
isCritical: false
name: string
requestBasicauth:
accessKey: string
accessTokenUrl: string
audience: string
clientId: string
clientSecret: string
domain: string
password: string
region: string
resource: string
scope: string
secretKey: string
serviceName: string
sessionToken: string
tokenApiAuthentication: string
type: string
username: string
workstation: string
requestClientCertificate:
cert:
content: string
filename: string
key:
content: string
filename: string
requestDefinition:
allowInsecure: false
body: string
bodyType: string
callType: string
certificateDomains:
- string
dnsServer: string
dnsServerPort: 0
followRedirects: false
host: string
httpVersion: string
message: string
method: string
noSavingResponseBody: false
numberOfPackets: 0
persistCookies: false
plainProtoFile: string
port: 0
servername: string
service: string
shouldTrackHops: false
timeout: 0
url: string
requestHeaders:
string: any
requestProxy:
headers:
string: any
url: string
requestQuery:
string: any
retry:
count: 0
interval: 0
subtype: string
assertions:
- operator: string
property: string
target: string
targetjsonpath:
jsonpath: string
operator: string
targetvalue: string
targetxpath:
operator: string
targetvalue: string
xpath: string
timingsScope: string
type: string
browserSteps:
- allowFailure: false
forceElementUpdate: false
isCritical: false
name: string
noScreenshot: false
params:
attribute: string
check: string
clickType: string
code: string
delay: 0
element: string
elementUserLocator:
failTestOnCannotLocate: false
value:
type: string
value: string
email: string
file: string
files: string
modifiers:
- string
playingTabId: string
request: string
subtestPublicId: string
value: string
variable:
example: string
name: string
withClick: false
x: 0
"y": 0
timeout: 0
type: string
browserVariables:
- example: string
id: string
name: string
pattern: string
secure: false
type: string
configVariables:
- example: string
id: string
name: string
pattern: string
secure: false
type: string
deviceIds:
- string
locations:
- string
message: string
name: string
optionsList:
acceptSelfSigned: false
allowInsecure: false
checkCertificateRevocation: false
ci:
executionRule: string
disableCors: false
disableCsp: false
followRedirects: false
httpVersion: string
ignoreServerCertificateError: false
initialNavigationTimeout: 0
minFailureDuration: 0
minLocationFailed: 0
monitorName: string
monitorOptions:
renotifyInterval: 0
monitorPriority: 0
noScreenshot: false
restrictedRoles:
- string
retry:
count: 0
interval: 0
rumSettings:
applicationId: string
clientTokenId: 0
isEnabled: false
scheduling:
timeframes:
- day: 0
from: string
to: string
timezone: string
tickEvery: 0
requestBasicauth:
accessKey: string
accessTokenUrl: string
audience: string
clientId: string
clientSecret: string
domain: string
password: string
region: string
resource: string
scope: string
secretKey: string
serviceName: string
sessionToken: string
tokenApiAuthentication: string
type: string
username: string
workstation: string
requestClientCertificate:
cert:
content: string
filename: string
key:
content: string
filename: string
requestDefinition:
body: string
bodyType: string
callType: string
certificateDomains:
- string
dnsServer: string
dnsServerPort: 0
host: string
httpVersion: string
message: string
method: string
noSavingResponseBody: false
numberOfPackets: 0
persistCookies: false
plainProtoFile: string
port: 0
servername: string
service: string
shouldTrackHops: false
timeout: 0
url: string
requestHeaders:
string: any
requestMetadata:
string: any
requestProxy:
headers:
string: any
url: string
requestQuery:
string: any
setCookie: string
status: string
subtype: string
tags:
- string
type: string
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 arelive,paused. - Type string
- Synthetics test type. Valid values are
api,browser. - Api
Steps List<SyntheticsTest Api Step> - Steps for multistep api tests
- Assertions
List<Synthetics
Test Assertion> - Assertions used for the test. Multiple
assertionblocks are allowed with the structure below. - Browser
Steps List<SyntheticsTest Browser Step> - Steps for browser tests.
- Browser
Variables List<SyntheticsTest Browser Variable> - Variables used for a browser test steps. Multiple
variableblocks are allowed with the structure below. - Config
Variables List<SyntheticsTest Config Variable> - Variables used for the test configuration. Multiple
config_variableblocks are allowed with the structure below. - Device
Ids List<string> - Required if
type = "browser". Array with the different device IDs used to run the test. Valid values arelaptop_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
@usernamenotation as events. Defaults to"". - Options
List SyntheticsTest Options List - Request
Basicauth SyntheticsTest Request Basicauth - The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- Request
Client SyntheticsCertificate Test Request Client Certificate - Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- Request
Definition SyntheticsTest Request Definition - Required if
type = "api". The synthetics test request. - Request
Headers Dictionary<string, object> - Header name and value map.
- Request
Metadata Dictionary<string, object> - Metadata to include when performing the gRPC test.
- Request
Proxy SyntheticsTest Request Proxy - The proxy to perform the test.
- Request
Query Dictionary<string, object> - Query arguments name and value map.
- 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 arehttp,ssl,tcp,dns,multi,icmp,udp,websocket,grpc. - 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 arelive,paused. - Type string
- Synthetics test type. Valid values are
api,browser. - Api
Steps []SyntheticsTest Api Step Args - Steps for multistep api tests
- Assertions
[]Synthetics
Test Assertion Args - Assertions used for the test. Multiple
assertionblocks are allowed with the structure below. - Browser
Steps []SyntheticsTest Browser Step Args - Steps for browser tests.
- Browser
Variables []SyntheticsTest Browser Variable Args - Variables used for a browser test steps. Multiple
variableblocks are allowed with the structure below. - Config
Variables []SyntheticsTest Config Variable Args - Variables used for the test configuration. Multiple
config_variableblocks are allowed with the structure below. - Device
Ids []string - Required if
type = "browser". Array with the different device IDs used to run the test. Valid values arelaptop_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
@usernamenotation as events. Defaults to"". - Options
List SyntheticsTest Options List Args - Request
Basicauth SyntheticsTest Request Basicauth Args - The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- Request
Client SyntheticsCertificate Test Request Client Certificate Args - Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- Request
Definition SyntheticsTest Request Definition Args - Required if
type = "api". The synthetics test request. - Request
Headers map[string]interface{} - Header name and value map.
- Request
Metadata map[string]interface{} - Metadata to include when performing the gRPC test.
- Request
Proxy SyntheticsTest Request Proxy Args - The proxy to perform the test.
- Request
Query map[string]interface{} - Query arguments name and value map.
- 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 arehttp,ssl,tcp,dns,multi,icmp,udp,websocket,grpc. - []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 arelive,paused. - type String
- Synthetics test type. Valid values are
api,browser. - api
Steps List<SyntheticsTest Api Step> - Steps for multistep api tests
- assertions
List<Synthetics
Test Assertion> - Assertions used for the test. Multiple
assertionblocks are allowed with the structure below. - browser
Steps List<SyntheticsTest Browser Step> - Steps for browser tests.
- browser
Variables List<SyntheticsTest Browser Variable> - Variables used for a browser test steps. Multiple
variableblocks are allowed with the structure below. - config
Variables List<SyntheticsTest Config Variable> - Variables used for the test configuration. Multiple
config_variableblocks are allowed with the structure below. - device
Ids List<String> - Required if
type = "browser". Array with the different device IDs used to run the test. Valid values arelaptop_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
@usernamenotation as events. Defaults to"". - options
List SyntheticsTest Options List - request
Basicauth SyntheticsTest Request Basicauth - The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- request
Client SyntheticsCertificate Test Request Client Certificate - Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- request
Definition SyntheticsTest Request Definition - Required if
type = "api". The synthetics test request. - request
Headers Map<String,Object> - Header name and value map.
- request
Metadata Map<String,Object> - Metadata to include when performing the gRPC test.
- request
Proxy SyntheticsTest Request Proxy - The proxy to perform the test.
- request
Query Map<String,Object> - Query arguments name and value map.
- 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 arehttp,ssl,tcp,dns,multi,icmp,udp,websocket,grpc. - 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 arelive,paused. - type string
- Synthetics test type. Valid values are
api,browser. - api
Steps SyntheticsTest Api Step[] - Steps for multistep api tests
- assertions
Synthetics
Test Assertion[] - Assertions used for the test. Multiple
assertionblocks are allowed with the structure below. - browser
Steps SyntheticsTest Browser Step[] - Steps for browser tests.
- browser
Variables SyntheticsTest Browser Variable[] - Variables used for a browser test steps. Multiple
variableblocks are allowed with the structure below. - config
Variables SyntheticsTest Config Variable[] - Variables used for the test configuration. Multiple
config_variableblocks are allowed with the structure below. - device
Ids string[] - Required if
type = "browser". Array with the different device IDs used to run the test. Valid values arelaptop_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
@usernamenotation as events. Defaults to"". - options
List SyntheticsTest Options List - request
Basicauth SyntheticsTest Request Basicauth - The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- request
Client SyntheticsCertificate Test Request Client Certificate - Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- request
Definition SyntheticsTest Request Definition - Required if
type = "api". The synthetics test request. - request
Headers {[key: string]: any} - Header name and value map.
- request
Metadata {[key: string]: any} - Metadata to include when performing the gRPC test.
- request
Proxy SyntheticsTest Request Proxy - The proxy to perform the test.
- request
Query {[key: string]: any} - Query arguments name and value map.
- 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 arehttp,ssl,tcp,dns,multi,icmp,udp,websocket,grpc. - 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 arelive,paused. - type str
- Synthetics test type. Valid values are
api,browser. - api_
steps Sequence[SyntheticsTest Api Step Args] - Steps for multistep api tests
- assertions
Sequence[Synthetics
Test Assertion Args] - Assertions used for the test. Multiple
assertionblocks are allowed with the structure below. - browser_
steps Sequence[SyntheticsTest Browser Step Args] - Steps for browser tests.
- browser_
variables Sequence[SyntheticsTest Browser Variable Args] - Variables used for a browser test steps. Multiple
variableblocks are allowed with the structure below. - config_
variables Sequence[SyntheticsTest Config Variable Args] - Variables used for the test configuration. Multiple
config_variableblocks 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 arelaptop_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
@usernamenotation as events. Defaults to"". - options_
list SyntheticsTest Options List Args - request_
basicauth SyntheticsTest Request Basicauth Args - The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- request_
client_ Syntheticscertificate Test Request Client Certificate Args - Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- request_
definition SyntheticsTest Request Definition Args - Required if
type = "api". The synthetics test request. - request_
headers Mapping[str, Any] - Header name and value map.
- request_
metadata Mapping[str, Any] - Metadata to include when performing the gRPC test.
- request_
proxy SyntheticsTest Request Proxy Args - The proxy to perform the test.
- request_
query Mapping[str, Any] - Query arguments name and value map.
- 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 arehttp,ssl,tcp,dns,multi,icmp,udp,websocket,grpc. - 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 arelive,paused. - type String
- Synthetics test type. Valid values are
api,browser. - api
Steps List<Property Map> - Steps for multistep api tests
- assertions List<Property Map>
- Assertions used for the test. Multiple
assertionblocks are allowed with the structure below. - browser
Steps List<Property Map> - Steps for browser tests.
- browser
Variables List<Property Map> - Variables used for a browser test steps. Multiple
variableblocks are allowed with the structure below. - config
Variables List<Property Map> - Variables used for the test configuration. Multiple
config_variableblocks are allowed with the structure below. - device
Ids List<String> - Required if
type = "browser". Array with the different device IDs used to run the test. Valid values arelaptop_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
@usernamenotation as events. Defaults to"". - options
List Property Map - request
Basicauth Property Map - The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- request
Client Property MapCertificate - Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- request
Definition Property Map - Required if
type = "api". The synthetics test request. - request
Headers Map<Any> - Header name and value map.
- request
Metadata Map<Any> - Metadata to include when performing the gRPC test.
- request
Proxy Property Map - The proxy to perform the test.
- request
Query Map<Any> - Query arguments name and value map.
- 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 arehttp,ssl,tcp,dns,multi,icmp,udp,websocket,grpc. - 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 str
- The provider-assigned unique ID for this managed resource.
- monitor_
id int - 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_metadata: 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) -> SyntheticsTestfunc 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.
- Api
Steps List<SyntheticsTest Api Step> - Steps for multistep api tests
- Assertions
List<Synthetics
Test Assertion> - Assertions used for the test. Multiple
assertionblocks are allowed with the structure below. - Browser
Steps List<SyntheticsTest Browser Step> - Steps for browser tests.
- Browser
Variables List<SyntheticsTest Browser Variable> - Variables used for a browser test steps. Multiple
variableblocks are allowed with the structure below. - Config
Variables List<SyntheticsTest Config Variable> - Variables used for the test configuration. Multiple
config_variableblocks are allowed with the structure below. - Device
Ids List<string> - Required if
type = "browser". Array with the different device IDs used to run the test. Valid values arelaptop_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
@usernamenotation as events. Defaults to"". - Monitor
Id int - ID of the monitor associated with the Datadog synthetics test.
- Name string
- Name of Datadog synthetics test.
- Options
List SyntheticsTest Options List - Request
Basicauth SyntheticsTest Request Basicauth - The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- Request
Client SyntheticsCertificate Test Request Client Certificate - Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- Request
Definition SyntheticsTest Request Definition - Required if
type = "api". The synthetics test request. - Request
Headers Dictionary<string, object> - Header name and value map.
- Request
Metadata Dictionary<string, object> - Metadata to include when performing the gRPC test.
- Request
Proxy SyntheticsTest Request Proxy - The proxy to perform the test.
- Request
Query Dictionary<string, object> - Query arguments name and value map.
- 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 arelive,paused. - Subtype string
- The subtype of the Synthetic API test. Defaults to
http. Valid values arehttp,ssl,tcp,dns,multi,icmp,udp,websocket,grpc. - 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.
- Api
Steps []SyntheticsTest Api Step Args - Steps for multistep api tests
- Assertions
[]Synthetics
Test Assertion Args - Assertions used for the test. Multiple
assertionblocks are allowed with the structure below. - Browser
Steps []SyntheticsTest Browser Step Args - Steps for browser tests.
- Browser
Variables []SyntheticsTest Browser Variable Args - Variables used for a browser test steps. Multiple
variableblocks are allowed with the structure below. - Config
Variables []SyntheticsTest Config Variable Args - Variables used for the test configuration. Multiple
config_variableblocks are allowed with the structure below. - Device
Ids []string - Required if
type = "browser". Array with the different device IDs used to run the test. Valid values arelaptop_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
@usernamenotation as events. Defaults to"". - Monitor
Id int - ID of the monitor associated with the Datadog synthetics test.
- Name string
- Name of Datadog synthetics test.
- Options
List SyntheticsTest Options List Args - Request
Basicauth SyntheticsTest Request Basicauth Args - The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- Request
Client SyntheticsCertificate Test Request Client Certificate Args - Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- Request
Definition SyntheticsTest Request Definition Args - Required if
type = "api". The synthetics test request. - Request
Headers map[string]interface{} - Header name and value map.
- Request
Metadata map[string]interface{} - Metadata to include when performing the gRPC test.
- Request
Proxy SyntheticsTest Request Proxy Args - The proxy to perform the test.
- Request
Query map[string]interface{} - Query arguments name and value map.
- 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 arelive,paused. - Subtype string
- The subtype of the Synthetic API test. Defaults to
http. Valid values arehttp,ssl,tcp,dns,multi,icmp,udp,websocket,grpc. - []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 List<SyntheticsTest Api Step> - Steps for multistep api tests
- assertions
List<Synthetics
Test Assertion> - Assertions used for the test. Multiple
assertionblocks are allowed with the structure below. - browser
Steps List<SyntheticsTest Browser Step> - Steps for browser tests.
- browser
Variables List<SyntheticsTest Browser Variable> - Variables used for a browser test steps. Multiple
variableblocks are allowed with the structure below. - config
Variables List<SyntheticsTest Config Variable> - Variables used for the test configuration. Multiple
config_variableblocks are allowed with the structure below. - device
Ids List<String> - Required if
type = "browser". Array with the different device IDs used to run the test. Valid values arelaptop_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
@usernamenotation as events. Defaults to"". - monitor
Id Integer - ID of the monitor associated with the Datadog synthetics test.
- name String
- Name of Datadog synthetics test.
- options
List SyntheticsTest Options List - request
Basicauth SyntheticsTest Request Basicauth - The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- request
Client SyntheticsCertificate Test Request Client Certificate - Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- request
Definition SyntheticsTest Request Definition - Required if
type = "api". The synthetics test request. - request
Headers Map<String,Object> - Header name and value map.
- request
Metadata Map<String,Object> - Metadata to include when performing the gRPC test.
- request
Proxy SyntheticsTest Request Proxy - The proxy to perform the test.
- request
Query Map<String,Object> - Query arguments name and value map.
- 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 arelive,paused. - subtype String
- The subtype of the Synthetic API test. Defaults to
http. Valid values arehttp,ssl,tcp,dns,multi,icmp,udp,websocket,grpc. - 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.
- api
Steps SyntheticsTest Api Step[] - Steps for multistep api tests
- assertions
Synthetics
Test Assertion[] - Assertions used for the test. Multiple
assertionblocks are allowed with the structure below. - browser
Steps SyntheticsTest Browser Step[] - Steps for browser tests.
- browser
Variables SyntheticsTest Browser Variable[] - Variables used for a browser test steps. Multiple
variableblocks are allowed with the structure below. - config
Variables SyntheticsTest Config Variable[] - Variables used for the test configuration. Multiple
config_variableblocks are allowed with the structure below. - device
Ids string[] - Required if
type = "browser". Array with the different device IDs used to run the test. Valid values arelaptop_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
@usernamenotation as events. Defaults to"". - monitor
Id number - ID of the monitor associated with the Datadog synthetics test.
- name string
- Name of Datadog synthetics test.
- options
List SyntheticsTest Options List - request
Basicauth SyntheticsTest Request Basicauth - The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- request
Client SyntheticsCertificate Test Request Client Certificate - Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- request
Definition SyntheticsTest Request Definition - Required if
type = "api". The synthetics test request. - request
Headers {[key: string]: any} - Header name and value map.
- request
Metadata {[key: string]: any} - Metadata to include when performing the gRPC test.
- request
Proxy SyntheticsTest Request Proxy - The proxy to perform the test.
- request
Query {[key: string]: any} - Query arguments name and value map.
- 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 arelive,paused. - subtype string
- The subtype of the Synthetic API test. Defaults to
http. Valid values arehttp,ssl,tcp,dns,multi,icmp,udp,websocket,grpc. - 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[SyntheticsTest Api Step Args] - Steps for multistep api tests
- assertions
Sequence[Synthetics
Test Assertion Args] - Assertions used for the test. Multiple
assertionblocks are allowed with the structure below. - browser_
steps Sequence[SyntheticsTest Browser Step Args] - Steps for browser tests.
- browser_
variables Sequence[SyntheticsTest Browser Variable Args] - Variables used for a browser test steps. Multiple
variableblocks are allowed with the structure below. - config_
variables Sequence[SyntheticsTest Config Variable Args] - Variables used for the test configuration. Multiple
config_variableblocks 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 arelaptop_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
@usernamenotation as events. Defaults to"". - monitor_
id int - ID of the monitor associated with the Datadog synthetics test.
- name str
- Name of Datadog synthetics test.
- options_
list SyntheticsTest Options List Args - request_
basicauth SyntheticsTest Request Basicauth Args - The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- request_
client_ Syntheticscertificate Test Request Client Certificate Args - Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- request_
definition SyntheticsTest Request Definition Args - Required if
type = "api". The synthetics test request. - request_
headers Mapping[str, Any] - Header name and value map.
- request_
metadata Mapping[str, Any] - Metadata to include when performing the gRPC test.
- request_
proxy SyntheticsTest Request Proxy Args - The proxy to perform the test.
- request_
query Mapping[str, Any] - Query arguments name and value map.
- 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 arelive,paused. - subtype str
- The subtype of the Synthetic API test. Defaults to
http. Valid values arehttp,ssl,tcp,dns,multi,icmp,udp,websocket,grpc. - 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.
- api
Steps List<Property Map> - Steps for multistep api tests
- assertions List<Property Map>
- Assertions used for the test. Multiple
assertionblocks are allowed with the structure below. - browser
Steps List<Property Map> - Steps for browser tests.
- browser
Variables List<Property Map> - Variables used for a browser test steps. Multiple
variableblocks are allowed with the structure below. - config
Variables List<Property Map> - Variables used for the test configuration. Multiple
config_variableblocks are allowed with the structure below. - device
Ids List<String> - Required if
type = "browser". Array with the different device IDs used to run the test. Valid values arelaptop_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
@usernamenotation as events. Defaults to"". - monitor
Id Number - ID of the monitor associated with the Datadog synthetics test.
- name String
- Name of Datadog synthetics test.
- options
List Property Map - request
Basicauth Property Map - The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- request
Client Property MapCertificate - Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- request
Definition Property Map - Required if
type = "api". The synthetics test request. - request
Headers Map<Any> - Header name and value map.
- request
Metadata Map<Any> - Metadata to include when performing the gRPC test.
- request
Proxy Property Map - The proxy to perform the test.
- request
Query Map<Any> - Query arguments name and value map.
- 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 arelive,paused. - subtype String
- The subtype of the Synthetic API test. Defaults to
http. Valid values arehttp,ssl,tcp,dns,multi,icmp,udp,websocket,grpc. - 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, SyntheticsTestApiStepArgs
- Name string
- The name of the step.
- Allow
Failure bool - Determines whether or not to continue with test if this step fails.
- Assertions
List<Synthetics
Test Api Step Assertion> - Assertions used for the test. Multiple
assertionblocks are allowed with the structure below. - Extracted
Values List<SyntheticsTest Api Step Extracted Value> - 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_failureistrue. - Request
Basicauth SyntheticsTest Api Step Request Basicauth - The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- Request
Client SyntheticsCertificate Test Api Step Request Client Certificate - Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- Request
Definition SyntheticsTest Api Step Request Definition - The request for the api step.
- Request
Headers Dictionary<string, object> - Header name and value map.
- Request
Proxy SyntheticsTest Api Step Request Proxy - The proxy to perform the test.
- Request
Query Dictionary<string, object> - Query arguments name and value map.
- Retry
Synthetics
Test Api Step Retry - Subtype string
- The subtype of the Synthetic multistep API test step. Valid values are
http,grpc. Defaults to"http".
- Name string
- The name of the step.
- Allow
Failure bool - Determines whether or not to continue with test if this step fails.
- Assertions
[]Synthetics
Test Api Step Assertion - Assertions used for the test. Multiple
assertionblocks are allowed with the structure below. - Extracted
Values []SyntheticsTest Api Step Extracted Value - 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_failureistrue. - Request
Basicauth SyntheticsTest Api Step Request Basicauth - The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- Request
Client SyntheticsCertificate Test Api Step Request Client Certificate - Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- Request
Definition SyntheticsTest Api Step Request Definition - The request for the api step.
- Request
Headers map[string]interface{} - Header name and value map.
- Request
Proxy SyntheticsTest Api Step Request Proxy - The proxy to perform the test.
- Request
Query map[string]interface{} - Query arguments name and value map.
- Retry
Synthetics
Test Api Step Retry - Subtype string
- The subtype of the Synthetic multistep API test step. Valid values are
http,grpc. Defaults to"http".
- name String
- The name of the step.
- allow
Failure Boolean - Determines whether or not to continue with test if this step fails.
- assertions
List<Synthetics
Test Api Step Assertion> - Assertions used for the test. Multiple
assertionblocks are allowed with the structure below. - extracted
Values List<SyntheticsTest Api Step Extracted Value> - Values to parse and save as variables from the response.
- is
Critical Boolean - Determines whether or not to consider the entire test as failed if this step fails. Can be used only if
allow_failureistrue. - request
Basicauth SyntheticsTest Api Step Request Basicauth - The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- request
Client SyntheticsCertificate Test Api Step Request Client Certificate - Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- request
Definition SyntheticsTest Api Step Request Definition - The request for the api step.
- request
Headers Map<String,Object> - Header name and value map.
- request
Proxy SyntheticsTest Api Step Request Proxy - The proxy to perform the test.
- request
Query Map<String,Object> - Query arguments name and value map.
- retry
Synthetics
Test Api Step Retry - subtype String
- The subtype of the Synthetic multistep API test step. Valid values are
http,grpc. Defaults to"http".
- name string
- The name of the step.
- allow
Failure boolean - Determines whether or not to continue with test if this step fails.
- assertions
Synthetics
Test Api Step Assertion[] - Assertions used for the test. Multiple
assertionblocks are allowed with the structure below. - extracted
Values SyntheticsTest Api Step Extracted Value[] - Values to parse and save as variables from the response.
- is
Critical boolean - Determines whether or not to consider the entire test as failed if this step fails. Can be used only if
allow_failureistrue. - request
Basicauth SyntheticsTest Api Step Request Basicauth - The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- request
Client SyntheticsCertificate Test Api Step Request Client Certificate - Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- request
Definition SyntheticsTest Api Step Request Definition - The request for the api step.
- request
Headers {[key: string]: any} - Header name and value map.
- request
Proxy SyntheticsTest Api Step Request Proxy - The proxy to perform the test.
- request
Query {[key: string]: any} - Query arguments name and value map.
- retry
Synthetics
Test Api Step Retry - subtype string
- The subtype of the Synthetic multistep API test step. Valid values are
http,grpc. Defaults to"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[Synthetics
Test Api Step Assertion] - Assertions used for the test. Multiple
assertionblocks are allowed with the structure below. - extracted_
values Sequence[SyntheticsTest Api Step Extracted Value] - 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_failureistrue. - request_
basicauth SyntheticsTest Api Step Request Basicauth - The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- request_
client_ Syntheticscertificate Test Api Step Request Client Certificate - Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- request_
definition SyntheticsTest Api Step Request Definition - The request for the api step.
- request_
headers Mapping[str, Any] - Header name and value map.
- request_
proxy SyntheticsTest Api Step Request Proxy - The proxy to perform the test.
- request_
query Mapping[str, Any] - Query arguments name and value map.
- retry
Synthetics
Test Api Step Retry - subtype str
- The subtype of the Synthetic multistep API test step. Valid values are
http,grpc. Defaults to"http".
- name String
- The name of the step.
- allow
Failure Boolean - Determines whether or not to continue with test if this step fails.
- assertions List<Property Map>
- Assertions used for the test. Multiple
assertionblocks are allowed with the structure below. - extracted
Values List<Property Map> - Values to parse and save as variables from the response.
- is
Critical Boolean - Determines whether or not to consider the entire test as failed if this step fails. Can be used only if
allow_failureistrue. - request
Basicauth Property Map - The HTTP basic authentication credentials. Exactly one nested block is allowed with the structure below.
- request
Client Property MapCertificate - Client certificate to use when performing the test request. Exactly one nested block is allowed with the structure below.
- request
Definition Property Map - The request for the api step.
- request
Headers Map<Any> - Header name and value map.
- request
Proxy Property Map - The proxy to perform the test.
- request
Query 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,grpc. Defaults to"http".
SyntheticsTestApiStepAssertion, SyntheticsTestApiStepAssertionArgs
- Operator string
- Assertion operator. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). - Type string
- Type of assertion. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). Valid values arebody,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
Synthetics
Test Api Step Assertion Targetjsonpath - Expected structure if
operatorisvalidatesJSONPath. Exactly one nested block is allowed with the structure below. - Targetxpath
Synthetics
Test Api Step Assertion Targetxpath - Expected structure if
operatorisvalidatesXPath. Exactly one nested block is allowed with the structure below. - Timings
Scope string - Timings scope for response time assertions. Valid values are
all,withoutDNS.
- Operator string
- Assertion operator. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). - Type string
- Type of assertion. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). Valid values arebody,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
Synthetics
Test Api Step Assertion Targetjsonpath - Expected structure if
operatorisvalidatesJSONPath. Exactly one nested block is allowed with the structure below. - Targetxpath
Synthetics
Test Api Step Assertion Targetxpath - Expected structure if
operatorisvalidatesXPath. Exactly one nested block is allowed with the structure below. - Timings
Scope string - Timings scope for response time assertions. Valid values are
all,withoutDNS.
- operator String
- Assertion operator. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). - type String
- Type of assertion. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). Valid values arebody,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
Synthetics
Test Api Step Assertion Targetjsonpath - Expected structure if
operatorisvalidatesJSONPath. Exactly one nested block is allowed with the structure below. - targetxpath
Synthetics
Test Api Step Assertion Targetxpath - Expected structure if
operatorisvalidatesXPath. Exactly one nested block is allowed with the structure below. - timings
Scope String - Timings scope for response time assertions. Valid values are
all,withoutDNS.
- operator string
- Assertion operator. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). - type string
- Type of assertion. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). Valid values arebody,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
Synthetics
Test Api Step Assertion Targetjsonpath - Expected structure if
operatorisvalidatesJSONPath. Exactly one nested block is allowed with the structure below. - targetxpath
Synthetics
Test Api Step Assertion Targetxpath - Expected structure if
operatorisvalidatesXPath. Exactly one nested block is allowed with the structure below. - timings
Scope string - Timings scope for response time assertions. Valid values are
all,withoutDNS.
- operator str
- Assertion operator. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). - type str
- Type of assertion. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). Valid values arebody,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
Synthetics
Test Api Step Assertion Targetjsonpath - Expected structure if
operatorisvalidatesJSONPath. Exactly one nested block is allowed with the structure below. - targetxpath
Synthetics
Test Api Step Assertion Targetxpath - Expected structure if
operatorisvalidatesXPath. Exactly one nested block is allowed with the structure below. - timings_
scope str - Timings scope for response time assertions. Valid values are
all,withoutDNS.
- operator String
- Assertion operator. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). - type String
- Type of assertion. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). Valid values arebody,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
operatorisvalidatesJSONPath. Exactly one nested block is allowed with the structure below. - targetxpath Property Map
- Expected structure if
operatorisvalidatesXPath. Exactly one nested block is allowed with the structure below. - timings
Scope String - Timings scope for response time assertions. Valid values are
all,withoutDNS.
SyntheticsTestApiStepAssertionTargetjsonpath, SyntheticsTestApiStepAssertionTargetjsonpathArgs
- Jsonpath string
- The JSON path to assert.
- Operator string
- The specific operator to use on the path.
- Targetvalue string
- Expected matching value.
- Jsonpath string
- The JSON path to assert.
- Operator string
- The specific operator to use on the path.
- Targetvalue string
- Expected matching value.
- jsonpath String
- The JSON path to assert.
- operator String
- The specific operator to use on the path.
- targetvalue String
- Expected matching value.
- jsonpath string
- The JSON path to assert.
- operator string
- The specific operator to use on the path.
- targetvalue string
- Expected matching value.
- jsonpath str
- The JSON path to assert.
- operator str
- The specific operator to use on the path.
- targetvalue str
- Expected matching value.
- jsonpath String
- The JSON path to assert.
- operator String
- The specific operator to use on the path.
- targetvalue String
- Expected matching value.
SyntheticsTestApiStepAssertionTargetxpath, SyntheticsTestApiStepAssertionTargetxpathArgs
- Operator string
- The specific operator to use on the path.
- Xpath string
- The xpath to assert.
- Targetvalue string
- Expected matching value.
- Operator string
- The specific operator to use on the path.
- Xpath string
- The xpath to assert.
- Targetvalue string
- Expected matching value.
- operator String
- The specific operator to use on the path.
- xpath String
- The xpath to assert.
- targetvalue String
- Expected matching value.
- operator string
- The specific operator to use on the path.
- xpath string
- The xpath to assert.
- targetvalue string
- Expected matching value.
- operator str
- The specific operator to use on the path.
- xpath str
- The xpath to assert.
- targetvalue str
- Expected matching value.
- operator String
- The specific operator to use on the path.
- xpath String
- The xpath to assert.
- targetvalue String
- Expected matching value.
SyntheticsTestApiStepExtractedValue, SyntheticsTestApiStepExtractedValueArgs
- Name string
- Parser
Synthetics
Test Api Step Extracted Value Parser - Type string
- Property of the Synthetics Test Response to use for the variable. Valid values are
http_body,http_header,local_variable. - Field string
- When type is
http_header, name of the header to use to extract the value. - Secure bool
- Determines whether or not the extracted value will be obfuscated.
- Name string
- Parser
Synthetics
Test Api Step Extracted Value Parser - Type string
- Property of the Synthetics Test Response to use for the variable. Valid values are
http_body,http_header,local_variable. - Field string
- When type is
http_header, name of the header to use to extract the value. - Secure bool
- Determines whether or not the extracted value will be obfuscated.
- name String
- parser
Synthetics
Test Api Step Extracted Value Parser - type String
- Property of the Synthetics Test Response to use for the variable. Valid values are
http_body,http_header,local_variable. - field String
- When type is
http_header, name of the header to use to extract the value. - secure Boolean
- Determines whether or not the extracted value will be obfuscated.
- name string
- parser
Synthetics
Test Api Step Extracted Value Parser - type string
- Property of the Synthetics Test Response to use for the variable. Valid values are
http_body,http_header,local_variable. - field string
- When type is
http_header, name of the header to use to extract the value. - secure boolean
- Determines whether or not the extracted value will be obfuscated.
- name str
- parser
Synthetics
Test Api Step Extracted Value Parser - type str
- Property of the Synthetics Test Response to use for the variable. Valid values are
http_body,http_header,local_variable. - field str
- When type is
http_header, name of the header to use to extract the value. - secure bool
- Determines whether or not the extracted value will be obfuscated.
- name String
- parser Property Map
- type String
- Property of the Synthetics Test Response to use for the variable. Valid values are
http_body,http_header,local_variable. - field String
- When type is
http_header, name of the header to use to extract the value. - secure Boolean
- Determines whether or not the extracted value will be obfuscated.
SyntheticsTestApiStepExtractedValueParser, SyntheticsTestApiStepExtractedValueParserArgs
SyntheticsTestApiStepRequestBasicauth, SyntheticsTestApiStepRequestBasicauthArgs
- Access
Key string - Access key for
SIGV4authentication. - Access
Token stringUrl - Access token url for
oauth-clientoroauth-ropauthentication. - Audience string
- Audience for
oauth-clientoroauth-ropauthentication. Defaults to"". - Client
Id string - Client ID for
oauth-clientoroauth-ropauthentication. - Client
Secret string - Client secret for
oauth-clientoroauth-ropauthentication. - Domain string
- Domain for
ntlmauthentication. - Password string
- Password for authentication.
- Region string
- Region for
SIGV4authentication. - Resource string
- Resource for
oauth-clientoroauth-ropauthentication. Defaults to"". - Scope string
- Scope for
oauth-clientoroauth-ropauthentication. Defaults to"". - Secret
Key string - Secret key for
SIGV4authentication. - Service
Name string - Service name for
SIGV4authentication. - Session
Token string - Session token for
SIGV4authentication. - Token
Api stringAuthentication - Token API Authentication for
oauth-clientoroauth-ropauthentication. Valid values areheader,body. - Type string
- Type of basic authentication to use when performing the test. Defaults to
"web". - Username string
- Username for authentication.
- Workstation string
- Workstation for
ntlmauthentication.
- Access
Key string - Access key for
SIGV4authentication. - Access
Token stringUrl - Access token url for
oauth-clientoroauth-ropauthentication. - Audience string
- Audience for
oauth-clientoroauth-ropauthentication. Defaults to"". - Client
Id string - Client ID for
oauth-clientoroauth-ropauthentication. - Client
Secret string - Client secret for
oauth-clientoroauth-ropauthentication. - Domain string
- Domain for
ntlmauthentication. - Password string
- Password for authentication.
- Region string
- Region for
SIGV4authentication. - Resource string
- Resource for
oauth-clientoroauth-ropauthentication. Defaults to"". - Scope string
- Scope for
oauth-clientoroauth-ropauthentication. Defaults to"". - Secret
Key string - Secret key for
SIGV4authentication. - Service
Name string - Service name for
SIGV4authentication. - Session
Token string - Session token for
SIGV4authentication. - Token
Api stringAuthentication - Token API Authentication for
oauth-clientoroauth-ropauthentication. Valid values areheader,body. - Type string
- Type of basic authentication to use when performing the test. Defaults to
"web". - Username string
- Username for authentication.
- Workstation string
- Workstation for
ntlmauthentication.
- access
Key String - Access key for
SIGV4authentication. - access
Token StringUrl - Access token url for
oauth-clientoroauth-ropauthentication. - audience String
- Audience for
oauth-clientoroauth-ropauthentication. Defaults to"". - client
Id String - Client ID for
oauth-clientoroauth-ropauthentication. - client
Secret String - Client secret for
oauth-clientoroauth-ropauthentication. - domain String
- Domain for
ntlmauthentication. - password String
- Password for authentication.
- region String
- Region for
SIGV4authentication. - resource String
- Resource for
oauth-clientoroauth-ropauthentication. Defaults to"". - scope String
- Scope for
oauth-clientoroauth-ropauthentication. Defaults to"". - secret
Key String - Secret key for
SIGV4authentication. - service
Name String - Service name for
SIGV4authentication. - session
Token String - Session token for
SIGV4authentication. - token
Api StringAuthentication - Token API Authentication for
oauth-clientoroauth-ropauthentication. Valid values areheader,body. - type String
- Type of basic authentication to use when performing the test. Defaults to
"web". - username String
- Username for authentication.
- workstation String
- Workstation for
ntlmauthentication.
- access
Key string - Access key for
SIGV4authentication. - access
Token stringUrl - Access token url for
oauth-clientoroauth-ropauthentication. - audience string
- Audience for
oauth-clientoroauth-ropauthentication. Defaults to"". - client
Id string - Client ID for
oauth-clientoroauth-ropauthentication. - client
Secret string - Client secret for
oauth-clientoroauth-ropauthentication. - domain string
- Domain for
ntlmauthentication. - password string
- Password for authentication.
- region string
- Region for
SIGV4authentication. - resource string
- Resource for
oauth-clientoroauth-ropauthentication. Defaults to"". - scope string
- Scope for
oauth-clientoroauth-ropauthentication. Defaults to"". - secret
Key string - Secret key for
SIGV4authentication. - service
Name string - Service name for
SIGV4authentication. - session
Token string - Session token for
SIGV4authentication. - token
Api stringAuthentication - Token API Authentication for
oauth-clientoroauth-ropauthentication. Valid values areheader,body. - type string
- Type of basic authentication to use when performing the test. Defaults to
"web". - username string
- Username for authentication.
- workstation string
- Workstation for
ntlmauthentication.
- access_
key str - Access key for
SIGV4authentication. - access_
token_ strurl - Access token url for
oauth-clientoroauth-ropauthentication. - audience str
- Audience for
oauth-clientoroauth-ropauthentication. Defaults to"". - client_
id str - Client ID for
oauth-clientoroauth-ropauthentication. - client_
secret str - Client secret for
oauth-clientoroauth-ropauthentication. - domain str
- Domain for
ntlmauthentication. - password str
- Password for authentication.
- region str
- Region for
SIGV4authentication. - resource str
- Resource for
oauth-clientoroauth-ropauthentication. Defaults to"". - scope str
- Scope for
oauth-clientoroauth-ropauthentication. Defaults to"". - secret_
key str - Secret key for
SIGV4authentication. - service_
name str - Service name for
SIGV4authentication. - session_
token str - Session token for
SIGV4authentication. - token_
api_ strauthentication - Token API Authentication for
oauth-clientoroauth-ropauthentication. Valid values areheader,body. - type str
- Type of basic authentication to use when performing the test. Defaults to
"web". - username str
- Username for authentication.
- workstation str
- Workstation for
ntlmauthentication.
- access
Key String - Access key for
SIGV4authentication. - access
Token StringUrl - Access token url for
oauth-clientoroauth-ropauthentication. - audience String
- Audience for
oauth-clientoroauth-ropauthentication. Defaults to"". - client
Id String - Client ID for
oauth-clientoroauth-ropauthentication. - client
Secret String - Client secret for
oauth-clientoroauth-ropauthentication. - domain String
- Domain for
ntlmauthentication. - password String
- Password for authentication.
- region String
- Region for
SIGV4authentication. - resource String
- Resource for
oauth-clientoroauth-ropauthentication. Defaults to"". - scope String
- Scope for
oauth-clientoroauth-ropauthentication. Defaults to"". - secret
Key String - Secret key for
SIGV4authentication. - service
Name String - Service name for
SIGV4authentication. - session
Token String - Session token for
SIGV4authentication. - token
Api StringAuthentication - Token API Authentication for
oauth-clientoroauth-ropauthentication. Valid values areheader,body. - type String
- Type of basic authentication to use when performing the test. Defaults to
"web". - username String
- Username for authentication.
- workstation String
- Workstation for
ntlmauthentication.
SyntheticsTestApiStepRequestClientCertificate, SyntheticsTestApiStepRequestClientCertificateArgs
SyntheticsTestApiStepRequestClientCertificateCert, SyntheticsTestApiStepRequestClientCertificateCertArgs
SyntheticsTestApiStepRequestClientCertificateKey, SyntheticsTestApiStepRequestClientCertificateKeyArgs
SyntheticsTestApiStepRequestDefinition, SyntheticsTestApiStepRequestDefinitionArgs
- Allow
Insecure bool - Allows loading insecure content for an HTTP request in an API test or in a multistep API test step.
- Body string
- The request body.
- Body
Type string - Type of the request body. Valid values are
text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data. - Call
Type string - The type of gRPC call to perform. Valid values are
healthcheck,unary. - Certificate
Domains 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. - Dns
Server string - DNS server to use for DNS tests (
subtype = "dns"). - Dns
Server intPort - DNS server port to use for DNS tests.
- Follow
Redirects bool - Determines whether or not the API HTTP test should follow redirects.
- Host string
- Host name to perform the test with.
- Http
Version string - HTTP version to use for an HTTP request in an API test or step. Valid values are
http1,http2,any. - 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
servicefield. Required ifsubtypeisHTTPor ifsubtypeisgrpcandcallTypeisunary. - No
Saving boolResponse Body - Determines whether or not to save the response body.
- Number
Of intPackets - Number of pings to use per test for ICMP tests (
subtype = "icmp") between 0 and 10. - bool
- Persist cookies across redirects.
- Plain
Proto stringFile - The content of a proto file as a string.
- Port int
- Port to use when performing the test.
- Proto
Json stringDescriptor - A protobuf JSON descriptor. Deprecated. Use
plain_proto_fileinstead. - 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.
- Should
Track boolHops - 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.
- Allow
Insecure bool - Allows loading insecure content for an HTTP request in an API test or in a multistep API test step.
- Body string
- The request body.
- Body
Type string - Type of the request body. Valid values are
text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data. - Call
Type string - The type of gRPC call to perform. Valid values are
healthcheck,unary. - Certificate
Domains []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. - Dns
Server string - DNS server to use for DNS tests (
subtype = "dns"). - Dns
Server intPort - DNS server port to use for DNS tests.
- Follow
Redirects bool - Determines whether or not the API HTTP test should follow redirects.
- Host string
- Host name to perform the test with.
- Http
Version string - HTTP version to use for an HTTP request in an API test or step. Valid values are
http1,http2,any. - 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
servicefield. Required ifsubtypeisHTTPor ifsubtypeisgrpcandcallTypeisunary. - No
Saving boolResponse Body - Determines whether or not to save the response body.
- Number
Of intPackets - Number of pings to use per test for ICMP tests (
subtype = "icmp") between 0 and 10. - bool
- Persist cookies across redirects.
- Plain
Proto stringFile - The content of a proto file as a string.
- Port int
- Port to use when performing the test.
- Proto
Json stringDescriptor - A protobuf JSON descriptor. Deprecated. Use
plain_proto_fileinstead. - 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.
- Should
Track boolHops - 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.
- allow
Insecure Boolean - Allows loading insecure content for an HTTP request in an API test or in a multistep API test step.
- body String
- The request body.
- body
Type String - Type of the request body. Valid values are
text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data. - call
Type String - The type of gRPC call to perform. Valid values are
healthcheck,unary. - certificate
Domains 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. - dns
Server String - DNS server to use for DNS tests (
subtype = "dns"). - dns
Server IntegerPort - DNS server port to use for DNS tests.
- follow
Redirects Boolean - Determines whether or not the API HTTP test should follow redirects.
- host String
- Host name to perform the test with.
- http
Version String - HTTP version to use for an HTTP request in an API test or step. Valid values are
http1,http2,any. - 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
servicefield. Required ifsubtypeisHTTPor ifsubtypeisgrpcandcallTypeisunary. - no
Saving BooleanResponse Body - Determines whether or not to save the response body.
- number
Of IntegerPackets - Number of pings to use per test for ICMP tests (
subtype = "icmp") between 0 and 10. - Boolean
- Persist cookies across redirects.
- plain
Proto StringFile - The content of a proto file as a string.
- port Integer
- Port to use when performing the test.
- proto
Json StringDescriptor - A protobuf JSON descriptor. Deprecated. Use
plain_proto_fileinstead. - 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.
- should
Track BooleanHops - 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.
- allow
Insecure boolean - Allows loading insecure content for an HTTP request in an API test or in a multistep API test step.
- body string
- The request body.
- body
Type string - Type of the request body. Valid values are
text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data. - call
Type string - The type of gRPC call to perform. Valid values are
healthcheck,unary. - certificate
Domains 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. - dns
Server string - DNS server to use for DNS tests (
subtype = "dns"). - dns
Server numberPort - DNS server port to use for DNS tests.
- follow
Redirects boolean - Determines whether or not the API HTTP test should follow redirects.
- host string
- Host name to perform the test with.
- http
Version string - HTTP version to use for an HTTP request in an API test or step. Valid values are
http1,http2,any. - 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
servicefield. Required ifsubtypeisHTTPor ifsubtypeisgrpcandcallTypeisunary. - no
Saving booleanResponse Body - Determines whether or not to save the response body.
- number
Of numberPackets - Number of pings to use per test for ICMP tests (
subtype = "icmp") between 0 and 10. - boolean
- Persist cookies across redirects.
- plain
Proto stringFile - The content of a proto file as a string.
- port number
- Port to use when performing the test.
- proto
Json stringDescriptor - A protobuf JSON descriptor. Deprecated. Use
plain_proto_fileinstead. - 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.
- should
Track booleanHops - 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 - Allows loading insecure content for an HTTP request in an API test or in a multistep API test step.
- 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,application/octet-stream,multipart/form-data. - 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_ intport - DNS server port to use for DNS tests.
- follow_
redirects bool - Determines whether or not the API HTTP test should follow redirects.
- host str
- Host name to perform the test with.
- http_
version str - HTTP version to use for an HTTP request in an API test or step. Valid values are
http1,http2,any. - 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
servicefield. Required ifsubtypeisHTTPor ifsubtypeisgrpcandcallTypeisunary. - no_
saving_ boolresponse_ body - Determines whether or not to save the response body.
- number_
of_ intpackets - Number of pings to use per test for ICMP tests (
subtype = "icmp") between 0 and 10. - bool
- Persist cookies across redirects.
- plain_
proto_ strfile - The content of a proto file as a string.
- port int
- Port to use when performing the test.
- proto_
json_ strdescriptor - A protobuf JSON descriptor. Deprecated. Use
plain_proto_fileinstead. - 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_ boolhops - 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.
- allow
Insecure Boolean - Allows loading insecure content for an HTTP request in an API test or in a multistep API test step.
- body String
- The request body.
- body
Type String - Type of the request body. Valid values are
text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data. - call
Type String - The type of gRPC call to perform. Valid values are
healthcheck,unary. - certificate
Domains 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. - dns
Server String - DNS server to use for DNS tests (
subtype = "dns"). - dns
Server NumberPort - DNS server port to use for DNS tests.
- follow
Redirects Boolean - Determines whether or not the API HTTP test should follow redirects.
- host String
- Host name to perform the test with.
- http
Version String - HTTP version to use for an HTTP request in an API test or step. Valid values are
http1,http2,any. - 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
servicefield. Required ifsubtypeisHTTPor ifsubtypeisgrpcandcallTypeisunary. - no
Saving BooleanResponse Body - Determines whether or not to save the response body.
- number
Of NumberPackets - Number of pings to use per test for ICMP tests (
subtype = "icmp") between 0 and 10. - Boolean
- Persist cookies across redirects.
- plain
Proto StringFile - The content of a proto file as a string.
- port Number
- Port to use when performing the test.
- proto
Json StringDescriptor - A protobuf JSON descriptor. Deprecated. Use
plain_proto_fileinstead. - 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.
- should
Track BooleanHops - 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, SyntheticsTestApiStepRequestProxyArgs
SyntheticsTestApiStepRetry, SyntheticsTestApiStepRetryArgs
SyntheticsTestAssertion, SyntheticsTestAssertionArgs
- Operator string
- Assertion operator. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). - Type string
- Type of assertion. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). Valid values arebody,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
Synthetics
Test Assertion Targetjsonpath - Expected structure if
operatorisvalidatesJSONPath. Exactly one nested block is allowed with the structure below. - Targetxpath
Synthetics
Test Assertion Targetxpath - Expected structure if
operatorisvalidatesXPath. Exactly one nested block is allowed with the structure below. - Timings
Scope string - Timings scope for response time assertions. Valid values are
all,withoutDNS.
- Operator string
- Assertion operator. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). - Type string
- Type of assertion. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). Valid values arebody,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
Synthetics
Test Assertion Targetjsonpath - Expected structure if
operatorisvalidatesJSONPath. Exactly one nested block is allowed with the structure below. - Targetxpath
Synthetics
Test Assertion Targetxpath - Expected structure if
operatorisvalidatesXPath. Exactly one nested block is allowed with the structure below. - Timings
Scope string - Timings scope for response time assertions. Valid values are
all,withoutDNS.
- operator String
- Assertion operator. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). - type String
- Type of assertion. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). Valid values arebody,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
Synthetics
Test Assertion Targetjsonpath - Expected structure if
operatorisvalidatesJSONPath. Exactly one nested block is allowed with the structure below. - targetxpath
Synthetics
Test Assertion Targetxpath - Expected structure if
operatorisvalidatesXPath. Exactly one nested block is allowed with the structure below. - timings
Scope String - Timings scope for response time assertions. Valid values are
all,withoutDNS.
- operator string
- Assertion operator. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). - type string
- Type of assertion. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). Valid values arebody,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
Synthetics
Test Assertion Targetjsonpath - Expected structure if
operatorisvalidatesJSONPath. Exactly one nested block is allowed with the structure below. - targetxpath
Synthetics
Test Assertion Targetxpath - Expected structure if
operatorisvalidatesXPath. Exactly one nested block is allowed with the structure below. - timings
Scope string - Timings scope for response time assertions. Valid values are
all,withoutDNS.
- operator str
- Assertion operator. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). - type str
- Type of assertion. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). Valid values arebody,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
Synthetics
Test Assertion Targetjsonpath - Expected structure if
operatorisvalidatesJSONPath. Exactly one nested block is allowed with the structure below. - targetxpath
Synthetics
Test Assertion Targetxpath - Expected structure if
operatorisvalidatesXPath. Exactly one nested block is allowed with the structure below. - timings_
scope str - Timings scope for response time assertions. Valid values are
all,withoutDNS.
- operator String
- Assertion operator. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). - type String
- Type of assertion. Note Only some combinations of
typeandoperatorare valid (please refer to Datadog documentation). Valid values arebody,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
operatorisvalidatesJSONPath. Exactly one nested block is allowed with the structure below. - targetxpath Property Map
- Expected structure if
operatorisvalidatesXPath. Exactly one nested block is allowed with the structure below. - timings
Scope String - Timings scope for response time assertions. Valid values are
all,withoutDNS.
SyntheticsTestAssertionTargetjsonpath, SyntheticsTestAssertionTargetjsonpathArgs
- Jsonpath string
- The JSON path to assert.
- Operator string
- The specific operator to use on the path.
- Targetvalue string
- Expected matching value.
- Jsonpath string
- The JSON path to assert.
- Operator string
- The specific operator to use on the path.
- Targetvalue string
- Expected matching value.
- jsonpath String
- The JSON path to assert.
- operator String
- The specific operator to use on the path.
- targetvalue String
- Expected matching value.
- jsonpath string
- The JSON path to assert.
- operator string
- The specific operator to use on the path.
- targetvalue string
- Expected matching value.
- jsonpath str
- The JSON path to assert.
- operator str
- The specific operator to use on the path.
- targetvalue str
- Expected matching value.
- jsonpath String
- The JSON path to assert.
- operator String
- The specific operator to use on the path.
- targetvalue String
- Expected matching value.
SyntheticsTestAssertionTargetxpath, SyntheticsTestAssertionTargetxpathArgs
- Operator string
- The specific operator to use on the path.
- Xpath string
- The xpath to assert.
- Targetvalue string
- Expected matching value.
- Operator string
- The specific operator to use on the path.
- Xpath string
- The xpath to assert.
- Targetvalue string
- Expected matching value.
- operator String
- The specific operator to use on the path.
- xpath String
- The xpath to assert.
- targetvalue String
- Expected matching value.
- operator string
- The specific operator to use on the path.
- xpath string
- The xpath to assert.
- targetvalue string
- Expected matching value.
- operator str
- The specific operator to use on the path.
- xpath str
- The xpath to assert.
- targetvalue str
- Expected matching value.
- operator String
- The specific operator to use on the path.
- xpath String
- The xpath to assert.
- targetvalue String
- Expected matching value.
SyntheticsTestBrowserStep, SyntheticsTestBrowserStepArgs
- Name string
- Name of the step.
- Params
Synthetics
Test Browser Step Params - 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. - Allow
Failure bool - Determines if the step should be allowed to fail.
- Force
Element boolUpdate - 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_failureistrue. - 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
Synthetics
Test Browser Step Params - 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. - Allow
Failure bool - Determines if the step should be allowed to fail.
- Force
Element boolUpdate - 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_failureistrue. - 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
Synthetics
Test Browser Step Params - 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. - allow
Failure Boolean - Determines if the step should be allowed to fail.
- force
Element BooleanUpdate - Force update of the "element" parameter for the step
- is
Critical Boolean - Determines whether or not to consider the entire test as failed if this step fails. Can be used only if
allow_failureistrue. - no
Screenshot 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
Synthetics
Test Browser Step Params - 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. - allow
Failure boolean - Determines if the step should be allowed to fail.
- force
Element booleanUpdate - Force update of the "element" parameter for the step
- is
Critical boolean - Determines whether or not to consider the entire test as failed if this step fails. Can be used only if
allow_failureistrue. - no
Screenshot 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
Synthetics
Test Browser Step Params - 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_ boolupdate - 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_failureistrue. - 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. - allow
Failure Boolean - Determines if the step should be allowed to fail.
- force
Element BooleanUpdate - Force update of the "element" parameter for the step
- is
Critical Boolean - Determines whether or not to consider the entire test as failed if this step fails. Can be used only if
allow_failureistrue. - no
Screenshot Boolean - Prevents saving screenshots of the step.
- timeout Number
- Used to override the default timeout of a step.
SyntheticsTestBrowserStepParams, SyntheticsTestBrowserStepParamsArgs
- Attribute string
- Name of the attribute to use for an "assert attribute" step.
- Check string
- Check type to use for an assertion step. Valid values are
equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty. - Click
Type string - Type of click to use for a "click" step.
- Code string
- Javascript code to use for the step.
- Delay int
- Delay between each key stroke for a "type test" step.
- Element string
- Element to use for the step, json encoded string.
- Element
User SyntheticsLocator Test Browser Step Params Element User Locator - Custom user selector to use for the step.
- Email string
- Details of the email for an "assert email" step.
- File string
- JSON encoded string used for an "assert download" step. Refer to the examples for a usage example showing the schema.
- Files string
- Details of the files for an "upload files" step, json encoded string.
- Modifiers List<string>
- Modifier to use for a "press key" step.
- Playing
Tab stringId - ID of the tab to play the subtest.
- Request string
- Request for an API step.
- Subtest
Public stringId - ID of the Synthetics test to use as subtest.
- Value string
- Value of the step.
- Variable
Synthetics
Test Browser Step Params Variable - Details of the variable to extract.
- With
Click bool - For "file upload" steps.
- X int
- X coordinates for a "scroll step".
- Y int
- Y coordinates for a "scroll step".
- Attribute string
- Name of the attribute to use for an "assert attribute" step.
- Check string
- Check type to use for an assertion step. Valid values are
equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty. - Click
Type string - Type of click to use for a "click" step.
- Code string
- Javascript code to use for the step.
- Delay int
- Delay between each key stroke for a "type test" step.
- Element string
- Element to use for the step, json encoded string.
- Element
User SyntheticsLocator Test Browser Step Params Element User Locator - Custom user selector to use for the step.
- Email string
- Details of the email for an "assert email" step.
- File string
- JSON encoded string used for an "assert download" step. Refer to the examples for a usage example showing the schema.
- Files string
- Details of the files for an "upload files" step, json encoded string.
- Modifiers []string
- Modifier to use for a "press key" step.
- Playing
Tab stringId - ID of the tab to play the subtest.
- Request string
- Request for an API step.
- Subtest
Public stringId - ID of the Synthetics test to use as subtest.
- Value string
- Value of the step.
- Variable
Synthetics
Test Browser Step Params Variable - Details of the variable to extract.
- With
Click bool - For "file upload" steps.
- X int
- X coordinates for a "scroll step".
- Y int
- Y coordinates for a "scroll step".
- attribute String
- Name of the attribute to use for an "assert attribute" step.
- check String
- Check type to use for an assertion step. Valid values are
equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty. - click
Type String - Type of click to use for a "click" step.
- code String
- Javascript code to use for the step.
- delay Integer
- Delay between each key stroke for a "type test" step.
- element String
- Element to use for the step, json encoded string.
- element
User SyntheticsLocator Test Browser Step Params Element User Locator - Custom user selector to use for the step.
- email String
- Details of the email for an "assert email" step.
- file String
- JSON encoded string used for an "assert download" step. Refer to the examples for a usage example showing the schema.
- files String
- Details of the files for an "upload files" step, json encoded string.
- modifiers List<String>
- Modifier to use for a "press key" step.
- playing
Tab StringId - ID of the tab to play the subtest.
- request String
- Request for an API step.
- subtest
Public StringId - ID of the Synthetics test to use as subtest.
- value String
- Value of the step.
- variable
Synthetics
Test Browser Step Params Variable - Details of the variable to extract.
- with
Click Boolean - For "file upload" steps.
- x Integer
- X coordinates for a "scroll step".
- y Integer
- Y coordinates for a "scroll step".
- attribute string
- Name of the attribute to use for an "assert attribute" step.
- check string
- Check type to use for an assertion step. Valid values are
equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty. - click
Type string - Type of click to use for a "click" step.
- code string
- Javascript code to use for the step.
- delay number
- Delay between each key stroke for a "type test" step.
- element string
- Element to use for the step, json encoded string.
- element
User SyntheticsLocator Test Browser Step Params Element User Locator - Custom user selector to use for the step.
- email string
- Details of the email for an "assert email" step.
- file string
- JSON encoded string used for an "assert download" step. Refer to the examples for a usage example showing the schema.
- files string
- Details of the files for an "upload files" step, json encoded string.
- modifiers string[]
- Modifier to use for a "press key" step.
- playing
Tab stringId - ID of the tab to play the subtest.
- request string
- Request for an API step.
- subtest
Public stringId - ID of the Synthetics test to use as subtest.
- value string
- Value of the step.
- variable
Synthetics
Test Browser Step Params Variable - Details of the variable to extract.
- with
Click boolean - For "file upload" steps.
- x number
- X coordinates for a "scroll step".
- y number
- Y coordinates for a "scroll step".
- attribute str
- Name of the attribute to use for an "assert attribute" step.
- check str
- Check type to use for an assertion step. Valid values are
equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty. - click_
type str - Type of click to use for a "click" step.
- code str
- Javascript code to use for the step.
- delay int
- Delay between each key stroke for a "type test" step.
- element str
- Element to use for the step, json encoded string.
- element_
user_ Syntheticslocator Test Browser Step Params Element User Locator - Custom user selector to use for the step.
- email str
- Details of the email for an "assert email" step.
- file str
- JSON encoded string used for an "assert download" step. Refer to the examples for a usage example showing the schema.
- files str
- Details of the files for an "upload files" step, json encoded string.
- modifiers Sequence[str]
- Modifier to use for a "press key" step.
- playing_
tab_ strid - ID of the tab to play the subtest.
- request str
- Request for an API step.
- subtest_
public_ strid - ID of the Synthetics test to use as subtest.
- value str
- Value of the step.
- variable
Synthetics
Test Browser Step Params Variable - Details of the variable to extract.
- with_
click bool - For "file upload" steps.
- x int
- X coordinates for a "scroll step".
- y int
- Y coordinates for a "scroll step".
- attribute String
- Name of the attribute to use for an "assert attribute" step.
- check String
- Check type to use for an assertion step. Valid values are
equals,notEquals,contains,notContains,startsWith,notStartsWith,greater,lower,greaterEquals,lowerEquals,matchRegex,between,isEmpty,notIsEmpty. - click
Type String - Type of click to use for a "click" step.
- code String
- Javascript code to use for the step.
- delay Number
- Delay between each key stroke for a "type test" step.
- element String
- Element to use for the step, json encoded string.
- element
User Property MapLocator - Custom user selector to use for the step.
- email String
- Details of the email for an "assert email" step.
- file String
- JSON encoded string used for an "assert download" step. Refer to the examples for a usage example showing the schema.
- files String
- Details of the files for an "upload files" step, json encoded string.
- modifiers List<String>
- Modifier to use for a "press key" step.
- playing
Tab StringId - ID of the tab to play the subtest.
- request String
- Request for an API step.
- subtest
Public StringId - ID of the Synthetics test to use as subtest.
- value String
- Value of the step.
- variable Property Map
- Details of the variable to extract.
- with
Click Boolean - For "file upload" steps.
- x Number
- X coordinates for a "scroll step".
- y Number
- Y coordinates for a "scroll step".
SyntheticsTestBrowserStepParamsElementUserLocator, SyntheticsTestBrowserStepParamsElementUserLocatorArgs
- Value
Synthetics
Test Browser Step Params Element User Locator Value - Fail
Test boolOn Cannot Locate - Defaults to
false.
- Value
Synthetics
Test Browser Step Params Element User Locator Value - Fail
Test boolOn Cannot Locate - Defaults to
false.
- value
Synthetics
Test Browser Step Params Element User Locator Value - fail
Test BooleanOn Cannot Locate - Defaults to
false.
- value
Synthetics
Test Browser Step Params Element User Locator Value - fail
Test booleanOn Cannot Locate - Defaults to
false.
- value
Synthetics
Test Browser Step Params Element User Locator Value - fail_
test_ boolon_ cannot_ locate - Defaults to
false.
- value Property Map
- fail
Test BooleanOn Cannot Locate - Defaults to
false.
SyntheticsTestBrowserStepParamsElementUserLocatorValue, SyntheticsTestBrowserStepParamsElementUserLocatorValueArgs
SyntheticsTestBrowserStepParamsVariable, SyntheticsTestBrowserStepParamsVariableArgs
SyntheticsTestBrowserVariable, SyntheticsTestBrowserVariableArgs
- 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. Defaults to
"". - 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. Defaults to
"". - Secure bool
- Determines whether or not the browser test variable is obfuscated. Can only be used with a browser variable of type
text
- 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. Defaults to
"". - 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. Defaults to
"". - Secure bool
- Determines whether or not the browser test variable is obfuscated. Can only be used with a browser variable of type
text
- 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. Defaults to
"". - 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. Defaults to
"". - secure Boolean
- Determines whether or not the browser test variable is obfuscated. Can only be used with a browser variable of type
text
- 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. Defaults to
"". - 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. Defaults to
"". - secure boolean
- Determines whether or not the browser test variable is obfuscated. Can only be used with a browser variable of type
text
- 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. Defaults to
"". - 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. Defaults to
"". - secure bool
- Determines whether or not the browser test variable is obfuscated. Can only be used with a browser variable of type
text
- 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. Defaults to
"". - 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. Defaults to
"". - secure Boolean
- Determines whether or not the browser test variable is obfuscated. Can only be used with a browser variable of type
text
SyntheticsTestConfigVariable, SyntheticsTestConfigVariableArgs
- 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. Defaults to
false.
- 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. Defaults to
false.
- 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. Defaults to
false.
- 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. Defaults to
false.
- 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. Defaults to
false.
SyntheticsTestOptionsList, SyntheticsTestOptionsListArgs
- Tick
Every int - How often the test should run (in seconds).
- Accept
Self boolSigned - For SSL test, whether or not the test should allow self signed certificates.
- Allow
Insecure bool - Allows loading insecure content for an HTTP request in an API test or in a multistep API test step.
- Check
Certificate boolRevocation - For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
- Ci
Synthetics
Test Options List Ci - 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 string - HTTP version to use for an HTTP request in an API test or step. Valid values are
http1,http2,any. - Ignore
Server boolCertificate Error - Ignore server certificate error for browser tests.
- int
- Timeout before declaring the initial step as failed (in seconds) for browser tests.
- Min
Failure intDuration - Minimum amount of time in failure required to trigger an alert (in seconds). Default is
0. - Min
Location intFailed - Minimum number of locations in failure required to trigger an alert. Defaults to
1. - Monitor
Name string - The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
- Monitor
Options SyntheticsTest Options List Monitor Options - Monitor
Priority int - No
Screenshot bool - Prevents saving screenshots of the steps.
- Restricted
Roles List<string> - A list of role identifiers pulled from the Roles API to restrict read and write access.
- Retry
Synthetics
Test Options List Retry - Rum
Settings SyntheticsTest Options List Rum Settings - The RUM data collection settings for the Synthetic browser test.
- Scheduling
Synthetics
Test Options List Scheduling - Object containing timeframes and timezone used for advanced scheduling.
- Tick
Every int - How often the test should run (in seconds).
- Accept
Self boolSigned - For SSL test, whether or not the test should allow self signed certificates.
- Allow
Insecure bool - Allows loading insecure content for an HTTP request in an API test or in a multistep API test step.
- Check
Certificate boolRevocation - For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
- Ci
Synthetics
Test Options List Ci - 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 string - HTTP version to use for an HTTP request in an API test or step. Valid values are
http1,http2,any. - Ignore
Server boolCertificate Error - Ignore server certificate error for browser tests.
- int
- Timeout before declaring the initial step as failed (in seconds) for browser tests.
- Min
Failure intDuration - Minimum amount of time in failure required to trigger an alert (in seconds). Default is
0. - Min
Location intFailed - Minimum number of locations in failure required to trigger an alert. Defaults to
1. - Monitor
Name string - The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
- Monitor
Options SyntheticsTest Options List Monitor Options - Monitor
Priority int - No
Screenshot bool - Prevents saving screenshots of the steps.
- Restricted
Roles []string - A list of role identifiers pulled from the Roles API to restrict read and write access.
- Retry
Synthetics
Test Options List Retry - Rum
Settings SyntheticsTest Options List Rum Settings - The RUM data collection settings for the Synthetic browser test.
- Scheduling
Synthetics
Test Options List Scheduling - Object containing timeframes and timezone used for advanced scheduling.
- tick
Every Integer - How often the test should run (in seconds).
- accept
Self BooleanSigned - For SSL test, whether or not the test should allow self signed certificates.
- allow
Insecure Boolean - Allows loading insecure content for an HTTP request in an API test or in a multistep API test step.
- check
Certificate BooleanRevocation - For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
- ci
Synthetics
Test Options List Ci - CI/CD options for a Synthetic test.
- disable
Cors Boolean - Disable Cross-Origin Resource Sharing for browser tests.
- disable
Csp Boolean - Disable Content Security Policy for browser tests.
- follow
Redirects Boolean - Determines whether or not the API HTTP test should follow redirects.
- http
Version String - HTTP version to use for an HTTP request in an API test or step. Valid values are
http1,http2,any. - ignore
Server BooleanCertificate Error - Ignore server certificate error for browser tests.
- Integer
- Timeout before declaring the initial step as failed (in seconds) for browser tests.
- min
Failure IntegerDuration - Minimum amount of time in failure required to trigger an alert (in seconds). Default is
0. - min
Location IntegerFailed - Minimum number of locations in failure required to trigger an alert. Defaults to
1. - monitor
Name String - The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
- monitor
Options SyntheticsTest Options List Monitor Options - monitor
Priority Integer - no
Screenshot Boolean - Prevents saving screenshots of the steps.
- restricted
Roles List<String> - A list of role identifiers pulled from the Roles API to restrict read and write access.
- retry
Synthetics
Test Options List Retry - rum
Settings SyntheticsTest Options List Rum Settings - The RUM data collection settings for the Synthetic browser test.
- scheduling
Synthetics
Test Options List Scheduling - Object containing timeframes and timezone used for advanced scheduling.
- tick
Every number - How often the test should run (in seconds).
- accept
Self booleanSigned - For SSL test, whether or not the test should allow self signed certificates.
- allow
Insecure boolean - Allows loading insecure content for an HTTP request in an API test or in a multistep API test step.
- check
Certificate booleanRevocation - For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
- ci
Synthetics
Test Options List Ci - CI/CD options for a Synthetic test.
- disable
Cors boolean - Disable Cross-Origin Resource Sharing for browser tests.
- disable
Csp boolean - Disable Content Security Policy for browser tests.
- follow
Redirects boolean - Determines whether or not the API HTTP test should follow redirects.
- http
Version string - HTTP version to use for an HTTP request in an API test or step. Valid values are
http1,http2,any. - ignore
Server booleanCertificate Error - Ignore server certificate error for browser tests.
- number
- Timeout before declaring the initial step as failed (in seconds) for browser tests.
- min
Failure numberDuration - Minimum amount of time in failure required to trigger an alert (in seconds). Default is
0. - min
Location numberFailed - Minimum number of locations in failure required to trigger an alert. Defaults to
1. - monitor
Name string - The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
- monitor
Options SyntheticsTest Options List Monitor Options - monitor
Priority number - no
Screenshot boolean - Prevents saving screenshots of the steps.
- restricted
Roles string[] - A list of role identifiers pulled from the Roles API to restrict read and write access.
- retry
Synthetics
Test Options List Retry - rum
Settings SyntheticsTest Options List Rum Settings - The RUM data collection settings for the Synthetic browser test.
- scheduling
Synthetics
Test Options List Scheduling - Object containing timeframes and timezone used for advanced scheduling.
- tick_
every int - How often the test should run (in seconds).
- accept_
self_ boolsigned - For SSL test, whether or not the test should allow self signed certificates.
- allow_
insecure bool - Allows loading insecure content for an HTTP request in an API test or in a multistep API test step.
- check_
certificate_ boolrevocation - For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.
- ci
Synthetics
Test Options List Ci - 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 an HTTP request in an API test or step. Valid values are
http1,http2,any. - ignore_
server_ boolcertificate_ error - Ignore server certificate error for browser tests.
- int
- Timeout before declaring the initial step as failed (in seconds) for browser tests.
- min_
failure_ intduration - Minimum amount of time in failure required to trigger an alert (in seconds). Default is
0. - min_
location_ intfailed - Minimum number of locations in failure required to trigger an alert. Defaults to
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 SyntheticsTest Options List Monitor Options - 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
Synthetics
Test Options List Retry - rum_
settings SyntheticsTest Options List Rum Settings - The RUM data collection settings for the Synthetic browser test.
- scheduling
Synthetics
Test Options List Scheduling - Object containing timeframes and timezone used for advanced scheduling.
- tick
Every Number - How often the test should run (in seconds).
- accept
Self BooleanSigned - For SSL test, whether or not the test should allow self signed certificates.
- allow
Insecure Boolean - Allows loading insecure content for an HTTP request in an API test or in a multistep API test step.
- check
Certificate BooleanRevocation - 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.
- disable
Cors Boolean - Disable Cross-Origin Resource Sharing for browser tests.
- disable
Csp Boolean - Disable Content Security Policy for browser tests.
- follow
Redirects Boolean - Determines whether or not the API HTTP test should follow redirects.
- http
Version String - HTTP version to use for an HTTP request in an API test or step. Valid values are
http1,http2,any. - ignore
Server BooleanCertificate Error - Ignore server certificate error for browser tests.
- Number
- Timeout before declaring the initial step as failed (in seconds) for browser tests.
- min
Failure NumberDuration - Minimum amount of time in failure required to trigger an alert (in seconds). Default is
0. - min
Location NumberFailed - Minimum number of locations in failure required to trigger an alert. Defaults to
1. - monitor
Name String - The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
- monitor
Options Property Map - monitor
Priority Number - no
Screenshot Boolean - Prevents saving screenshots of the steps.
- restricted
Roles List<String> - A list of role identifiers pulled from the Roles API to restrict read and write access.
- retry Property Map
- rum
Settings 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, SyntheticsTestOptionsListCiArgs
- Execution
Rule string - Execution rule for a Synthetics test. Valid values are
blocking,non_blocking,skipped.
- Execution
Rule string - Execution rule for a Synthetics test. Valid values are
blocking,non_blocking,skipped.
- execution
Rule String - Execution rule for a Synthetics test. Valid values are
blocking,non_blocking,skipped.
- execution
Rule string - Execution rule for a Synthetics test. Valid values are
blocking,non_blocking,skipped.
- execution_
rule str - Execution rule for a Synthetics test. Valid values are
blocking,non_blocking,skipped.
- execution
Rule String - Execution rule for a Synthetics test. Valid values are
blocking,non_blocking,skipped.
SyntheticsTestOptionsListMonitorOptions, SyntheticsTestOptionsListMonitorOptionsArgs
- Renotify
Interval int - Specify a renotification frequency in minutes. Values available by default are
0,10,20,30,40,50,60,90,120,180,240,300,360,720,1440. Defaults to0.
- Renotify
Interval int - Specify a renotification frequency in minutes. Values available by default are
0,10,20,30,40,50,60,90,120,180,240,300,360,720,1440. Defaults to0.
- renotify
Interval Integer - Specify a renotification frequency in minutes. Values available by default are
0,10,20,30,40,50,60,90,120,180,240,300,360,720,1440. Defaults to0.
- renotify
Interval number - Specify a renotification frequency in minutes. Values available by default are
0,10,20,30,40,50,60,90,120,180,240,300,360,720,1440. Defaults to0.
- renotify_
interval int - Specify a renotification frequency in minutes. Values available by default are
0,10,20,30,40,50,60,90,120,180,240,300,360,720,1440. Defaults to0.
- renotify
Interval Number - Specify a renotification frequency in minutes. Values available by default are
0,10,20,30,40,50,60,90,120,180,240,300,360,720,1440. Defaults to0.
SyntheticsTestOptionsListRetry, SyntheticsTestOptionsListRetryArgs
SyntheticsTestOptionsListRumSettings, SyntheticsTestOptionsListRumSettingsArgs
- Is
Enabled bool - Determines whether RUM data is collected during test runs.
- Application
Id string - RUM application ID used to collect RUM data for the browser test.
- Client
Token intId - RUM application API key ID used to collect RUM data for the browser test.
- Is
Enabled bool - Determines whether RUM data is collected during test runs.
- Application
Id string - RUM application ID used to collect RUM data for the browser test.
- Client
Token intId - RUM application API key ID used to collect RUM data for the browser test.
- is
Enabled Boolean - Determines whether RUM data is collected during test runs.
- application
Id String - RUM application ID used to collect RUM data for the browser test.
- client
Token IntegerId - RUM application API key ID used to collect RUM data for the browser test.
- is
Enabled boolean - Determines whether RUM data is collected during test runs.
- application
Id string - RUM application ID used to collect RUM data for the browser test.
- client
Token numberId - RUM application API key ID used to collect RUM data for the browser test.
- is_
enabled bool - Determines whether RUM data is collected during test runs.
- application_
id str - RUM application ID used to collect RUM data for the browser test.
- client_
token_ intid - RUM application API key ID used to collect RUM data for the browser test.
- is
Enabled Boolean - Determines whether RUM data is collected during test runs.
- application
Id String - RUM application ID used to collect RUM data for the browser test.
- client
Token NumberId - RUM application API key ID used to collect RUM data for the browser test.
SyntheticsTestOptionsListScheduling, SyntheticsTestOptionsListSchedulingArgs
- Timeframes
List<Synthetics
Test Options List Scheduling Timeframe> - Array containing objects describing the scheduling pattern to apply to each day.
- Timezone string
- Timezone in which the timeframe is based.
- Timeframes
[]Synthetics
Test Options List Scheduling Timeframe - Array containing objects describing the scheduling pattern to apply to each day.
- Timezone string
- Timezone in which the timeframe is based.
- timeframes
List<Synthetics
Test Options List Scheduling Timeframe> - Array containing objects describing the scheduling pattern to apply to each day.
- timezone String
- Timezone in which the timeframe is based.
- timeframes
Synthetics
Test Options List Scheduling Timeframe[] - Array containing objects describing the scheduling pattern to apply to each day.
- timezone string
- Timezone in which the timeframe is based.
- timeframes
Sequence[Synthetics
Test Options List Scheduling Timeframe] - Array containing objects describing the scheduling pattern to apply to each day.
- timezone str
- Timezone in which the timeframe is based.
- timeframes List<Property Map>
- Array containing objects describing the scheduling pattern to apply to each day.
- timezone String
- Timezone in which the timeframe is based.
SyntheticsTestOptionsListSchedulingTimeframe, SyntheticsTestOptionsListSchedulingTimeframeArgs
SyntheticsTestRequestBasicauth, SyntheticsTestRequestBasicauthArgs
- Access
Key string - Access key for
SIGV4authentication. - Access
Token stringUrl - Access token url for
oauth-clientoroauth-ropauthentication. - Audience string
- Audience for
oauth-clientoroauth-ropauthentication. Defaults to"". - Client
Id string - Client ID for
oauth-clientoroauth-ropauthentication. - Client
Secret string - Client secret for
oauth-clientoroauth-ropauthentication. - Domain string
- Domain for
ntlmauthentication. - Password string
- Password for authentication.
- Region string
- Region for
SIGV4authentication. - Resource string
- Resource for
oauth-clientoroauth-ropauthentication. Defaults to"". - Scope string
- Scope for
oauth-clientoroauth-ropauthentication. Defaults to"". - Secret
Key string - Secret key for
SIGV4authentication. - Service
Name string - Service name for
SIGV4authentication. - Session
Token string - Session token for
SIGV4authentication. - Token
Api stringAuthentication - Token API Authentication for
oauth-clientoroauth-ropauthentication. Valid values areheader,body. - Type string
- Type of basic authentication to use when performing the test. Defaults to
"web". - Username string
- Username for authentication.
- Workstation string
- Workstation for
ntlmauthentication.
- Access
Key string - Access key for
SIGV4authentication. - Access
Token stringUrl - Access token url for
oauth-clientoroauth-ropauthentication. - Audience string
- Audience for
oauth-clientoroauth-ropauthentication. Defaults to"". - Client
Id string - Client ID for
oauth-clientoroauth-ropauthentication. - Client
Secret string - Client secret for
oauth-clientoroauth-ropauthentication. - Domain string
- Domain for
ntlmauthentication. - Password string
- Password for authentication.
- Region string
- Region for
SIGV4authentication. - Resource string
- Resource for
oauth-clientoroauth-ropauthentication. Defaults to"". - Scope string
- Scope for
oauth-clientoroauth-ropauthentication. Defaults to"". - Secret
Key string - Secret key for
SIGV4authentication. - Service
Name string - Service name for
SIGV4authentication. - Session
Token string - Session token for
SIGV4authentication. - Token
Api stringAuthentication - Token API Authentication for
oauth-clientoroauth-ropauthentication. Valid values areheader,body. - Type string
- Type of basic authentication to use when performing the test. Defaults to
"web". - Username string
- Username for authentication.
- Workstation string
- Workstation for
ntlmauthentication.
- access
Key String - Access key for
SIGV4authentication. - access
Token StringUrl - Access token url for
oauth-clientoroauth-ropauthentication. - audience String
- Audience for
oauth-clientoroauth-ropauthentication. Defaults to"". - client
Id String - Client ID for
oauth-clientoroauth-ropauthentication. - client
Secret String - Client secret for
oauth-clientoroauth-ropauthentication. - domain String
- Domain for
ntlmauthentication. - password String
- Password for authentication.
- region String
- Region for
SIGV4authentication. - resource String
- Resource for
oauth-clientoroauth-ropauthentication. Defaults to"". - scope String
- Scope for
oauth-clientoroauth-ropauthentication. Defaults to"". - secret
Key String - Secret key for
SIGV4authentication. - service
Name String - Service name for
SIGV4authentication. - session
Token String - Session token for
SIGV4authentication. - token
Api StringAuthentication - Token API Authentication for
oauth-clientoroauth-ropauthentication. Valid values areheader,body. - type String
- Type of basic authentication to use when performing the test. Defaults to
"web". - username String
- Username for authentication.
- workstation String
- Workstation for
ntlmauthentication.
- access
Key string - Access key for
SIGV4authentication. - access
Token stringUrl - Access token url for
oauth-clientoroauth-ropauthentication. - audience string
- Audience for
oauth-clientoroauth-ropauthentication. Defaults to"". - client
Id string - Client ID for
oauth-clientoroauth-ropauthentication. - client
Secret string - Client secret for
oauth-clientoroauth-ropauthentication. - domain string
- Domain for
ntlmauthentication. - password string
- Password for authentication.
- region string
- Region for
SIGV4authentication. - resource string
- Resource for
oauth-clientoroauth-ropauthentication. Defaults to"". - scope string
- Scope for
oauth-clientoroauth-ropauthentication. Defaults to"". - secret
Key string - Secret key for
SIGV4authentication. - service
Name string - Service name for
SIGV4authentication. - session
Token string - Session token for
SIGV4authentication. - token
Api stringAuthentication - Token API Authentication for
oauth-clientoroauth-ropauthentication. Valid values areheader,body. - type string
- Type of basic authentication to use when performing the test. Defaults to
"web". - username string
- Username for authentication.
- workstation string
- Workstation for
ntlmauthentication.
- access_
key str - Access key for
SIGV4authentication. - access_
token_ strurl - Access token url for
oauth-clientoroauth-ropauthentication. - audience str
- Audience for
oauth-clientoroauth-ropauthentication. Defaults to"". - client_
id str - Client ID for
oauth-clientoroauth-ropauthentication. - client_
secret str - Client secret for
oauth-clientoroauth-ropauthentication. - domain str
- Domain for
ntlmauthentication. - password str
- Password for authentication.
- region str
- Region for
SIGV4authentication. - resource str
- Resource for
oauth-clientoroauth-ropauthentication. Defaults to"". - scope str
- Scope for
oauth-clientoroauth-ropauthentication. Defaults to"". - secret_
key str - Secret key for
SIGV4authentication. - service_
name str - Service name for
SIGV4authentication. - session_
token str - Session token for
SIGV4authentication. - token_
api_ strauthentication - Token API Authentication for
oauth-clientoroauth-ropauthentication. Valid values areheader,body. - type str
- Type of basic authentication to use when performing the test. Defaults to
"web". - username str
- Username for authentication.
- workstation str
- Workstation for
ntlmauthentication.
- access
Key String - Access key for
SIGV4authentication. - access
Token StringUrl - Access token url for
oauth-clientoroauth-ropauthentication. - audience String
- Audience for
oauth-clientoroauth-ropauthentication. Defaults to"". - client
Id String - Client ID for
oauth-clientoroauth-ropauthentication. - client
Secret String - Client secret for
oauth-clientoroauth-ropauthentication. - domain String
- Domain for
ntlmauthentication. - password String
- Password for authentication.
- region String
- Region for
SIGV4authentication. - resource String
- Resource for
oauth-clientoroauth-ropauthentication. Defaults to"". - scope String
- Scope for
oauth-clientoroauth-ropauthentication. Defaults to"". - secret
Key String - Secret key for
SIGV4authentication. - service
Name String - Service name for
SIGV4authentication. - session
Token String - Session token for
SIGV4authentication. - token
Api StringAuthentication - Token API Authentication for
oauth-clientoroauth-ropauthentication. Valid values areheader,body. - type String
- Type of basic authentication to use when performing the test. Defaults to
"web". - username String
- Username for authentication.
- workstation String
- Workstation for
ntlmauthentication.
SyntheticsTestRequestClientCertificate, SyntheticsTestRequestClientCertificateArgs
SyntheticsTestRequestClientCertificateCert, SyntheticsTestRequestClientCertificateCertArgs
SyntheticsTestRequestClientCertificateKey, SyntheticsTestRequestClientCertificateKeyArgs
SyntheticsTestRequestDefinition, SyntheticsTestRequestDefinitionArgs
- Body string
- The request body.
- Body
Type string - Type of the request body. Valid values are
text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data. - Call
Type string - The type of gRPC call to perform. Valid values are
healthcheck,unary. - Certificate
Domains 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. - Dns
Server string - DNS server to use for DNS tests (
subtype = "dns"). - Dns
Server intPort - DNS server port to use for DNS tests.
- Host string
- Host name to perform the test with.
- Http
Version string - HTTP version to use for an HTTP request in an API test or step. Valid values are
http1,http2,any. - 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
servicefield. Required ifsubtypeisHTTPor ifsubtypeisgrpcandcallTypeisunary. - No
Saving boolResponse Body - Determines whether or not to save the response body.
- Number
Of intPackets - Number of pings to use per test for ICMP tests (
subtype = "icmp") between 0 and 10. - bool
- Persist cookies across redirects.
- Plain
Proto stringFile - The content of a proto file as a string.
- Port int
- Port to use when performing the test.
- Proto
Json stringDescriptor - A protobuf JSON descriptor. Deprecated. Use
plain_proto_fileinstead. - 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.
- Should
Track boolHops - 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.
- Body
Type string - Type of the request body. Valid values are
text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data. - Call
Type string - The type of gRPC call to perform. Valid values are
healthcheck,unary. - Certificate
Domains []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. - Dns
Server string - DNS server to use for DNS tests (
subtype = "dns"). - Dns
Server intPort - DNS server port to use for DNS tests.
- Host string
- Host name to perform the test with.
- Http
Version string - HTTP version to use for an HTTP request in an API test or step. Valid values are
http1,http2,any. - 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
servicefield. Required ifsubtypeisHTTPor ifsubtypeisgrpcandcallTypeisunary. - No
Saving boolResponse Body - Determines whether or not to save the response body.
- Number
Of intPackets - Number of pings to use per test for ICMP tests (
subtype = "icmp") between 0 and 10. - bool
- Persist cookies across redirects.
- Plain
Proto stringFile - The content of a proto file as a string.
- Port int
- Port to use when performing the test.
- Proto
Json stringDescriptor - A protobuf JSON descriptor. Deprecated. Use
plain_proto_fileinstead. - 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.
- Should
Track boolHops - 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.
- body
Type String - Type of the request body. Valid values are
text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data. - call
Type String - The type of gRPC call to perform. Valid values are
healthcheck,unary. - certificate
Domains 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. - dns
Server String - DNS server to use for DNS tests (
subtype = "dns"). - dns
Server IntegerPort - DNS server port to use for DNS tests.
- host String
- Host name to perform the test with.
- http
Version String - HTTP version to use for an HTTP request in an API test or step. Valid values are
http1,http2,any. - 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
servicefield. Required ifsubtypeisHTTPor ifsubtypeisgrpcandcallTypeisunary. - no
Saving BooleanResponse Body - Determines whether or not to save the response body.
- number
Of IntegerPackets - Number of pings to use per test for ICMP tests (
subtype = "icmp") between 0 and 10. - Boolean
- Persist cookies across redirects.
- plain
Proto StringFile - The content of a proto file as a string.
- port Integer
- Port to use when performing the test.
- proto
Json StringDescriptor - A protobuf JSON descriptor. Deprecated. Use
plain_proto_fileinstead. - 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.
- should
Track BooleanHops - 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.
- body
Type string - Type of the request body. Valid values are
text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data. - call
Type string - The type of gRPC call to perform. Valid values are
healthcheck,unary. - certificate
Domains 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. - dns
Server string - DNS server to use for DNS tests (
subtype = "dns"). - dns
Server numberPort - DNS server port to use for DNS tests.
- host string
- Host name to perform the test with.
- http
Version string - HTTP version to use for an HTTP request in an API test or step. Valid values are
http1,http2,any. - 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
servicefield. Required ifsubtypeisHTTPor ifsubtypeisgrpcandcallTypeisunary. - no
Saving booleanResponse Body - Determines whether or not to save the response body.
- number
Of numberPackets - Number of pings to use per test for ICMP tests (
subtype = "icmp") between 0 and 10. - boolean
- Persist cookies across redirects.
- plain
Proto stringFile - The content of a proto file as a string.
- port number
- Port to use when performing the test.
- proto
Json stringDescriptor - A protobuf JSON descriptor. Deprecated. Use
plain_proto_fileinstead. - 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.
- should
Track booleanHops - 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,application/octet-stream,multipart/form-data. - 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_ intport - DNS server port to use for DNS tests.
- host str
- Host name to perform the test with.
- http_
version str - HTTP version to use for an HTTP request in an API test or step. Valid values are
http1,http2,any. - 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
servicefield. Required ifsubtypeisHTTPor ifsubtypeisgrpcandcallTypeisunary. - no_
saving_ boolresponse_ body - Determines whether or not to save the response body.
- number_
of_ intpackets - Number of pings to use per test for ICMP tests (
subtype = "icmp") between 0 and 10. - bool
- Persist cookies across redirects.
- plain_
proto_ strfile - The content of a proto file as a string.
- port int
- Port to use when performing the test.
- proto_
json_ strdescriptor - A protobuf JSON descriptor. Deprecated. Use
plain_proto_fileinstead. - 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_ boolhops - 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.
- body
Type String - Type of the request body. Valid values are
text/plain,application/json,text/xml,text/html,application/x-www-form-urlencoded,graphql,application/octet-stream,multipart/form-data. - call
Type String - The type of gRPC call to perform. Valid values are
healthcheck,unary. - certificate
Domains 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. - dns
Server String - DNS server to use for DNS tests (
subtype = "dns"). - dns
Server NumberPort - DNS server port to use for DNS tests.
- host String
- Host name to perform the test with.
- http
Version String - HTTP version to use for an HTTP request in an API test or step. Valid values are
http1,http2,any. - 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
servicefield. Required ifsubtypeisHTTPor ifsubtypeisgrpcandcallTypeisunary. - no
Saving BooleanResponse Body - Determines whether or not to save the response body.
- number
Of NumberPackets - Number of pings to use per test for ICMP tests (
subtype = "icmp") between 0 and 10. - Boolean
- Persist cookies across redirects.
- plain
Proto StringFile - The content of a proto file as a string.
- port Number
- Port to use when performing the test.
- proto
Json StringDescriptor - A protobuf JSON descriptor. Deprecated. Use
plain_proto_fileinstead. - 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.
- should
Track BooleanHops - 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, SyntheticsTestRequestProxyArgs
Import
Synthetics tests can be imported using their public string ID, e.g.
$ pulumi import datadog:index/syntheticsTest:SyntheticsTest fizz abc-123-xyz
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Datadog pulumi/pulumi-datadog
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
datadogTerraform Provider.