cloudflare.NotificationPolicy
Provides a resource, that manages a notification policy for Cloudflare’s products. The delivery mechanisms supported are email, webhooks, and PagerDuty.
Create NotificationPolicy Resource
new NotificationPolicy(name: string, args: NotificationPolicyArgs, opts?: CustomResourceOptions);
@overload
def NotificationPolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_id: Optional[str] = None,
alert_type: Optional[str] = None,
description: Optional[str] = None,
email_integrations: Optional[Sequence[NotificationPolicyEmailIntegrationArgs]] = None,
enabled: Optional[bool] = None,
filters: Optional[NotificationPolicyFiltersArgs] = None,
name: Optional[str] = None,
pagerduty_integrations: Optional[Sequence[NotificationPolicyPagerdutyIntegrationArgs]] = None,
webhooks_integrations: Optional[Sequence[NotificationPolicyWebhooksIntegrationArgs]] = None)
@overload
def NotificationPolicy(resource_name: str,
args: NotificationPolicyArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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
The NotificationPolicy resource accepts the following input properties:
- Account
Id string The account identifier to target for the resource.
- Alert
Type string The event type that will trigger the dispatch of a notification. See the developer documentation for descriptions of available alert types. Available values:
access_custom_certificate_expiration_type
,advanced_ddos_attack_l4_alert
,advanced_ddos_attack_l7_alert
,bgp_hijack_notification
,billing_usage_alert
,block_notification_block_removed
,block_notification_new_block
,block_notification_review_rejected
,clickhouse_alert_fw_anomaly
,clickhouse_alert_fw_ent_anomaly
,custom_ssl_certificate_event_type
,dedicated_ssl_certificate_event_type
,dos_attack_l4
,dos_attack_l7
,expiring_service_token_alert
,failing_logpush_job_disabled_alert
,fbm_auto_advertisement
,fbm_dosd_attack
,fbm_volumetric_attack
,health_check_status_notification
,hostname_aop_custom_certificate_expiration_type
,http_alert_edge_error
,http_alert_origin_error
,load_balancing_health_alert
,load_balancing_pool_enablement_alert
,real_origin_monitoring
,scriptmonitor_alert_new_code_change_detections
,scriptmonitor_alert_new_hosts
,scriptmonitor_alert_new_malicious_hosts
,scriptmonitor_alert_new_malicious_scripts
,scriptmonitor_alert_new_malicious_url
,scriptmonitor_alert_new_max_length_resource_url
,scriptmonitor_alert_new_resources
,secondary_dns_all_primaries_failing
,secondary_dns_primaries_failing
,secondary_dns_zone_successfully_updated
,secondary_dns_zone_validation_warning
,sentinel_alert
,stream_live_notifications
,tunnel_health_event
,tunnel_update_event
,universal_ssl_event_type
,web_analytics_metrics_update
,weekly_account_overview
,workers_alert
,zone_aop_custom_certificate_expiration_type
.- Enabled bool
The status of the notification policy.
- Name string
The name of the notification policy.
- Description string
Description of the notification policy.
- Email
Integrations List<NotificationPolicy Email Integration Args> The email id to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- Filters
Notification
Policy Filters Args An optional nested block of filters that applies to the selected
alert_type
. A key-value map that specifies the type of filter and the values to match against (refer to the alert type block for available fields).- Pagerduty
Integrations List<NotificationPolicy Pagerduty Integration Args> The unique id of a configured pagerduty endpoint to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- Webhooks
Integrations List<NotificationPolicy Webhooks Integration Args> The unique id of a configured webhooks endpoint to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- Account
Id string The account identifier to target for the resource.
- Alert
Type string The event type that will trigger the dispatch of a notification. See the developer documentation for descriptions of available alert types. Available values:
access_custom_certificate_expiration_type
,advanced_ddos_attack_l4_alert
,advanced_ddos_attack_l7_alert
,bgp_hijack_notification
,billing_usage_alert
,block_notification_block_removed
,block_notification_new_block
,block_notification_review_rejected
,clickhouse_alert_fw_anomaly
,clickhouse_alert_fw_ent_anomaly
,custom_ssl_certificate_event_type
,dedicated_ssl_certificate_event_type
,dos_attack_l4
,dos_attack_l7
,expiring_service_token_alert
,failing_logpush_job_disabled_alert
,fbm_auto_advertisement
,fbm_dosd_attack
,fbm_volumetric_attack
,health_check_status_notification
,hostname_aop_custom_certificate_expiration_type
,http_alert_edge_error
,http_alert_origin_error
,load_balancing_health_alert
,load_balancing_pool_enablement_alert
,real_origin_monitoring
,scriptmonitor_alert_new_code_change_detections
,scriptmonitor_alert_new_hosts
,scriptmonitor_alert_new_malicious_hosts
,scriptmonitor_alert_new_malicious_scripts
,scriptmonitor_alert_new_malicious_url
,scriptmonitor_alert_new_max_length_resource_url
,scriptmonitor_alert_new_resources
,secondary_dns_all_primaries_failing
,secondary_dns_primaries_failing
,secondary_dns_zone_successfully_updated
,secondary_dns_zone_validation_warning
,sentinel_alert
,stream_live_notifications
,tunnel_health_event
,tunnel_update_event
,universal_ssl_event_type
,web_analytics_metrics_update
,weekly_account_overview
,workers_alert
,zone_aop_custom_certificate_expiration_type
.- Enabled bool
The status of the notification policy.
- Name string
The name of the notification policy.
- Description string
Description of the notification policy.
- Email
Integrations []NotificationPolicy Email Integration Args The email id to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- Filters
Notification
Policy Filters Args An optional nested block of filters that applies to the selected
alert_type
. A key-value map that specifies the type of filter and the values to match against (refer to the alert type block for available fields).- Pagerduty
Integrations []NotificationPolicy Pagerduty Integration Args The unique id of a configured pagerduty endpoint to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- Webhooks
Integrations []NotificationPolicy Webhooks Integration Args The unique id of a configured webhooks endpoint to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- account
Id String The account identifier to target for the resource.
- alert
Type String The event type that will trigger the dispatch of a notification. See the developer documentation for descriptions of available alert types. Available values:
access_custom_certificate_expiration_type
,advanced_ddos_attack_l4_alert
,advanced_ddos_attack_l7_alert
,bgp_hijack_notification
,billing_usage_alert
,block_notification_block_removed
,block_notification_new_block
,block_notification_review_rejected
,clickhouse_alert_fw_anomaly
,clickhouse_alert_fw_ent_anomaly
,custom_ssl_certificate_event_type
,dedicated_ssl_certificate_event_type
,dos_attack_l4
,dos_attack_l7
,expiring_service_token_alert
,failing_logpush_job_disabled_alert
,fbm_auto_advertisement
,fbm_dosd_attack
,fbm_volumetric_attack
,health_check_status_notification
,hostname_aop_custom_certificate_expiration_type
,http_alert_edge_error
,http_alert_origin_error
,load_balancing_health_alert
,load_balancing_pool_enablement_alert
,real_origin_monitoring
,scriptmonitor_alert_new_code_change_detections
,scriptmonitor_alert_new_hosts
,scriptmonitor_alert_new_malicious_hosts
,scriptmonitor_alert_new_malicious_scripts
,scriptmonitor_alert_new_malicious_url
,scriptmonitor_alert_new_max_length_resource_url
,scriptmonitor_alert_new_resources
,secondary_dns_all_primaries_failing
,secondary_dns_primaries_failing
,secondary_dns_zone_successfully_updated
,secondary_dns_zone_validation_warning
,sentinel_alert
,stream_live_notifications
,tunnel_health_event
,tunnel_update_event
,universal_ssl_event_type
,web_analytics_metrics_update
,weekly_account_overview
,workers_alert
,zone_aop_custom_certificate_expiration_type
.- enabled Boolean
The status of the notification policy.
- name String
The name of the notification policy.
- description String
Description of the notification policy.
- email
Integrations List<NotificationPolicy Email Integration Args> The email id to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- filters
Notification
Policy Filters Args An optional nested block of filters that applies to the selected
alert_type
. A key-value map that specifies the type of filter and the values to match against (refer to the alert type block for available fields).- pagerduty
Integrations List<NotificationPolicy Pagerduty Integration Args> The unique id of a configured pagerduty endpoint to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- webhooks
Integrations List<NotificationPolicy Webhooks Integration Args> The unique id of a configured webhooks endpoint to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- account
Id string The account identifier to target for the resource.
- alert
Type string The event type that will trigger the dispatch of a notification. See the developer documentation for descriptions of available alert types. Available values:
access_custom_certificate_expiration_type
,advanced_ddos_attack_l4_alert
,advanced_ddos_attack_l7_alert
,bgp_hijack_notification
,billing_usage_alert
,block_notification_block_removed
,block_notification_new_block
,block_notification_review_rejected
,clickhouse_alert_fw_anomaly
,clickhouse_alert_fw_ent_anomaly
,custom_ssl_certificate_event_type
,dedicated_ssl_certificate_event_type
,dos_attack_l4
,dos_attack_l7
,expiring_service_token_alert
,failing_logpush_job_disabled_alert
,fbm_auto_advertisement
,fbm_dosd_attack
,fbm_volumetric_attack
,health_check_status_notification
,hostname_aop_custom_certificate_expiration_type
,http_alert_edge_error
,http_alert_origin_error
,load_balancing_health_alert
,load_balancing_pool_enablement_alert
,real_origin_monitoring
,scriptmonitor_alert_new_code_change_detections
,scriptmonitor_alert_new_hosts
,scriptmonitor_alert_new_malicious_hosts
,scriptmonitor_alert_new_malicious_scripts
,scriptmonitor_alert_new_malicious_url
,scriptmonitor_alert_new_max_length_resource_url
,scriptmonitor_alert_new_resources
,secondary_dns_all_primaries_failing
,secondary_dns_primaries_failing
,secondary_dns_zone_successfully_updated
,secondary_dns_zone_validation_warning
,sentinel_alert
,stream_live_notifications
,tunnel_health_event
,tunnel_update_event
,universal_ssl_event_type
,web_analytics_metrics_update
,weekly_account_overview
,workers_alert
,zone_aop_custom_certificate_expiration_type
.- enabled boolean
The status of the notification policy.
- name string
The name of the notification policy.
- description string
Description of the notification policy.
- email
Integrations NotificationPolicy Email Integration Args[] The email id to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- filters
Notification
Policy Filters Args An optional nested block of filters that applies to the selected
alert_type
. A key-value map that specifies the type of filter and the values to match against (refer to the alert type block for available fields).- pagerduty
Integrations NotificationPolicy Pagerduty Integration Args[] The unique id of a configured pagerduty endpoint to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- webhooks
Integrations NotificationPolicy Webhooks Integration Args[] The unique id of a configured webhooks endpoint to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- account_
id str The account identifier to target for the resource.
- alert_
type str The event type that will trigger the dispatch of a notification. See the developer documentation for descriptions of available alert types. Available values:
access_custom_certificate_expiration_type
,advanced_ddos_attack_l4_alert
,advanced_ddos_attack_l7_alert
,bgp_hijack_notification
,billing_usage_alert
,block_notification_block_removed
,block_notification_new_block
,block_notification_review_rejected
,clickhouse_alert_fw_anomaly
,clickhouse_alert_fw_ent_anomaly
,custom_ssl_certificate_event_type
,dedicated_ssl_certificate_event_type
,dos_attack_l4
,dos_attack_l7
,expiring_service_token_alert
,failing_logpush_job_disabled_alert
,fbm_auto_advertisement
,fbm_dosd_attack
,fbm_volumetric_attack
,health_check_status_notification
,hostname_aop_custom_certificate_expiration_type
,http_alert_edge_error
,http_alert_origin_error
,load_balancing_health_alert
,load_balancing_pool_enablement_alert
,real_origin_monitoring
,scriptmonitor_alert_new_code_change_detections
,scriptmonitor_alert_new_hosts
,scriptmonitor_alert_new_malicious_hosts
,scriptmonitor_alert_new_malicious_scripts
,scriptmonitor_alert_new_malicious_url
,scriptmonitor_alert_new_max_length_resource_url
,scriptmonitor_alert_new_resources
,secondary_dns_all_primaries_failing
,secondary_dns_primaries_failing
,secondary_dns_zone_successfully_updated
,secondary_dns_zone_validation_warning
,sentinel_alert
,stream_live_notifications
,tunnel_health_event
,tunnel_update_event
,universal_ssl_event_type
,web_analytics_metrics_update
,weekly_account_overview
,workers_alert
,zone_aop_custom_certificate_expiration_type
.- enabled bool
The status of the notification policy.
- name str
The name of the notification policy.
- description str
Description of the notification policy.
- email_
integrations Sequence[NotificationPolicy Email Integration Args] The email id to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- filters
Notification
Policy Filters Args An optional nested block of filters that applies to the selected
alert_type
. A key-value map that specifies the type of filter and the values to match against (refer to the alert type block for available fields).- pagerduty_
integrations Sequence[NotificationPolicy Pagerduty Integration Args] The unique id of a configured pagerduty endpoint to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- webhooks_
integrations Sequence[NotificationPolicy Webhooks Integration Args] The unique id of a configured webhooks endpoint to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- account
Id String The account identifier to target for the resource.
- alert
Type String The event type that will trigger the dispatch of a notification. See the developer documentation for descriptions of available alert types. Available values:
access_custom_certificate_expiration_type
,advanced_ddos_attack_l4_alert
,advanced_ddos_attack_l7_alert
,bgp_hijack_notification
,billing_usage_alert
,block_notification_block_removed
,block_notification_new_block
,block_notification_review_rejected
,clickhouse_alert_fw_anomaly
,clickhouse_alert_fw_ent_anomaly
,custom_ssl_certificate_event_type
,dedicated_ssl_certificate_event_type
,dos_attack_l4
,dos_attack_l7
,expiring_service_token_alert
,failing_logpush_job_disabled_alert
,fbm_auto_advertisement
,fbm_dosd_attack
,fbm_volumetric_attack
,health_check_status_notification
,hostname_aop_custom_certificate_expiration_type
,http_alert_edge_error
,http_alert_origin_error
,load_balancing_health_alert
,load_balancing_pool_enablement_alert
,real_origin_monitoring
,scriptmonitor_alert_new_code_change_detections
,scriptmonitor_alert_new_hosts
,scriptmonitor_alert_new_malicious_hosts
,scriptmonitor_alert_new_malicious_scripts
,scriptmonitor_alert_new_malicious_url
,scriptmonitor_alert_new_max_length_resource_url
,scriptmonitor_alert_new_resources
,secondary_dns_all_primaries_failing
,secondary_dns_primaries_failing
,secondary_dns_zone_successfully_updated
,secondary_dns_zone_validation_warning
,sentinel_alert
,stream_live_notifications
,tunnel_health_event
,tunnel_update_event
,universal_ssl_event_type
,web_analytics_metrics_update
,weekly_account_overview
,workers_alert
,zone_aop_custom_certificate_expiration_type
.- enabled Boolean
The status of the notification policy.
- name String
The name of the notification policy.
- description String
Description of the notification policy.
- email
Integrations List<Property Map> The email id to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- filters Property Map
An optional nested block of filters that applies to the selected
alert_type
. A key-value map that specifies the type of filter and the values to match against (refer to the alert type block for available fields).- pagerduty
Integrations List<Property Map> The unique id of a configured pagerduty endpoint to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- webhooks
Integrations List<Property Map> The unique id of a configured webhooks endpoint to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
Outputs
All input properties are implicitly available as output properties. Additionally, the NotificationPolicy resource produces the following output properties:
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_type: Optional[str] = None,
created: Optional[str] = None,
description: Optional[str] = None,
email_integrations: Optional[Sequence[NotificationPolicyEmailIntegrationArgs]] = None,
enabled: Optional[bool] = None,
filters: Optional[NotificationPolicyFiltersArgs] = None,
modified: Optional[str] = None,
name: Optional[str] = None,
pagerduty_integrations: Optional[Sequence[NotificationPolicyPagerdutyIntegrationArgs]] = None,
webhooks_integrations: Optional[Sequence[NotificationPolicyWebhooksIntegrationArgs]] = 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)
Resource lookup is not supported in YAML
- 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.
- Account
Id string The account identifier to target for the resource.
- Alert
Type string The event type that will trigger the dispatch of a notification. See the developer documentation for descriptions of available alert types. Available values:
access_custom_certificate_expiration_type
,advanced_ddos_attack_l4_alert
,advanced_ddos_attack_l7_alert
,bgp_hijack_notification
,billing_usage_alert
,block_notification_block_removed
,block_notification_new_block
,block_notification_review_rejected
,clickhouse_alert_fw_anomaly
,clickhouse_alert_fw_ent_anomaly
,custom_ssl_certificate_event_type
,dedicated_ssl_certificate_event_type
,dos_attack_l4
,dos_attack_l7
,expiring_service_token_alert
,failing_logpush_job_disabled_alert
,fbm_auto_advertisement
,fbm_dosd_attack
,fbm_volumetric_attack
,health_check_status_notification
,hostname_aop_custom_certificate_expiration_type
,http_alert_edge_error
,http_alert_origin_error
,load_balancing_health_alert
,load_balancing_pool_enablement_alert
,real_origin_monitoring
,scriptmonitor_alert_new_code_change_detections
,scriptmonitor_alert_new_hosts
,scriptmonitor_alert_new_malicious_hosts
,scriptmonitor_alert_new_malicious_scripts
,scriptmonitor_alert_new_malicious_url
,scriptmonitor_alert_new_max_length_resource_url
,scriptmonitor_alert_new_resources
,secondary_dns_all_primaries_failing
,secondary_dns_primaries_failing
,secondary_dns_zone_successfully_updated
,secondary_dns_zone_validation_warning
,sentinel_alert
,stream_live_notifications
,tunnel_health_event
,tunnel_update_event
,universal_ssl_event_type
,web_analytics_metrics_update
,weekly_account_overview
,workers_alert
,zone_aop_custom_certificate_expiration_type
.- Created string
When the notification policy was created.
- Description string
Description of the notification policy.
- Email
Integrations List<NotificationPolicy Email Integration Args> The email id to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- Enabled bool
The status of the notification policy.
- Filters
Notification
Policy Filters Args An optional nested block of filters that applies to the selected
alert_type
. A key-value map that specifies the type of filter and the values to match against (refer to the alert type block for available fields).- Modified string
When the notification policy was last modified.
- Name string
The name of the notification policy.
- Pagerduty
Integrations List<NotificationPolicy Pagerduty Integration Args> The unique id of a configured pagerduty endpoint to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- Webhooks
Integrations List<NotificationPolicy Webhooks Integration Args> The unique id of a configured webhooks endpoint to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- Account
Id string The account identifier to target for the resource.
- Alert
Type string The event type that will trigger the dispatch of a notification. See the developer documentation for descriptions of available alert types. Available values:
access_custom_certificate_expiration_type
,advanced_ddos_attack_l4_alert
,advanced_ddos_attack_l7_alert
,bgp_hijack_notification
,billing_usage_alert
,block_notification_block_removed
,block_notification_new_block
,block_notification_review_rejected
,clickhouse_alert_fw_anomaly
,clickhouse_alert_fw_ent_anomaly
,custom_ssl_certificate_event_type
,dedicated_ssl_certificate_event_type
,dos_attack_l4
,dos_attack_l7
,expiring_service_token_alert
,failing_logpush_job_disabled_alert
,fbm_auto_advertisement
,fbm_dosd_attack
,fbm_volumetric_attack
,health_check_status_notification
,hostname_aop_custom_certificate_expiration_type
,http_alert_edge_error
,http_alert_origin_error
,load_balancing_health_alert
,load_balancing_pool_enablement_alert
,real_origin_monitoring
,scriptmonitor_alert_new_code_change_detections
,scriptmonitor_alert_new_hosts
,scriptmonitor_alert_new_malicious_hosts
,scriptmonitor_alert_new_malicious_scripts
,scriptmonitor_alert_new_malicious_url
,scriptmonitor_alert_new_max_length_resource_url
,scriptmonitor_alert_new_resources
,secondary_dns_all_primaries_failing
,secondary_dns_primaries_failing
,secondary_dns_zone_successfully_updated
,secondary_dns_zone_validation_warning
,sentinel_alert
,stream_live_notifications
,tunnel_health_event
,tunnel_update_event
,universal_ssl_event_type
,web_analytics_metrics_update
,weekly_account_overview
,workers_alert
,zone_aop_custom_certificate_expiration_type
.- Created string
When the notification policy was created.
- Description string
Description of the notification policy.
- Email
Integrations []NotificationPolicy Email Integration Args The email id to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- Enabled bool
The status of the notification policy.
- Filters
Notification
Policy Filters Args An optional nested block of filters that applies to the selected
alert_type
. A key-value map that specifies the type of filter and the values to match against (refer to the alert type block for available fields).- Modified string
When the notification policy was last modified.
- Name string
The name of the notification policy.
- Pagerduty
Integrations []NotificationPolicy Pagerduty Integration Args The unique id of a configured pagerduty endpoint to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- Webhooks
Integrations []NotificationPolicy Webhooks Integration Args The unique id of a configured webhooks endpoint to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- account
Id String The account identifier to target for the resource.
- alert
Type String The event type that will trigger the dispatch of a notification. See the developer documentation for descriptions of available alert types. Available values:
access_custom_certificate_expiration_type
,advanced_ddos_attack_l4_alert
,advanced_ddos_attack_l7_alert
,bgp_hijack_notification
,billing_usage_alert
,block_notification_block_removed
,block_notification_new_block
,block_notification_review_rejected
,clickhouse_alert_fw_anomaly
,clickhouse_alert_fw_ent_anomaly
,custom_ssl_certificate_event_type
,dedicated_ssl_certificate_event_type
,dos_attack_l4
,dos_attack_l7
,expiring_service_token_alert
,failing_logpush_job_disabled_alert
,fbm_auto_advertisement
,fbm_dosd_attack
,fbm_volumetric_attack
,health_check_status_notification
,hostname_aop_custom_certificate_expiration_type
,http_alert_edge_error
,http_alert_origin_error
,load_balancing_health_alert
,load_balancing_pool_enablement_alert
,real_origin_monitoring
,scriptmonitor_alert_new_code_change_detections
,scriptmonitor_alert_new_hosts
,scriptmonitor_alert_new_malicious_hosts
,scriptmonitor_alert_new_malicious_scripts
,scriptmonitor_alert_new_malicious_url
,scriptmonitor_alert_new_max_length_resource_url
,scriptmonitor_alert_new_resources
,secondary_dns_all_primaries_failing
,secondary_dns_primaries_failing
,secondary_dns_zone_successfully_updated
,secondary_dns_zone_validation_warning
,sentinel_alert
,stream_live_notifications
,tunnel_health_event
,tunnel_update_event
,universal_ssl_event_type
,web_analytics_metrics_update
,weekly_account_overview
,workers_alert
,zone_aop_custom_certificate_expiration_type
.- created String
When the notification policy was created.
- description String
Description of the notification policy.
- email
Integrations List<NotificationPolicy Email Integration Args> The email id to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- enabled Boolean
The status of the notification policy.
- filters
Notification
Policy Filters Args An optional nested block of filters that applies to the selected
alert_type
. A key-value map that specifies the type of filter and the values to match against (refer to the alert type block for available fields).- modified String
When the notification policy was last modified.
- name String
The name of the notification policy.
- pagerduty
Integrations List<NotificationPolicy Pagerduty Integration Args> The unique id of a configured pagerduty endpoint to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- webhooks
Integrations List<NotificationPolicy Webhooks Integration Args> The unique id of a configured webhooks endpoint to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- account
Id string The account identifier to target for the resource.
- alert
Type string The event type that will trigger the dispatch of a notification. See the developer documentation for descriptions of available alert types. Available values:
access_custom_certificate_expiration_type
,advanced_ddos_attack_l4_alert
,advanced_ddos_attack_l7_alert
,bgp_hijack_notification
,billing_usage_alert
,block_notification_block_removed
,block_notification_new_block
,block_notification_review_rejected
,clickhouse_alert_fw_anomaly
,clickhouse_alert_fw_ent_anomaly
,custom_ssl_certificate_event_type
,dedicated_ssl_certificate_event_type
,dos_attack_l4
,dos_attack_l7
,expiring_service_token_alert
,failing_logpush_job_disabled_alert
,fbm_auto_advertisement
,fbm_dosd_attack
,fbm_volumetric_attack
,health_check_status_notification
,hostname_aop_custom_certificate_expiration_type
,http_alert_edge_error
,http_alert_origin_error
,load_balancing_health_alert
,load_balancing_pool_enablement_alert
,real_origin_monitoring
,scriptmonitor_alert_new_code_change_detections
,scriptmonitor_alert_new_hosts
,scriptmonitor_alert_new_malicious_hosts
,scriptmonitor_alert_new_malicious_scripts
,scriptmonitor_alert_new_malicious_url
,scriptmonitor_alert_new_max_length_resource_url
,scriptmonitor_alert_new_resources
,secondary_dns_all_primaries_failing
,secondary_dns_primaries_failing
,secondary_dns_zone_successfully_updated
,secondary_dns_zone_validation_warning
,sentinel_alert
,stream_live_notifications
,tunnel_health_event
,tunnel_update_event
,universal_ssl_event_type
,web_analytics_metrics_update
,weekly_account_overview
,workers_alert
,zone_aop_custom_certificate_expiration_type
.- created string
When the notification policy was created.
- description string
Description of the notification policy.
- email
Integrations NotificationPolicy Email Integration Args[] The email id to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- enabled boolean
The status of the notification policy.
- filters
Notification
Policy Filters Args An optional nested block of filters that applies to the selected
alert_type
. A key-value map that specifies the type of filter and the values to match against (refer to the alert type block for available fields).- modified string
When the notification policy was last modified.
- name string
The name of the notification policy.
- pagerduty
Integrations NotificationPolicy Pagerduty Integration Args[] The unique id of a configured pagerduty endpoint to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- webhooks
Integrations NotificationPolicy Webhooks Integration Args[] The unique id of a configured webhooks endpoint to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- account_
id str The account identifier to target for the resource.
- alert_
type str The event type that will trigger the dispatch of a notification. See the developer documentation for descriptions of available alert types. Available values:
access_custom_certificate_expiration_type
,advanced_ddos_attack_l4_alert
,advanced_ddos_attack_l7_alert
,bgp_hijack_notification
,billing_usage_alert
,block_notification_block_removed
,block_notification_new_block
,block_notification_review_rejected
,clickhouse_alert_fw_anomaly
,clickhouse_alert_fw_ent_anomaly
,custom_ssl_certificate_event_type
,dedicated_ssl_certificate_event_type
,dos_attack_l4
,dos_attack_l7
,expiring_service_token_alert
,failing_logpush_job_disabled_alert
,fbm_auto_advertisement
,fbm_dosd_attack
,fbm_volumetric_attack
,health_check_status_notification
,hostname_aop_custom_certificate_expiration_type
,http_alert_edge_error
,http_alert_origin_error
,load_balancing_health_alert
,load_balancing_pool_enablement_alert
,real_origin_monitoring
,scriptmonitor_alert_new_code_change_detections
,scriptmonitor_alert_new_hosts
,scriptmonitor_alert_new_malicious_hosts
,scriptmonitor_alert_new_malicious_scripts
,scriptmonitor_alert_new_malicious_url
,scriptmonitor_alert_new_max_length_resource_url
,scriptmonitor_alert_new_resources
,secondary_dns_all_primaries_failing
,secondary_dns_primaries_failing
,secondary_dns_zone_successfully_updated
,secondary_dns_zone_validation_warning
,sentinel_alert
,stream_live_notifications
,tunnel_health_event
,tunnel_update_event
,universal_ssl_event_type
,web_analytics_metrics_update
,weekly_account_overview
,workers_alert
,zone_aop_custom_certificate_expiration_type
.- created str
When the notification policy was created.
- description str
Description of the notification policy.
- email_
integrations Sequence[NotificationPolicy Email Integration Args] The email id to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- enabled bool
The status of the notification policy.
- filters
Notification
Policy Filters Args An optional nested block of filters that applies to the selected
alert_type
. A key-value map that specifies the type of filter and the values to match against (refer to the alert type block for available fields).- modified str
When the notification policy was last modified.
- name str
The name of the notification policy.
- pagerduty_
integrations Sequence[NotificationPolicy Pagerduty Integration Args] The unique id of a configured pagerduty endpoint to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- webhooks_
integrations Sequence[NotificationPolicy Webhooks Integration Args] The unique id of a configured webhooks endpoint to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- account
Id String The account identifier to target for the resource.
- alert
Type String The event type that will trigger the dispatch of a notification. See the developer documentation for descriptions of available alert types. Available values:
access_custom_certificate_expiration_type
,advanced_ddos_attack_l4_alert
,advanced_ddos_attack_l7_alert
,bgp_hijack_notification
,billing_usage_alert
,block_notification_block_removed
,block_notification_new_block
,block_notification_review_rejected
,clickhouse_alert_fw_anomaly
,clickhouse_alert_fw_ent_anomaly
,custom_ssl_certificate_event_type
,dedicated_ssl_certificate_event_type
,dos_attack_l4
,dos_attack_l7
,expiring_service_token_alert
,failing_logpush_job_disabled_alert
,fbm_auto_advertisement
,fbm_dosd_attack
,fbm_volumetric_attack
,health_check_status_notification
,hostname_aop_custom_certificate_expiration_type
,http_alert_edge_error
,http_alert_origin_error
,load_balancing_health_alert
,load_balancing_pool_enablement_alert
,real_origin_monitoring
,scriptmonitor_alert_new_code_change_detections
,scriptmonitor_alert_new_hosts
,scriptmonitor_alert_new_malicious_hosts
,scriptmonitor_alert_new_malicious_scripts
,scriptmonitor_alert_new_malicious_url
,scriptmonitor_alert_new_max_length_resource_url
,scriptmonitor_alert_new_resources
,secondary_dns_all_primaries_failing
,secondary_dns_primaries_failing
,secondary_dns_zone_successfully_updated
,secondary_dns_zone_validation_warning
,sentinel_alert
,stream_live_notifications
,tunnel_health_event
,tunnel_update_event
,universal_ssl_event_type
,web_analytics_metrics_update
,weekly_account_overview
,workers_alert
,zone_aop_custom_certificate_expiration_type
.- created String
When the notification policy was created.
- description String
Description of the notification policy.
- email
Integrations List<Property Map> The email id to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- enabled Boolean
The status of the notification policy.
- filters Property Map
An optional nested block of filters that applies to the selected
alert_type
. A key-value map that specifies the type of filter and the values to match against (refer to the alert type block for available fields).- modified String
When the notification policy was last modified.
- name String
The name of the notification policy.
- pagerduty
Integrations List<Property Map> The unique id of a configured pagerduty endpoint to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
- webhooks
Integrations List<Property Map> The unique id of a configured webhooks endpoint to which the notification should be dispatched. One of email, webhooks, or PagerDuty mechanisms is required.
Supporting Types
NotificationPolicyEmailIntegration
NotificationPolicyFilters
- Enableds List<string>
State of the pool to alert on.
- Event
Sources List<string> Source configuration to alert on for pool or origin.
- Event
Types List<string> Stream event type to alert on.
- Health
Check List<string>Ids Identifier health check. Required when using
filters.0.status
.- Input
Ids List<string> Stream input id to alert on.
- Limits List<string>
A numerical limit. Example:
100
.- New
Healths List<string> Health status to alert on for pool or origin.
- Packets
Per List<string>Seconds Packets per second threshold for dos alert.
- Pool
Ids List<string> Load balancer pool identifier.
- Products List<string>
Product name. Available values:
worker_requests
,worker_durable_objects_requests
,worker_durable_objects_duration
,worker_durable_objects_data_transfer
,worker_durable_objects_stored_data
,worker_durable_objects_storage_deletes
,worker_durable_objects_storage_writes
,worker_durable_objects_storage_reads
.- Protocols List<string>
Protocol to alert on for dos.
- Requests
Per List<string>Seconds Requests per second threshold for dos alert.
- Services List<string>
- Slos List<string>
A numerical limit. Example:
99.9
.- Statuses List<string>
Status to alert on.
- Target
Hosts List<string> Target host to alert on for dos.
- Target
Zone List<string>Names Target domain to alert on.
- Zones List<string>
A list of zone identifiers.
- Enableds []string
State of the pool to alert on.
- Event
Sources []string Source configuration to alert on for pool or origin.
- Event
Types []string Stream event type to alert on.
- Health
Check []stringIds Identifier health check. Required when using
filters.0.status
.- Input
Ids []string Stream input id to alert on.
- Limits []string
A numerical limit. Example:
100
.- New
Healths []string Health status to alert on for pool or origin.
- Packets
Per []stringSeconds Packets per second threshold for dos alert.
- Pool
Ids []string Load balancer pool identifier.
- Products []string
Product name. Available values:
worker_requests
,worker_durable_objects_requests
,worker_durable_objects_duration
,worker_durable_objects_data_transfer
,worker_durable_objects_stored_data
,worker_durable_objects_storage_deletes
,worker_durable_objects_storage_writes
,worker_durable_objects_storage_reads
.- Protocols []string
Protocol to alert on for dos.
- Requests
Per []stringSeconds Requests per second threshold for dos alert.
- Services []string
- Slos []string
A numerical limit. Example:
99.9
.- Statuses []string
Status to alert on.
- Target
Hosts []string Target host to alert on for dos.
- Target
Zone []stringNames Target domain to alert on.
- Zones []string
A list of zone identifiers.
- enableds List<String>
State of the pool to alert on.
- event
Sources List<String> Source configuration to alert on for pool or origin.
- event
Types List<String> Stream event type to alert on.
- health
Check List<String>Ids Identifier health check. Required when using
filters.0.status
.- input
Ids List<String> Stream input id to alert on.
- limits List<String>
A numerical limit. Example:
100
.- new
Healths List<String> Health status to alert on for pool or origin.
- packets
Per List<String>Seconds Packets per second threshold for dos alert.
- pool
Ids List<String> Load balancer pool identifier.
- products List<String>
Product name. Available values:
worker_requests
,worker_durable_objects_requests
,worker_durable_objects_duration
,worker_durable_objects_data_transfer
,worker_durable_objects_stored_data
,worker_durable_objects_storage_deletes
,worker_durable_objects_storage_writes
,worker_durable_objects_storage_reads
.- protocols List<String>
Protocol to alert on for dos.
- requests
Per List<String>Seconds Requests per second threshold for dos alert.
- services List<String>
- slos List<String>
A numerical limit. Example:
99.9
.- statuses List<String>
Status to alert on.
- target
Hosts List<String> Target host to alert on for dos.
- target
Zone List<String>Names Target domain to alert on.
- zones List<String>
A list of zone identifiers.
- enableds string[]
State of the pool to alert on.
- event
Sources string[] Source configuration to alert on for pool or origin.
- event
Types string[] Stream event type to alert on.
- health
Check string[]Ids Identifier health check. Required when using
filters.0.status
.- input
Ids string[] Stream input id to alert on.
- limits string[]
A numerical limit. Example:
100
.- new
Healths string[] Health status to alert on for pool or origin.
- packets
Per string[]Seconds Packets per second threshold for dos alert.
- pool
Ids string[] Load balancer pool identifier.
- products string[]
Product name. Available values:
worker_requests
,worker_durable_objects_requests
,worker_durable_objects_duration
,worker_durable_objects_data_transfer
,worker_durable_objects_stored_data
,worker_durable_objects_storage_deletes
,worker_durable_objects_storage_writes
,worker_durable_objects_storage_reads
.- protocols string[]
Protocol to alert on for dos.
- requests
Per string[]Seconds Requests per second threshold for dos alert.
- services string[]
- slos string[]
A numerical limit. Example:
99.9
.- statuses string[]
Status to alert on.
- target
Hosts string[] Target host to alert on for dos.
- target
Zone string[]Names Target domain to alert on.
- zones string[]
A list of zone identifiers.
- enableds Sequence[str]
State of the pool to alert on.
- event_
sources Sequence[str] Source configuration to alert on for pool or origin.
- event_
types Sequence[str] Stream event type to alert on.
- health_
check_ Sequence[str]ids Identifier health check. Required when using
filters.0.status
.- input_
ids Sequence[str] Stream input id to alert on.
- limits Sequence[str]
A numerical limit. Example:
100
.- new_
healths Sequence[str] Health status to alert on for pool or origin.
- packets_
per_ Sequence[str]seconds Packets per second threshold for dos alert.
- pool_
ids Sequence[str] Load balancer pool identifier.
- products Sequence[str]
Product name. Available values:
worker_requests
,worker_durable_objects_requests
,worker_durable_objects_duration
,worker_durable_objects_data_transfer
,worker_durable_objects_stored_data
,worker_durable_objects_storage_deletes
,worker_durable_objects_storage_writes
,worker_durable_objects_storage_reads
.- protocols Sequence[str]
Protocol to alert on for dos.
- requests_
per_ Sequence[str]seconds Requests per second threshold for dos alert.
- services Sequence[str]
- slos Sequence[str]
A numerical limit. Example:
99.9
.- statuses Sequence[str]
Status to alert on.
- target_
hosts Sequence[str] Target host to alert on for dos.
- target_
zone_ Sequence[str]names Target domain to alert on.
- zones Sequence[str]
A list of zone identifiers.
- enableds List<String>
State of the pool to alert on.
- event
Sources List<String> Source configuration to alert on for pool or origin.
- event
Types List<String> Stream event type to alert on.
- health
Check List<String>Ids Identifier health check. Required when using
filters.0.status
.- input
Ids List<String> Stream input id to alert on.
- limits List<String>
A numerical limit. Example:
100
.- new
Healths List<String> Health status to alert on for pool or origin.
- packets
Per List<String>Seconds Packets per second threshold for dos alert.
- pool
Ids List<String> Load balancer pool identifier.
- products List<String>
Product name. Available values:
worker_requests
,worker_durable_objects_requests
,worker_durable_objects_duration
,worker_durable_objects_data_transfer
,worker_durable_objects_stored_data
,worker_durable_objects_storage_deletes
,worker_durable_objects_storage_writes
,worker_durable_objects_storage_reads
.- protocols List<String>
Protocol to alert on for dos.
- requests
Per List<String>Seconds Requests per second threshold for dos alert.
- services List<String>
- slos List<String>
A numerical limit. Example:
99.9
.- statuses List<String>
Status to alert on.
- target
Hosts List<String> Target host to alert on for dos.
- target
Zone List<String>Names Target domain to alert on.
- zones List<String>
A list of zone identifiers.
NotificationPolicyPagerdutyIntegration
NotificationPolicyWebhooksIntegration
Import
$ pulumi import cloudflare:index/notificationPolicy:NotificationPolicy example <account_id>/<policy_id>
Package Details
- Repository
- Cloudflare pulumi/pulumi-cloudflare
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
cloudflare
Terraform Provider.