Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. CisEdgeFunctionsTrigger
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.CisEdgeFunctionsTrigger

Explore with Pulumi AI

ibm logo
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Create, update, or delete an edge functions trigger for a domain to include in your CIS edge functions trigger resource. For more information, about CIS edge functions trigger, see working with triggers.

    Example Usage

    The example to add an edge functions trigger to the domain.

    import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

// Add a Edge Functions Trigger to the domain
const testTrigger = new ibm.CisEdgeFunctionsTrigger("testTrigger", {
    cisId: ibm_cis_edge_functions_action.test_action.cis_id,
    domainId: ibm_cis_edge_functions_action.test_action.domain_id,
    actionName: ibm_cis_edge_functions_action.test_action.action_name,
    patternUrl: "example.com/*",
});

    import pulumi
import pulumi_ibm as ibm

# Add a Edge Functions Trigger to the domain
test_trigger = ibm.CisEdgeFunctionsTrigger("testTrigger",
    cis_id=ibm_cis_edge_functions_action["test_action"]["cis_id"],
    domain_id=ibm_cis_edge_functions_action["test_action"]["domain_id"],
    action_name=ibm_cis_edge_functions_action["test_action"]["action_name"],
    pattern_url="example.com/*")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Add a Edge Functions Trigger to the domain
		_, err := ibm.NewCisEdgeFunctionsTrigger(ctx, "testTrigger", &ibm.CisEdgeFunctionsTriggerArgs{
			CisId:      pulumi.Any(ibm_cis_edge_functions_action.Test_action.Cis_id),
			DomainId:   pulumi.Any(ibm_cis_edge_functions_action.Test_action.Domain_id),
			ActionName: pulumi.Any(ibm_cis_edge_functions_action.Test_action.Action_name),
			PatternUrl: pulumi.String("example.com/*"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    // Add a Edge Functions Trigger to the domain
    var testTrigger = new Ibm.CisEdgeFunctionsTrigger("testTrigger", new()
    {
        CisId = ibm_cis_edge_functions_action.Test_action.Cis_id,
        DomainId = ibm_cis_edge_functions_action.Test_action.Domain_id,
        ActionName = ibm_cis_edge_functions_action.Test_action.Action_name,
        PatternUrl = "example.com/*",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.CisEdgeFunctionsTrigger;
import com.pulumi.ibm.CisEdgeFunctionsTriggerArgs;
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) {
        // Add a Edge Functions Trigger to the domain
        var testTrigger = new CisEdgeFunctionsTrigger("testTrigger", CisEdgeFunctionsTriggerArgs.builder()
            .cisId(ibm_cis_edge_functions_action.test_action().cis_id())
            .domainId(ibm_cis_edge_functions_action.test_action().domain_id())
            .actionName(ibm_cis_edge_functions_action.test_action().action_name())
            .patternUrl("example.com/*")
            .build());

    }
}

    resources:
  # Add a Edge Functions Trigger to the domain
  testTrigger:
    type: ibm:CisEdgeFunctionsTrigger
    properties:
      cisId: ${ibm_cis_edge_functions_action.test_action.cis_id}
      domainId: ${ibm_cis_edge_functions_action.test_action.domain_id}
      actionName: ${ibm_cis_edge_functions_action.test_action.action_name}
      patternUrl: example.com/*

    Create CisEdgeFunctionsTrigger Resource

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

    Constructor syntax

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

@overload
def CisEdgeFunctionsTrigger(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            cis_id: Optional[str] = None,
                            domain_id: Optional[str] = None,
                            pattern_url: Optional[str] = None,
                            action_name: Optional[str] = None,
                            cis_edge_functions_trigger_id: Optional[str] = None)
    func NewCisEdgeFunctionsTrigger(ctx *Context, name string, args CisEdgeFunctionsTriggerArgs, opts ...ResourceOption) (*CisEdgeFunctionsTrigger, error)
    public CisEdgeFunctionsTrigger(string name, CisEdgeFunctionsTriggerArgs args, CustomResourceOptions? opts = null)
    public CisEdgeFunctionsTrigger(String name, CisEdgeFunctionsTriggerArgs args)
public CisEdgeFunctionsTrigger(String name, CisEdgeFunctionsTriggerArgs args, CustomResourceOptions options)

    type: ibm:CisEdgeFunctionsTrigger
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 CisEdgeFunctionsTriggerArgs
    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 CisEdgeFunctionsTriggerArgs
    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 CisEdgeFunctionsTriggerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CisEdgeFunctionsTriggerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CisEdgeFunctionsTriggerArgs
    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 cisEdgeFunctionsTriggerResource = new Ibm.CisEdgeFunctionsTrigger("cisEdgeFunctionsTriggerResource", new()
{
    CisId = "string",
    DomainId = "string",
    PatternUrl = "string",
    ActionName = "string",
    CisEdgeFunctionsTriggerId = "string",
});

    example, err := ibm.NewCisEdgeFunctionsTrigger(ctx, "cisEdgeFunctionsTriggerResource", &ibm.CisEdgeFunctionsTriggerArgs{
CisId: pulumi.String("string"),
DomainId: pulumi.String("string"),
PatternUrl: pulumi.String("string"),
ActionName: pulumi.String("string"),
CisEdgeFunctionsTriggerId: pulumi.String("string"),
})

    var cisEdgeFunctionsTriggerResource = new CisEdgeFunctionsTrigger("cisEdgeFunctionsTriggerResource", CisEdgeFunctionsTriggerArgs.builder()
    .cisId("string")
    .domainId("string")
    .patternUrl("string")
    .actionName("string")
    .cisEdgeFunctionsTriggerId("string")
    .build());

    cis_edge_functions_trigger_resource = ibm.CisEdgeFunctionsTrigger("cisEdgeFunctionsTriggerResource",
    cis_id="string",
    domain_id="string",
    pattern_url="string",
    action_name="string",
    cis_edge_functions_trigger_id="string")

    const cisEdgeFunctionsTriggerResource = new ibm.CisEdgeFunctionsTrigger("cisEdgeFunctionsTriggerResource", {
    cisId: "string",
    domainId: "string",
    patternUrl: "string",
    actionName: "string",
    cisEdgeFunctionsTriggerId: "string",
});

    type: ibm:CisEdgeFunctionsTrigger
properties:
    actionName: string
    cisEdgeFunctionsTriggerId: string
    cisId: string
    domainId: string
    patternUrl: string

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

    CisId string
    The ID of the IBM Cloud Internet Services instance.
    DomainId string
    The ID of the domain to add the edge functions trigger.
    PatternUrl string
    The domain name pattern on which the edge function action trigger should be executed.
    ActionName string
    An action name of the edge functions action on which the trigger associates. If it is not specified, then the trigger will be disabled.
    CisEdgeFunctionsTriggerId string
    (String) The action ID with a combination of <trigger_id>,<domain_id>,<cis_id> attributes concatenate with colon (:).
    CisId string
    The ID of the IBM Cloud Internet Services instance.
    DomainId string
    The ID of the domain to add the edge functions trigger.
    PatternUrl string
    The domain name pattern on which the edge function action trigger should be executed.
    ActionName string
    An action name of the edge functions action on which the trigger associates. If it is not specified, then the trigger will be disabled.
    CisEdgeFunctionsTriggerId string
    (String) The action ID with a combination of <trigger_id>,<domain_id>,<cis_id> attributes concatenate with colon (:).
    cisId String
    The ID of the IBM Cloud Internet Services instance.
    domainId String
    The ID of the domain to add the edge functions trigger.
    patternUrl String
    The domain name pattern on which the edge function action trigger should be executed.
    actionName String
    An action name of the edge functions action on which the trigger associates. If it is not specified, then the trigger will be disabled.
    cisEdgeFunctionsTriggerId String
    (String) The action ID with a combination of <trigger_id>,<domain_id>,<cis_id> attributes concatenate with colon (:).
    cisId string
    The ID of the IBM Cloud Internet Services instance.
    domainId string
    The ID of the domain to add the edge functions trigger.
    patternUrl string
    The domain name pattern on which the edge function action trigger should be executed.
    actionName string
    An action name of the edge functions action on which the trigger associates. If it is not specified, then the trigger will be disabled.
    cisEdgeFunctionsTriggerId string
    (String) The action ID with a combination of <trigger_id>,<domain_id>,<cis_id> attributes concatenate with colon (:).
    cis_id str
    The ID of the IBM Cloud Internet Services instance.
    domain_id str
    The ID of the domain to add the edge functions trigger.
    pattern_url str
    The domain name pattern on which the edge function action trigger should be executed.
    action_name str
    An action name of the edge functions action on which the trigger associates. If it is not specified, then the trigger will be disabled.
    cis_edge_functions_trigger_id str
    (String) The action ID with a combination of <trigger_id>,<domain_id>,<cis_id> attributes concatenate with colon (:).
    cisId String
    The ID of the IBM Cloud Internet Services instance.
    domainId String
    The ID of the domain to add the edge functions trigger.
    patternUrl String
    The domain name pattern on which the edge function action trigger should be executed.
    actionName String
    An action name of the edge functions action on which the trigger associates. If it is not specified, then the trigger will be disabled.
    cisEdgeFunctionsTriggerId String
    (String) The action ID with a combination of <trigger_id>,<domain_id>,<cis_id> attributes concatenate with colon (:).

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    RequestLimitFailOpen bool
    (String) An action request limit fail open.
    TriggerId string
    (String) The route ID of an action trigger.
    Id string
    The provider-assigned unique ID for this managed resource.
    RequestLimitFailOpen bool
    (String) An action request limit fail open.
    TriggerId string
    (String) The route ID of an action trigger.
    id String
    The provider-assigned unique ID for this managed resource.
    requestLimitFailOpen Boolean
    (String) An action request limit fail open.
    triggerId String
    (String) The route ID of an action trigger.
    id string
    The provider-assigned unique ID for this managed resource.
    requestLimitFailOpen boolean
    (String) An action request limit fail open.
    triggerId string
    (String) The route ID of an action trigger.
    id str
    The provider-assigned unique ID for this managed resource.
    request_limit_fail_open bool
    (String) An action request limit fail open.
    trigger_id str
    (String) The route ID of an action trigger.
    id String
    The provider-assigned unique ID for this managed resource.
    requestLimitFailOpen Boolean
    (String) An action request limit fail open.
    triggerId String
    (String) The route ID of an action trigger.

    Look up Existing CisEdgeFunctionsTrigger Resource

    Get an existing CisEdgeFunctionsTrigger 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?: CisEdgeFunctionsTriggerState, opts?: CustomResourceOptions): CisEdgeFunctionsTrigger
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action_name: Optional[str] = None,
        cis_edge_functions_trigger_id: Optional[str] = None,
        cis_id: Optional[str] = None,
        domain_id: Optional[str] = None,
        pattern_url: Optional[str] = None,
        request_limit_fail_open: Optional[bool] = None,
        trigger_id: Optional[str] = None) -> CisEdgeFunctionsTrigger
    func GetCisEdgeFunctionsTrigger(ctx *Context, name string, id IDInput, state *CisEdgeFunctionsTriggerState, opts ...ResourceOption) (*CisEdgeFunctionsTrigger, error)
    public static CisEdgeFunctionsTrigger Get(string name, Input<string> id, CisEdgeFunctionsTriggerState? state, CustomResourceOptions? opts = null)
    public static CisEdgeFunctionsTrigger get(String name, Output<String> id, CisEdgeFunctionsTriggerState state, CustomResourceOptions options)
    resources:  _:    type: ibm:CisEdgeFunctionsTrigger    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:
    ActionName string
    An action name of the edge functions action on which the trigger associates. If it is not specified, then the trigger will be disabled.
    CisEdgeFunctionsTriggerId string
    (String) The action ID with a combination of <trigger_id>,<domain_id>,<cis_id> attributes concatenate with colon (:).
    CisId string
    The ID of the IBM Cloud Internet Services instance.
    DomainId string
    The ID of the domain to add the edge functions trigger.
    PatternUrl string
    The domain name pattern on which the edge function action trigger should be executed.
    RequestLimitFailOpen bool
    (String) An action request limit fail open.
    TriggerId string
    (String) The route ID of an action trigger.
    ActionName string
    An action name of the edge functions action on which the trigger associates. If it is not specified, then the trigger will be disabled.
    CisEdgeFunctionsTriggerId string
    (String) The action ID with a combination of <trigger_id>,<domain_id>,<cis_id> attributes concatenate with colon (:).
    CisId string
    The ID of the IBM Cloud Internet Services instance.
    DomainId string
    The ID of the domain to add the edge functions trigger.
    PatternUrl string
    The domain name pattern on which the edge function action trigger should be executed.
    RequestLimitFailOpen bool
    (String) An action request limit fail open.
    TriggerId string
    (String) The route ID of an action trigger.
    actionName String
    An action name of the edge functions action on which the trigger associates. If it is not specified, then the trigger will be disabled.
    cisEdgeFunctionsTriggerId String
    (String) The action ID with a combination of <trigger_id>,<domain_id>,<cis_id> attributes concatenate with colon (:).
    cisId String
    The ID of the IBM Cloud Internet Services instance.
    domainId String
    The ID of the domain to add the edge functions trigger.
    patternUrl String
    The domain name pattern on which the edge function action trigger should be executed.
    requestLimitFailOpen Boolean
    (String) An action request limit fail open.
    triggerId String
    (String) The route ID of an action trigger.
    actionName string
    An action name of the edge functions action on which the trigger associates. If it is not specified, then the trigger will be disabled.
    cisEdgeFunctionsTriggerId string
    (String) The action ID with a combination of <trigger_id>,<domain_id>,<cis_id> attributes concatenate with colon (:).
    cisId string
    The ID of the IBM Cloud Internet Services instance.
    domainId string
    The ID of the domain to add the edge functions trigger.
    patternUrl string
    The domain name pattern on which the edge function action trigger should be executed.
    requestLimitFailOpen boolean
    (String) An action request limit fail open.
    triggerId string
    (String) The route ID of an action trigger.
    action_name str
    An action name of the edge functions action on which the trigger associates. If it is not specified, then the trigger will be disabled.
    cis_edge_functions_trigger_id str
    (String) The action ID with a combination of <trigger_id>,<domain_id>,<cis_id> attributes concatenate with colon (:).
    cis_id str
    The ID of the IBM Cloud Internet Services instance.
    domain_id str
    The ID of the domain to add the edge functions trigger.
    pattern_url str
    The domain name pattern on which the edge function action trigger should be executed.
    request_limit_fail_open bool
    (String) An action request limit fail open.
    trigger_id str
    (String) The route ID of an action trigger.
    actionName String
    An action name of the edge functions action on which the trigger associates. If it is not specified, then the trigger will be disabled.
    cisEdgeFunctionsTriggerId String
    (String) The action ID with a combination of <trigger_id>,<domain_id>,<cis_id> attributes concatenate with colon (:).
    cisId String
    The ID of the IBM Cloud Internet Services instance.
    domainId String
    The ID of the domain to add the edge functions trigger.
    patternUrl String
    The domain name pattern on which the edge function action trigger should be executed.
    requestLimitFailOpen Boolean
    (String) An action request limit fail open.
    triggerId String
    (String) The route ID of an action trigger.

    Import

    The ibm_cis_edge_functions_trigger resource can be imported by using the ID. The ID is composed from an edge functions trigger route ID, the domain ID of the domain and the CRN (Cloud Resource Name) is concatenated with colon (:).

    The domain ID and CRN are located on the overview page of the Internet Services instance in the domain heading of the console, or by using the IBM Cloud CIS command line commands.

    • Domain ID is a 32 digit character string of the form: 9caf68812ae9b3f0377fdf986751a78f.

    • CRN is a 120 digit character string of the form: crn:v1:bluemix:public:internet-svcs:global:a/4ea1882a2d3401ed1e459979941966ea:31fa970d-51d0-4b05-893e-251cba75a7b3::.

    Edge functions trigger route ID is a 32 digit character string of the form: 48996f0da6ed76251b475971b097205c.

    Syntax

    $ pulumi import ibm:index/cisEdgeFunctionsTrigger:CisEdgeFunctionsTrigger test_trigger <trigger_id>:<domain-id>:<crn>

    Example

    $ pulumi import ibm:index/cisEdgeFunctionsTrigger:CisEdgeFunctionsTrigger test_trigger 48996f0da6ed76251b475971b097205c:9caf68812ae9b3f0377fdf986751a78f:crn:v1:ibmcloud:public:internet-svcs:global:a/4ea1882a2d3401ed1e459979941966ea:31fa970d-51d0-4b05-893e-251cba75a7b3::

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

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm