1. Packages
  2. Datadog Provider
  3. API Docs
  4. SyntheticsSuite
Datadog v4.64.0 published on Thursday, Jan 29, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-datadog

datadog.SyntheticsSuite

datadog logo
Datadog v4.64.0 published on Thursday, Jan 29, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-datadog

    Provides a Datadog Synthetics Suite resource. This can be used to create and manage Synthetics test suites.

    Create SyntheticsSuite Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SyntheticsSuite(name: string, args: SyntheticsSuiteArgs, opts?: CustomResourceOptions);
    @overload
def SyntheticsSuite(resource_name: str,
                    args: SyntheticsSuiteArgs,
                    opts: Optional[ResourceOptions] = None)

@overload
def SyntheticsSuite(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    name: Optional[str] = None,
                    message: Optional[str] = None,
                    options: Optional[Sequence[SyntheticsSuiteOptionArgs]] = None,
                    tags: Optional[Sequence[str]] = None,
                    tests: Optional[Sequence[SyntheticsSuiteTestArgs]] = None)
    func NewSyntheticsSuite(ctx *Context, name string, args SyntheticsSuiteArgs, opts ...ResourceOption) (*SyntheticsSuite, error)
    public SyntheticsSuite(string name, SyntheticsSuiteArgs args, CustomResourceOptions? opts = null)
    public SyntheticsSuite(String name, SyntheticsSuiteArgs args)
public SyntheticsSuite(String name, SyntheticsSuiteArgs args, CustomResourceOptions options)

    type: datadog:SyntheticsSuite
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 SyntheticsSuiteArgs
    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 SyntheticsSuiteArgs
    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 SyntheticsSuiteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SyntheticsSuiteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SyntheticsSuiteArgs
    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 syntheticsSuiteResource = new Datadog.SyntheticsSuite("syntheticsSuiteResource", new()
{
    Name = "string",
    Message = "string",
    Options = new[]
    {
        new Datadog.Inputs.SyntheticsSuiteOptionArgs
        {
            AlertingThreshold = 0,
        },
    },
    Tags = new[]
    {
        "string",
    },
    Tests = new[]
    {
        new Datadog.Inputs.SyntheticsSuiteTestArgs
        {
            PublicId = "string",
            AlertingCriticality = "string",
        },
    },
});

    example, err := datadog.NewSyntheticsSuite(ctx, "syntheticsSuiteResource", &datadog.SyntheticsSuiteArgs{
	Name:    pulumi.String("string"),
	Message: pulumi.String("string"),
	Options: datadog.SyntheticsSuiteOptionArray{
		&datadog.SyntheticsSuiteOptionArgs{
			AlertingThreshold: pulumi.Float64(0),
		},
	},
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tests: datadog.SyntheticsSuiteTestArray{
		&datadog.SyntheticsSuiteTestArgs{
			PublicId:            pulumi.String("string"),
			AlertingCriticality: pulumi.String("string"),
		},
	},
})

    var syntheticsSuiteResource = new SyntheticsSuite("syntheticsSuiteResource", SyntheticsSuiteArgs.builder()
    .name("string")
    .message("string")
    .options(SyntheticsSuiteOptionArgs.builder()
        .alertingThreshold(0.0)
        .build())
    .tags("string")
    .tests(SyntheticsSuiteTestArgs.builder()
        .publicId("string")
        .alertingCriticality("string")
        .build())
    .build());

    synthetics_suite_resource = datadog.SyntheticsSuite("syntheticsSuiteResource",
    name="string",
    message="string",
    options=[{
        "alerting_threshold": 0,
    }],
    tags=["string"],
    tests=[{
        "public_id": "string",
        "alerting_criticality": "string",
    }])

    const syntheticsSuiteResource = new datadog.SyntheticsSuite("syntheticsSuiteResource", {
    name: "string",
    message: "string",
    options: [{
        alertingThreshold: 0,
    }],
    tags: ["string"],
    tests: [{
        publicId: "string",
        alertingCriticality: "string",
    }],
});

    type: datadog:SyntheticsSuite
