1. Packages
  2. Checkly
  3. API Docs
  4. PrivateLocation
Checkly v2.0.0 published on Tuesday, Feb 4, 2025 by Checkly

checkly.PrivateLocation

Explore with Pulumi AI

checkly logo
Checkly v2.0.0 published on Tuesday, Feb 4, 2025 by Checkly

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as checkly from "@checkly/pulumi";
    
    const location = new checkly.PrivateLocation("location", {
        name: "New Private Location",
        slugName: "new-private-location",
    });
    
    import pulumi
    import pulumi_checkly as checkly
    
    location = checkly.PrivateLocation("location",
        name="New Private Location",
        slug_name="new-private-location")
    
    package main
    
    import (
    	"github.com/checkly/pulumi-checkly/sdk/v2/go/checkly"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := checkly.NewPrivateLocation(ctx, "location", &checkly.PrivateLocationArgs{
    			Name:     pulumi.String("New Private Location"),
    			SlugName: pulumi.String("new-private-location"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Checkly = Pulumi.Checkly;
    
    return await Deployment.RunAsync(() => 
    {
        var location = new Checkly.PrivateLocation("location", new()
        {
            Name = "New Private Location",
            SlugName = "new-private-location",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.checkly.PrivateLocation;
    import com.pulumi.checkly.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()
                .name("New Private Location")
                .slugName("new-private-location")
                .build());
    
        }
    }
    
    resources:
      location:
        type: checkly:PrivateLocation
        properties:
          name: New Private Location
          slugName: new-private-location
    

    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,
                        slug_name: Optional[str] = None,
                        icon: Optional[str] = None,
                        name: Optional[str] = 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: checkly: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.

    Constructor example

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

    var privateLocationResource = new Checkly.PrivateLocation("privateLocationResource", new()
    {
        SlugName = "string",
        Icon = "string",
        Name = "string",
    });
    
    example, err := checkly.NewPrivateLocation(ctx, "privateLocationResource", &checkly.PrivateLocationArgs{
    	SlugName: pulumi.String("string"),
    	Icon:     pulumi.String("string"),
    	Name:     pulumi.String("string"),
    })
    
    var privateLocationResource = new PrivateLocation("privateLocationResource", PrivateLocationArgs.builder()
        .slugName("string")
        .icon("string")
        .name("string")
        .build());
    
    private_location_resource = checkly.PrivateLocation("privateLocationResource",
        slug_name="string",
        icon="string",
        name="string")
    
    const privateLocationResource = new checkly.PrivateLocation("privateLocationResource", {
        slugName: "string",
        icon: "string",
        name: "string",
    });
    
    type: checkly:PrivateLocation
    properties:
        icon: string
        name: string
        slugName: string
    

    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

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

    The PrivateLocation resource accepts the following input properties:

    SlugName string
    Valid slug name.
    Icon string
    Icon assigned to the private location.
    Name string
    The private location name.
    SlugName string
    Valid slug name.
    Icon string
    Icon assigned to the private location.
    Name string
    The private location name.
    slugName String
    Valid slug name.
    icon String
    Icon assigned to the private location.
    name String
    The private location name.
    slugName string
    Valid slug name.
    icon string
    Icon assigned to the private location.
    name string
    The private location name.
    slug_name str
    Valid slug name.
    icon str
    Icon assigned to the private location.
    name str
    The private location name.
    slugName String
    Valid slug name.
    icon String
    Icon assigned to the private location.
    name String
    The private location name.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Keys List<string>
    Private location API keys.
    Id string
    The provider-assigned unique ID for this managed resource.
    Keys []string
    Private location API keys.
    id String
    The provider-assigned unique ID for this managed resource.
    keys List<String>
    Private location API keys.
    id string
    The provider-assigned unique ID for this managed resource.
    keys string[]
    Private location API keys.
    id str
    The provider-assigned unique ID for this managed resource.
    keys Sequence[str]
    Private location API keys.
    id String
    The provider-assigned unique ID for this managed resource.
    keys List<String>
    Private location API keys.

    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,
            icon: Optional[str] = None,
            keys: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            slug_name: Optional[str] = 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)
    resources:  _:    type: checkly:PrivateLocation    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:
    Icon string
    Icon assigned to the private location.
    Keys List<string>
    Private location API keys.
    Name string
    The private location name.
    SlugName string
    Valid slug name.
    Icon string
    Icon assigned to the private location.
    Keys []string
    Private location API keys.
    Name string
    The private location name.
    SlugName string
    Valid slug name.
    icon String
    Icon assigned to the private location.
    keys List<String>
    Private location API keys.
    name String
    The private location name.
    slugName String
    Valid slug name.
    icon string
    Icon assigned to the private location.
    keys string[]
    Private location API keys.
    name string
    The private location name.
    slugName string
    Valid slug name.
    icon str
    Icon assigned to the private location.
    keys Sequence[str]
    Private location API keys.
    name str
    The private location name.
    slug_name str
    Valid slug name.
    icon String
    Icon assigned to the private location.
    keys List<String>
    Private location API keys.
    name String
    The private location name.
    slugName String
    Valid slug name.

    Package Details

    Repository
    checkly checkly/pulumi-checkly
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the checkly Terraform Provider.
    checkly logo
    Checkly v2.0.0 published on Tuesday, Feb 4, 2025 by Checkly