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

checkly.Snippet

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 example1 = new checkly.Snippet("example_1", {
        name: "Example 1",
        script: "console.log('test');",
    });
    // An alternative way to use multi-line script.
    const example2 = new checkly.Snippet("example_2", {
        name: "Example 2",
        script: `    console.log('test1');
        console.log('test2');
    `,
    });
    
    import pulumi
    import pulumi_checkly as checkly
    
    example1 = checkly.Snippet("example_1",
        name="Example 1",
        script="console.log('test');")
    # An alternative way to use multi-line script.
    example2 = checkly.Snippet("example_2",
        name="Example 2",
        script="""    console.log('test1');
        console.log('test2');
    """)
    
    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.NewSnippet(ctx, "example_1", &checkly.SnippetArgs{
    			Name:   pulumi.String("Example 1"),
    			Script: pulumi.String("console.log('test');"),
    		})
    		if err != nil {
    			return err
    		}
    		// An alternative way to use multi-line script.
    		_, err = checkly.NewSnippet(ctx, "example_2", &checkly.SnippetArgs{
    			Name:   pulumi.String("Example 2"),
    			Script: pulumi.String("    console.log('test1');\n    console.log('test2');\n"),
    		})
    		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 example1 = new Checkly.Snippet("example_1", new()
        {
            Name = "Example 1",
            Script = "console.log('test');",
        });
    
        // An alternative way to use multi-line script.
        var example2 = new Checkly.Snippet("example_2", new()
        {
            Name = "Example 2",
            Script = @"    console.log('test1');
        console.log('test2');
    ",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.checkly.Snippet;
    import com.pulumi.checkly.SnippetArgs;
    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 example1 = new Snippet("example1", SnippetArgs.builder()
                .name("Example 1")
                .script("console.log('test');")
                .build());
    
            // An alternative way to use multi-line script.
            var example2 = new Snippet("example2", SnippetArgs.builder()
                .name("Example 2")
                .script("""
        console.log('test1');
        console.log('test2');
                """)
                .build());
    
        }
    }
    
    resources:
      example1:
        type: checkly:Snippet
        name: example_1
        properties:
          name: Example 1
          script: console.log('test');
      # An alternative way to use multi-line script.
      example2:
        type: checkly:Snippet
        name: example_2
        properties:
          name: Example 2
          script: |2
                console.log('test1');
                console.log('test2');
    

    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

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

    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)
    resources:  _:    type: checkly:Snippet    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:
    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
    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