properties:
    message: string
    name: string
    options:
        - alertingThreshold: 0
    tags:
        - string
    tests:
        - alertingCriticality: string
          publicId: string

    SyntheticsSuite Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SyntheticsSuite resource accepts the following input properties:

    Name string
    Name of the Synthetics suite.
    Message string
    Message of the Synthetics suite.
    Options List<SyntheticsSuiteOption>
    Options for the Synthetics suite.
    Tags List<string>
    A set of tags to associate with your synthetics suite.
    Tests List<SyntheticsSuiteTest>
    List of tests in the Synthetics suite. Can be empty but the field is always sent to the API.
    Name string
    Name of the Synthetics suite.
    Message string
    Message of the Synthetics suite.
    Options []SyntheticsSuiteOptionArgs
    Options for the Synthetics suite.
    Tags []string
    A set of tags to associate with your synthetics suite.
    Tests []SyntheticsSuiteTestArgs
    List of tests in the Synthetics suite. Can be empty but the field is always sent to the API.
    name String
    Name of the Synthetics suite.
    message String
    Message of the Synthetics suite.
    options List<SyntheticsSuiteOption>
    Options for the Synthetics suite.
    tags List<String>
    A set of tags to associate with your synthetics suite.
    tests List<SyntheticsSuiteTest>
    List of tests in the Synthetics suite. Can be empty but the field is always sent to the API.
    name string
    Name of the Synthetics suite.
    message string
    Message of the Synthetics suite.
    options SyntheticsSuiteOption[]
    Options for the Synthetics suite.
    tags string[]
    A set of tags to associate with your synthetics suite.
    tests SyntheticsSuiteTest[]
    List of tests in the Synthetics suite. Can be empty but the field is always sent to the API.
    name str
    Name of the Synthetics suite.
    message str
    Message of the Synthetics suite.
    options Sequence[SyntheticsSuiteOptionArgs]
    Options for the Synthetics suite.
    tags Sequence[str]
    A set of tags to associate with your synthetics suite.
    tests Sequence[SyntheticsSuiteTestArgs]
    List of tests in the Synthetics suite. Can be empty but the field is always sent to the API.
    name String
    Name of the Synthetics suite.
    message String
    Message of the Synthetics suite.
    options List<Property Map>
    Options for the Synthetics suite.
    tags List<String>
    A set of tags to associate with your synthetics suite.
    tests List<Property Map>
    List of tests in the Synthetics suite. Can be empty but the field is always sent to the API.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SyntheticsSuite Resource

    Get an existing SyntheticsSuite 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?: SyntheticsSuiteState, opts?: CustomResourceOptions): SyntheticsSuite
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        message: Optional[str] = None,
        name: Optional[str] = None,
        options: Optional[Sequence[SyntheticsSuiteOptionArgs]] = None,
        tags: Optional[Sequence[str]] = None,
        tests: Optional[Sequence[SyntheticsSuiteTestArgs]] = None) -> SyntheticsSuite
    func GetSyntheticsSuite(ctx *Context, name string, id IDInput, state *SyntheticsSuiteState, opts ...ResourceOption) (*SyntheticsSuite, error)
    public static SyntheticsSuite Get(string name, Input<string> id, SyntheticsSuiteState? state, CustomResourceOptions? opts = null)
    public static SyntheticsSuite get(String name, Output<String> id, SyntheticsSuiteState state, CustomResourceOptions options)
    resources:  _:    type: datadog:SyntheticsSuite    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Message string
    Message of the Synthetics suite.
    Name string
    Name of the Synthetics suite.
    Options List<SyntheticsSuiteOption>
    Options for the Synthetics suite.
    Tags List<string>
    A set of tags to associate with your synthetics suite.
    Tests List<SyntheticsSuiteTest>
    List of tests in the Synthetics suite. Can be empty but the field is always sent to the API.
    Message string
    Message of the Synthetics suite.
    Name string
    Name of the Synthetics suite.
    Options []SyntheticsSuiteOptionArgs
    Options for the Synthetics suite.
    Tags []string
    A set of tags to associate with your synthetics suite.
    Tests []SyntheticsSuiteTestArgs
    List of tests in the Synthetics suite. Can be empty but the field is always sent to the API.
    message String
    Message of the Synthetics suite.
    name String
    Name of the Synthetics suite.
    options List<SyntheticsSuiteOption>
    Options for the Synthetics suite.
    tags List<String>
    A set of tags to associate with your synthetics suite.
    tests List<SyntheticsSuiteTest>
    List of tests in the Synthetics suite. Can be empty but the field is always sent to the API.
    message string
    Message of the Synthetics suite.
    name string
    Name of the Synthetics suite.
    options SyntheticsSuiteOption[]
    Options for the Synthetics suite.
    tags string[]
    A set of tags to associate with your synthetics suite.
    tests SyntheticsSuiteTest[]
    List of tests in the Synthetics suite. Can be empty but the field is always sent to the API.
    message str
    Message of the Synthetics suite.
    name str
    Name of the Synthetics suite.
    options Sequence[SyntheticsSuiteOptionArgs]
    Options for the Synthetics suite.
    tags Sequence[str]
    A set of tags to associate with your synthetics suite.
    tests Sequence[SyntheticsSuiteTestArgs]
    List of tests in the Synthetics suite. Can be empty but the field is always sent to the API.
    message String
    Message of the Synthetics suite.
    name String
    Name of the Synthetics suite.
    options List<Property Map>
    Options for the Synthetics suite.
    tags List<String>
    A set of tags to associate with your synthetics suite.
    tests List<Property Map>
    List of tests in the Synthetics suite. Can be empty but the field is always sent to the API.

    Supporting Types

    SyntheticsSuiteOption, SyntheticsSuiteOptionArgs

    AlertingThreshold double
    Alerting threshold for the suite. Value must be between 0.000000 and 1.000000.
    AlertingThreshold float64
    Alerting threshold for the suite. Value must be between 0.000000 and 1.000000.
    alertingThreshold Double
    Alerting threshold for the suite. Value must be between 0.000000 and 1.000000.
    alertingThreshold number
    Alerting threshold for the suite. Value must be between 0.000000 and 1.000000.
    alerting_threshold float
    Alerting threshold for the suite. Value must be between 0.000000 and 1.000000.
    alertingThreshold Number
    Alerting threshold for the suite. Value must be between 0.000000 and 1.000000.

    SyntheticsSuiteTest, SyntheticsSuiteTestArgs

    PublicId string
    Public ID of the test.
    AlertingCriticality string
    Alerting criticality for the test. Valid values are ignore, critical.
    PublicId string
    Public ID of the test.
    AlertingCriticality string
    Alerting criticality for the test. Valid values are ignore, critical.
    publicId String
    Public ID of the test.
    alertingCriticality String
    Alerting criticality for the test. Valid values are ignore, critical.
    publicId string
    Public ID of the test.
    alertingCriticality string
    Alerting criticality for the test. Valid values are ignore, critical.
    public_id str
    Public ID of the test.
    alerting_criticality str
    Alerting criticality for the test. Valid values are ignore, critical.
    publicId String
    Public ID of the test.
    alertingCriticality String
    Alerting criticality for the test. Valid values are ignore, critical.

    Package Details

    Repository
    Datadog pulumi/pulumi-datadog
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the datadog Terraform Provider.
    datadog logo
    Datadog v4.64.0 published on Thursday, Jan 29, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-datadog
      Meet Neo: Your AI Platform Teammate