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

checkly.TriggerCheck

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 testTriggerCheck = new checkly.TriggerCheck("test_trigger_check", {checkId: "c1ff95c5-d7f6-4a90-9ce2-1e605f117592"});
    export const testTriggerCheckUrl = testTriggerCheck.url;
    
    import pulumi
    import pulumi_checkly as checkly
    
    test_trigger_check = checkly.TriggerCheck("test_trigger_check", check_id="c1ff95c5-d7f6-4a90-9ce2-1e605f117592")
    pulumi.export("testTriggerCheckUrl", test_trigger_check.url)
    
    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 {
    		testTriggerCheck, err := checkly.NewTriggerCheck(ctx, "test_trigger_check", &checkly.TriggerCheckArgs{
    			CheckId: pulumi.String("c1ff95c5-d7f6-4a90-9ce2-1e605f117592"),
    		})
    		if err != nil {
    			return err
    		}
    		ctx.Export("testTriggerCheckUrl", testTriggerCheck.Url)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Checkly = Pulumi.Checkly;
    
    return await Deployment.RunAsync(() => 
    {
        var testTriggerCheck = new Checkly.TriggerCheck("test_trigger_check", new()
        {
            CheckId = "c1ff95c5-d7f6-4a90-9ce2-1e605f117592",
        });
    
        return new Dictionary<string, object?>
        {
            ["testTriggerCheckUrl"] = testTriggerCheck.Url,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.checkly.TriggerCheck;
    import com.pulumi.checkly.TriggerCheckArgs;
    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 testTriggerCheck = new TriggerCheck("testTriggerCheck", TriggerCheckArgs.builder()
                .checkId("c1ff95c5-d7f6-4a90-9ce2-1e605f117592")
                .build());
    
            ctx.export("testTriggerCheckUrl", testTriggerCheck.url());
        }
    }
    
    resources:
      testTriggerCheck:
        type: checkly:TriggerCheck
        name: test_trigger_check
        properties:
          checkId: c1ff95c5-d7f6-4a90-9ce2-1e605f117592
    outputs:
      testTriggerCheckUrl: ${testTriggerCheck.url}
    

    Create TriggerCheck Resource

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

    Constructor syntax

    new TriggerCheck(name: string, args: TriggerCheckArgs, opts?: CustomResourceOptions);
    @overload
    def TriggerCheck(resource_name: str,
                     args: TriggerCheckArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def TriggerCheck(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     check_id: Optional[str] = None,
                     token: Optional[str] = None,
                     url: Optional[str] = None)
    func NewTriggerCheck(ctx *Context, name string, args TriggerCheckArgs, opts ...ResourceOption) (*TriggerCheck, error)
    public TriggerCheck(string name, TriggerCheckArgs args, CustomResourceOptions? opts = null)
    public TriggerCheck(String name, TriggerCheckArgs args)
    public TriggerCheck(String name, TriggerCheckArgs args, CustomResourceOptions options)
    
    type: checkly:TriggerCheck
    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 TriggerCheckArgs
    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 TriggerCheckArgs
    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 TriggerCheckArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TriggerCheckArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TriggerCheckArgs
    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 triggerCheckResource = new Checkly.TriggerCheck("triggerCheckResource", new()
    {
        CheckId = "string",
        Token = "string",
        Url = "string",
    });
    
    example, err := checkly.NewTriggerCheck(ctx, "triggerCheckResource", &checkly.TriggerCheckArgs{
    	CheckId: pulumi.String("string"),
    	Token:   pulumi.String("string"),
    	Url:     pulumi.String("string"),
    })
    
    var triggerCheckResource = new TriggerCheck("triggerCheckResource", TriggerCheckArgs.builder()
        .checkId("string")
        .token("string")
        .url("string")
        .build());
    
    trigger_check_resource = checkly.TriggerCheck("triggerCheckResource",
        check_id="string",
        token="string",
        url="string")
    
    const triggerCheckResource = new checkly.TriggerCheck("triggerCheckResource", {
        checkId: "string",
        token: "string",
        url: "string",
    });
    
    type: checkly:TriggerCheck
    properties:
        checkId: string
        token: string
        url: string
    

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

    CheckId string
    The id of the check that you want to attach the trigger to.
    Token string
    The token value created to trigger the check
    Url string
    The request URL to trigger the check run.
    CheckId string
    The id of the check that you want to attach the trigger to.
    Token string
    The token value created to trigger the check
    Url string
    The request URL to trigger the check run.
    checkId String
    The id of the check that you want to attach the trigger to.
    token String
    The token value created to trigger the check
    url String
    The request URL to trigger the check run.
    checkId string
    The id of the check that you want to attach the trigger to.
    token string
    The token value created to trigger the check
    url string
    The request URL to trigger the check run.
    check_id str
    The id of the check that you want to attach the trigger to.
    token str
    The token value created to trigger the check
    url str
    The request URL to trigger the check run.
    checkId String
    The id of the check that you want to attach the trigger to.
    token String
    The token value created to trigger the check
    url String
    The request URL to trigger the check run.

    Outputs

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

    Get an existing TriggerCheck 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?: TriggerCheckState, opts?: CustomResourceOptions): TriggerCheck
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            check_id: Optional[str] = None,
            token: Optional[str] = None,
            url: Optional[str] = None) -> TriggerCheck
    func GetTriggerCheck(ctx *Context, name string, id IDInput, state *TriggerCheckState, opts ...ResourceOption) (*TriggerCheck, error)
    public static TriggerCheck Get(string name, Input<string> id, TriggerCheckState? state, CustomResourceOptions? opts = null)
    public static TriggerCheck get(String name, Output<String> id, TriggerCheckState state, CustomResourceOptions options)
    resources:  _:    type: checkly:TriggerCheck    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:
    CheckId string
    The id of the check that you want to attach the trigger to.
    Token string
    The token value created to trigger the check
    Url string
    The request URL to trigger the check run.
    CheckId string
    The id of the check that you want to attach the trigger to.
    Token string
    The token value created to trigger the check
    Url string
    The request URL to trigger the check run.
    checkId String
    The id of the check that you want to attach the trigger to.
    token String
    The token value created to trigger the check
    url String
    The request URL to trigger the check run.
    checkId string
    The id of the check that you want to attach the trigger to.
    token string
    The token value created to trigger the check
    url string
    The request URL to trigger the check run.
    check_id str
    The id of the check that you want to attach the trigger to.
    token str
    The token value created to trigger the check
    url str
    The request URL to trigger the check run.
    checkId String
    The id of the check that you want to attach the trigger to.
    token String
    The token value created to trigger the check
    url String
    The request URL to trigger the check run.

    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