Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Datadog Provider
  3. API Docs
  4. SyntheticsPrivateLocation
Datadog v4.50.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-datadog

datadog.SyntheticsPrivateLocation

Explore with Pulumi AI

datadog logo
Datadog v4.50.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-datadog

    Provides a Datadog synthetics private location resource. This can be used to create and manage Datadog synthetics private locations.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as datadog from "@pulumi/datadog";

const privateLocation = new datadog.SyntheticsPrivateLocation("private_location", {
    name: "First private location",
    description: "Description of the private location",
    tags: [
        "foo:bar",
        "env:test",
    ],
});

    import pulumi
import pulumi_datadog as datadog

private_location = datadog.SyntheticsPrivateLocation("private_location",
    name="First private location",
    description="Description of the private location",
    tags=[
        "foo:bar",
        "env:test",
    ])

    package main

import (
	"github.com/pulumi/pulumi-datadog/sdk/v4/go/datadog"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datadog.NewSyntheticsPrivateLocation(ctx, "private_location", &datadog.SyntheticsPrivateLocationArgs{
			Name:        pulumi.String("First private location"),
			Description: pulumi.String("Description of the private location"),
			Tags: pulumi.StringArray{
				pulumi.String("foo:bar"),
				pulumi.String("env:test"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Datadog = Pulumi.Datadog;

return await Deployment.RunAsync(() => 
{
    var privateLocation = new Datadog.SyntheticsPrivateLocation("private_location", new()
    {
        Name = "First private location",
        Description = "Description of the private location",
        Tags = new[]
        {
            "foo:bar",
            "env:test",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.datadog.SyntheticsPrivateLocation;
import com.pulumi.datadog.SyntheticsPrivateLocationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var privateLocation = new SyntheticsPrivateLocation("privateLocation", SyntheticsPrivateLocationArgs.builder()
            .name("First private location")
            .description("Description of the private location")
            .tags(            
                "foo:bar",
                "env:test")
            .build());

    }
}

    resources:
  privateLocation:
    type: datadog:SyntheticsPrivateLocation
    name: private_location
    properties:
      name: First private location
      description: Description of the private location
      tags:
        - foo:bar
        - env:test

    Create SyntheticsPrivateLocation Resource

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

    Constructor syntax

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

@overload
def SyntheticsPrivateLocation(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              name: Optional[str] = None,
                              description: Optional[str] = None,
                              metadata: Optional[SyntheticsPrivateLocationMetadataArgs] = None,
                              tags: Optional[Sequence[str]] = None)
    func NewSyntheticsPrivateLocation(ctx *Context, name string, args SyntheticsPrivateLocationArgs, opts ...ResourceOption) (*SyntheticsPrivateLocation, error)
    public SyntheticsPrivateLocation(string name, SyntheticsPrivateLocationArgs args, CustomResourceOptions? opts = null)
    public SyntheticsPrivateLocation(String name, SyntheticsPrivateLocationArgs args)
public SyntheticsPrivateLocation(String name, SyntheticsPrivateLocationArgs args, CustomResourceOptions options)

    type: datadog:SyntheticsPrivateLocation
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 SyntheticsPrivateLocationArgs
    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 SyntheticsPrivateLocationArgs
    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 SyntheticsPrivateLocationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SyntheticsPrivateLocationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SyntheticsPrivateLocationArgs
    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 syntheticsPrivateLocationResource = new Datadog.SyntheticsPrivateLocation("syntheticsPrivateLocationResource", new()
{
    Name = "string",
    Description = "string",
    Metadata = null,
    Tags = new[]
    {
        "string",
    },
});

    example, err := datadog.NewSyntheticsPrivateLocation(ctx, "syntheticsPrivateLocationResource", &datadog.SyntheticsPrivateLocationArgs{
	Name:        pulumi.String("string"),
	Description: pulumi.String("string"),
	Metadata:    &datadog.SyntheticsPrivateLocationMetadataArgs{},
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var syntheticsPrivateLocationResource = new SyntheticsPrivateLocation("syntheticsPrivateLocationResource", SyntheticsPrivateLocationArgs.builder()
    .name("string")
    .description("string")
    .metadata(SyntheticsPrivateLocationMetadataArgs.builder()
        .build())
    .tags("string")
    .build());

    synthetics_private_location_resource = datadog.SyntheticsPrivateLocation("syntheticsPrivateLocationResource",
    name="string",
    description="string",
    metadata={},
    tags=["string"])

    const syntheticsPrivateLocationResource = new datadog.SyntheticsPrivateLocation("syntheticsPrivateLocationResource", {
    name: "string",
    description: "string",
    metadata: {},
    tags: ["string"],
});

    type: datadog:SyntheticsPrivateLocation
properties:
    description: string
    metadata: {}
    name: string
    tags:
        - string

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

    Name string
    Synthetics private location name.
    Description string
    Description of the private location. Defaults to "".
    Metadata SyntheticsPrivateLocationMetadata
    The private location metadata
    Tags List<string>
    A list of tags to associate with your synthetics private location.
    Name string
    Synthetics private location name.
    Description string
    Description of the private location. Defaults to "".
    Metadata SyntheticsPrivateLocationMetadataArgs
    The private location metadata
    Tags []string
    A list of tags to associate with your synthetics private location.
    name String
    Synthetics private location name.
    description String
    Description of the private location. Defaults to "".
    metadata SyntheticsPrivateLocationMetadata
    The private location metadata
    tags List<String>
    A list of tags to associate with your synthetics private location.
    name string
    Synthetics private location name.
    description string
    Description of the private location. Defaults to "".
    metadata SyntheticsPrivateLocationMetadata
    The private location metadata
    tags string[]
    A list of tags to associate with your synthetics private location.
    name str
    Synthetics private location name.
    description str
    Description of the private location. Defaults to "".
    metadata SyntheticsPrivateLocationMetadataArgs
    The private location metadata
    tags Sequence[str]
    A list of tags to associate with your synthetics private location.
    name String
    Synthetics private location name.
    description String
    Description of the private location. Defaults to "".
    metadata Property Map
    The private location metadata
    tags List<String>
    A list of tags to associate with your synthetics private location.

    Outputs

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

    Config string
    Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration.
    Id string
    The provider-assigned unique ID for this managed resource.
    Config string
    Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration.
    Id string
    The provider-assigned unique ID for this managed resource.
    config String
    Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration.
    id String
    The provider-assigned unique ID for this managed resource.
    config string
    Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration.
    id string
    The provider-assigned unique ID for this managed resource.
    config str
    Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration.
    id str
    The provider-assigned unique ID for this managed resource.
    config String
    Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SyntheticsPrivateLocation Resource

    Get an existing SyntheticsPrivateLocation 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?: SyntheticsPrivateLocationState, opts?: CustomResourceOptions): SyntheticsPrivateLocation
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[str] = None,
        description: Optional[str] = None,
        metadata: Optional[SyntheticsPrivateLocationMetadataArgs] = None,
        name: Optional[str] = None,
        tags: Optional[Sequence[str]] = None) -> SyntheticsPrivateLocation
    func GetSyntheticsPrivateLocation(ctx *Context, name string, id IDInput, state *SyntheticsPrivateLocationState, opts ...ResourceOption) (*SyntheticsPrivateLocation, error)
    public static SyntheticsPrivateLocation Get(string name, Input<string> id, SyntheticsPrivateLocationState? state, CustomResourceOptions? opts = null)
    public static SyntheticsPrivateLocation get(String name, Output<String> id, SyntheticsPrivateLocationState state, CustomResourceOptions options)
    resources:  _:    type: datadog:SyntheticsPrivateLocation    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:
    Config string
    Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration.
    Description string
    Description of the private location. Defaults to "".
    Metadata SyntheticsPrivateLocationMetadata
    The private location metadata
    Name string
    Synthetics private location name.
    Tags List<string>
    A list of tags to associate with your synthetics private location.
    Config string
    Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration.
    Description string
    Description of the private location. Defaults to "".
    Metadata SyntheticsPrivateLocationMetadataArgs
    The private location metadata
    Name string
    Synthetics private location name.
    Tags []string
    A list of tags to associate with your synthetics private location.
    config String
    Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration.
    description String
    Description of the private location. Defaults to "".
    metadata SyntheticsPrivateLocationMetadata
    The private location metadata
    name String
    Synthetics private location name.
    tags List<String>
    A list of tags to associate with your synthetics private location.
    config string
    Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration.
    description string
    Description of the private location. Defaults to "".
    metadata SyntheticsPrivateLocationMetadata
    The private location metadata
    name string
    Synthetics private location name.
    tags string[]
    A list of tags to associate with your synthetics private location.
    config str
    Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration.
    description str
    Description of the private location. Defaults to "".
    metadata SyntheticsPrivateLocationMetadataArgs
    The private location metadata
    name str
    Synthetics private location name.
    tags Sequence[str]
    A list of tags to associate with your synthetics private location.
    config String
    Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration.
    description String
    Description of the private location. Defaults to "".
    metadata Property Map
    The private location metadata
    name String
    Synthetics private location name.
    tags List<String>
    A list of tags to associate with your synthetics private location.

    Supporting Types

    SyntheticsPrivateLocationMetadata, SyntheticsPrivateLocationMetadataArgs

    RestrictedRoles List<string>
    A set of role identifiers pulled from the Roles API to restrict read and write access. Deprecated. This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    RestrictedRoles []string
    A set of role identifiers pulled from the Roles API to restrict read and write access. Deprecated. This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    restrictedRoles List<String>
    A set of role identifiers pulled from the Roles API to restrict read and write access. Deprecated. This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    restrictedRoles string[]
    A set of role identifiers pulled from the Roles API to restrict read and write access. Deprecated. This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    restricted_roles Sequence[str]
    A set of role identifiers pulled from the Roles API to restrict read and write access. Deprecated. This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    restrictedRoles List<String>
    A set of role identifiers pulled from the Roles API to restrict read and write access. Deprecated. This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Deprecated: This field is no longer supported by the Datadog API. Please use datadog.RestrictionPolicy instead.

    Import

    Synthetics private locations can be imported using their string ID, e.g.

    $ pulumi import datadog:index/syntheticsPrivateLocation:SyntheticsPrivateLocation bar pl:private-location-name-abcdef123456

    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 datadog Terraform Provider.
    datadog logo
    Datadog v4.50.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-datadog