@pulumi/datadog 4.0.0 → 4.2.0-alpha.1632753173

package/syntheticsTest.d.ts

@@ -3,6 +3,34 @@ import { input as inputs, output as outputs } from "./types";
 /**
  * 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 `configVariable` 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):
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * ```
+ *
+ * to
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ *
+ * const config_variable = {
+ *     name: "LOCAL_VAR",
+ *     id: [your_global_variable_id],
+ *     type: "global",
+ * };
+ * ```
+ *
+ * which you can now use in your request definition:
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * ```
+ *
  * ## Example Usage
  *
  * ```typescript
@@ -11,169 +39,219 @@ import { input as inputs, output as outputs } from "./types";
  *
  * // Example Usage (Synthetics API test)
  * // Create a new Datadog Synthetics API/HTTP test on https://www.example.org
- * const testApi = new datadog.SyntheticsTest("testApi", {
- *     type: "api",
- *     subtype: "http",
- *     requestDefinition: {
- *         method: "GET",
- *         url: "https://www.example.org",
- *     },
- *     requestHeaders: {
- *         "Content-Type": "application/json",
- *         Authentication: "Token: 1234566789",
- *     },
+ * const testApi = new datadog.SyntheticsTest("test_api", {
  *     assertions: [{
- *         type: "statusCode",
  *         operator: "is",
  *         target: "200",
+ *         type: "statusCode",
  *     }],
  *     locations: ["aws:eu-central-1"],
+ *     message: "Notify @pagerduty",
+ *     name: "An API test on example.org",
  *     optionsList: {
- *         tickEvery: 900,
+ *         monitorOptions: {
+ *             renotifyInterval: 100,
+ *         },
  *         retry: {
  *             count: 2,
  *             interval: 300,
  *         },
- *         monitorOptions: {
- *             renotifyInterval: 100,
- *         },
+ *         tickEvery: 900,
  *     },
- *     name: "An API test on example.org",
- *     message: "Notify @pagerduty",
+ *     requestDefinition: {
+ *         method: "GET",
+ *         url: "https://www.example.org",
+ *     },
+ *     requestHeaders: {
+ *         Authentication: "Token: 1234566789",
+ *         "Content-Type": "application/json",
+ *     },
+ *     status: "live",
+ *     subtype: "http",
  *     tags: [
  *         "foo:bar",
  *         "foo",
  *         "env:test",
  *     ],
- *     status: "live",
+ *     type: "api",
  * });
  * // Example Usage (Synthetics SSL test)
  * // Create a new Datadog Synthetics API/SSL test on example.org
- * const testSsl = new datadog.SyntheticsTest("testSsl", {
- *     type: "api",
- *     subtype: "ssl",
- *     requestDefinition: {
- *         host: "example.org",
- *         port: 443,
- *     },
+ * const testSsl = new datadog.SyntheticsTest("test_ssl", {
  *     assertions: [{
- *         type: "certificate",
  *         operator: "isInMoreThan",
- *         target: 30,
+ *         target: "30",
+ *         type: "certificate",
  *     }],
  *     locations: ["aws:eu-central-1"],
+ *     message: "Notify @pagerduty",
+ *     name: "An API test on example.org",
  *     optionsList: {
- *         tickEvery: 900,
  *         acceptSelfSigned: true,
+ *         tickEvery: 900,
  *     },
- *     name: "An API test on example.org",
- *     message: "Notify @pagerduty",
+ *     requestDefinition: {
+ *         host: "example.org",
+ *         port: 443,
+ *     },
+ *     status: "live",
+ *     subtype: "ssl",
  *     tags: [
  *         "foo:bar",
  *         "foo",
  *         "env:test",
  *     ],
- *     status: "live",
+ *     type: "api",
  * });
  * // Example Usage (Synthetics TCP test)
  * // Create a new Datadog Synthetics API/TCP test on example.org
- * const testTcp = new datadog.SyntheticsTest("testTcp", {
- *     type: "api",
- *     subtype: "tcp",
- *     requestDefinition: {
- *         host: "example.org",
- *         port: 443,
- *     },
+ * const testTcp = new datadog.SyntheticsTest("test_tcp", {
  *     assertions: [{
- *         type: "responseTime",
  *         operator: "lessThan",
- *         target: 2000,
+ *         target: "2000",
+ *         type: "responseTime",
+ *     }],
+ *     configVariables: [{
+ *         id: "76636cd1-82e2-4aeb-9cfe-51366a8198a2",
+ *         name: "MY_GLOBAL_VAR",
+ *         type: "global",
  *     }],
  *     locations: ["aws:eu-central-1"],
+ *     message: "Notify @pagerduty",
+ *     name: "An API test on example.org",
  *     optionsList: {
  *         tickEvery: 900,
  *     },
- *     name: "An API test on example.org",
- *     message: "Notify @pagerduty",
+ *     requestDefinition: {
+ *         host: "example.org",
+ *         port: 443,
+ *     },
+ *     status: "live",
+ *     subtype: "tcp",
  *     tags: [
  *         "foo:bar",
  *         "foo",
  *         "env:test",
  *     ],
- *     status: "live",
+ *     type: "api",
  * });
  * // Example Usage (Synthetics DNS test)
  * // Create a new Datadog Synthetics API/DNS test on example.org
- * const testDns = new datadog.SyntheticsTest("testDns", {
- *     type: "api",
- *     subtype: "dns",
- *     requestDefinition: {
- *         host: "example.org",
- *     },
+ * const testDns = new datadog.SyntheticsTest("test_dns", {
  *     assertions: [{
- *         type: "recordSome",
  *         operator: "is",
  *         property: "A",
  *         target: "0.0.0.0",
+ *         type: "recordSome",
  *     }],
  *     locations: ["aws:eu-central-1"],
+ *     message: "Notify @pagerduty",
+ *     name: "An API test on example.org",
  *     optionsList: {
  *         tickEvery: 900,
  *     },
- *     name: "An API test on example.org",
- *     message: "Notify @pagerduty",
+ *     requestDefinition: {
+ *         host: "example.org",
+ *     },
+ *     status: "live",
+ *     subtype: "dns",
  *     tags: [
  *         "foo:bar",
  *         "foo",
  *         "env:test",
  *     ],
+ *     type: "api",
+ * });
+ * // Example Usage (Synthetics Multistep API test)
+ * // Create a new Datadog Synthetics Multistep API test
+ * const test = new datadog.SyntheticsTest("test", {
+ *     apiSteps: [
+ *         {
+ *             assertions: [{
+ *                 operator: "is",
+ *                 target: "200",
+ *                 type: "statusCode",
+ *             }],
+ *             name: "An API test on example.org",
+ *             requestDefinition: {
+ *                 method: "GET",
+ *                 url: "https://example.org",
+ *             },
+ *             requestHeaders: {
+ *                 Authentication: "Token: 1234566789",
+ *                 "Content-Type": "application/json",
+ *             },
+ *             subtype: "http",
+ *         },
+ *         {
+ *             assertions: [{
+ *                 operator: "is",
+ *                 target: "200",
+ *                 type: "statusCode",
+ *             }],
+ *             name: "An API test on example.org",
+ *             requestDefinition: {
+ *                 method: "GET",
+ *                 url: "http://example.org",
+ *             },
+ *             subtype: "http",
+ *         },
+ *     ],
+ *     locations: ["aws:eu-central-1"],
+ *     name: "Multistep API test",
+ *     optionsList: {
+ *         acceptSelfSigned: true,
+ *         tickEvery: 900,
+ *     },
  *     status: "live",
+ *     subtype: "multi",
+ *     type: "api",
  * });
  * // Example Usage (Synthetics Browser test)
  * // Support for Synthetics Browser test steps is limited (see below)
  * // Create a new Datadog Synthetics Browser test starting on https://www.example.org
- * const testBrowser = new datadog.SyntheticsTest("testBrowser", {
- *     type: "browser",
- *     requestDefinition: {
- *         method: "GET",
- *         url: "https://app.datadoghq.com",
- *     },
- *     deviceIds: ["laptop_large"],
- *     locations: ["aws:eu-central-1"],
- *     optionsList: {
- *         tickEvery: 3600,
- *     },
- *     name: "A Browser test on example.org",
- *     message: "Notify @qa",
- *     tags: [],
- *     status: "paused",
- *     step: [{
+ * const testBrowser = new datadog.SyntheticsTest("test_browser", {
+ *     browserSteps: [{
  *         name: "Check current url",
- *         type: "assertCurrentUrl",
- *         params: JSON.stringify({
+ *         params: {
  *             check: "contains",
  *             value: "datadoghq",
- *         }),
+ *         },
+ *         type: "assertCurrentUrl",
  *     }],
- *     variable: [
+ *     browserVariables: [
  *         {
- *             type: "text",
+ *             example: "597",
  *             name: "MY_PATTERN_VAR",
  *             pattern: "{{numeric(3)}}",
- *             example: "597",
+ *             type: "text",
  *         },
  *         {
- *             type: "email",
+ *             example: "jd8-afe-ydv.4546132139@synthetics.dtdg.co",
  *             name: "MY_EMAIL_VAR",
  *             pattern: "jd8-afe-ydv.{{ numeric(10) }}@synthetics.dtdg.co",
- *             example: "jd8-afe-ydv.4546132139@synthetics.dtdg.co",
+ *             type: "email",
  *         },
  *         {
- *             type: "global",
- *             name: "MY_GLOBAL_VAR",
  *             id: "76636cd1-82e2-4aeb-9cfe-51366a8198a2",
+ *             name: "MY_GLOBAL_VAR",
+ *             type: "global",
  *         },
  *     ],
+ *     deviceIds: ["laptop_large"],
+ *     locations: ["aws:eu-central-1"],
+ *     message: "Notify @qa",
+ *     name: "A Browser test on example.org",
+ *     optionsList: {
+ *         tickEvery: 3600,
+ *     },
+ *     requestDefinition: {
+ *         method: "GET",
+ *         url: "https://app.datadoghq.com",
+ *     },
+ *     status: "paused",
+ *     tags: [],
+ *     type: "browser",
  * });
  * ```
  *
@@ -222,7 +300,7 @@ export declare class SyntheticsTest extends pulumi.CustomResource {
      */
     readonly configVariables: pulumi.Output<outputs.SyntheticsTestConfigVariable[] | undefined>;
     /**
-     * Array with the different device IDs used to run the test (only for `browser` tests). Valid values are `laptopLarge`, `tablet`, `mobileSmall`, `chrome.laptop_large`, `chrome.tablet`, `chrome.mobile_small`, `firefox.laptop_large`, `firefox.tablet`, `firefox.mobile_small`.
+     * Array with the different device IDs used to run the test (only for `browser` tests). Valid values are `laptopLarge`, `tablet`, `mobileSmall`, `chrome.laptop_large`, `chrome.tablet`, `chrome.mobile_small`, `firefox.laptop_large`, `firefox.tablet`, `firefox.mobile_small`, `edge.laptop_large`, `edge.tablet`, `edge.mobile_small`.
      */
     readonly deviceIds: pulumi.Output<string[] | undefined>;
     /**
@@ -320,7 +398,7 @@ export interface SyntheticsTestState {
      */
     configVariables?: pulumi.Input<pulumi.Input<inputs.SyntheticsTestConfigVariable>[]>;
     /**
-     * Array with the different device IDs used to run the test (only for `browser` tests). Valid values are `laptopLarge`, `tablet`, `mobileSmall`, `chrome.laptop_large`, `chrome.tablet`, `chrome.mobile_small`, `firefox.laptop_large`, `firefox.tablet`, `firefox.mobile_small`.
+     * Array with the different device IDs used to run the test (only for `browser` tests). Valid values are `laptopLarge`, `tablet`, `mobileSmall`, `chrome.laptop_large`, `chrome.tablet`, `chrome.mobile_small`, `firefox.laptop_large`, `firefox.tablet`, `firefox.mobile_small`, `edge.laptop_large`, `edge.tablet`, `edge.mobile_small`.
      */
     deviceIds?: pulumi.Input<pulumi.Input<string>[]>;
     /**
@@ -410,7 +488,7 @@ export interface SyntheticsTestArgs {
      */
     configVariables?: pulumi.Input<pulumi.Input<inputs.SyntheticsTestConfigVariable>[]>;
     /**
-     * Array with the different device IDs used to run the test (only for `browser` tests). Valid values are `laptopLarge`, `tablet`, `mobileSmall`, `chrome.laptop_large`, `chrome.tablet`, `chrome.mobile_small`, `firefox.laptop_large`, `firefox.tablet`, `firefox.mobile_small`.
+     * Array with the different device IDs used to run the test (only for `browser` tests). Valid values are `laptopLarge`, `tablet`, `mobileSmall`, `chrome.laptop_large`, `chrome.tablet`, `chrome.mobile_small`, `firefox.laptop_large`, `firefox.tablet`, `firefox.mobile_small`, `edge.laptop_large`, `edge.tablet`, `edge.mobile_small`.
      */
     deviceIds?: pulumi.Input<pulumi.Input<string>[]>;
     /**

package/syntheticsTest.js

@@ -7,6 +7,34 @@ const utilities = require("./utilities");
 /**
  * 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 `configVariable` 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):
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * ```
+ *
+ * to
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ *
+ * const config_variable = {
+ *     name: "LOCAL_VAR",
+ *     id: [your_global_variable_id],
+ *     type: "global",
+ * };
+ * ```
+ *
+ * which you can now use in your request definition:
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * ```
+ *
  * ## Example Usage
  *
  * ```typescript
@@ -15,169 +43,219 @@ const utilities = require("./utilities");
  *
  * // Example Usage (Synthetics API test)
  * // Create a new Datadog Synthetics API/HTTP test on https://www.example.org
- * const testApi = new datadog.SyntheticsTest("testApi", {
- *     type: "api",
- *     subtype: "http",
- *     requestDefinition: {
- *         method: "GET",
- *         url: "https://www.example.org",
- *     },
- *     requestHeaders: {
- *         "Content-Type": "application/json",
- *         Authentication: "Token: 1234566789",
- *     },
+ * const testApi = new datadog.SyntheticsTest("test_api", {
  *     assertions: [{
- *         type: "statusCode",
  *         operator: "is",
  *         target: "200",
+ *         type: "statusCode",
  *     }],
  *     locations: ["aws:eu-central-1"],
+ *     message: "Notify @pagerduty",
+ *     name: "An API test on example.org",
  *     optionsList: {
- *         tickEvery: 900,
+ *         monitorOptions: {
+ *             renotifyInterval: 100,
+ *         },
  *         retry: {
  *             count: 2,
  *             interval: 300,
  *         },
- *         monitorOptions: {
- *             renotifyInterval: 100,
- *         },
+ *         tickEvery: 900,
  *     },
- *     name: "An API test on example.org",
- *     message: "Notify @pagerduty",
+ *     requestDefinition: {
+ *         method: "GET",
+ *         url: "https://www.example.org",
+ *     },
+ *     requestHeaders: {
+ *         Authentication: "Token: 1234566789",
+ *         "Content-Type": "application/json",
+ *     },
+ *     status: "live",
+ *     subtype: "http",
  *     tags: [
  *         "foo:bar",
  *         "foo",
  *         "env:test",
  *     ],
- *     status: "live",
+ *     type: "api",
  * });
  * // Example Usage (Synthetics SSL test)
  * // Create a new Datadog Synthetics API/SSL test on example.org
- * const testSsl = new datadog.SyntheticsTest("testSsl", {
- *     type: "api",
- *     subtype: "ssl",
- *     requestDefinition: {
- *         host: "example.org",
- *         port: 443,
- *     },
+ * const testSsl = new datadog.SyntheticsTest("test_ssl", {
  *     assertions: [{
- *         type: "certificate",
  *         operator: "isInMoreThan",
- *         target: 30,
+ *         target: "30",
+ *         type: "certificate",
  *     }],
  *     locations: ["aws:eu-central-1"],
+ *     message: "Notify @pagerduty",
+ *     name: "An API test on example.org",
  *     optionsList: {
- *         tickEvery: 900,
  *         acceptSelfSigned: true,
+ *         tickEvery: 900,
  *     },
- *     name: "An API test on example.org",
- *     message: "Notify @pagerduty",
+ *     requestDefinition: {
+ *         host: "example.org",
+ *         port: 443,
+ *     },
+ *     status: "live",
+ *     subtype: "ssl",
  *     tags: [
  *         "foo:bar",
  *         "foo",
  *         "env:test",
  *     ],
- *     status: "live",
+ *     type: "api",
  * });
  * // Example Usage (Synthetics TCP test)
  * // Create a new Datadog Synthetics API/TCP test on example.org
- * const testTcp = new datadog.SyntheticsTest("testTcp", {
- *     type: "api",
- *     subtype: "tcp",
- *     requestDefinition: {
- *         host: "example.org",
- *         port: 443,
- *     },
+ * const testTcp = new datadog.SyntheticsTest("test_tcp", {
  *     assertions: [{
- *         type: "responseTime",
  *         operator: "lessThan",
- *         target: 2000,
+ *         target: "2000",
+ *         type: "responseTime",
+ *     }],
+ *     configVariables: [{
+ *         id: "76636cd1-82e2-4aeb-9cfe-51366a8198a2",
+ *         name: "MY_GLOBAL_VAR",
+ *         type: "global",
  *     }],
  *     locations: ["aws:eu-central-1"],
+ *     message: "Notify @pagerduty",
+ *     name: "An API test on example.org",
  *     optionsList: {
  *         tickEvery: 900,
  *     },
- *     name: "An API test on example.org",
- *     message: "Notify @pagerduty",
+ *     requestDefinition: {
+ *         host: "example.org",
+ *         port: 443,
+ *     },
+ *     status: "live",
+ *     subtype: "tcp",
  *     tags: [
  *         "foo:bar",
  *         "foo",
  *         "env:test",
  *     ],
- *     status: "live",
+ *     type: "api",
  * });
  * // Example Usage (Synthetics DNS test)
  * // Create a new Datadog Synthetics API/DNS test on example.org
- * const testDns = new datadog.SyntheticsTest("testDns", {
- *     type: "api",
- *     subtype: "dns",
- *     requestDefinition: {
- *         host: "example.org",
- *     },
+ * const testDns = new datadog.SyntheticsTest("test_dns", {
  *     assertions: [{
- *         type: "recordSome",
  *         operator: "is",
  *         property: "A",
  *         target: "0.0.0.0",
+ *         type: "recordSome",
  *     }],
  *     locations: ["aws:eu-central-1"],
+ *     message: "Notify @pagerduty",
+ *     name: "An API test on example.org",
  *     optionsList: {
  *         tickEvery: 900,
  *     },
- *     name: "An API test on example.org",
- *     message: "Notify @pagerduty",
+ *     requestDefinition: {
+ *         host: "example.org",
+ *     },
+ *     status: "live",
+ *     subtype: "dns",
  *     tags: [
  *         "foo:bar",
  *         "foo",
  *         "env:test",
  *     ],
+ *     type: "api",
+ * });
+ * // Example Usage (Synthetics Multistep API test)
+ * // Create a new Datadog Synthetics Multistep API test
+ * const test = new datadog.SyntheticsTest("test", {
+ *     apiSteps: [
+ *         {
+ *             assertions: [{
+ *                 operator: "is",
+ *                 target: "200",
+ *                 type: "statusCode",
+ *             }],
+ *             name: "An API test on example.org",
+ *             requestDefinition: {
+ *                 method: "GET",
+ *                 url: "https://example.org",
+ *             },
+ *             requestHeaders: {
+ *                 Authentication: "Token: 1234566789",
+ *                 "Content-Type": "application/json",
+ *             },
+ *             subtype: "http",
+ *         },
+ *         {
+ *             assertions: [{
+ *                 operator: "is",
+ *                 target: "200",
+ *                 type: "statusCode",
+ *             }],
+ *             name: "An API test on example.org",
+ *             requestDefinition: {
+ *                 method: "GET",
+ *                 url: "http://example.org",
+ *             },
+ *             subtype: "http",
+ *         },
+ *     ],
+ *     locations: ["aws:eu-central-1"],
+ *     name: "Multistep API test",
+ *     optionsList: {
+ *         acceptSelfSigned: true,
+ *         tickEvery: 900,
+ *     },
  *     status: "live",
+ *     subtype: "multi",
+ *     type: "api",
  * });
  * // Example Usage (Synthetics Browser test)
  * // Support for Synthetics Browser test steps is limited (see below)
  * // Create a new Datadog Synthetics Browser test starting on https://www.example.org
- * const testBrowser = new datadog.SyntheticsTest("testBrowser", {
- *     type: "browser",
- *     requestDefinition: {
- *         method: "GET",
- *         url: "https://app.datadoghq.com",
- *     },
- *     deviceIds: ["laptop_large"],
- *     locations: ["aws:eu-central-1"],
- *     optionsList: {
- *         tickEvery: 3600,
- *     },
- *     name: "A Browser test on example.org",
- *     message: "Notify @qa",
- *     tags: [],
- *     status: "paused",
- *     step: [{
+ * const testBrowser = new datadog.SyntheticsTest("test_browser", {
+ *     browserSteps: [{
  *         name: "Check current url",
- *         type: "assertCurrentUrl",
- *         params: JSON.stringify({
+ *         params: {
  *             check: "contains",
  *             value: "datadoghq",
- *         }),
+ *         },
+ *         type: "assertCurrentUrl",
  *     }],
- *     variable: [
+ *     browserVariables: [
  *         {
- *             type: "text",
+ *             example: "597",
  *             name: "MY_PATTERN_VAR",
  *             pattern: "{{numeric(3)}}",
- *             example: "597",
+ *             type: "text",
  *         },
  *         {
- *             type: "email",
+ *             example: "jd8-afe-ydv.4546132139@synthetics.dtdg.co",
  *             name: "MY_EMAIL_VAR",
  *             pattern: "jd8-afe-ydv.{{ numeric(10) }}@synthetics.dtdg.co",
- *             example: "jd8-afe-ydv.4546132139@synthetics.dtdg.co",
+ *             type: "email",
  *         },
  *         {
- *             type: "global",
- *             name: "MY_GLOBAL_VAR",
  *             id: "76636cd1-82e2-4aeb-9cfe-51366a8198a2",
+ *             name: "MY_GLOBAL_VAR",
+ *             type: "global",
  *         },
  *     ],
+ *     deviceIds: ["laptop_large"],
+ *     locations: ["aws:eu-central-1"],
+ *     message: "Notify @qa",
+ *     name: "A Browser test on example.org",
+ *     optionsList: {
+ *         tickEvery: 3600,
+ *     },
+ *     requestDefinition: {
+ *         method: "GET",
+ *         url: "https://app.datadoghq.com",
+ *     },
+ *     status: "paused",
+ *     tags: [],
+ *     type: "browser",
  * });
  * ```
  *