@pulumi/datadog 4.29.0-alpha.1720762446 → 4.29.0

package/syntheticsTest.d.ts

@@ -15,359 +15,6 @@ import * as outputs from "./types/output";
  *
  * which you can now use in your request definition:
  *
- * ## Example Usage
- *
- * ```typescript
- * 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
  *
  * Synthetics tests can be imported using their public string ID, e.g.
@@ -393,7 +40,7 @@ export declare class SyntheticsTest extends pulumi.CustomResource {
      */
     static isInstance(obj: any): obj is SyntheticsTest;
     /**
-     * Steps for multistep api tests
+     * Steps for multi-step api tests
      */
     readonly apiSteps: pulumi.Output<outputs.SyntheticsTestApiStep[] | undefined>;
     /**
@@ -416,6 +63,10 @@ export declare class SyntheticsTest extends pulumi.CustomResource {
      * Required if `type = "browser"`. Array with the different device IDs used to run the test. 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>;
+    /**
+     * A boolean indicating whether this synthetics test can be deleted even if it's referenced by other resources (for example, SLOs and composite monitors).
+     */
+    readonly forceDeleteDependencies: pulumi.Output<boolean | undefined>;
     /**
      * Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.
      */
@@ -445,6 +96,10 @@ export declare class SyntheticsTest extends pulumi.CustomResource {
      * Required if `type = "api"`. The synthetics test request.
      */
     readonly requestDefinition: pulumi.Output<outputs.SyntheticsTestRequestDefinition | undefined>;
+    /**
+     * Files to be used as part of the request in the test.
+     */
+    readonly requestFiles: pulumi.Output<outputs.SyntheticsTestRequestFile[] | undefined>;
     /**
      * Header name and value map.
      */
@@ -487,6 +142,10 @@ export declare class SyntheticsTest extends pulumi.CustomResource {
      * Synthetics test type. Valid values are `api`, `browser`.
      */
     readonly type: pulumi.Output<string>;
+    /**
+     * Variables defined from JavaScript code for API HTTP tests.
+     */
+    readonly variablesFromScript: pulumi.Output<string | undefined>;
     /**
      * Create a SyntheticsTest resource with the given unique name, arguments, and options.
      *
@@ -501,7 +160,7 @@ export declare class SyntheticsTest extends pulumi.CustomResource {
  */
 export interface SyntheticsTestState {
     /**
-     * Steps for multistep api tests
+     * Steps for multi-step api tests
      */
     apiSteps?: pulumi.Input<pulumi.Input<inputs.SyntheticsTestApiStep>[]>;
     /**
@@ -524,6 +183,10 @@ export interface SyntheticsTestState {
      * Required if `type = "browser"`. Array with the different device IDs used to run the test. 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>[]>;
+    /**
+     * A boolean indicating whether this synthetics test can be deleted even if it's referenced by other resources (for example, SLOs and composite monitors).
+     */
+    forceDeleteDependencies?: pulumi.Input<boolean>;
     /**
      * Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.
      */
@@ -553,6 +216,10 @@ export interface SyntheticsTestState {
      * Required if `type = "api"`. The synthetics test request.
      */
     requestDefinition?: pulumi.Input<inputs.SyntheticsTestRequestDefinition>;
+    /**
+     * Files to be used as part of the request in the test.
+     */
+    requestFiles?: pulumi.Input<pulumi.Input<inputs.SyntheticsTestRequestFile>[]>;
     /**
      * Header name and value map.
      */
@@ -595,13 +262,17 @@ export interface SyntheticsTestState {
      * Synthetics test type. Valid values are `api`, `browser`.
      */
     type?: pulumi.Input<string>;
+    /**
+     * Variables defined from JavaScript code for API HTTP tests.
+     */
+    variablesFromScript?: pulumi.Input<string>;
 }
 /**
  * The set of arguments for constructing a SyntheticsTest resource.
  */
 export interface SyntheticsTestArgs {
     /**
-     * Steps for multistep api tests
+     * Steps for multi-step api tests
      */
     apiSteps?: pulumi.Input<pulumi.Input<inputs.SyntheticsTestApiStep>[]>;
     /**
@@ -624,6 +295,10 @@ export interface SyntheticsTestArgs {
      * Required if `type = "browser"`. Array with the different device IDs used to run the test. 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>[]>;
+    /**
+     * A boolean indicating whether this synthetics test can be deleted even if it's referenced by other resources (for example, SLOs and composite monitors).
+     */
+    forceDeleteDependencies?: pulumi.Input<boolean>;
     /**
      * Array of locations used to run the test. Refer to the Datadog Synthetics location data source to retrieve the list of locations.
      */
@@ -649,6 +324,10 @@ export interface SyntheticsTestArgs {
      * Required if `type = "api"`. The synthetics test request.
      */
     requestDefinition?: pulumi.Input<inputs.SyntheticsTestRequestDefinition>;
+    /**
+     * Files to be used as part of the request in the test.
+     */
+    requestFiles?: pulumi.Input<pulumi.Input<inputs.SyntheticsTestRequestFile>[]>;
     /**
      * Header name and value map.
      */
@@ -691,4 +370,8 @@ export interface SyntheticsTestArgs {
      * Synthetics test type. Valid values are `api`, `browser`.
      */
     type: pulumi.Input<string>;
+    /**
+     * Variables defined from JavaScript code for API HTTP tests.
+     */
+    variablesFromScript?: pulumi.Input<string>;
 }