1. Packages
  2. New Relic
  3. API Docs
  4. synthetics
  5. PrivateLocation
New Relic v5.22.1 published on Friday, Mar 29, 2024 by Pulumi

newrelic.synthetics.PrivateLocation

Explore with Pulumi AI

newrelic logo
New Relic v5.22.1 published on Friday, Mar 29, 2024 by Pulumi

    Use this resource to create and manage New Relic Synthetic private location.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as newrelic from "@pulumi/newrelic";
    
    const location = new newrelic.synthetics.PrivateLocation("location", {description: "The private location description"});
    
    import pulumi
    import pulumi_newrelic as newrelic
    
    location = newrelic.synthetics.PrivateLocation("location", description="The private location description")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-newrelic/sdk/v5/go/newrelic/synthetics"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := synthetics.NewPrivateLocation(ctx, "location", &synthetics.PrivateLocationArgs{
    			Description: pulumi.String("The private location description"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using NewRelic = Pulumi.NewRelic;
    
    return await Deployment.RunAsync(() => 
    {
        var location = new NewRelic.Synthetics.PrivateLocation("location", new()
        {
            Description = "The private location description",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.newrelic.synthetics.PrivateLocation;
    import com.pulumi.newrelic.synthetics.PrivateLocationArgs;
    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 location = new PrivateLocation("location", PrivateLocationArgs.builder()        
                .description("The private location description")
                .build());
    
        }
    }
    
    resources:
      location:
        type: newrelic:synthetics:PrivateLocation
        properties:
          description: The private location description
    

    Create PrivateLocation Resource

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

    Constructor syntax

    new PrivateLocation(name: string, args: PrivateLocationArgs, opts?: CustomResourceOptions);
    @overload
    def PrivateLocation(resource_name: str,
                        args: PrivateLocationArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def PrivateLocation(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        description: Optional[str] = None,
                        account_id: Optional[int] = None,
                        name: Optional[str] = None,
                        verified_script_execution: Optional[bool] = None)
    func NewPrivateLocation(ctx *Context, name string, args PrivateLocationArgs, opts ...ResourceOption) (*PrivateLocation, error)
    public PrivateLocation(string name, PrivateLocationArgs args, CustomResourceOptions? opts = null)
    public PrivateLocation(String name, PrivateLocationArgs args)
    public PrivateLocation(String name, PrivateLocationArgs args, CustomResourceOptions options)
    
    type: newrelic:synthetics:PrivateLocation
    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 PrivateLocationArgs
    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 PrivateLocationArgs
    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 PrivateLocationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivateLocationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivateLocationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var privateLocationResource = new NewRelic.Synthetics.PrivateLocation("privateLocationResource", new()
    {
        Description = "string",
        AccountId = 0,
        Name = "string",
        VerifiedScriptExecution = false,
    });
    
    example, err := synthetics.NewPrivateLocation(ctx, "privateLocationResource", &synthetics.PrivateLocationArgs{
    	Description:             pulumi.String("string"),
    	AccountId:               pulumi.Int(0),
    	Name:                    pulumi.String("string"),
    	VerifiedScriptExecution: pulumi.Bool(false),
    })
    
    var privateLocationResource = new PrivateLocation("privateLocationResource", PrivateLocationArgs.builder()        
        .description("string")
        .accountId(0)
        .name("string")
        .verifiedScriptExecution(false)
        .build());
    
    private_location_resource = newrelic.synthetics.PrivateLocation("privateLocationResource",
        description="string",
        account_id=0,
        name="string",
        verified_script_execution=False)
    
    const privateLocationResource = new newrelic.synthetics.PrivateLocation("privateLocationResource", {
        description: "string",
        accountId: 0,
        name: "string",
        verifiedScriptExecution: false,
    });
    
    type: newrelic:synthetics:PrivateLocation
    properties:
        accountId: 0
        description: string
        name: string
        verifiedScriptExecution: false
    

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

    Description string
    The private location description.
    AccountId int
    The account in which the private location will be created.
    Name string
    The name of the private location.
    VerifiedScriptExecution bool
    The private location requires a password to edit if value is true. Defaults to false
    Description string
    The private location description.
    AccountId int
    The account in which the private location will be created.
    Name string
    The name of the private location.
    VerifiedScriptExecution bool
    The private location requires a password to edit if value is true. Defaults to false
    description String
    The private location description.
    accountId Integer
    The account in which the private location will be created.
    name String
    The name of the private location.
    verifiedScriptExecution Boolean
    The private location requires a password to edit if value is true. Defaults to false
    description string
    The private location description.
    accountId number
    The account in which the private location will be created.
    name string
    The name of the private location.
    verifiedScriptExecution boolean
    The private location requires a password to edit if value is true. Defaults to false
    description str
    The private location description.
    account_id int
    The account in which the private location will be created.
    name str
    The name of the private location.
    verified_script_execution bool
    The private location requires a password to edit if value is true. Defaults to false
    description String
    The private location description.
    accountId Number
    The account in which the private location will be created.
    name String
    The name of the private location.
    verifiedScriptExecution Boolean
    The private location requires a password to edit if value is true. Defaults to false

    Outputs

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

    DomainId string
    The private location globally unique identifier.
    Guid string
    The unique client identifier for the private location in New Relic. Same as id.
    Id string
    The provider-assigned unique ID for this managed resource.
    Key string
    The private locations key.
    LocationId string
    An alternate identifier based on name.
    DomainId string
    The private location globally unique identifier.
    Guid string
    The unique client identifier for the private location in New Relic. Same as id.
    Id string
    The provider-assigned unique ID for this managed resource.
    Key string
    The private locations key.
    LocationId string
    An alternate identifier based on name.
    domainId String
    The private location globally unique identifier.
    guid String
    The unique client identifier for the private location in New Relic. Same as id.
    id String
    The provider-assigned unique ID for this managed resource.
    key String
    The private locations key.
    locationId String
    An alternate identifier based on name.
    domainId string
    The private location globally unique identifier.
    guid string
    The unique client identifier for the private location in New Relic. Same as id.
    id string
    The provider-assigned unique ID for this managed resource.
    key string
    The private locations key.
    locationId string
    An alternate identifier based on name.
    domain_id str
    The private location globally unique identifier.
    guid str
    The unique client identifier for the private location in New Relic. Same as id.
    id str
    The provider-assigned unique ID for this managed resource.
    key str
    The private locations key.
    location_id str
    An alternate identifier based on name.
    domainId String
    The private location globally unique identifier.
    guid String
    The unique client identifier for the private location in New Relic. Same as id.
    id String
    The provider-assigned unique ID for this managed resource.
    key String
    The private locations key.
    locationId String
    An alternate identifier based on name.

    Look up Existing PrivateLocation Resource

    Get an existing PrivateLocation 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?: PrivateLocationState, opts?: CustomResourceOptions): PrivateLocation
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[int] = None,
            description: Optional[str] = None,
            domain_id: Optional[str] = None,
            guid: Optional[str] = None,
            key: Optional[str] = None,
            location_id: Optional[str] = None,
            name: Optional[str] = None,
            verified_script_execution: Optional[bool] = None) -> PrivateLocation
    func GetPrivateLocation(ctx *Context, name string, id IDInput, state *PrivateLocationState, opts ...ResourceOption) (*PrivateLocation, error)
    public static PrivateLocation Get(string name, Input<string> id, PrivateLocationState? state, CustomResourceOptions? opts = null)
    public static PrivateLocation get(String name, Output<String> id, PrivateLocationState 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.
    The following state arguments are supported:
    AccountId int
    The account in which the private location will be created.
    Description string
    The private location description.
    DomainId string
    The private location globally unique identifier.
    Guid string
    The unique client identifier for the private location in New Relic. Same as id.
    Key string
    The private locations key.
    LocationId string
    An alternate identifier based on name.
    Name string
    The name of the private location.
    VerifiedScriptExecution bool
    The private location requires a password to edit if value is true. Defaults to false
    AccountId int
    The account in which the private location will be created.
    Description string
    The private location description.
    DomainId string
    The private location globally unique identifier.
    Guid string
    The unique client identifier for the private location in New Relic. Same as id.
    Key string
    The private locations key.
    LocationId string
    An alternate identifier based on name.
    Name string
    The name of the private location.
    VerifiedScriptExecution bool
    The private location requires a password to edit if value is true. Defaults to false
    accountId Integer
    The account in which the private location will be created.
    description String
    The private location description.
    domainId String
    The private location globally unique identifier.
    guid String
    The unique client identifier for the private location in New Relic. Same as id.
    key String
    The private locations key.
    locationId String
    An alternate identifier based on name.
    name String
    The name of the private location.
    verifiedScriptExecution Boolean
    The private location requires a password to edit if value is true. Defaults to false
    accountId number
    The account in which the private location will be created.
    description string
    The private location description.
    domainId string
    The private location globally unique identifier.
    guid string
    The unique client identifier for the private location in New Relic. Same as id.
    key string
    The private locations key.
    locationId string
    An alternate identifier based on name.
    name string
    The name of the private location.
    verifiedScriptExecution boolean
    The private location requires a password to edit if value is true. Defaults to false
    account_id int
    The account in which the private location will be created.
    description str
    The private location description.
    domain_id str
    The private location globally unique identifier.
    guid str
    The unique client identifier for the private location in New Relic. Same as id.
    key str
    The private locations key.
    location_id str
    An alternate identifier based on name.
    name str
    The name of the private location.
    verified_script_execution bool
    The private location requires a password to edit if value is true. Defaults to false
    accountId Number
    The account in which the private location will be created.
    description String
    The private location description.
    domainId String
    The private location globally unique identifier.
    guid String
    The unique client identifier for the private location in New Relic. Same as id.
    key String
    The private locations key.
    locationId String
    An alternate identifier based on name.
    name String
    The name of the private location.
    verifiedScriptExecution Boolean
    The private location requires a password to edit if value is true. Defaults to false

    Import

    A Synthetics private location can be imported using the guid

    $ pulumi import newrelic:synthetics/privateLocation:PrivateLocation location GUID
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    New Relic pulumi/pulumi-newrelic
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the newrelic Terraform Provider.
    newrelic logo
    New Relic v5.22.1 published on Friday, Mar 29, 2024 by Pulumi