Docs Packages
  1. Packages
  2. Checkly
  3. API Docs
  4. Snippet
Checkly v1.1.4 published on Thursday, Mar 9, 2023 by checkly
checkly/pulumi-checkly

checkly.Snippet

Explore with Pulumi AI

checkly logo
Checkly v1.1.4 published on Thursday, Mar 9, 2023 by checkly
checkly/pulumi-checkly

    Create Snippet Resource

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

    Constructor syntax

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

@overload
def Snippet(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            script: Optional[str] = None,
            name: Optional[str] = None)
    func NewSnippet(ctx *Context, name string, args SnippetArgs, opts ...ResourceOption) (*Snippet, error)
    public Snippet(string name, SnippetArgs args, CustomResourceOptions? opts = null)
    public Snippet(String name, SnippetArgs args)
public Snippet(String name, SnippetArgs args, CustomResourceOptions options)

    type: checkly:Snippet
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 SnippetArgs
    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 SnippetArgs
    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 SnippetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SnippetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SnippetArgs
    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 snippetResource = new Checkly.Snippet("snippetResource", new()
{
    Script = "string",
    Name = "string",
});

    example, err := checkly.NewSnippet(ctx, "snippetResource", &checkly.SnippetArgs{
	Script: pulumi.String("string"),
	Name:   pulumi.String("string"),
})

    var snippetResource = new Snippet("snippetResource", SnippetArgs.builder()
    .script("string")
    .name("string")
    .build());

    snippet_resource = checkly.Snippet("snippetResource",
    script="string",
    name="string")

    const snippetResource = new checkly.Snippet("snippetResource", {
    script: "string",
    name: "string",
});

    type: checkly:Snippet
properties:
    name: string
    script: string

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

    Script string
    Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.
    Name string
    The name of the snippet
    Script string
    Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.
    Name string
    The name of the snippet
    script String
    Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.
    name String
    The name of the snippet
    script string
    Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.
    name string
    The name of the snippet
    script str
    Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.
    name str
    The name of the snippet
    script String
    Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.
    name String
    The name of the snippet

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Snippet 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 Snippet Resource

    Get an existing Snippet 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?: SnippetState, opts?: CustomResourceOptions): Snippet
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        script: Optional[str] = None) -> Snippet
    func GetSnippet(ctx *Context, name string, id IDInput, state *SnippetState, opts ...ResourceOption) (*Snippet, error)
    public static Snippet Get(string name, Input<string> id, SnippetState? state, CustomResourceOptions? opts = null)
    public static Snippet get(String name, Output<String> id, SnippetState 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:
    Name string
    The name of the snippet
    Script string
    Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.
    Name string
    The name of the snippet
    Script string
    Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.
    name String
    The name of the snippet
    script String
    Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.
    name string
    The name of the snippet
    script string
    Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.
    name str
    The name of the snippet
    script str
    Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.
    name String
    The name of the snippet
    script String
    Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.

    Package Details

    Repository
    checkly checkly/pulumi-checkly
    License
    MIT
    Notes
    This Pulumi package is based on the checkly Terraform Provider.
    checkly logo
    Checkly v1.1.4 published on Thursday, Mar 9, 2023 by checkly
    checkly/pulumi-checkly