Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. CisWebhook
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.CisWebhook

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Provides a IBM CIS Webhook. This resource is associated with an IBM Cloud Internet Services (CIS) instance and a CIS Domain resource. It allows to create, update, delete webhook of a CIS instance. For more information, see IBM Cloud Internet Services.

    Create CisWebhook Resource

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

    Constructor syntax

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

@overload
def CisWebhook(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               cis_id: Optional[str] = None,
               cis_webhook_id: Optional[str] = None,
               name: Optional[str] = None,
               secret: Optional[str] = None,
               url: Optional[str] = None)
    func NewCisWebhook(ctx *Context, name string, args CisWebhookArgs, opts ...ResourceOption) (*CisWebhook, error)
    public CisWebhook(string name, CisWebhookArgs args, CustomResourceOptions? opts = null)
    public CisWebhook(String name, CisWebhookArgs args)
public CisWebhook(String name, CisWebhookArgs args, CustomResourceOptions options)

    type: ibm:CisWebhook
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 CisWebhookArgs
    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 CisWebhookArgs
    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 CisWebhookArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CisWebhookArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CisWebhookArgs
    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 cisWebhookResource = new Ibm.CisWebhook("cisWebhookResource", new()
{
    CisId = "string",
    CisWebhookId = "string",
    Name = "string",
    Secret = "string",
    Url = "string",
});

    example, err := ibm.NewCisWebhook(ctx, "cisWebhookResource", &ibm.CisWebhookArgs{
	CisId:        pulumi.String("string"),
	CisWebhookId: pulumi.String("string"),
	Name:         pulumi.String("string"),
	Secret:       pulumi.String("string"),
	Url:          pulumi.String("string"),
})

    var cisWebhookResource = new CisWebhook("cisWebhookResource", CisWebhookArgs.builder()
    .cisId("string")
    .cisWebhookId("string")
    .name("string")
    .secret("string")
    .url("string")
    .build());

    cis_webhook_resource = ibm.CisWebhook("cisWebhookResource",
    cis_id="string",
    cis_webhook_id="string",
    name="string",
    secret="string",
    url="string")

    const cisWebhookResource = new ibm.CisWebhook("cisWebhookResource", {
    cisId: "string",
    cisWebhookId: "string",
    name: "string",
    secret: "string",
    url: "string",
});

    type: ibm:CisWebhook
