Cloudflare v6.1.1, Apr 21 25

Cloudflare v6.1.1 published on Monday, Apr 21, 2025 by Pulumi

cloudflare.NotificationPolicy

Explore with Pulumi AI

Cloudflare v6.1.1 published on Monday, Apr 21, 2025 by Pulumi

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  exampleNotificationPolicy:
    type: cloudflare:NotificationPolicy
    name: example_notification_policy
    properties:
      accountId: 023e105f4ecef8ad9ca31a8372d0c353
      alertType: universal_ssl_event_type
      enabled: true
      mechanisms:
        email:
          - id: test@example.com
        pagerduty:
          - id: e8133a15-00a4-4d69-aec1-32f70c51f6e5
        webhooks:
          - id: 14cc1190-5d2b-4b98-a696-c424cb2ad05f
      name: SSL Notification Event Policy
      alertInterval: 30m
      description: Something describing the policy.
      filters:
        actions:
          - string
        affected_asns:
          - string
        affected_components:
          - string
        affected_locations:
          - string
        airport_code:
          - string
        alert_trigger_preferences:
          - string
        alert_trigger_preferences_value:
          - string
        enabled:
          - string
        environment:
          - string
        event:
          - string
        event_source:
          - string
        event_type:
          - string
        group_by:
          - string
        health_check_id:
          - string
        incident_impact:
          - INCIDENT_IMPACT_NONE
        input_id:
          - string
        insight_class:
          - string
        limit:
          - string
        logo_tag:
          - string
        megabits_per_second:
          - string
        new_health:
          - string
        new_status:
          - string
        packets_per_second:
          - string
        pool_id:
          - string
        pop_names:
          - string
        product:
          - string
        project_id:
          - string
        protocol:
          - string
        query_tag:
          - string
        requests_per_second:
          - string
        selectors:
          - string
        services:
          - string
        slo:
          - '99.9'
        status:
          - string
        target_hostname:
          - string
        target_ip:
          - string
        target_zone_name:
          - string
        traffic_exclusions:
          - security_events
        tunnel_id:
          - string
        tunnel_name:
          - string
        where:
          - string
        zones:
          - string

Create NotificationPolicy Resource

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

Constructor syntax

new NotificationPolicy(name: string, args: NotificationPolicyArgs, opts?: CustomResourceOptions);

@overload
def NotificationPolicy(resource_name: str,
                       args: NotificationPolicyArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def NotificationPolicy(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       account_id: Optional[str] = None,
                       alert_type: Optional[str] = None,
                       mechanisms: Optional[NotificationPolicyMechanismsArgs] = None,
                       name: Optional[str] = None,
                       alert_interval: Optional[str] = None,
                       description: Optional[str] = None,
                       enabled: Optional[bool] = None,
                       filters: Optional[NotificationPolicyFiltersArgs] = None)

func NewNotificationPolicy(ctx *Context, name string, args NotificationPolicyArgs, opts ...ResourceOption) (*NotificationPolicy, error)

public NotificationPolicy(string name, NotificationPolicyArgs args, CustomResourceOptions? opts = null)

public NotificationPolicy(String name, NotificationPolicyArgs args)
public NotificationPolicy(String name, NotificationPolicyArgs args, CustomResourceOptions options)

type: cloudflare:NotificationPolicy
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 NotificationPolicyArgs: 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 NotificationPolicyArgs: 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 NotificationPolicyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args NotificationPolicyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args NotificationPolicyArgs: 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 notificationPolicyResource = new Cloudflare.NotificationPolicy("notificationPolicyResource", new()
{
    AccountId = "string",
    AlertType = "string",
    Mechanisms = new Cloudflare.Inputs.NotificationPolicyMechanismsArgs
    {
        Emails = new[]
        {
            new Cloudflare.Inputs.NotificationPolicyMechanismsEmailArgs
            {
                Id = "string",
            },
        },
        Pagerduties = new[]
        {
            new Cloudflare.Inputs.NotificationPolicyMechanismsPagerdutyArgs
            {
                Id = "string",
            },
        },
        Webhooks = new[]
        {
            new Cloudflare.Inputs.NotificationPolicyMechanismsWebhookArgs
            {
                Id = "string",
            },
        },
    },
    Name = "string",
    AlertInterval = "string",
    Description = "string",
    Enabled = false,
    Filters = new Cloudflare.Inputs.NotificationPolicyFiltersArgs
    {
        Actions = new[]
        {
            "string",
        },
        AffectedAsns = new[]
        {
            "string",
        },
        AffectedComponents = new[]
        {
            "string",
        },
        AffectedLocations = new[]
        {
            "string",
        },
        AirportCodes = new[]
        {
            "string",
        },
        AlertTriggerPreferences = new[]
        {
            "string",
        },
        AlertTriggerPreferencesValues = new[]
        {
            "string",
        },
        Enableds = new[]
        {
            "string",
        },
        Environments = new[]
        {
            "string",
        },
        EventSources = new[]
        {
            "string",
        },
        EventTypes = new[]
        {
            "string",
        },
        Events = new[]
        {
            "string",
        },
        GroupBies = new[]
        {
            "string",
        },
        HealthCheckIds = new[]
        {
            "string",
        },
        IncidentImpacts = new[]
        {
            "string",
        },
        InputIds = new[]
        {
            "string",
        },
        InsightClasses = new[]
        {
            "string",
        },
        Limits = new[]
        {
            "string",
        },
        LogoTags = new[]
        {
            "string",
        },
        MegabitsPerSeconds = new[]
        {
            "string",
        },
        NewHealths = new[]
        {
            "string",
        },
        NewStatuses = new[]
        {
            "string",
        },
        PacketsPerSeconds = new[]
        {
            "string",
        },
        PoolIds = new[]
        {
            "string",
        },
        PopNames = new[]
        {
            "string",
        },
        Products = new[]
        {
            "string",
        },
        ProjectIds = new[]
        {
            "string",
        },
        Protocols = new[]
        {
            "string",
        },
        QueryTags = new[]
        {
            "string",
        },
        RequestsPerSeconds = new[]
        {
            "string",
        },
        Selectors = new[]
        {
            "string",
        },
        Services = new[]
        {
            "string",
        },
        Slos = new[]
        {
            "string",
        },
        Statuses = new[]
        {
            "string",
        },
        TargetHostnames = new[]
        {
            "string",
        },
        TargetIps = new[]
        {
            "string",
        },
        TargetZoneNames = new[]
        {
            "string",
        },
        TrafficExclusions = new[]
        {
            "string",
        },
        TunnelIds = new[]
        {
            "string",
        },
        TunnelNames = new[]
        {
            "string",
        },
        Wheres = new[]
        {
            "string",
        },
        Zones = new[]
        {
            "string",
        },
    },
});

example, err := cloudflare.NewNotificationPolicy(ctx, "notificationPolicyResource", &cloudflare.NotificationPolicyArgs{
	AccountId: pulumi.String("string"),
	AlertType: pulumi.String("string"),
	Mechanisms: &cloudflare.NotificationPolicyMechanismsArgs{
		Emails: cloudflare.NotificationPolicyMechanismsEmailArray{
			&cloudflare.NotificationPolicyMechanismsEmailArgs{
				Id: pulumi.String("string"),
			},
		},
		Pagerduties: cloudflare.NotificationPolicyMechanismsPagerdutyArray{
			&cloudflare.NotificationPolicyMechanismsPagerdutyArgs{
				Id: pulumi.String("string"),
			},
		},
		Webhooks: cloudflare.NotificationPolicyMechanismsWebhookArray{
			&cloudflare.NotificationPolicyMechanismsWebhookArgs{
				Id: pulumi.String("string"),
			},
		},
	},
	Name:          pulumi.String("string"),
	AlertInterval: pulumi.String("string"),
	Description:   pulumi.String("string"),
	Enabled:       pulumi.Bool(false),
	Filters: &cloudflare.NotificationPolicyFiltersArgs{
		Actions: pulumi.StringArray{
			pulumi.String("string"),
		},
		AffectedAsns: pulumi.StringArray{
			pulumi.String("string"),
		},
		AffectedComponents: pulumi.StringArray{
			pulumi.String("string"),
		},
		AffectedLocations: pulumi.StringArray{
			pulumi.String("string"),
		},
		AirportCodes: pulumi.StringArray{
			pulumi.String("string"),
		},
		AlertTriggerPreferences: pulumi.StringArray{
			pulumi.String("string"),
		},
		AlertTriggerPreferencesValues: pulumi.StringArray{
			pulumi.String("string"),
		},
		Enableds: pulumi.StringArray{
			pulumi.String("string"),
		},
		Environments: pulumi.StringArray{
			pulumi.String("string"),
		},
		EventSources: pulumi.StringArray{
			pulumi.String("string"),
		},
		EventTypes: pulumi.StringArray{
			pulumi.String("string"),
		},
		Events: pulumi.StringArray{
			pulumi.String("string"),
		},
		GroupBies: pulumi.StringArray{
			pulumi.String("string"),
		},
		HealthCheckIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		IncidentImpacts: pulumi.StringArray{
			pulumi.String("string"),
		},
		InputIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		InsightClasses: pulumi.StringArray{
			pulumi.String("string"),
		},
		Limits: pulumi.StringArray{
			pulumi.String("string"),
		},
		LogoTags: pulumi.StringArray{
			pulumi.String("string"),
		},
		MegabitsPerSeconds: pulumi.StringArray{
			pulumi.String("string"),
		},
		NewHealths: pulumi.StringArray{
			pulumi.String("string"),
		},
		NewStatuses: pulumi.StringArray{
			pulumi.String("string"),
		},
		PacketsPerSeconds: pulumi.StringArray{
			pulumi.String("string"),
		},
		PoolIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		PopNames: pulumi.StringArray{
			pulumi.String("string"),
		},
		Products: pulumi.StringArray{
			pulumi.String("string"),
		},
		ProjectIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		Protocols: pulumi.StringArray{
			pulumi.String("string"),
		},
		QueryTags: pulumi.StringArray{
			pulumi.String("string"),
		},
		RequestsPerSeconds: pulumi.StringArray{
			pulumi.String("string"),
		},
		Selectors: pulumi.StringArray{
			pulumi.String("string"),
		},
		Services: pulumi.StringArray{
			pulumi.String("string"),
		},
		Slos: pulumi.StringArray{
			pulumi.String("string"),
		},
		Statuses: pulumi.StringArray{
			pulumi.String("string"),
		},
		TargetHostnames: pulumi.StringArray{
			pulumi.String("string"),
		},
		TargetIps: pulumi.StringArray{
			pulumi.String("string"),
		},
		TargetZoneNames: pulumi.StringArray{
			pulumi.String("string"),
		},
		TrafficExclusions: pulumi.StringArray{
			pulumi.String("string"),
		},
		TunnelIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		TunnelNames: pulumi.StringArray{
			pulumi.String("string"),
		},
		Wheres: pulumi.StringArray{
			pulumi.String("string"),
		},
		Zones: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
})

var notificationPolicyResource = new NotificationPolicy("notificationPolicyResource", NotificationPolicyArgs.builder()
    .accountId("string")
    .alertType("string")
    .mechanisms(NotificationPolicyMechanismsArgs.builder()
        .emails(NotificationPolicyMechanismsEmailArgs.builder()
            .id("string")
            .build())
        .pagerduties(NotificationPolicyMechanismsPagerdutyArgs.builder()
            .id("string")
            .build())
        .webhooks(NotificationPolicyMechanismsWebhookArgs.builder()
            .id("string")
            .build())
        .build())
    .name("string")
    .alertInterval("string")
    .description("string")
    .enabled(false)
    .filters(NotificationPolicyFiltersArgs.builder()
        .actions("string")
        .affectedAsns("string")
        .affectedComponents("string")
        .affectedLocations("string")
        .airportCodes("string")
        .alertTriggerPreferences("string")
        .alertTriggerPreferencesValues("string")
        .enableds("string")
        .environments("string")
        .eventSources("string")
        .eventTypes("string")
        .events("string")
        .groupBies("string")
        .healthCheckIds("string")
        .incidentImpacts("string")
        .inputIds("string")
        .insightClasses("string")
        .limits("string")
        .logoTags("string")
        .megabitsPerSeconds("string")
        .newHealths("string")
        .newStatuses("string")
        .packetsPerSeconds("string")
        .poolIds("string")
        .popNames("string")
        .products("string")
        .projectIds("string")
        .protocols("string")
        .queryTags("string")
        .requestsPerSeconds("string")
        .selectors("string")
        .services("string")
        .slos("string")
        .statuses("string")
        .targetHostnames("string")
        .targetIps("string")
        .targetZoneNames("string")
        .trafficExclusions("string")
        .tunnelIds("string")
        .tunnelNames("string")
        .wheres("string")
        .zones("string")
        .build())
    .build());

notification_policy_resource = cloudflare.NotificationPolicy("notificationPolicyResource",
    account_id="string",
    alert_type="string",
    mechanisms={
        "emails": [{
            "id": "string",
        }],
        "pagerduties": [{
            "id": "string",
        }],
        "webhooks": [{
            "id": "string",
        }],
    },
    name="string",
    alert_interval="string",
    description="string",
    enabled=False,
    filters={
        "actions": ["string"],
        "affected_asns": ["string"],
        "affected_components": ["string"],
        "affected_locations": ["string"],
        "airport_codes": ["string"],
        "alert_trigger_preferences": ["string"],
        "alert_trigger_preferences_values": ["string"],
        "enableds": ["string"],
        "environments": ["string"],
        "event_sources": ["string"],
        "event_types": ["string"],
        "events": ["string"],
        "group_bies": ["string"],
        "health_check_ids": ["string"],
        "incident_impacts": ["string"],
        "input_ids": ["string"],
        "insight_classes": ["string"],
        "limits": ["string"],
        "logo_tags": ["string"],
        "megabits_per_seconds": ["string"],
        "new_healths": ["string"],
        "new_statuses": ["string"],
        "packets_per_seconds": ["string"],
        "pool_ids": ["string"],
        "pop_names": ["string"],
        "products": ["string"],
        "project_ids": ["string"],
        "protocols": ["string"],
        "query_tags": ["string"],
        "requests_per_seconds": ["string"],
        "selectors": ["string"],
        "services": ["string"],
        "slos": ["string"],
        "statuses": ["string"],
        "target_hostnames": ["string"],
        "target_ips": ["string"],
        "target_zone_names": ["string"],
        "traffic_exclusions": ["string"],
        "tunnel_ids": ["string"],
        "tunnel_names": ["string"],
        "wheres": ["string"],
        "zones": ["string"],
    })

const notificationPolicyResource = new cloudflare.NotificationPolicy("notificationPolicyResource", {
    accountId: "string",
    alertType: "string",
    mechanisms: {
        emails: [{
            id: "string",
        }],
        pagerduties: [{
            id: "string",
        }],
        webhooks: [{
            id: "string",
        }],
    },
    name: "string",
    alertInterval: "string",
    description: "string",
    enabled: false,
    filters: {
        actions: ["string"],
        affectedAsns: ["string"],
        affectedComponents: ["string"],
        affectedLocations: ["string"],
        airportCodes: ["string"],
        alertTriggerPreferences: ["string"],
        alertTriggerPreferencesValues: ["string"],
        enableds: ["string"],
        environments: ["string"],
        eventSources: ["string"],
        eventTypes: ["string"],
        events: ["string"],
        groupBies: ["string"],
        healthCheckIds: ["string"],
        incidentImpacts: ["string"],
        inputIds: ["string"],
        insightClasses: ["string"],
        limits: ["string"],
        logoTags: ["string"],
        megabitsPerSeconds: ["string"],
        newHealths: ["string"],
        newStatuses: ["string"],
        packetsPerSeconds: ["string"],
        poolIds: ["string"],
        popNames: ["string"],
        products: ["string"],
        projectIds: ["string"],
        protocols: ["string"],
        queryTags: ["string"],
        requestsPerSeconds: ["string"],
        selectors: ["string"],
        services: ["string"],
        slos: ["string"],
        statuses: ["string"],
        targetHostnames: ["string"],
        targetIps: ["string"],
        targetZoneNames: ["string"],
        trafficExclusions: ["string"],
        tunnelIds: ["string"],
        tunnelNames: ["string"],
        wheres: ["string"],
        zones: ["string"],
    },
});

type: cloudflare:NotificationPolicy
properties:
    accountId: string
    alertInterval: string
    alertType: string
    description: string
    enabled: false
    filters:
        actions:
            - string
        affectedAsns:
            - string
        affectedComponents:
            - string
        affectedLocations:
            - string
        airportCodes:
            - string
        alertTriggerPreferences:
            - string
        alertTriggerPreferencesValues:
            - string
        enableds:
            - string
        environments:
            - string
        eventSources:
            - string
        eventTypes:
            - string
        events:
            - string
        groupBies:
            - string
        healthCheckIds:
            - string
        incidentImpacts:
            - string
        inputIds:
            - string
        insightClasses:
            - string
        limits:
            - string
        logoTags:
            - string
        megabitsPerSeconds:
            - string
        newHealths:
            - string
        newStatuses:
            - string
        packetsPerSeconds:
            - string
        poolIds:
            - string
        popNames:
            - string
        products:
            - string
        projectIds:
            - string
        protocols:
            - string
        queryTags:
            - string
        requestsPerSeconds:
            - string
        selectors:
            - string
        services:
            - string
        slos:
            - string
        statuses:
            - string
        targetHostnames:
            - string
        targetIps:
            - string
        targetZoneNames:
            - string
        trafficExclusions:
            - string
        tunnelIds:
            - string
        tunnelNames:
            - string
        wheres:
            - string
        zones:
            - string
    mechanisms:
        emails:
            - id: string
        pagerduties:
            - id: string
        webhooks:
            - id: string
    name: string

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

AccountId string: The account id
AlertType string: Refers to which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible values. Available values: "accesscustomcertificateexpirationtype", "advancedddosattackl4alert", "advancedddosattackl7alert", "advancedhttpalerterror", "bgphijacknotification", "billingusagealert", "blocknotificationblockremoved", "blocknotificationnewblock", "blocknotificationreviewrejected", "brandprotectionalert", "brandprotectiondigest", "clickhousealertfwanomaly", "clickhousealertfwentanomaly", "cloudforceonerequestnotification", "customanalytics", "customsslcertificateeventtype", "dedicatedsslcertificateeventtype", "deviceconnectivityanomalyalert", "dosattackl4", "dosattackl7", "expiringservicetokenalert", "failinglogpushjobdisabledalert", "fbmautoadvertisement", "fbmdosdattack", "fbmvolumetricattack", "healthcheckstatusnotification", "hostnameaopcustomcertificateexpirationtype", "httpalertedgeerror", "httpalertoriginerror", "imagenotification", "imageresizingnotification", "incidentalert", "loadbalancinghealthalert", "loadbalancingpoolenablementalert", "logomatchalert", "magictunnelhealthcheckevent", "magicwantunnelhealth", "maintenanceeventnotification", "mtlscertificatestorecertificateexpirationtype", "pageseventalert", "radarnotification", "realoriginmonitoring", "scriptmonitoralertnewcodechangedetections", "scriptmonitoralertnewhosts", "scriptmonitoralertnewmalicioushosts", "scriptmonitoralertnewmaliciousscripts", "scriptmonitoralertnewmaliciousurl", "scriptmonitoralertnewmaxlengthresourceurl", "scriptmonitoralertnewresources", "secondarydnsallprimariesfailing", "secondarydnsprimariesfailing", "secondarydnswarning", "secondarydnszonesuccessfullyupdated", "secondarydnszonevalidationwarning", "securityinsightsalert", "sentinelalert", "streamlivenotifications", "synthetictestlatencyalert", "synthetictestlowavailabilityalert", "trafficanomaliesalert", "tunnelhealthevent", "tunnelupdateevent", "universalssleventtype", "webanalyticsmetricsupdate", "zoneaopcustomcertificateexpirationtype".
Mechanisms NotificationPolicyMechanisms: List of IDs that will be used when dispatching a notification. IDs for email type will be the email address.
Name string: Name of the policy.
AlertInterval string: Optional specification of how often to re-alert from the same incident, not support on all alert types.
Description string: Optional description for the Notification policy.
Enabled bool: Whether or not the Notification policy is enabled.
Filters NotificationPolicyFilters: Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert types. See alert type documentation for more details.

AccountId string: The account id
AlertType string: Refers to which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible values. Available values: "accesscustomcertificateexpirationtype", "advancedddosattackl4alert", "advancedddosattackl7alert", "advancedhttpalerterror", "bgphijacknotification", "billingusagealert", "blocknotificationblockremoved", "blocknotificationnewblock", "blocknotificationreviewrejected", "brandprotectionalert", "brandprotectiondigest", "clickhousealertfwanomaly", "clickhousealertfwentanomaly", "cloudforceonerequestnotification", "customanalytics", "customsslcertificateeventtype", "dedicatedsslcertificateeventtype", "deviceconnectivityanomalyalert", "dosattackl4", "dosattackl7", "expiringservicetokenalert", "failinglogpushjobdisabledalert", "fbmautoadvertisement", "fbmdosdattack", "fbmvolumetricattack", "healthcheckstatusnotification", "hostnameaopcustomcertificateexpirationtype", "httpalertedgeerror", "httpalertoriginerror", "imagenotification", "imageresizingnotification", "incidentalert", "loadbalancinghealthalert", "loadbalancingpoolenablementalert", "logomatchalert", "magictunnelhealthcheckevent", "magicwantunnelhealth", "maintenanceeventnotification", "mtlscertificatestorecertificateexpirationtype", "pageseventalert", "radarnotification", "realoriginmonitoring", "scriptmonitoralertnewcodechangedetections", "scriptmonitoralertnewhosts", "scriptmonitoralertnewmalicioushosts", "scriptmonitoralertnewmaliciousscripts", "scriptmonitoralertnewmaliciousurl", "scriptmonitoralertnewmaxlengthresourceurl", "scriptmonitoralertnewresources", "secondarydnsallprimariesfailing", "secondarydnsprimariesfailing", "secondarydnswarning", "secondarydnszonesuccessfullyupdated", "secondarydnszonevalidationwarning", "securityinsightsalert", "sentinelalert", "streamlivenotifications", "synthetictestlatencyalert", "synthetictestlowavailabilityalert", "trafficanomaliesalert", "tunnelhealthevent", "tunnelupdateevent", "universalssleventtype", "webanalyticsmetricsupdate", "zoneaopcustomcertificateexpirationtype".
Mechanisms NotificationPolicyMechanismsArgs: List of IDs that will be used when dispatching a notification. IDs for email type will be the email address.
Name string: Name of the policy.
AlertInterval string: Optional specification of how often to re-alert from the same incident, not support on all alert types.
Description string: Optional description for the Notification policy.
Enabled bool: Whether or not the Notification policy is enabled.
Filters NotificationPolicyFiltersArgs: Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert types. See alert type documentation for more details.

accountId String: The account id
alertType String: Refers to which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible values. Available values: "accesscustomcertificateexpirationtype", "advancedddosattackl4alert", "advancedddosattackl7alert", "advancedhttpalerterror", "bgphijacknotification", "billingusagealert", "blocknotificationblockremoved", "blocknotificationnewblock", "blocknotificationreviewrejected", "brandprotectionalert", "brandprotectiondigest", "clickhousealertfwanomaly", "clickhousealertfwentanomaly", "cloudforceonerequestnotification", "customanalytics", "customsslcertificateeventtype", "dedicatedsslcertificateeventtype", "deviceconnectivityanomalyalert", "dosattackl4", "dosattackl7", "expiringservicetokenalert", "failinglogpushjobdisabledalert", "fbmautoadvertisement", "fbmdosdattack", "fbmvolumetricattack", "healthcheckstatusnotification", "hostnameaopcustomcertificateexpirationtype", "httpalertedgeerror", "httpalertoriginerror", "imagenotification", "imageresizingnotification", "incidentalert", "loadbalancinghealthalert", "loadbalancingpoolenablementalert", "logomatchalert", "magictunnelhealthcheckevent", "magicwantunnelhealth", "maintenanceeventnotification", "mtlscertificatestorecertificateexpirationtype", "pageseventalert", "radarnotification", "realoriginmonitoring", "scriptmonitoralertnewcodechangedetections", "scriptmonitoralertnewhosts", "scriptmonitoralertnewmalicioushosts", "scriptmonitoralertnewmaliciousscripts", "scriptmonitoralertnewmaliciousurl", "scriptmonitoralertnewmaxlengthresourceurl", "scriptmonitoralertnewresources", "secondarydnsallprimariesfailing", "secondarydnsprimariesfailing", "secondarydnswarning", "secondarydnszonesuccessfullyupdated", "secondarydnszonevalidationwarning", "securityinsightsalert", "sentinelalert", "streamlivenotifications", "synthetictestlatencyalert", "synthetictestlowavailabilityalert", "trafficanomaliesalert", "tunnelhealthevent", "tunnelupdateevent", "universalssleventtype", "webanalyticsmetricsupdate", "zoneaopcustomcertificateexpirationtype".
mechanisms NotificationPolicyMechanisms: List of IDs that will be used when dispatching a notification. IDs for email type will be the email address.
name String: Name of the policy.
alertInterval String: Optional specification of how often to re-alert from the same incident, not support on all alert types.
description String: Optional description for the Notification policy.
enabled Boolean: Whether or not the Notification policy is enabled.
filters NotificationPolicyFilters: Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert types. See alert type documentation for more details.

accountId string: The account id
alertType string: Refers to which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible values. Available values: "accesscustomcertificateexpirationtype", "advancedddosattackl4alert", "advancedddosattackl7alert", "advancedhttpalerterror", "bgphijacknotification", "billingusagealert", "blocknotificationblockremoved", "blocknotificationnewblock", "blocknotificationreviewrejected", "brandprotectionalert", "brandprotectiondigest", "clickhousealertfwanomaly", "clickhousealertfwentanomaly", "cloudforceonerequestnotification", "customanalytics", "customsslcertificateeventtype", "dedicatedsslcertificateeventtype", "deviceconnectivityanomalyalert", "dosattackl4", "dosattackl7", "expiringservicetokenalert", "failinglogpushjobdisabledalert", "fbmautoadvertisement", "fbmdosdattack", "fbmvolumetricattack", "healthcheckstatusnotification", "hostnameaopcustomcertificateexpirationtype", "httpalertedgeerror", "httpalertoriginerror", "imagenotification", "imageresizingnotification", "incidentalert", "loadbalancinghealthalert", "loadbalancingpoolenablementalert", "logomatchalert", "magictunnelhealthcheckevent", "magicwantunnelhealth", "maintenanceeventnotification", "mtlscertificatestorecertificateexpirationtype", "pageseventalert", "radarnotification", "realoriginmonitoring", "scriptmonitoralertnewcodechangedetections", "scriptmonitoralertnewhosts", "scriptmonitoralertnewmalicioushosts", "scriptmonitoralertnewmaliciousscripts", "scriptmonitoralertnewmaliciousurl", "scriptmonitoralertnewmaxlengthresourceurl", "scriptmonitoralertnewresources", "secondarydnsallprimariesfailing", "secondarydnsprimariesfailing", "secondarydnswarning", "secondarydnszonesuccessfullyupdated", "secondarydnszonevalidationwarning", "securityinsightsalert", "sentinelalert", "streamlivenotifications", "synthetictestlatencyalert", "synthetictestlowavailabilityalert", "trafficanomaliesalert", "tunnelhealthevent", "tunnelupdateevent", "universalssleventtype", "webanalyticsmetricsupdate", "zoneaopcustomcertificateexpirationtype".
mechanisms NotificationPolicyMechanisms: List of IDs that will be used when dispatching a notification. IDs for email type will be the email address.
name string: Name of the policy.
alertInterval string: Optional specification of how often to re-alert from the same incident, not support on all alert types.
description string: Optional description for the Notification policy.
enabled boolean: Whether or not the Notification policy is enabled.
filters NotificationPolicyFilters: Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert types. See alert type documentation for more details.

account_id str: The account id
alert_type str: Refers to which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible values. Available values: "accesscustomcertificateexpirationtype", "advancedddosattackl4alert", "advancedddosattackl7alert", "advancedhttpalerterror", "bgphijacknotification", "billingusagealert", "blocknotificationblockremoved", "blocknotificationnewblock", "blocknotificationreviewrejected", "brandprotectionalert", "brandprotectiondigest", "clickhousealertfwanomaly", "clickhousealertfwentanomaly", "cloudforceonerequestnotification", "customanalytics", "customsslcertificateeventtype", "dedicatedsslcertificateeventtype", "deviceconnectivityanomalyalert", "dosattackl4", "dosattackl7", "expiringservicetokenalert", "failinglogpushjobdisabledalert", "fbmautoadvertisement", "fbmdosdattack", "fbmvolumetricattack", "healthcheckstatusnotification", "hostnameaopcustomcertificateexpirationtype", "httpalertedgeerror", "httpalertoriginerror", "imagenotification", "imageresizingnotification", "incidentalert", "loadbalancinghealthalert", "loadbalancingpoolenablementalert", "logomatchalert", "magictunnelhealthcheckevent", "magicwantunnelhealth", "maintenanceeventnotification", "mtlscertificatestorecertificateexpirationtype", "pageseventalert", "radarnotification", "realoriginmonitoring", "scriptmonitoralertnewcodechangedetections", "scriptmonitoralertnewhosts", "scriptmonitoralertnewmalicioushosts", "scriptmonitoralertnewmaliciousscripts", "scriptmonitoralertnewmaliciousurl", "scriptmonitoralertnewmaxlengthresourceurl", "scriptmonitoralertnewresources", "secondarydnsallprimariesfailing", "secondarydnsprimariesfailing", "secondarydnswarning", "secondarydnszonesuccessfullyupdated", "secondarydnszonevalidationwarning", "securityinsightsalert", "sentinelalert", "streamlivenotifications", "synthetictestlatencyalert", "synthetictestlowavailabilityalert", "trafficanomaliesalert", "tunnelhealthevent", "tunnelupdateevent", "universalssleventtype", "webanalyticsmetricsupdate", "zoneaopcustomcertificateexpirationtype".
mechanisms NotificationPolicyMechanismsArgs: List of IDs that will be used when dispatching a notification. IDs for email type will be the email address.
name str: Name of the policy.
alert_interval str: Optional specification of how often to re-alert from the same incident, not support on all alert types.
description str: Optional description for the Notification policy.
enabled bool: Whether or not the Notification policy is enabled.
filters NotificationPolicyFiltersArgs: Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert types. See alert type documentation for more details.

accountId String: The account id
alertType String: Refers to which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible values. Available values: "accesscustomcertificateexpirationtype", "advancedddosattackl4alert", "advancedddosattackl7alert", "advancedhttpalerterror", "bgphijacknotification", "billingusagealert", "blocknotificationblockremoved", "blocknotificationnewblock", "blocknotificationreviewrejected", "brandprotectionalert", "brandprotectiondigest", "clickhousealertfwanomaly", "clickhousealertfwentanomaly", "cloudforceonerequestnotification", "customanalytics", "customsslcertificateeventtype", "dedicatedsslcertificateeventtype", "deviceconnectivityanomalyalert", "dosattackl4", "dosattackl7", "expiringservicetokenalert", "failinglogpushjobdisabledalert", "fbmautoadvertisement", "fbmdosdattack", "fbmvolumetricattack", "healthcheckstatusnotification", "hostnameaopcustomcertificateexpirationtype", "httpalertedgeerror", "httpalertoriginerror", "imagenotification", "imageresizingnotification", "incidentalert", "loadbalancinghealthalert", "loadbalancingpoolenablementalert", "logomatchalert", "magictunnelhealthcheckevent", "magicwantunnelhealth", "maintenanceeventnotification", "mtlscertificatestorecertificateexpirationtype", "pageseventalert", "radarnotification", "realoriginmonitoring", "scriptmonitoralertnewcodechangedetections", "scriptmonitoralertnewhosts", "scriptmonitoralertnewmalicioushosts", "scriptmonitoralertnewmaliciousscripts", "scriptmonitoralertnewmaliciousurl", "scriptmonitoralertnewmaxlengthresourceurl", "scriptmonitoralertnewresources", "secondarydnsallprimariesfailing", "secondarydnsprimariesfailing", "secondarydnswarning", "secondarydnszonesuccessfullyupdated", "secondarydnszonevalidationwarning", "securityinsightsalert", "sentinelalert", "streamlivenotifications", "synthetictestlatencyalert", "synthetictestlowavailabilityalert", "trafficanomaliesalert", "tunnelhealthevent", "tunnelupdateevent", "universalssleventtype", "webanalyticsmetricsupdate", "zoneaopcustomcertificateexpirationtype".
mechanisms Property Map: List of IDs that will be used when dispatching a notification. IDs for email type will be the email address.
name String: Name of the policy.
alertInterval String: Optional specification of how often to re-alert from the same incident, not support on all alert types.
description String: Optional description for the Notification policy.
enabled Boolean: Whether or not the Notification policy is enabled.
filters Property Map: Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert types. See alert type documentation for more details.

Outputs

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

Created string
Id string: The provider-assigned unique ID for this managed resource.
Modified string

Created string
Id string: The provider-assigned unique ID for this managed resource.
Modified string

created String
id String: The provider-assigned unique ID for this managed resource.
modified String

created string
id string: The provider-assigned unique ID for this managed resource.
modified string

created str
id str: The provider-assigned unique ID for this managed resource.
modified str

created String
id String: The provider-assigned unique ID for this managed resource.
modified String

Look up Existing NotificationPolicy Resource

Get an existing NotificationPolicy 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?: NotificationPolicyState, opts?: CustomResourceOptions): NotificationPolicy

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        alert_interval: Optional[str] = None,
        alert_type: Optional[str] = None,
        created: Optional[str] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        filters: Optional[NotificationPolicyFiltersArgs] = None,
        mechanisms: Optional[NotificationPolicyMechanismsArgs] = None,
        modified: Optional[str] = None,
        name: Optional[str] = None) -> NotificationPolicy

func GetNotificationPolicy(ctx *Context, name string, id IDInput, state *NotificationPolicyState, opts ...ResourceOption) (*NotificationPolicy, error)

public static NotificationPolicy Get(string name, Input<string> id, NotificationPolicyState? state, CustomResourceOptions? opts = null)

public static NotificationPolicy get(String name, Output<String> id, NotificationPolicyState state, CustomResourceOptions options)

resources:  _:    type: cloudflare:NotificationPolicy    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:

AccountId string: The account id
AlertInterval string: Optional specification of how often to re-alert from the same incident, not support on all alert types.
AlertType string: Refers to which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible values. Available values: "accesscustomcertificateexpirationtype", "advancedddosattackl4alert", "advancedddosattackl7alert", "advancedhttpalerterror", "bgphijacknotification", "billingusagealert", "blocknotificationblockremoved", "blocknotificationnewblock", "blocknotificationreviewrejected", "brandprotectionalert", "brandprotectiondigest", "clickhousealertfwanomaly", "clickhousealertfwentanomaly", "cloudforceonerequestnotification", "customanalytics", "customsslcertificateeventtype", "dedicatedsslcertificateeventtype", "deviceconnectivityanomalyalert", "dosattackl4", "dosattackl7", "expiringservicetokenalert", "failinglogpushjobdisabledalert", "fbmautoadvertisement", "fbmdosdattack", "fbmvolumetricattack", "healthcheckstatusnotification", "hostnameaopcustomcertificateexpirationtype", "httpalertedgeerror", "httpalertoriginerror", "imagenotification", "imageresizingnotification", "incidentalert", "loadbalancinghealthalert", "loadbalancingpoolenablementalert", "logomatchalert", "magictunnelhealthcheckevent", "magicwantunnelhealth", "maintenanceeventnotification", "mtlscertificatestorecertificateexpirationtype", "pageseventalert", "radarnotification", "realoriginmonitoring", "scriptmonitoralertnewcodechangedetections", "scriptmonitoralertnewhosts", "scriptmonitoralertnewmalicioushosts", "scriptmonitoralertnewmaliciousscripts", "scriptmonitoralertnewmaliciousurl", "scriptmonitoralertnewmaxlengthresourceurl", "scriptmonitoralertnewresources", "secondarydnsallprimariesfailing", "secondarydnsprimariesfailing", "secondarydnswarning", "secondarydnszonesuccessfullyupdated", "secondarydnszonevalidationwarning", "securityinsightsalert", "sentinelalert", "streamlivenotifications", "synthetictestlatencyalert", "synthetictestlowavailabilityalert", "trafficanomaliesalert", "tunnelhealthevent", "tunnelupdateevent", "universalssleventtype", "webanalyticsmetricsupdate", "zoneaopcustomcertificateexpirationtype".
Created string
Description string: Optional description for the Notification policy.
Enabled bool: Whether or not the Notification policy is enabled.
Filters NotificationPolicyFilters: Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert types. See alert type documentation for more details.
Mechanisms NotificationPolicyMechanisms: List of IDs that will be used when dispatching a notification. IDs for email type will be the email address.
Modified string
Name string: Name of the policy.

AccountId string: The account id
AlertInterval string: Optional specification of how often to re-alert from the same incident, not support on all alert types.
AlertType string: Refers to which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible values. Available values: "accesscustomcertificateexpirationtype", "advancedddosattackl4alert", "advancedddosattackl7alert", "advancedhttpalerterror", "bgphijacknotification", "billingusagealert", "blocknotificationblockremoved", "blocknotificationnewblock", "blocknotificationreviewrejected", "brandprotectionalert", "brandprotectiondigest", "clickhousealertfwanomaly", "clickhousealertfwentanomaly", "cloudforceonerequestnotification", "customanalytics", "customsslcertificateeventtype", "dedicatedsslcertificateeventtype", "deviceconnectivityanomalyalert", "dosattackl4", "dosattackl7", "expiringservicetokenalert", "failinglogpushjobdisabledalert", "fbmautoadvertisement", "fbmdosdattack", "fbmvolumetricattack", "healthcheckstatusnotification", "hostnameaopcustomcertificateexpirationtype", "httpalertedgeerror", "httpalertoriginerror", "imagenotification", "imageresizingnotification", "incidentalert", "loadbalancinghealthalert", "loadbalancingpoolenablementalert", "logomatchalert", "magictunnelhealthcheckevent", "magicwantunnelhealth", "maintenanceeventnotification", "mtlscertificatestorecertificateexpirationtype", "pageseventalert", "radarnotification", "realoriginmonitoring", "scriptmonitoralertnewcodechangedetections", "scriptmonitoralertnewhosts", "scriptmonitoralertnewmalicioushosts", "scriptmonitoralertnewmaliciousscripts", "scriptmonitoralertnewmaliciousurl", "scriptmonitoralertnewmaxlengthresourceurl", "scriptmonitoralertnewresources", "secondarydnsallprimariesfailing", "secondarydnsprimariesfailing", "secondarydnswarning", "secondarydnszonesuccessfullyupdated", "secondarydnszonevalidationwarning", "securityinsightsalert", "sentinelalert", "streamlivenotifications", "synthetictestlatencyalert", "synthetictestlowavailabilityalert", "trafficanomaliesalert", "tunnelhealthevent", "tunnelupdateevent", "universalssleventtype", "webanalyticsmetricsupdate", "zoneaopcustomcertificateexpirationtype".
Created string
Description string: Optional description for the Notification policy.
Enabled bool: Whether or not the Notification policy is enabled.
Filters NotificationPolicyFiltersArgs: Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert types. See alert type documentation for more details.
Mechanisms NotificationPolicyMechanismsArgs: List of IDs that will be used when dispatching a notification. IDs for email type will be the email address.
Modified string
Name string: Name of the policy.

