1. Packages
  2. Ibm Provider
  3. API Docs
  4. CisAlert
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.CisAlert

Explore with Pulumi AI

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

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

    Create CisAlert Resource

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

    Constructor syntax

    new CisAlert(name: string, args: CisAlertArgs, opts?: CustomResourceOptions);
    @overload
    def CisAlert(resource_name: str,
                 args: CisAlertArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def CisAlert(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 alert_type: Optional[str] = None,
                 cis_id: Optional[str] = None,
                 enabled: Optional[bool] = None,
                 mechanisms: Optional[Sequence[CisAlertMechanismArgs]] = None,
                 cis_alert_id: Optional[str] = None,
                 conditions: Optional[str] = None,
                 description: Optional[str] = None,
                 filters: Optional[str] = None,
                 name: Optional[str] = None)
    func NewCisAlert(ctx *Context, name string, args CisAlertArgs, opts ...ResourceOption) (*CisAlert, error)
    public CisAlert(string name, CisAlertArgs args, CustomResourceOptions? opts = null)
    public CisAlert(String name, CisAlertArgs args)
    public CisAlert(String name, CisAlertArgs args, CustomResourceOptions options)
    
    type: ibm:CisAlert
    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 CisAlertArgs
    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 CisAlertArgs
    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 CisAlertArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CisAlertArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CisAlertArgs
    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 cisAlertResource = new Ibm.CisAlert("cisAlertResource", new()
    {
        AlertType = "string",
        CisId = "string",
        Enabled = false,
        Mechanisms = new[]
        {
            new Ibm.Inputs.CisAlertMechanismArgs
            {
                Emails = new[]
                {
                    "string",
                },
                Webhooks = new[]
                {
                    "string",
                },
            },
        },
        CisAlertId = "string",
        Conditions = "string",
        Description = "string",
        Filters = "string",
        Name = "string",
    });
    
    example, err := ibm.NewCisAlert(ctx, "cisAlertResource", &ibm.CisAlertArgs{
    	AlertType: pulumi.String("string"),
    	CisId:     pulumi.String("string"),
    	Enabled:   pulumi.Bool(false),
    	Mechanisms: ibm.CisAlertMechanismArray{
    		&ibm.CisAlertMechanismArgs{
    			Emails: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			Webhooks: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    		},
    	},
    	CisAlertId:  pulumi.String("string"),
    	Conditions:  pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Filters:     pulumi.String("string"),
    	Name:        pulumi.String("string"),
    })
    
    var cisAlertResource = new CisAlert("cisAlertResource", CisAlertArgs.builder()
        .alertType("string")
        .cisId("string")
        .enabled(false)
        .mechanisms(CisAlertMechanismArgs.builder()
            .emails("string")
            .webhooks("string")
            .build())
        .cisAlertId("string")
        .conditions("string")
        .description("string")
        .filters("string")
        .name("string")
        .build());
    
    cis_alert_resource = ibm.CisAlert("cisAlertResource",
        alert_type="string",
        cis_id="string",
        enabled=False,
        mechanisms=[{
            "emails": ["string"],
            "webhooks": ["string"],
        }],
        cis_alert_id="string",
        conditions="string",
        description="string",
        filters="string",
        name="string")
    
    const cisAlertResource = new ibm.CisAlert("cisAlertResource", {
        alertType: "string",
        cisId: "string",
        enabled: false,
        mechanisms: [{
            emails: ["string"],
            webhooks: ["string"],
        }],
        cisAlertId: "string",
        conditions: "string",
        description: "string",
        filters: "string",
        name: "string",
    });
    
    type: ibm:CisAlert
    properties:
        alertType: string
        cisAlertId: string
        cisId: string
        conditions: string
        description: string
        enabled: false
        filters: string
        mechanisms:
            - emails:
                - string
              webhooks:
                - string
        name: string
    

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

    AlertType string
    Condition for the alert.
    CisId string
    The ID of the CIS service instance.
    Enabled bool
    Alert Policy status enabled/disbaled.
    Mechanisms List<CisAlertMechanism>

    Delivery mechanisms for the alert, can include an email, a webhook, or both.

    Nested scheme for mechanisms:

    CisAlertId string
    (String) The ID of alert resource. It is a combination of <alert-id>:<crn> attributes concatenated with ":".
    Conditions string
    The conditions in JSON format. Required field when updating the Alert policy. Conditions depending on the alert type. HTTP DDOS Attack Alerter does not have any conditions. The Load Balancing Pool Enablement Alerter takes conditions that describe for all pools whether the pool is being enabled, disabled, or both. This field is not required when creating a new alert.(https://cloud.ibm.com/docs/cis?topic=cis-configuring-notifications&interface=api)
    Description string
    Description of the Alert Policy.
    Filters string
    Must provided in JSON format. filter is the list of all enablement statuses and pool IDs for the pool toggle alert. Empty filters depending for the alert type. HTTP DDOS Attack Alerter does not require any filters. The Load Balancing Pool Enablement Alerter requires a list of IDs for the pools and their corresponding alert trigger (set whether alerts are recieved on disablement, enablement, or both). The basic WAF Alerter requires a list of zones to be monitored. The Advanced Security Alerter requires a list of zones to be monitored as well as a list of services to monitor.(https://cloud.ibm.com/docs/cis?topic=cis-configuring-notifications&interface=api)
    Name string
    Name of the Alert Policy.
    AlertType string
    Condition for the alert.
    CisId string
    The ID of the CIS service instance.
    Enabled bool
    Alert Policy status enabled/disbaled.
    Mechanisms []CisAlertMechanismArgs

    Delivery mechanisms for the alert, can include an email, a webhook, or both.

    Nested scheme for mechanisms:

    CisAlertId string
    (String) The ID of alert resource. It is a combination of <alert-id>:<crn> attributes concatenated with ":".
    Conditions string
    The conditions in JSON format. Required field when updating the Alert policy. Conditions depending on the alert type. HTTP DDOS Attack Alerter does not have any conditions. The Load Balancing Pool Enablement Alerter takes conditions that describe for all pools whether the pool is being enabled, disabled, or both. This field is not required when creating a new alert.(https://cloud.ibm.com/docs/cis?topic=cis-configuring-notifications&interface=api)
    Description string
    Description of the Alert Policy.
    Filters string
    Must provided in JSON format. filter is the list of all enablement statuses and pool IDs for the pool toggle alert. Empty filters depending for the alert type. HTTP DDOS Attack Alerter does not require any filters. The Load Balancing Pool Enablement Alerter requires a list of IDs for the pools and their corresponding alert trigger (set whether alerts are recieved on disablement, enablement, or both). The basic WAF Alerter requires a list of zones to be monitored. The Advanced Security Alerter requires a list of zones to be monitored as well as a list of services to monitor.(https://cloud.ibm.com/docs/cis?topic=cis-configuring-notifications&interface=api)
    Name string
    Name of the Alert Policy.
    alertType String
    Condition for the alert.
    cisId String
    The ID of the CIS service instance.
    enabled Boolean
    Alert Policy status enabled/disbaled.
    mechanisms List<CisAlertMechanism>

    Delivery mechanisms for the alert, can include an email, a webhook, or both.

    Nested scheme for mechanisms:

    cisAlertId String
    (String) The ID of alert resource. It is a combination of <alert-id>:<crn> attributes concatenated with ":".
    conditions String
    The conditions in JSON format. Required field when updating the Alert policy. Conditions depending on the alert type. HTTP DDOS Attack Alerter does not have any conditions. The Load Balancing Pool Enablement Alerter takes conditions that describe for all pools whether the pool is being enabled, disabled, or both. This field is not required when creating a new alert.(https://cloud.ibm.com/docs/cis?topic=cis-configuring-notifications&interface=api)
    description String
    Description of the Alert Policy.
    filters String
    Must provided in JSON format. filter is the list of all enablement statuses and pool IDs for the pool toggle alert. Empty filters depending for the alert type. HTTP DDOS Attack Alerter does not require any filters. The Load Balancing Pool Enablement Alerter requires a list of IDs for the pools and their corresponding alert trigger (set whether alerts are recieved on disablement, enablement, or both). The basic WAF Alerter requires a list of zones to be monitored. The Advanced Security Alerter requires a list of zones to be monitored as well as a list of services to monitor.(https://cloud.ibm.com/docs/cis?topic=cis-configuring-notifications&interface=api)
    name String
    Name of the Alert Policy.
    alertType string
    Condition for the alert.
    cisId string
    The ID of the CIS service instance.
    enabled boolean
    Alert Policy status enabled/disbaled.
    mechanisms CisAlertMechanism[]

    Delivery mechanisms for the alert, can include an email, a webhook, or both.

    Nested scheme for mechanisms:

    cisAlertId string
    (String) The ID of alert resource. It is a combination of <alert-id>:<crn> attributes concatenated with ":".
    conditions string
    The conditions in JSON format. Required field when updating the Alert policy. Conditions depending on the alert type. HTTP DDOS Attack Alerter does not have any conditions. The Load Balancing Pool Enablement Alerter takes conditions that describe for all pools whether the pool is being enabled, disabled, or both. This field is not required when creating a new alert.(https://cloud.ibm.com/docs/cis?topic=cis-configuring-notifications&interface=api)
    description string
    Description of the Alert Policy.
    filters string
    Must provided in JSON format. filter is the list of all enablement statuses and pool IDs for the pool toggle alert. Empty filters depending for the alert type. HTTP DDOS Attack Alerter does not require any filters. The Load Balancing Pool Enablement Alerter requires a list of IDs for the pools and their corresponding alert trigger (set whether alerts are recieved on disablement, enablement, or both). The basic WAF Alerter requires a list of zones to be monitored. The Advanced Security Alerter requires a list of zones to be monitored as well as a list of services to monitor.(https://cloud.ibm.com/docs/cis?topic=cis-configuring-notifications&interface=api)
    name string
    Name of the Alert Policy.
    alert_type str
    Condition for the alert.
    cis_id str
    The ID of the CIS service instance.
    enabled bool
    Alert Policy status enabled/disbaled.
    mechanisms Sequence[CisAlertMechanismArgs]

    Delivery mechanisms for the alert, can include an email, a webhook, or both.

    Nested scheme for mechanisms:

    cis_alert_id str
    (String) The ID of alert resource. It is a combination of <alert-id>:<crn> attributes concatenated with ":".
    conditions str
    The conditions in JSON format. Required field when updating the Alert policy. Conditions depending on the alert type. HTTP DDOS Attack Alerter does not have any conditions. The Load Balancing Pool Enablement Alerter takes conditions that describe for all pools whether the pool is being enabled, disabled, or both. This field is not required when creating a new alert.(https://cloud.ibm.com/docs/cis?topic=cis-configuring-notifications&interface=api)
    description str
    Description of the Alert Policy.
    filters str
    Must provided in JSON format. filter is the list of all enablement statuses and pool IDs for the pool toggle alert. Empty filters depending for the alert type. HTTP DDOS Attack Alerter does not require any filters. The Load Balancing Pool Enablement Alerter requires a list of IDs for the pools and their corresponding alert trigger (set whether alerts are recieved on disablement, enablement, or both). The basic WAF Alerter requires a list of zones to be monitored. The Advanced Security Alerter requires a list of zones to be monitored as well as a list of services to monitor.(https://cloud.ibm.com/docs/cis?topic=cis-configuring-notifications&interface=api)
    name str
    Name of the Alert Policy.
    alertType String
    Condition for the alert.
    cisId String
    The ID of the CIS service instance.
    enabled Boolean
    Alert Policy status enabled/disbaled.
    mechanisms List<Property Map>

    Delivery mechanisms for the alert, can include an email, a webhook, or both.

    Nested scheme for mechanisms:

    cisAlertId String
    (String) The ID of alert resource. It is a combination of <alert-id>:<crn> attributes concatenated with ":".
    conditions String
    The conditions in JSON format. Required field when updating the Alert policy. Conditions depending on the alert type. HTTP DDOS Attack Alerter does not have any conditions. The Load Balancing Pool Enablement Alerter takes conditions that describe for all pools whether the pool is being enabled, disabled, or both. This field is not required when creating a new alert.(https://cloud.ibm.com/docs/cis?topic=cis-configuring-notifications&interface=api)
    description String
    Description of the Alert Policy.
    filters String
    Must provided in JSON format. filter is the list of all enablement statuses and pool IDs for the pool toggle alert. Empty filters depending for the alert type. HTTP DDOS Attack Alerter does not require any filters. The Load Balancing Pool Enablement Alerter requires a list of IDs for the pools and their corresponding alert trigger (set whether alerts are recieved on disablement, enablement, or both). The basic WAF Alerter requires a list of zones to be monitored. The Advanced Security Alerter requires a list of zones to be monitored as well as a list of services to monitor.(https://cloud.ibm.com/docs/cis?topic=cis-configuring-notifications&interface=api)
    name String
    Name of the Alert Policy.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    PolicyId string
    Identifier of the Alert Policy
    Id string
    The provider-assigned unique ID for this managed resource.
    PolicyId string
    Identifier of the Alert Policy
    id String
    The provider-assigned unique ID for this managed resource.
    policyId String
    Identifier of the Alert Policy
    id string
    The provider-assigned unique ID for this managed resource.
    policyId string
    Identifier of the Alert Policy
    id str
    The provider-assigned unique ID for this managed resource.
    policy_id str
    Identifier of the Alert Policy
    id String
    The provider-assigned unique ID for this managed resource.
    policyId String
    Identifier of the Alert Policy

    Look up Existing CisAlert Resource

    Get an existing CisAlert 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?: CisAlertState, opts?: CustomResourceOptions): CisAlert
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            alert_type: Optional[str] = None,
            cis_alert_id: Optional[str] = None,
            cis_id: Optional[str] = None,
            conditions: Optional[str] = None,
            description: Optional[str] = None,
            enabled: Optional[bool] = None,
            filters: Optional[str] = None,
            mechanisms: Optional[Sequence[CisAlertMechanismArgs]] = None,
            name: Optional[str] = None,
            policy_id: Optional[str] = None) -> CisAlert
    func GetCisAlert(ctx *Context, name string, id IDInput, state *CisAlertState, opts ...ResourceOption) (*CisAlert, error)
    public static CisAlert Get(string name, Input<string> id, CisAlertState? state, CustomResourceOptions? opts = null)
    public static CisAlert get(String name, Output<String> id, CisAlertState state, CustomResourceOptions options)
    resources:  _:    type: ibm:CisAlert    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:
    AlertType string
    Condition for the alert.
    CisAlertId string
    (String) The ID of alert resource. It is a combination of <alert-id>:<crn> attributes concatenated with ":".
    CisId string
    The ID of the CIS service instance.
    Conditions string
    The conditions in JSON format. Required field when updating the Alert policy. Conditions depending on the alert type. HTTP DDOS Attack Alerter does not have any conditions. The Load Balancing Pool Enablement Alerter takes conditions that describe for all pools whether the pool is being enabled, disabled, or both. This field is not required when creating a new alert.(https://cloud.ibm.com/docs/cis?topic=cis-configuring-notifications&interface=api)
    Description string
    Description of the Alert Policy.
    Enabled bool
    Alert Policy status enabled/disbaled.
    Filters string
    Must provided in JSON format. filter is the list of all enablement statuses and pool IDs for the pool toggle alert. Empty filters depending for the alert type. HTTP DDOS Attack Alerter does not require any filters. The Load Balancing Pool Enablement Alerter requires a list of IDs for the pools and their corresponding alert trigger (set whether alerts are recieved on disablement, enablement, or both). The basic WAF Alerter requires a list of zones to be monitored. The Advanced Security Alerter requires a list of zones to be monitored as well as a list of services to monitor.(https://cloud.ibm.com/docs/cis?topic=cis-configuring-notifications&interface=api)
    Mechanisms List<CisAlertMechanism>

    Delivery mechanisms for the alert, can include an email, a webhook, or both.

    Nested scheme for mechanisms:

    Name string
    Name of the Alert Policy.
    PolicyId string
    Identifier of the Alert Policy
    AlertType string
    Condition for the alert.
    CisAlertId string
    (String) The ID of alert resource. It is a combination of <alert-id>:<crn> attributes concatenated with ":".
    CisId string
    The ID of the CIS service instance.
    Conditions string
    The conditions in JSON format. Required field when updating the Alert policy. Conditions depending on the alert type. HTTP DDOS Attack Alerter does not have any conditions. The Load Balancing Pool Enablement Alerter takes conditions that describe for all pools whether the pool is being enabled, disabled, or both. This field is not required when creating a new alert.(https://cloud.ibm.com/docs/cis?topic=cis-configuring-notifications&interface=api)
    Description string
    Description of the Alert Policy.
    Enabled bool
    Alert Policy status enabled/disbaled.
    Filters string
    Must provided in JSON format. filter is the list of all enablement statuses and pool IDs for the pool toggle alert. Empty filters depending for the alert type. HTTP DDOS Attack Alerter does not require any filters. The Load Balancing Pool Enablement Alerter requires a list of IDs for the pools and their corresponding alert trigger (set whether alerts are recieved on disablement, enablement, or both). The basic WAF Alerter requires a list of zones to be monitored. The Advanced Security Alerter requires a list of zones to be monitored as well as a list of services to monitor.(https://cloud.ibm.com/docs/cis?topic=cis-configuring-notifications&interface=api)
    Mechanisms []CisAlertMechanismArgs

    Delivery mechanisms for the alert, can include an email, a webhook, or both.

    Nested scheme for mechanisms:

    Name string
    Name of the Alert Policy.
    PolicyId string
    Identifier of the Alert Policy
    alertType String
    Condition for the alert.
    cisAlertId String
    (String) The ID of alert resource. It is a combination of <alert-id>:<crn> attributes concatenated with ":".
    cisId String
    The ID of the CIS service instance.
    conditions String
    The conditions in JSON format. Required field when updating the Alert policy. Conditions depending on the alert type. HTTP DDOS Attack Alerter does not have any conditions. The Load Balancing Pool Enablement Alerter takes conditions that describe for all pools whether the pool is being enabled, disabled, or both. This field is not required when creating a new alert.(https://cloud.ibm.com/docs/cis?topic=cis-configuring-notifications&interface=api)
    description String
    Description of the Alert Policy.
    enabled Boolean
    Alert Policy status enabled/disbaled.
    filters String
    Must provided in JSON format. filter is the list of all enablement statuses and pool IDs for the pool toggle alert. Empty filters depending for the alert type. HTTP DDOS Attack Alerter does not require any filters. The Load Balancing Pool Enablement Alerter requires a list of IDs for the pools and their corresponding alert trigger (set whether alerts are recieved on disablement, enablement, or both). The basic WAF Alerter requires a list of zones to be monitored. The Advanced Security Alerter requires a list of zones to be monitored as well as a list of services to monitor.(https://cloud.ibm.com/docs/cis?topic=cis-configuring-notifications&interface=api)
    mechanisms List<CisAlertMechanism>

    Delivery mechanisms for the alert, can include an email, a webhook, or both.

    Nested scheme for mechanisms:

    name String
    Name of the Alert Policy.
    policyId String
    Identifier of the Alert Policy
    alertType string
    Condition for the alert.
    cisAlertId string
    (String) The ID of alert resource. It is a combination of <alert-id>:<crn> attributes concatenated with ":".
    cisId string
    The ID of the CIS service instance.
    conditions string
    The conditions in JSON format. Required field when updating the Alert policy. Conditions depending on the alert type. HTTP DDOS Attack Alerter does not have any conditions. The Load Balancing Pool Enablement Alerter takes conditions that describe for all pools whether the pool is being enabled, disabled, or both. This field is not required when creating a new alert.(https://cloud.ibm.com/docs/cis?topic=cis-configuring-notifications&interface=api)
    description string
    Description of the Alert Policy.
    enabled boolean
    Alert Policy status enabled/disbaled.
    filters string
    Must provided in JSON format. filter is the list of all enablement statuses and pool IDs for the pool toggle alert. Empty filters depending for the alert type. HTTP DDOS Attack Alerter does not require any filters. The Load Balancing Pool Enablement Alerter requires a list of IDs for the pools and their corresponding alert trigger (set whether alerts are recieved on disablement, enablement, or both). The basic WAF Alerter requires a list of zones to be monitored. The Advanced Security Alerter requires a list of zones to be monitored as well as a list of services to monitor.(https://cloud.ibm.com/docs/cis?topic=cis-configuring-notifications&interface=api)
    mechanisms CisAlertMechanism[]

    Delivery mechanisms for the alert, can include an email, a webhook, or both.

    Nested scheme for mechanisms:

    name string
    Name of the Alert Policy.
    policyId string
    Identifier of the Alert Policy
    alert_type str
    Condition for the alert.
    cis_alert_id str
    (String) The ID of alert resource. It is a combination of <alert-id>:<crn> attributes concatenated with ":".
    cis_id str
    The ID of the CIS service instance.
    conditions str
    The conditions in JSON format. Required field when updating the Alert policy. Conditions depending on the alert type. HTTP DDOS Attack Alerter does not have any conditions. The Load Balancing Pool Enablement Alerter takes conditions that describe for all pools whether the pool is being enabled, disabled, or both. This field is not required when creating a new alert.(https://cloud.ibm.com/docs/cis?topic=cis-configuring-notifications&interface=api)
    description str
    Description of the Alert Policy.
    enabled bool
    Alert Policy status enabled/disbaled.
    filters str
    Must provided in JSON format. filter is the list of all enablement statuses and pool IDs for the pool toggle alert. Empty filters depending for the alert type. HTTP DDOS Attack Alerter does not require any filters. The Load Balancing Pool Enablement Alerter requires a list of IDs for the pools and their corresponding alert trigger (set whether alerts are recieved on disablement, enablement, or both). The basic WAF Alerter requires a list of zones to be monitored. The Advanced Security Alerter requires a list of zones to be monitored as well as a list of services to monitor.(https://cloud.ibm.com/docs/cis?topic=cis-configuring-notifications&interface=api)
    mechanisms Sequence[CisAlertMechanismArgs]

    Delivery mechanisms for the alert, can include an email, a webhook, or both.

    Nested scheme for mechanisms:

    name str
    Name of the Alert Policy.
    policy_id str
    Identifier of the Alert Policy
    alertType String
    Condition for the alert.
    cisAlertId String
    (String) The ID of alert resource. It is a combination of <alert-id>:<crn> attributes concatenated with ":".
    cisId String
    The ID of the CIS service instance.
    conditions String
    The conditions in JSON format. Required field when updating the Alert policy. Conditions depending on the alert type. HTTP DDOS Attack Alerter does not have any conditions. The Load Balancing Pool Enablement Alerter takes conditions that describe for all pools whether the pool is being enabled, disabled, or both. This field is not required when creating a new alert.(https://cloud.ibm.com/docs/cis?topic=cis-configuring-notifications&interface=api)
    description String
    Description of the Alert Policy.
    enabled Boolean
    Alert Policy status enabled/disbaled.
    filters String
    Must provided in JSON format. filter is the list of all enablement statuses and pool IDs for the pool toggle alert. Empty filters depending for the alert type. HTTP DDOS Attack Alerter does not require any filters. The Load Balancing Pool Enablement Alerter requires a list of IDs for the pools and their corresponding alert trigger (set whether alerts are recieved on disablement, enablement, or both). The basic WAF Alerter requires a list of zones to be monitored. The Advanced Security Alerter requires a list of zones to be monitored as well as a list of services to monitor.(https://cloud.ibm.com/docs/cis?topic=cis-configuring-notifications&interface=api)
    mechanisms List<Property Map>

    Delivery mechanisms for the alert, can include an email, a webhook, or both.

    Nested scheme for mechanisms:

    name String
    Name of the Alert Policy.
    policyId String
    Identifier of the Alert Policy

    Supporting Types

    CisAlertMechanism, CisAlertMechanismArgs

    Emails List<string>
    Provide at least one of email id.
    Webhooks List<string>
    Provide at least one of Webhook id.
    Emails []string
    Provide at least one of email id.
    Webhooks []string
    Provide at least one of Webhook id.
    emails List<String>
    Provide at least one of email id.
    webhooks List<String>
    Provide at least one of Webhook id.
    emails string[]
    Provide at least one of email id.
    webhooks string[]
    Provide at least one of Webhook id.
    emails Sequence[str]
    Provide at least one of email id.
    webhooks Sequence[str]
    Provide at least one of Webhook id.
    emails List<String>
    Provide at least one of email id.
    webhooks List<String>
    Provide at least one of Webhook id.

    Import

    The ibm_cis_alert resource can be imported using the id. The ID is formed from the Alert 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::

    • Alert ID is a 32 digit character string of the form: 52bfa670237f49ecb68473033c569649.

    Syntax

    $ pulumi import ibm:index/cisAlert:CisAlert myorg <alert_id>:<crn>
    

    Example

    $ pulumi import ibm:index/cisAlert:CisAlert 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