notification_integrations

Creates, updates, deletes, gets or lists a notification_integrations resource.

Overview

Name	notification_integrations
Type	Resource
Id	snowflake.notification_integration.notification_integrations

Fields

The following fields are returned by SELECT queries:

list_notification_integrations

A Snowflake notification

Name	Datatype	Description
name	string	Name of the notification. (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
comment	string	Comment for the notification integration.
created_on	string (date-time)	Date and time when the notification was created.
enabled	boolean	Whether the notification integration is enabled.
notification_hook	object

fetch_notification_integration

A Snowflake notification

Name	Datatype	Description
name	string	Name of the notification. (pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$)
comment	string	Comment for the notification integration.
created_on	string (date-time)	Date and time when the notification was created.
enabled	boolean	Whether the notification integration is enabled.
notification_hook	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_notification_integrations	select	endpoint	like	List notification integrations
fetch_notification_integration	select	name, endpoint		Fetch a notification integration
create_notification_integration	insert	endpoint	createMode	Create a notification integration
delete_notification_integration	delete	name, endpoint	ifExists	Delete a notification integration

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpoint	string	Organization and Account Name (default: orgid-acctid)
name	string	Identifier (i.e. name) for the resource.
createMode	string	Query parameter allowing support for different modes of resource creation. Possible values include: - errorIfExists: Throws an error if you try to create a resource that already exists. - orReplace: Automatically replaces the existing resource with the current one. - ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.
ifExists	boolean	Query parameter that specifies how to handle the request for a resource that does not exist: - true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. - false: The endpoint throws an error if the resource doesn't exist.
like	string	Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.

SELECT examples

list_notification_integrations

List notification integrations

SELECT
name,
comment,
created_on,
enabled,
notification_hook
FROM snowflake.notification_integration.notification_integrations
WHERE endpoint = '{{ endpoint }}' -- required
AND like = '{{ like }}';

fetch_notification_integration

Fetch a notification integration

SELECT
name,
comment,
created_on,
enabled,
notification_hook
FROM snowflake.notification_integration.notification_integrations
WHERE name = '{{ name }}' -- required
AND endpoint = '{{ endpoint }}' -- required;

INSERT examples

create_notification_integration

Create a notification integration

INSERT INTO snowflake.notification_integration.notification_integrations (
data__name,
data__enabled,
data__comment,
data__notification_hook,
endpoint,
createMode
)
SELECT 
'{{ name }}' --required,
{{ enabled }},
'{{ comment }}',
'{{ notification_hook }}' --required,
'{{ endpoint }}',
'{{ createMode }}'
;

Manifest

# Description fields are for documentation purposes
- name: notification_integrations
  props:
    - name: endpoint
      value: string
      description: Required parameter for the notification_integrations resource.
    - name: name
      value: string
      description: >
        Name of the notification.
        
    - name: enabled
      value: boolean
      description: >
        Whether the notification integration is enabled.
        
    - name: comment
      value: string
      description: >
        Comment for the notification integration.
        
    - name: notification_hook
      value: object
    - name: createMode
      value: string
      description: Query parameter allowing support for different modes of resource creation. Possible values include: - `errorIfExists`: Throws an error if you try to create a resource that already exists. - `orReplace`: Automatically replaces the existing resource with the current one. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.

DELETE examples

delete_notification_integration

Delete a notification integration

DELETE FROM snowflake.notification_integration.notification_integrations
WHERE name = '{{ name }}' --required
AND endpoint = '{{ endpoint }}' --required
AND ifExists = '{{ ifExists }}';