accountId String: The account id
alertInterval String: Optional specification of how often to re-alert from the same incident, not support on all alert types.
alertType String: Refers to which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible values. Available values: "accesscustomcertificateexpirationtype", "advancedddosattackl4alert", "advancedddosattackl7alert", "advancedhttpalerterror", "bgphijacknotification", "billingusagealert", "blocknotificationblockremoved", "blocknotificationnewblock", "blocknotificationreviewrejected", "brandprotectionalert", "brandprotectiondigest", "clickhousealertfwanomaly", "clickhousealertfwentanomaly", "cloudforceonerequestnotification", "customanalytics", "customsslcertificateeventtype", "dedicatedsslcertificateeventtype", "deviceconnectivityanomalyalert", "dosattackl4", "dosattackl7", "expiringservicetokenalert", "failinglogpushjobdisabledalert", "fbmautoadvertisement", "fbmdosdattack", "fbmvolumetricattack", "healthcheckstatusnotification", "hostnameaopcustomcertificateexpirationtype", "httpalertedgeerror", "httpalertoriginerror", "imagenotification", "imageresizingnotification", "incidentalert", "loadbalancinghealthalert", "loadbalancingpoolenablementalert", "logomatchalert", "magictunnelhealthcheckevent", "magicwantunnelhealth", "maintenanceeventnotification", "mtlscertificatestorecertificateexpirationtype", "pageseventalert", "radarnotification", "realoriginmonitoring", "scriptmonitoralertnewcodechangedetections", "scriptmonitoralertnewhosts", "scriptmonitoralertnewmalicioushosts", "scriptmonitoralertnewmaliciousscripts", "scriptmonitoralertnewmaliciousurl", "scriptmonitoralertnewmaxlengthresourceurl", "scriptmonitoralertnewresources", "secondarydnsallprimariesfailing", "secondarydnsprimariesfailing", "secondarydnswarning", "secondarydnszonesuccessfullyupdated", "secondarydnszonevalidationwarning", "securityinsightsalert", "sentinelalert", "streamlivenotifications", "synthetictestlatencyalert", "synthetictestlowavailabilityalert", "trafficanomaliesalert", "tunnelhealthevent", "tunnelupdateevent", "universalssleventtype", "webanalyticsmetricsupdate", "zoneaopcustomcertificateexpirationtype".
created String
description String: Optional description for the Notification policy.
enabled Boolean: Whether or not the Notification policy is enabled.
filters NotificationPolicyFilters: Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert types. See alert type documentation for more details.
mechanisms NotificationPolicyMechanisms: List of IDs that will be used when dispatching a notification. IDs for email type will be the email address.
modified String
name String: Name of the policy.

accountId string: The account id
alertInterval string: Optional specification of how often to re-alert from the same incident, not support on all alert types.
alertType string: Refers to which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible values. Available values: "accesscustomcertificateexpirationtype", "advancedddosattackl4alert", "advancedddosattackl7alert", "advancedhttpalerterror", "bgphijacknotification", "billingusagealert", "blocknotificationblockremoved", "blocknotificationnewblock", "blocknotificationreviewrejected", "brandprotectionalert", "brandprotectiondigest", "clickhousealertfwanomaly", "clickhousealertfwentanomaly", "cloudforceonerequestnotification", "customanalytics", "customsslcertificateeventtype", "dedicatedsslcertificateeventtype", "deviceconnectivityanomalyalert", "dosattackl4", "dosattackl7", "expiringservicetokenalert", "failinglogpushjobdisabledalert", "fbmautoadvertisement", "fbmdosdattack", "fbmvolumetricattack", "healthcheckstatusnotification", "hostnameaopcustomcertificateexpirationtype", "httpalertedgeerror", "httpalertoriginerror", "imagenotification", "imageresizingnotification", "incidentalert", "loadbalancinghealthalert", "loadbalancingpoolenablementalert", "logomatchalert", "magictunnelhealthcheckevent", "magicwantunnelhealth", "maintenanceeventnotification", "mtlscertificatestorecertificateexpirationtype", "pageseventalert", "radarnotification", "realoriginmonitoring", "scriptmonitoralertnewcodechangedetections", "scriptmonitoralertnewhosts", "scriptmonitoralertnewmalicioushosts", "scriptmonitoralertnewmaliciousscripts", "scriptmonitoralertnewmaliciousurl", "scriptmonitoralertnewmaxlengthresourceurl", "scriptmonitoralertnewresources", "secondarydnsallprimariesfailing", "secondarydnsprimariesfailing", "secondarydnswarning", "secondarydnszonesuccessfullyupdated", "secondarydnszonevalidationwarning", "securityinsightsalert", "sentinelalert", "streamlivenotifications", "synthetictestlatencyalert", "synthetictestlowavailabilityalert", "trafficanomaliesalert", "tunnelhealthevent", "tunnelupdateevent", "universalssleventtype", "webanalyticsmetricsupdate", "zoneaopcustomcertificateexpirationtype".
created string
description string: Optional description for the Notification policy.
enabled boolean: Whether or not the Notification policy is enabled.
filters NotificationPolicyFilters: Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert types. See alert type documentation for more details.
mechanisms NotificationPolicyMechanisms: List of IDs that will be used when dispatching a notification. IDs for email type will be the email address.
modified string
name string: Name of the policy.

account_id str: The account id
alert_interval str: Optional specification of how often to re-alert from the same incident, not support on all alert types.
alert_type str: Refers to which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible values. Available values: "accesscustomcertificateexpirationtype", "advancedddosattackl4alert", "advancedddosattackl7alert", "advancedhttpalerterror", "bgphijacknotification", "billingusagealert", "blocknotificationblockremoved", "blocknotificationnewblock", "blocknotificationreviewrejected", "brandprotectionalert", "brandprotectiondigest", "clickhousealertfwanomaly", "clickhousealertfwentanomaly", "cloudforceonerequestnotification", "customanalytics", "customsslcertificateeventtype", "dedicatedsslcertificateeventtype", "deviceconnectivityanomalyalert", "dosattackl4", "dosattackl7", "expiringservicetokenalert", "failinglogpushjobdisabledalert", "fbmautoadvertisement", "fbmdosdattack", "fbmvolumetricattack", "healthcheckstatusnotification", "hostnameaopcustomcertificateexpirationtype", "httpalertedgeerror", "httpalertoriginerror", "imagenotification", "imageresizingnotification", "incidentalert", "loadbalancinghealthalert", "loadbalancingpoolenablementalert", "logomatchalert", "magictunnelhealthcheckevent", "magicwantunnelhealth", "maintenanceeventnotification", "mtlscertificatestorecertificateexpirationtype", "pageseventalert", "radarnotification", "realoriginmonitoring", "scriptmonitoralertnewcodechangedetections", "scriptmonitoralertnewhosts", "scriptmonitoralertnewmalicioushosts", "scriptmonitoralertnewmaliciousscripts", "scriptmonitoralertnewmaliciousurl", "scriptmonitoralertnewmaxlengthresourceurl", "scriptmonitoralertnewresources", "secondarydnsallprimariesfailing", "secondarydnsprimariesfailing", "secondarydnswarning", "secondarydnszonesuccessfullyupdated", "secondarydnszonevalidationwarning", "securityinsightsalert", "sentinelalert", "streamlivenotifications", "synthetictestlatencyalert", "synthetictestlowavailabilityalert", "trafficanomaliesalert", "tunnelhealthevent", "tunnelupdateevent", "universalssleventtype", "webanalyticsmetricsupdate", "zoneaopcustomcertificateexpirationtype".
created str
description str: Optional description for the Notification policy.
enabled bool: Whether or not the Notification policy is enabled.
filters NotificationPolicyFiltersArgs: Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert types. See alert type documentation for more details.
mechanisms NotificationPolicyMechanismsArgs: List of IDs that will be used when dispatching a notification. IDs for email type will be the email address.
modified str
name str: Name of the policy.

accountId String: The account id
alertInterval String: Optional specification of how often to re-alert from the same incident, not support on all alert types.
alertType String: Refers to which event will trigger a Notification dispatch. You can use the endpoint to get available alert types which then will give you a list of possible values. Available values: "accesscustomcertificateexpirationtype", "advancedddosattackl4alert", "advancedddosattackl7alert", "advancedhttpalerterror", "bgphijacknotification", "billingusagealert", "blocknotificationblockremoved", "blocknotificationnewblock", "blocknotificationreviewrejected", "brandprotectionalert", "brandprotectiondigest", "clickhousealertfwanomaly", "clickhousealertfwentanomaly", "cloudforceonerequestnotification", "customanalytics", "customsslcertificateeventtype", "dedicatedsslcertificateeventtype", "deviceconnectivityanomalyalert", "dosattackl4", "dosattackl7", "expiringservicetokenalert", "failinglogpushjobdisabledalert", "fbmautoadvertisement", "fbmdosdattack", "fbmvolumetricattack", "healthcheckstatusnotification", "hostnameaopcustomcertificateexpirationtype", "httpalertedgeerror", "httpalertoriginerror", "imagenotification", "imageresizingnotification", "incidentalert", "loadbalancinghealthalert", "loadbalancingpoolenablementalert", "logomatchalert", "magictunnelhealthcheckevent", "magicwantunnelhealth", "maintenanceeventnotification", "mtlscertificatestorecertificateexpirationtype", "pageseventalert", "radarnotification", "realoriginmonitoring", "scriptmonitoralertnewcodechangedetections", "scriptmonitoralertnewhosts", "scriptmonitoralertnewmalicioushosts", "scriptmonitoralertnewmaliciousscripts", "scriptmonitoralertnewmaliciousurl", "scriptmonitoralertnewmaxlengthresourceurl", "scriptmonitoralertnewresources", "secondarydnsallprimariesfailing", "secondarydnsprimariesfailing", "secondarydnswarning", "secondarydnszonesuccessfullyupdated", "secondarydnszonevalidationwarning", "securityinsightsalert", "sentinelalert", "streamlivenotifications", "synthetictestlatencyalert", "synthetictestlowavailabilityalert", "trafficanomaliesalert", "tunnelhealthevent", "tunnelupdateevent", "universalssleventtype", "webanalyticsmetricsupdate", "zoneaopcustomcertificateexpirationtype".
created String
description String: Optional description for the Notification policy.
enabled Boolean: Whether or not the Notification policy is enabled.
filters Property Map: Optional filters that allow you to be alerted only on a subset of events for that alert type based on some criteria. This is only available for select alert types. See alert type documentation for more details.
mechanisms Property Map: List of IDs that will be used when dispatching a notification. IDs for email type will be the email address.
modified String
name String: Name of the policy.

Supporting Types

NotificationPolicyFilters, NotificationPolicyFiltersArgs

Actions List<string>: Usage depends on specific alert type
AffectedAsns List<string>: Used for configuring radar_notification
AffectedComponents List<string>: Used for configuring incident_alert
AffectedLocations List<string>: Used for configuring radar_notification
AirportCodes List<string>: Used for configuring maintenanceeventnotification
AlertTriggerPreferences List<string>: Usage depends on specific alert type
AlertTriggerPreferencesValues List<string>: Usage depends on specific alert type
Enableds List<string>: Used for configuring loadbalancingpoolenablementalert
Environments List<string>: Used for configuring pageseventalert
EventSources List<string>: Used for configuring loadbalancinghealth_alert
EventTypes List<string>: Usage depends on specific alert type
Events List<string>: Used for configuring pageseventalert
GroupBies List<string>: Usage depends on specific alert type
HealthCheckIds List<string>: Used for configuring healthcheckstatus_notification
IncidentImpacts List<string>: Used for configuring incident_alert
InputIds List<string>: Used for configuring streamlivenotifications
InsightClasses List<string>: Used for configuring securityinsightsalert
Limits List<string>: Used for configuring billingusagealert
LogoTags List<string>: Used for configuring logomatchalert
MegabitsPerSeconds List<string>: Used for configuring advancedddosattackl4alert
NewHealths List<string>: Used for configuring loadbalancinghealth_alert
NewStatuses List<string>: Used for configuring tunnelhealthevent
PacketsPerSeconds List<string>: Used for configuring advancedddosattackl4alert
PoolIds List<string>: Usage depends on specific alert type
PopNames List<string>: Usage depends on specific alert type
Products List<string>: Used for configuring billingusagealert
ProjectIds List<string>: Used for configuring pageseventalert
Protocols List<string>: Used for configuring advancedddosattackl4alert
QueryTags List<string>: Usage depends on specific alert type
RequestsPerSeconds List<string>: Used for configuring advancedddosattackl7alert
Selectors List<string>: Usage depends on specific alert type
Services List<string>: Used for configuring clickhousealertfwentanomaly
Slos List<string>: Usage depends on specific alert type
Statuses List<string>: Used for configuring healthcheckstatus_notification
TargetHostnames List<string>: Used for configuring advancedddosattackl7alert
TargetIps List<string>: Used for configuring advancedddosattackl4alert
TargetZoneNames List<string>: Used for configuring advancedddosattackl7alert
TrafficExclusions List<string>: Used for configuring trafficanomaliesalert
TunnelIds List<string>: Used for configuring tunnelhealthevent
TunnelNames List<string>: Usage depends on specific alert type
Wheres List<string>: Usage depends on specific alert type
Zones List<string>: Usage depends on specific alert type

Actions []string: Usage depends on specific alert type
AffectedAsns []string: Used for configuring radar_notification
AffectedComponents []string: Used for configuring incident_alert
AffectedLocations []string: Used for configuring radar_notification
AirportCodes []string: Used for configuring maintenanceeventnotification
AlertTriggerPreferences []string: Usage depends on specific alert type
AlertTriggerPreferencesValues []string: Usage depends on specific alert type
Enableds []string: Used for configuring loadbalancingpoolenablementalert
Environments []string: Used for configuring pageseventalert
EventSources []string: Used for configuring loadbalancinghealth_alert
EventTypes []string: Usage depends on specific alert type
Events []string: Used for configuring pageseventalert
GroupBies []string: Usage depends on specific alert type
HealthCheckIds []string: Used for configuring healthcheckstatus_notification
IncidentImpacts []string: Used for configuring incident_alert
InputIds []string: Used for configuring streamlivenotifications
InsightClasses []string: Used for configuring securityinsightsalert
Limits []string: Used for configuring billingusagealert
LogoTags []string: Used for configuring logomatchalert
MegabitsPerSeconds []string: Used for configuring advancedddosattackl4alert
NewHealths []string: Used for configuring loadbalancinghealth_alert
NewStatuses []string: Used for configuring tunnelhealthevent
PacketsPerSeconds []string: Used for configuring advancedddosattackl4alert
PoolIds []string: Usage depends on specific alert type
PopNames []string: Usage depends on specific alert type
Products []string: Used for configuring billingusagealert
ProjectIds []string: Used for configuring pageseventalert
Protocols []string: Used for configuring advancedddosattackl4alert
QueryTags []string: Usage depends on specific alert type
RequestsPerSeconds []string: Used for configuring advancedddosattackl7alert
Selectors []string: Usage depends on specific alert type
Services []string: Used for configuring clickhousealertfwentanomaly
Slos []string: Usage depends on specific alert type
Statuses []string: Used for configuring healthcheckstatus_notification
TargetHostnames []string: Used for configuring advancedddosattackl7alert
TargetIps []string: Used for configuring advancedddosattackl4alert
TargetZoneNames []string: Used for configuring advancedddosattackl7alert
TrafficExclusions []string: Used for configuring trafficanomaliesalert
TunnelIds []string: Used for configuring tunnelhealthevent
TunnelNames []string: Usage depends on specific alert type
Wheres []string: Usage depends on specific alert type
Zones []string: Usage depends on specific alert type

actions List<String>: Usage depends on specific alert type
affectedAsns List<String>: Used for configuring radar_notification
affectedComponents List<String>: Used for configuring incident_alert
affectedLocations List<String>: Used for configuring radar_notification
airportCodes List<String>: Used for configuring maintenanceeventnotification
alertTriggerPreferences List<String>: Usage depends on specific alert type
alertTriggerPreferencesValues List<String>: Usage depends on specific alert type
enableds List<String>: Used for configuring loadbalancingpoolenablementalert
environments List<String>: Used for configuring pageseventalert
eventSources List<String>: Used for configuring loadbalancinghealth_alert
eventTypes List<String>: Usage depends on specific alert type
events List<String>: Used for configuring pageseventalert
groupBies List<String>: Usage depends on specific alert type
healthCheckIds List<String>: Used for configuring healthcheckstatus_notification
incidentImpacts List<String>: Used for configuring incident_alert
inputIds List<String>: Used for configuring streamlivenotifications
insightClasses List<String>: Used for configuring securityinsightsalert
limits List<String>: Used for configuring billingusagealert
logoTags List<String>: Used for configuring logomatchalert
megabitsPerSeconds List<String>: Used for configuring advancedddosattackl4alert
newHealths List<String>: Used for configuring loadbalancinghealth_alert
newStatuses List<String>: Used for configuring tunnelhealthevent
packetsPerSeconds List<String>: Used for configuring advancedddosattackl4alert
poolIds List<String>: Usage depends on specific alert type
popNames List<String>: Usage depends on specific alert type
products List<String>: Used for configuring billingusagealert
projectIds List<String>: Used for configuring pageseventalert
protocols List<String>: Used for configuring advancedddosattackl4alert
queryTags List<String>: Usage depends on specific alert type
requestsPerSeconds List<String>: Used for configuring advancedddosattackl7alert
selectors List<String>: Usage depends on specific alert type
services List<String>: Used for configuring clickhousealertfwentanomaly
slos List<String>: Usage depends on specific alert type
statuses List<String>: Used for configuring healthcheckstatus_notification
targetHostnames List<String>: Used for configuring advancedddosattackl7alert
targetIps List<String>: Used for configuring advancedddosattackl4alert
targetZoneNames List<String>: Used for configuring advancedddosattackl7alert
trafficExclusions List<String>: Used for configuring trafficanomaliesalert
tunnelIds List<String>: Used for configuring tunnelhealthevent
tunnelNames List<String>: Usage depends on specific alert type
wheres List<String>: Usage depends on specific alert type
zones List<String>: Usage depends on specific alert type

actions string[]: Usage depends on specific alert type
affectedAsns string[]: Used for configuring radar_notification
affectedComponents string[]: Used for configuring incident_alert
affectedLocations string[]: Used for configuring radar_notification
airportCodes string[]: Used for configuring maintenanceeventnotification
alertTriggerPreferences string[]: Usage depends on specific alert type
alertTriggerPreferencesValues string[]: Usage depends on specific alert type
enableds string[]: Used for configuring loadbalancingpoolenablementalert
environments string[]: Used for configuring pageseventalert
eventSources string[]: Used for configuring loadbalancinghealth_alert
eventTypes string[]: Usage depends on specific alert type
events string[]: Used for configuring pageseventalert
groupBies string[]: Usage depends on specific alert type
healthCheckIds string[]: Used for configuring healthcheckstatus_notification
incidentImpacts string[]: Used for configuring incident_alert
inputIds string[]: Used for configuring streamlivenotifications
insightClasses string[]: Used for configuring securityinsightsalert
limits string[]: Used for configuring billingusagealert
logoTags string[]: Used for configuring logomatchalert
megabitsPerSeconds string[]: Used for configuring advancedddosattackl4alert
newHealths string[]: Used for configuring loadbalancinghealth_alert
newStatuses string[]: Used for configuring tunnelhealthevent
packetsPerSeconds string[]: Used for configuring advancedddosattackl4alert
poolIds string[]: Usage depends on specific alert type
popNames string[]: Usage depends on specific alert type
products string[]: Used for configuring billingusagealert
projectIds string[]: Used for configuring pageseventalert
protocols string[]: Used for configuring advancedddosattackl4alert
queryTags string[]: Usage depends on specific alert type
requestsPerSeconds string[]: Used for configuring advancedddosattackl7alert
selectors string[]: Usage depends on specific alert type
services string[]: Used for configuring clickhousealertfwentanomaly
slos string[]: Usage depends on specific alert type
statuses string[]: Used for configuring healthcheckstatus_notification
targetHostnames string[]: Used for configuring advancedddosattackl7alert
targetIps string[]: Used for configuring advancedddosattackl4alert
targetZoneNames string[]: Used for configuring advancedddosattackl7alert
trafficExclusions string[]: Used for configuring trafficanomaliesalert
tunnelIds string[]: Used for configuring tunnelhealthevent
tunnelNames string[]: Usage depends on specific alert type
wheres string[]: Usage depends on specific alert type
zones string[]: Usage depends on specific alert type

actions Sequence[str]: Usage depends on specific alert type
affected_asns Sequence[str]: Used for configuring radar_notification
affected_components Sequence[str]: Used for configuring incident_alert
affected_locations Sequence[str]: Used for configuring radar_notification
airport_codes Sequence[str]: Used for configuring maintenanceeventnotification
alert_trigger_preferences Sequence[str]: Usage depends on specific alert type
alert_trigger_preferences_values Sequence[str]: Usage depends on specific alert type
enableds Sequence[str]: Used for configuring loadbalancingpoolenablementalert
environments Sequence[str]: Used for configuring pageseventalert
event_sources Sequence[str]: Used for configuring loadbalancinghealth_alert
event_types Sequence[str]: Usage depends on specific alert type
events Sequence[str]: Used for configuring pageseventalert
group_bies Sequence[str]: Usage depends on specific alert type
health_check_ids Sequence[str]: Used for configuring healthcheckstatus_notification
incident_impacts Sequence[str]: Used for configuring incident_alert
input_ids Sequence[str]: Used for configuring streamlivenotifications
insight_classes Sequence[str]: Used for configuring securityinsightsalert
limits Sequence[str]: Used for configuring billingusagealert
logo_tags Sequence[str]: Used for configuring logomatchalert
megabits_per_seconds Sequence[str]: Used for configuring advancedddosattackl4alert
new_healths Sequence[str]: Used for configuring loadbalancinghealth_alert
new_statuses Sequence[str]: Used for configuring tunnelhealthevent
packets_per_seconds Sequence[str]: Used for configuring advancedddosattackl4alert
pool_ids Sequence[str]: Usage depends on specific alert type
pop_names Sequence[str]: Usage depends on specific alert type
products Sequence[str]: Used for configuring billingusagealert
project_ids Sequence[str]: Used for configuring pageseventalert
protocols Sequence[str]: Used for configuring advancedddosattackl4alert
query_tags Sequence[str]: Usage depends on specific alert type
requests_per_seconds Sequence[str]: Used for configuring advancedddosattackl7alert
selectors Sequence[str]: Usage depends on specific alert type
services Sequence[str]: Used for configuring clickhousealertfwentanomaly
slos Sequence[str]: Usage depends on specific alert type
statuses Sequence[str]: Used for configuring healthcheckstatus_notification
target_hostnames Sequence[str]: Used for configuring advancedddosattackl7alert
target_ips Sequence[str]: Used for configuring advancedddosattackl4alert
target_zone_names Sequence[str]: Used for configuring advancedddosattackl7alert
traffic_exclusions Sequence[str]: Used for configuring trafficanomaliesalert
tunnel_ids Sequence[str]: Used for configuring tunnelhealthevent
tunnel_names Sequence[str]: Usage depends on specific alert type
wheres Sequence[str]: Usage depends on specific alert type
zones Sequence[str]: Usage depends on specific alert type

actions List<String>: Usage depends on specific alert type
affectedAsns List<String>: Used for configuring radar_notification
affectedComponents List<String>: Used for configuring incident_alert
affectedLocations List<String>: Used for configuring radar_notification
airportCodes List<String>: Used for configuring maintenanceeventnotification
alertTriggerPreferences List<String>: Usage depends on specific alert type
alertTriggerPreferencesValues List<String>: Usage depends on specific alert type
enableds List<String>: Used for configuring loadbalancingpoolenablementalert
environments List<String>: Used for configuring pageseventalert
eventSources List<String>: Used for configuring loadbalancinghealth_alert
eventTypes List<String>: Usage depends on specific alert type
events List<String>: Used for configuring pageseventalert
groupBies List<String>: Usage depends on specific alert type
healthCheckIds List<String>: Used for configuring healthcheckstatus_notification
incidentImpacts List<String>: Used for configuring incident_alert
inputIds List<String>: Used for configuring streamlivenotifications
insightClasses List<String>: Used for configuring securityinsightsalert
limits List<String>: Used for configuring billingusagealert
logoTags List<String>: Used for configuring logomatchalert
megabitsPerSeconds List<String>: Used for configuring advancedddosattackl4alert
newHealths List<String>: Used for configuring loadbalancinghealth_alert
newStatuses List<String>: Used for configuring tunnelhealthevent
packetsPerSeconds List<String>: Used for configuring advancedddosattackl4alert
poolIds List<String>: Usage depends on specific alert type
popNames List<String>: Usage depends on specific alert type
products List<String>: Used for configuring billingusagealert
projectIds List<String>: Used for configuring pageseventalert
protocols List<String>: Used for configuring advancedddosattackl4alert
queryTags List<String>: Usage depends on specific alert type
requestsPerSeconds List<String>: Used for configuring advancedddosattackl7alert
selectors List<String>: Usage depends on specific alert type
services List<String>: Used for configuring clickhousealertfwentanomaly
slos List<String>: Usage depends on specific alert type
statuses List<String>: Used for configuring healthcheckstatus_notification
targetHostnames List<String>: Used for configuring advancedddosattackl7alert
targetIps List<String>: Used for configuring advancedddosattackl4alert
targetZoneNames List<String>: Used for configuring advancedddosattackl7alert
trafficExclusions List<String>: Used for configuring trafficanomaliesalert
tunnelIds List<String>: Used for configuring tunnelhealthevent
tunnelNames List<String>: Usage depends on specific alert type
wheres List<String>: Usage depends on specific alert type
zones List<String>: Usage depends on specific alert type

NotificationPolicyMechanisms, NotificationPolicyMechanismsArgs

Emails List<NotificationPolicyMechanismsEmail>
Pagerduties List<NotificationPolicyMechanismsPagerduty>
Webhooks List<NotificationPolicyMechanismsWebhook>

Emails []NotificationPolicyMechanismsEmail
Pagerduties []NotificationPolicyMechanismsPagerduty
Webhooks []NotificationPolicyMechanismsWebhook

emails List<NotificationPolicyMechanismsEmail>
pagerduties List<NotificationPolicyMechanismsPagerduty>
webhooks List<NotificationPolicyMechanismsWebhook>

emails NotificationPolicyMechanismsEmail[]
pagerduties NotificationPolicyMechanismsPagerduty[]
webhooks NotificationPolicyMechanismsWebhook[]

emails Sequence[NotificationPolicyMechanismsEmail]
pagerduties Sequence[NotificationPolicyMechanismsPagerduty]
webhooks Sequence[NotificationPolicyMechanismsWebhook]

emails List<Property Map>
pagerduties List<Property Map>
webhooks List<Property Map>

NotificationPolicyMechanismsEmail, NotificationPolicyMechanismsEmailArgs

Id string: The email address

Id string: The email address

id String: The email address

id string: The email address

id str: The email address

id String: The email address

NotificationPolicyMechanismsPagerduty, NotificationPolicyMechanismsPagerdutyArgs

Id string: UUID

Id string: UUID

id String: UUID

id string: UUID

id str: UUID

id String: UUID

NotificationPolicyMechanismsWebhook, NotificationPolicyMechanismsWebhookArgs

Id string: UUID

Id string: UUID

id String: UUID

id string: UUID

id str: UUID

id String: UUID

Import

$ pulumi import cloudflare:index/notificationPolicy:NotificationPolicy example '<account_id>/<policy_id>'

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

Package Details

Repository: Cloudflare pulumi/pulumi-cloudflare
License: Apache-2.0
Notes: This Pulumi package is based on the cloudflare Terraform Provider.

Cloudflare v6.1.1 published on Monday, Apr 21, 2025 by Pulumi

pulumi/pulumi-cloudflare

cloudflare.NotificationPolicy

On this page

On this page

Example Usage

Create NotificationPolicy Resource

Constructor syntax

Parameters

Constructor example

NotificationPolicy Resource Properties

Inputs

Outputs

Look up Existing NotificationPolicy Resource

Supporting Types

NotificationPolicyFilters, NotificationPolicyFiltersArgs

NotificationPolicyMechanisms, NotificationPolicyMechanismsArgs

NotificationPolicyMechanismsEmail, NotificationPolicyMechanismsEmailArgs

NotificationPolicyMechanismsPagerduty, NotificationPolicyMechanismsPagerdutyArgs

NotificationPolicyMechanismsWebhook, NotificationPolicyMechanismsWebhookArgs

Import

Package Details

On this page

On this page