properties:
    cisId: string
    cisWebhookId: string
    name: string
    secret: string
    url: string

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

    CisId string
    The ID of the CIS service instance.
    CisWebhookId string
    (String) The ID of webhook resource. It is a combination of <webhook-id>:<crn> attributes concatenated with ":".
    Name string
    Name of the Webhook.
    Secret string
    This is Sensitive and optional secret or API key needed to use the webhook.
    Url string
    Webhook Url.
    CisId string
    The ID of the CIS service instance.
    CisWebhookId string
    (String) The ID of webhook resource. It is a combination of <webhook-id>:<crn> attributes concatenated with ":".
    Name string
    Name of the Webhook.
    Secret string
    This is Sensitive and optional secret or API key needed to use the webhook.
    Url string
    Webhook Url.
    cisId String
    The ID of the CIS service instance.
    cisWebhookId String
    (String) The ID of webhook resource. It is a combination of <webhook-id>:<crn> attributes concatenated with ":".
    name String
    Name of the Webhook.
    secret String
    This is Sensitive and optional secret or API key needed to use the webhook.
    url String
    Webhook Url.
    cisId string
    The ID of the CIS service instance.
    cisWebhookId string
    (String) The ID of webhook resource. It is a combination of <webhook-id>:<crn> attributes concatenated with ":".
    name string
    Name of the Webhook.
    secret string
    This is Sensitive and optional secret or API key needed to use the webhook.
    url string
    Webhook Url.
    cis_id str
    The ID of the CIS service instance.
    cis_webhook_id str
    (String) The ID of webhook resource. It is a combination of <webhook-id>:<crn> attributes concatenated with ":".
    name str
    Name of the Webhook.
    secret str
    This is Sensitive and optional secret or API key needed to use the webhook.
    url str
    Webhook Url.
    cisId String
    The ID of the CIS service instance.
    cisWebhookId String
    (String) The ID of webhook resource. It is a combination of <webhook-id>:<crn> attributes concatenated with ":".
    name String
    Name of the Webhook.
    secret String
    This is Sensitive and optional secret or API key needed to use the webhook.
    url String
    Webhook Url.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Webhook Type
    WebhookId string
    (String) Unique identifier for the Webhook.
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Webhook Type
    WebhookId string
    (String) Unique identifier for the Webhook.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Webhook Type
    webhookId String
    (String) Unique identifier for the Webhook.
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    Webhook Type
    webhookId string
    (String) Unique identifier for the Webhook.
    id str
    The provider-assigned unique ID for this managed resource.
    type str
    Webhook Type
    webhook_id str
    (String) Unique identifier for the Webhook.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Webhook Type
    webhookId String
    (String) Unique identifier for the Webhook.

    Look up Existing CisWebhook Resource

    Get an existing CisWebhook 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?: CisWebhookState, opts?: CustomResourceOptions): CisWebhook
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cis_id: Optional[str] = None,
        cis_webhook_id: Optional[str] = None,
        name: Optional[str] = None,
        secret: Optional[str] = None,
        type: Optional[str] = None,
        url: Optional[str] = None,
        webhook_id: Optional[str] = None) -> CisWebhook
    func GetCisWebhook(ctx *Context, name string, id IDInput, state *CisWebhookState, opts ...ResourceOption) (*CisWebhook, error)
    public static CisWebhook Get(string name, Input<string> id, CisWebhookState? state, CustomResourceOptions? opts = null)
    public static CisWebhook get(String name, Output<String> id, CisWebhookState state, CustomResourceOptions options)
    resources:  _:    type: ibm:CisWebhook    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:
    CisId string
    The ID of the CIS service instance.
    CisWebhookId string
    (String) The ID of webhook resource. It is a combination of <webhook-id>:<crn> attributes concatenated with ":".
    Name string
    Name of the Webhook.
    Secret string
    This is Sensitive and optional secret or API key needed to use the webhook.
    Type string
    Webhook Type
    Url string
    Webhook Url.
    WebhookId string
    (String) Unique identifier for the Webhook.
    CisId string
    The ID of the CIS service instance.
    CisWebhookId string
    (String) The ID of webhook resource. It is a combination of <webhook-id>:<crn> attributes concatenated with ":".
    Name string
    Name of the Webhook.
    Secret string
    This is Sensitive and optional secret or API key needed to use the webhook.
    Type string
    Webhook Type
    Url string
    Webhook Url.
    WebhookId string
    (String) Unique identifier for the Webhook.
    cisId String
    The ID of the CIS service instance.
    cisWebhookId String
    (String) The ID of webhook resource. It is a combination of <webhook-id>:<crn> attributes concatenated with ":".
    name String
    Name of the Webhook.
    secret String
    This is Sensitive and optional secret or API key needed to use the webhook.
    type String
    Webhook Type
    url String
    Webhook Url.
    webhookId String
    (String) Unique identifier for the Webhook.
    cisId string
    The ID of the CIS service instance.
    cisWebhookId string
    (String) The ID of webhook resource. It is a combination of <webhook-id>:<crn> attributes concatenated with ":".
    name string
    Name of the Webhook.
    secret string
    This is Sensitive and optional secret or API key needed to use the webhook.
    type string
    Webhook Type
    url string
    Webhook Url.
    webhookId string
    (String) Unique identifier for the Webhook.
    cis_id str
    The ID of the CIS service instance.
    cis_webhook_id str
    (String) The ID of webhook resource. It is a combination of <webhook-id>:<crn> attributes concatenated with ":".
    name str
    Name of the Webhook.
    secret str
    This is Sensitive and optional secret or API key needed to use the webhook.
    type str
    Webhook Type
    url str
    Webhook Url.
    webhook_id str
    (String) Unique identifier for the Webhook.
    cisId String
    The ID of the CIS service instance.
    cisWebhookId String
    (String) The ID of webhook resource. It is a combination of <webhook-id>:<crn> attributes concatenated with ":".
    name String
    Name of the Webhook.
    secret String
    This is Sensitive and optional secret or API key needed to use the webhook.
    type String
    Webhook Type
    url String
    Webhook Url.
    webhookId String
    (String) Unique identifier for the Webhook.

    Import

    The ibm_cis_webhook resource can be imported using the id. The ID is formed from the Webhook IDand the CRN (Cloud Resource Name) concatentated usinga : character.

    The CRN will be located on the Overview page of the Internet Services instance under the Domain heading of the UI, or via using the ibmcloud cis CLI commands.

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

    • Webhook ID is a 32 digit character string of the form: d72c91492cc24d8286fb713d406abe91.

    Syntax

    $ pulumi import ibm:index/cisWebhook:CisWebhook myorg <webhook_id>:<crn>

    Example

    $ pulumi import ibm:index/cisWebhook:CisWebhook myorg

    crn:v1:bluemix:public:internet-svcs-ci:global:a/01652b251c3ae2787110a995d8db0135:9054ad06-3485-421a-9300-fe3fb4b79e1d::

    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.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm