Get a detailed overview of this resourceList the top 5 use cases for this resourceBuild a program using gcp.monitoring.NotificationChannelRepositoryGoogle Cloud (GCP) Classic pulumi/pulumi-gcpLicenseApache-2.0NotesThis Pulumi package is based on the google-beta Terraform Provider.

Google Cloud v9.26.0, Jun 9 26

Viewing docs for Google Cloud v9.26.0

published on Tuesday, Jun 9, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-gcp

v9.26.0 (9.x, latest)v8.41.1 (8.x)v7.38.0 (7.x)

gcp.monitoring.NotificationChannel Anchor

Explore with Neo

Explain this resource Show real-world scenarios Provision a new instance

Viewing docs for Google Cloud v9.26.0

published on Tuesday, Jun 9, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-gcp

v9.26.0 (9.x, latest)v8.41.1 (8.x)v7.38.0 (7.x)

A NotificationChannel is a medium through which an alert is delivered when a policy violation is detected. Examples of channels include email, SMS, and third-party messaging applications. Fields containing sensitive information like authentication tokens or contact info are only partially populated on retrieval.

Notification Channels are designed to be flexible and are made up of a supported type and labels to configure that channel. Each type has specific labels that need to be present for that channel to be correctly configured. The labels that are required to be present for one channel type are often different than those required for another. Due to these loose constraints it’s often best to set up a channel through the UI and import it to the provider when setting up a brand new channel type to determine which labels are required.

A list of supported channels per project the list endpoint can be accessed programmatically or through the api explorer at https://cloud.google.com/monitoring/api/ref\_v3/rest/v3/projects.notificationChannelDescriptors/list . This provides the channel type and all of the required labels that must be passed.

To get more information about NotificationChannel, see:

API documentation
How-to Guides
- Monitoring API Documentation
- Notification Options

Note: All arguments marked as write-only values will not be stored in the state: sensitive_labels.auth_token_wo, sensitive_labels.password_wo, sensitive_labels.service_key_wo. Read more about Write-only Arguments.

Example Usage Anchor

Notification Channel Basic Anchor

TypeScript
Python
Go
C#
Java
YAML
HCL PREVIEW

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const basic = new gcp.monitoring.NotificationChannel("basic", {
    displayName: "Test Notification Channel",
    type: "email",
    labels: {
        email_address: "fake_email@blahblah.com",
    },
    forceDelete: false,
});

Copy

import pulumi
import pulumi_gcp as gcp

basic = gcp.monitoring.NotificationChannel("basic",
    display_name="Test Notification Channel",
    type="email",
    labels={
        "email_address": "fake_email@blahblah.com",
    },
    force_delete=False)

Copy

package main

import (
    "github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/monitoring"
    "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := monitoring.NewNotificationChannel(ctx, "basic", &monitoring.NotificationChannelArgs{
            DisplayName: pulumi.String("Test Notification Channel"),
            Type:        pulumi.String("email"),
            Labels: pulumi.StringMap{
                "email_address": pulumi.String("fake_email@blahblah.com"),
            },
            ForceDelete: pulumi.Bool(false),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

Copy

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var basic = new Gcp.Monitoring.NotificationChannel("basic", new()
    {
        DisplayName = "Test Notification Channel",
        Type = "email",
        Labels =
        {
            { "email_address", "fake_email@blahblah.com" },
        },
        ForceDelete = false,
    });

});

Copy

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.monitoring.NotificationChannel;
import com.pulumi.gcp.monitoring.NotificationChannelArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

public static void stack(Context ctx) {
        var basic = new NotificationChannel("basic", NotificationChannelArgs.builder()
            .displayName("Test Notification Channel")
            .type("email")
            .labels(Map.of("email_address", "fake_email@blahblah.com"))
            .forceDelete(false)
            .build());

}
}

Copy

resources:
  basic:
    type: gcp:monitoring:NotificationChannel
    properties:
      displayName: Test Notification Channel
      type: email
      labels:
        email_address: fake_email@blahblah.com
      forceDelete: false

Copy

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_monitoring_notificationchannel" "basic" {
  display_name = "Test Notification Channel"
  type         = "email"
  labels = {
    "email_address" = "fake_email@blahblah.com"
  }
  force_delete = false
}

Copy

Notification Channel Sensitive Anchor

TypeScript
Python
Go
C#
Java
YAML
HCL PREVIEW

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const _default = new gcp.monitoring.NotificationChannel("default", {
    displayName: "Test Slack Channel",
    type: "slack",
    labels: {
        channel_name: "#foobar",
    },
    sensitiveLabels: {
        authToken: "one",
    },
});

Copy

import pulumi
import pulumi_gcp as gcp

default = gcp.monitoring.NotificationChannel("default",
    display_name="Test Slack Channel",
    type="slack",
    labels={
        "channel_name": "#foobar",
    },
    sensitive_labels={
        "auth_token": "one",
    })

Copy

package main

import (
    "github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/monitoring"
    "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := monitoring.NewNotificationChannel(ctx, "default", &monitoring.NotificationChannelArgs{
            DisplayName: pulumi.String("Test Slack Channel"),
            Type:        pulumi.String("slack"),
            Labels: pulumi.StringMap{
                "channel_name": pulumi.String("#foobar"),
            },
            SensitiveLabels: &monitoring.NotificationChannelSensitiveLabelsArgs{
                AuthToken: pulumi.String("one"),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}

Copy

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var @default = new Gcp.Monitoring.NotificationChannel("default", new()
    {
        DisplayName = "Test Slack Channel",
        Type = "slack",
        Labels =
        {
            { "channel_name", "#foobar" },
        },
        SensitiveLabels = new Gcp.Monitoring.Inputs.NotificationChannelSensitiveLabelsArgs
        {
            AuthToken = "one",
        },
    });

});

Copy

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.monitoring.NotificationChannel;
import com.pulumi.gcp.monitoring.NotificationChannelArgs;
import com.pulumi.gcp.monitoring.inputs.NotificationChannelSensitiveLabelsArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

public static void stack(Context ctx) {
        var default_ = new NotificationChannel("default", NotificationChannelArgs.builder()
            .displayName("Test Slack Channel")
            .type("slack")
            .labels(Map.of("channel_name", "#foobar"))
            .sensitiveLabels(NotificationChannelSensitiveLabelsArgs.builder()
                .authToken("one")
                .build())
            .build());

}
}

Copy

resources:
  default:
    type: gcp:monitoring:NotificationChannel
    properties:
      displayName: Test Slack Channel
      type: slack
      labels:
        channel_name: '#foobar'
      sensitiveLabels:
        authToken: one

Copy

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_monitoring_notificationchannel" "default" {
  display_name = "Test Slack Channel"
  type         = "slack"
  labels = {
    "channel_name" = "#foobar"
  }
  sensitive_labels = {
    auth_token = "one"
  }
}

Copy

Create NotificationChannel Resource Anchor

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

Constructor syntax Anchor

TypeScript
Python
Go
C#
Java
YAML
HCL PREVIEW

new NotificationChannel(name: string, args: NotificationChannelArgs, opts?: CustomResourceOptions);

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

@overload
def NotificationChannel(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        type: Optional[str] = None,
                        deletion_policy: Optional[str] = None,
                        description: Optional[str] = None,
                        display_name: Optional[str] = None,
                        enabled: Optional[bool] = None,
                        force_delete: Optional[bool] = None,
                        labels: Optional[Mapping[str, str]] = None,
                        project: Optional[str] = None,
                        sensitive_labels: Optional[NotificationChannelSensitiveLabelsArgs] = None,
                        user_labels: Optional[Mapping[str, str]] = None)

func NewNotificationChannel(ctx *Context, name string, args NotificationChannelArgs, opts ...ResourceOption) (*NotificationChannel, error)

public NotificationChannel(string name, NotificationChannelArgs args, CustomResourceOptions? opts = null)

public NotificationChannel(String name, NotificationChannelArgs args)
public NotificationChannel(String name, NotificationChannelArgs args, CustomResourceOptions options)

type: gcp:monitoring:NotificationChannel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "gcp_monitoring_notificationchannel" "name" {
    # resource properties
}

Parameters Anchor

nameThis property is required.stringThe unique name of the resource.argsThis property is required.NotificationChannelArgsThe arguments to resource properties.optsCustomResourceOptionsBag of options to control resource's behavior.

resource_nameThis property is required.strThe unique name of the resource.argsThis property is required.NotificationChannelArgsThe arguments to resource properties.optsResourceOptionsBag of options to control resource's behavior.

ctxContextContext object for the current deployment.nameThis property is required.stringThe unique name of the resource.argsThis property is required.NotificationChannelArgsThe arguments to resource properties.optsResourceOptionBag of options to control resource's behavior.

nameThis property is required.StringThe unique name of the resource.argsThis property is required.NotificationChannelArgsThe arguments to resource properties.optionsCustomResourceOptionsBag of options to control resource's behavior.

Constructor example Anchor

The following reference example uses placeholder values for all input properties.

TypeScript
Python
Go
C#
Java
YAML
HCL PREVIEW

var notificationChannelResource = new Gcp.Monitoring.NotificationChannel("notificationChannelResource", new()
{
    Type = "string",
    DeletionPolicy = "string",
    Description = "string",
    DisplayName = "string",
    Enabled = false,
    ForceDelete = false,
    Labels =
    {
        { "string", "string" },
    },
    Project = "string",
    SensitiveLabels = new Gcp.Monitoring.Inputs.NotificationChannelSensitiveLabelsArgs
    {
        AuthToken = "string",
        AuthTokenWo = "string",
        AuthTokenWoVersion = "string",
        Password = "string",
        PasswordWo = "string",
        PasswordWoVersion = "string",
        ServiceKey = "string",
        ServiceKeyWo = "string",
        ServiceKeyWoVersion = "string",
    },
    UserLabels =
    {
        { "string", "string" },
    },
});

Copy

example, err := monitoring.NewNotificationChannel(ctx, "notificationChannelResource", &monitoring.NotificationChannelArgs{
    Type:           pulumi.String("string"),
    DeletionPolicy: pulumi.String("string"),
    Description:    pulumi.String("string"),
    DisplayName:    pulumi.String("string"),
    Enabled:        pulumi.Bool(false),
    ForceDelete:    pulumi.Bool(false),
    Labels: pulumi.StringMap{
        "string": pulumi.String("string"),
    },
    Project: pulumi.String("string"),
    SensitiveLabels: &monitoring.NotificationChannelSensitiveLabelsArgs{
        AuthToken:           pulumi.String("string"),
        AuthTokenWo:         pulumi.String("string"),
        AuthTokenWoVersion:  pulumi.String("string"),
        Password:            pulumi.String("string"),
        PasswordWo:          pulumi.String("string"),
        PasswordWoVersion:   pulumi.String("string"),
        ServiceKey:          pulumi.String("string"),
        ServiceKeyWo:        pulumi.String("string"),
        ServiceKeyWoVersion: pulumi.String("string"),
    },
    UserLabels: pulumi.StringMap{
        "string": pulumi.String("string"),
    },
})

Copy

resource "gcp_monitoring_notificationchannel" "notificationChannelResource" {
  type            = "string"
  deletion_policy = "string"
  description     = "string"
  display_name    = "string"
  enabled         = false
  force_delete    = false
  labels = {
    "string" = "string"
  }
  project = "string"
  sensitive_labels = {
    auth_token             = "string"
    auth_token_wo          = "string"
    auth_token_wo_version  = "string"
    password               = "string"
    password_wo            = "string"
    password_wo_version    = "string"
    service_key            = "string"
    service_key_wo         = "string"
    service_key_wo_version = "string"
  }
  user_labels = {
    "string" = "string"
  }
}

Copy

var notificationChannelResource = new NotificationChannel("notificationChannelResource", NotificationChannelArgs.builder()
    .type("string")
    .deletionPolicy("string")
    .description("string")
    .displayName("string")
    .enabled(false)
    .forceDelete(false)
    .labels(Map.of("string", "string"))
    .project("string")
    .sensitiveLabels(NotificationChannelSensitiveLabelsArgs.builder()
        .authToken("string")
        .authTokenWo("string")
        .authTokenWoVersion("string")
        .password("string")
        .passwordWo("string")
        .passwordWoVersion("string")
        .serviceKey("string")
        .serviceKeyWo("string")
        .serviceKeyWoVersion("string")
        .build())
    .userLabels(Map.of("string", "string"))
    .build());

Copy

notification_channel_resource = gcp.monitoring.NotificationChannel("notificationChannelResource",
    type="string",
    deletion_policy="string",
    description="string",
    display_name="string",
    enabled=False,
    force_delete=False,
    labels={
        "string": "string",
    },
    project="string",
    sensitive_labels={
        "auth_token": "string",
        "auth_token_wo": "string",
        "auth_token_wo_version": "string",
        "password": "string",
        "password_wo": "string",
        "password_wo_version": "string",
        "service_key": "string",
        "service_key_wo": "string",
        "service_key_wo_version": "string",
    },
    user_labels={
        "string": "string",
    })

Copy

const notificationChannelResource = new gcp.monitoring.NotificationChannel("notificationChannelResource", {
    type: "string",
    deletionPolicy: "string",
    description: "string",
    displayName: "string",
    enabled: false,
    forceDelete: false,
    labels: {
        string: "string",
    },
    project: "string",
    sensitiveLabels: {
        authToken: "string",
        authTokenWo: "string",
        authTokenWoVersion: "string",
        password: "string",
        passwordWo: "string",
        passwordWoVersion: "string",
        serviceKey: "string",
        serviceKeyWo: "string",
        serviceKeyWoVersion: "string",
    },
    userLabels: {
        string: "string",
    },
});

Copy

type: gcp:monitoring:NotificationChannel
properties:
    deletionPolicy: string
    description: string
    displayName: string
    enabled: false
    forceDelete: false
    labels:
        string: string
    project: string
    sensitiveLabels:
        authToken: string
        authTokenWo: string
        authTokenWoVersion: string
        password: string
        passwordWo: string
        passwordWoVersion: string
        serviceKey: string
        serviceKeyWo: string
        serviceKeyWoVersion: string
    type: string
    userLabels:
        string: string

Copy

NotificationChannel Resource Properties Anchor

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs Anchor

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The NotificationChannel resource accepts the following input properties:

TypeThis property is required.stringThe type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field. See https://cloud.google.com/monitoring/api/ref\_v3/rest/v3/projects.notificationChannelDescriptors/list to get the list of valid values such as "email", "slack", etc...DeletionPolicystringWhether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.DescriptionstringAn optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.DisplayNamestringAn optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.EnabledboolWhether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.ForceDeleteboolIf true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.LabelsDictionary<string, string>Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor corresponding to the type field. Labels with sensitive data are obfuscated by the API and therefore the provider cannot determine if there are upstream changes to these fields. They can also be configured via the sensitiveLabels block, but cannot be configured in both places.ProjectChanges to this property will trigger replacement.stringThe ID of the project in which the resource belongs. If it is not provided, the provider project is used.SensitiveLabels NotificationChannelSensitiveLabelsDifferent notification type behaviors are configured primarily using the the labels field on this resource. This block contains the labels which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: password, will be the key in the labels map in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below.UserLabelsDictionary<string, string>User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

TypeThis property is required.stringThe type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field. See https://cloud.google.com/monitoring/api/ref\_v3/rest/v3/projects.notificationChannelDescriptors/list to get the list of valid values such as "email", "slack", etc...DeletionPolicystringWhether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.DescriptionstringAn optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.DisplayNamestringAn optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.EnabledboolWhether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.ForceDeleteboolIf true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.Labelsmap[string]stringConfiguration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor corresponding to the type field. Labels with sensitive data are obfuscated by the API and therefore the provider cannot determine if there are upstream changes to these fields. They can also be configured via the sensitiveLabels block, but cannot be configured in both places.ProjectChanges to this property will trigger replacement.stringThe ID of the project in which the resource belongs. If it is not provided, the provider project is used.SensitiveLabels NotificationChannelSensitiveLabelsArgsDifferent notification type behaviors are configured primarily using the the labels field on this resource. This block contains the labels which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: password, will be the key in the labels map in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below.UserLabelsmap[string]stringUser-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

typeThis property is required.stringThe type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field. See https://cloud.google.com/monitoring/api/ref\_v3/rest/v3/projects.notificationChannelDescriptors/list to get the list of valid values such as "email", "slack", etc...deletion_policystringWhether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.descriptionstringAn optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.display_namestringAn optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.enabledboolWhether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.force_deleteboolIf true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.labelsmap(string)Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor corresponding to the type field. Labels with sensitive data are obfuscated by the API and therefore the provider cannot determine if there are upstream changes to these fields. They can also be configured via the sensitiveLabels block, but cannot be configured in both places.projectChanges to this property will trigger replacement.stringThe ID of the project in which the resource belongs. If it is not provided, the provider project is used.sensitive_labels objectDifferent notification type behaviors are configured primarily using the the labels field on this resource. This block contains the labels which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: password, will be the key in the labels map in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below.user_labelsmap(string)User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

typeThis property is required.StringThe type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field. See https://cloud.google.com/monitoring/api/ref\_v3/rest/v3/projects.notificationChannelDescriptors/list to get the list of valid values such as "email", "slack", etc...deletionPolicyStringWhether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.descriptionStringAn optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.displayNameStringAn optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.enabledBooleanWhether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.forceDeleteBooleanIf true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.labelsMap<String,String>Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor corresponding to the type field. Labels with sensitive data are obfuscated by the API and therefore the provider cannot determine if there are upstream changes to these fields. They can also be configured via the sensitiveLabels block, but cannot be configured in both places.projectChanges to this property will trigger replacement.StringThe ID of the project in which the resource belongs. If it is not provided, the provider project is used.sensitiveLabels NotificationChannelSensitiveLabelsDifferent notification type behaviors are configured primarily using the the labels field on this resource. This block contains the labels which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: password, will be the key in the labels map in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below.userLabelsMap<String,String>User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

typeThis property is required.stringThe type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field. See https://cloud.google.com/monitoring/api/ref\_v3/rest/v3/projects.notificationChannelDescriptors/list to get the list of valid values such as "email", "slack", etc...deletionPolicystringWhether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.descriptionstringAn optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.displayNamestringAn optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.enabledbooleanWhether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.forceDeletebooleanIf true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.labels{[key: string]: string}Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor corresponding to the type field. Labels with sensitive data are obfuscated by the API and therefore the provider cannot determine if there are upstream changes to these fields. They can also be configured via the sensitiveLabels block, but cannot be configured in both places.projectChanges to this property will trigger replacement.stringThe ID of the project in which the resource belongs. If it is not provided, the provider project is used.sensitiveLabels NotificationChannelSensitiveLabelsDifferent notification type behaviors are configured primarily using the the labels field on this resource. This block contains the labels which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: password, will be the key in the labels map in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below.userLabels{[key: string]: string}User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

typeThis property is required.strThe type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field. See https://cloud.google.com/monitoring/api/ref\_v3/rest/v3/projects.notificationChannelDescriptors/list to get the list of valid values such as "email", "slack", etc...deletion_policystrWhether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.descriptionstrAn optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.display_namestrAn optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.enabledboolWhether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.force_deleteboolIf true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.labelsMapping[str, str]Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor corresponding to the type field. Labels with sensitive data are obfuscated by the API and therefore the provider cannot determine if there are upstream changes to these fields. They can also be configured via the sensitiveLabels block, but cannot be configured in both places.projectChanges to this property will trigger replacement.strThe ID of the project in which the resource belongs. If it is not provided, the provider project is used.sensitive_labels NotificationChannelSensitiveLabelsArgsDifferent notification type behaviors are configured primarily using the the labels field on this resource. This block contains the labels which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: password, will be the key in the labels map in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below.user_labelsMapping[str, str]User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

typeThis property is required.StringThe type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field. See https://cloud.google.com/monitoring/api/ref\_v3/rest/v3/projects.notificationChannelDescriptors/list to get the list of valid values such as "email", "slack", etc...deletionPolicyStringWhether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.descriptionStringAn optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.displayNameStringAn optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.enabledBooleanWhether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.forceDeleteBooleanIf true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.labelsMapConfiguration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor corresponding to the type field. Labels with sensitive data are obfuscated by the API and therefore the provider cannot determine if there are upstream changes to these fields. They can also be configured via the sensitiveLabels block, but cannot be configured in both places.projectChanges to this property will trigger replacement.StringThe ID of the project in which the resource belongs. If it is not provided, the provider project is used.sensitiveLabels Property MapDifferent notification type behaviors are configured primarily using the the labels field on this resource. This block contains the labels which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: password, will be the key in the labels map in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below.userLabelsMapUser-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

Outputs Anchor

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

IdstringThe provider-assigned unique ID for this managed resource.NamestringThe full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.VerificationStatusstringIndicates whether this channel has been verified or not. On a ListNotificationChannels or GetNotificationChannel operation, this field is expected to be populated.If the value is UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.If the channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type.This field cannot be modified using a standard UpdateNotificationChannel operation. To change the value of this field, you must call VerifyNotificationChannel.

idstringThe provider-assigned unique ID for this managed resource.namestringThe full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.verification_statusstringIndicates whether this channel has been verified or not. On a ListNotificationChannels or GetNotificationChannel operation, this field is expected to be populated.If the value is UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.If the channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type.This field cannot be modified using a standard UpdateNotificationChannel operation. To change the value of this field, you must call VerifyNotificationChannel.

idStringThe provider-assigned unique ID for this managed resource.nameStringThe full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.verificationStatusStringIndicates whether this channel has been verified or not. On a ListNotificationChannels or GetNotificationChannel operation, this field is expected to be populated.If the value is UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.If the channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type.This field cannot be modified using a standard UpdateNotificationChannel operation. To change the value of this field, you must call VerifyNotificationChannel.

idstringThe provider-assigned unique ID for this managed resource.namestringThe full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.verificationStatusstringIndicates whether this channel has been verified or not. On a ListNotificationChannels or GetNotificationChannel operation, this field is expected to be populated.If the value is UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.If the channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type.This field cannot be modified using a standard UpdateNotificationChannel operation. To change the value of this field, you must call VerifyNotificationChannel.

idstrThe provider-assigned unique ID for this managed resource.namestrThe full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.verification_statusstrIndicates whether this channel has been verified or not. On a ListNotificationChannels or GetNotificationChannel operation, this field is expected to be populated.If the value is UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.If the channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type.This field cannot be modified using a standard UpdateNotificationChannel operation. To change the value of this field, you must call VerifyNotificationChannel.

Look up Existing NotificationChannel Resource Anchor

Get an existing NotificationChannel resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

TypeScript
Python
Go
C#
Java
YAML
HCL PREVIEW

public static get(name: string, id: Input<ID>, state?: NotificationChannelState, opts?: CustomResourceOptions): NotificationChannel

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        deletion_policy: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        enabled: Optional[bool] = None,
        force_delete: Optional[bool] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        sensitive_labels: Optional[NotificationChannelSensitiveLabelsArgs] = None,
        type: Optional[str] = None,
        user_labels: Optional[Mapping[str, str]] = None,
        verification_status: Optional[str] = None) -> NotificationChannel

func GetNotificationChannel(ctx *Context, name string, id IDInput, state *NotificationChannelState, opts ...ResourceOption) (*NotificationChannel, error)

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

public static NotificationChannel get(String name, Output<String> id, NotificationChannelState state, CustomResourceOptions options)

resources:  _:    type: gcp:monitoring:NotificationChannel    get:      id: ${id}

import {
  to = gcp_monitoring_notificationchannel.example
  id = "${id}"
}

nameThis property is required.The unique name of the resulting resource.idThis property is required.The unique provider ID of the resource to lookup.stateAny extra arguments used during the lookup.optsA bag of options that control this resource's behavior.

resource_nameThis property is required.The unique name of the resulting resource.idThis property is required.The unique provider ID of the resource to lookup.

The following state arguments are supported:

DeletionPolicystringWhether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.DescriptionstringAn optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.DisplayNamestringAn optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.EnabledboolWhether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.ForceDeleteboolIf true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.LabelsDictionary<string, string>Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor corresponding to the type field. Labels with sensitive data are obfuscated by the API and therefore the provider cannot determine if there are upstream changes to these fields. They can also be configured via the sensitiveLabels block, but cannot be configured in both places.NamestringThe full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.ProjectChanges to this property will trigger replacement.stringThe ID of the project in which the resource belongs. If it is not provided, the provider project is used.SensitiveLabels NotificationChannelSensitiveLabelsDifferent notification type behaviors are configured primarily using the the labels field on this resource. This block contains the labels which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: password, will be the key in the labels map in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below.TypestringThe type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field. See https://cloud.google.com/monitoring/api/ref\_v3/rest/v3/projects.notificationChannelDescriptors/list to get the list of valid values such as "email", "slack", etc...UserLabelsDictionary<string, string>User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.VerificationStatusstringIndicates whether this channel has been verified or not. On a ListNotificationChannels or GetNotificationChannel operation, this field is expected to be populated.If the value is UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.If the channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type.This field cannot be modified using a standard UpdateNotificationChannel operation. To change the value of this field, you must call VerifyNotificationChannel.

DeletionPolicystringWhether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.DescriptionstringAn optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.DisplayNamestringAn optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.EnabledboolWhether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.ForceDeleteboolIf true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.Labelsmap[string]stringConfiguration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor corresponding to the type field. Labels with sensitive data are obfuscated by the API and therefore the provider cannot determine if there are upstream changes to these fields. They can also be configured via the sensitiveLabels block, but cannot be configured in both places.NamestringThe full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.ProjectChanges to this property will trigger replacement.stringThe ID of the project in which the resource belongs. If it is not provided, the provider project is used.SensitiveLabels NotificationChannelSensitiveLabelsArgsDifferent notification type behaviors are configured primarily using the the labels field on this resource. This block contains the labels which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: password, will be the key in the labels map in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below.TypestringThe type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field. See https://cloud.google.com/monitoring/api/ref\_v3/rest/v3/projects.notificationChannelDescriptors/list to get the list of valid values such as "email", "slack", etc...UserLabelsmap[string]stringUser-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.VerificationStatusstringIndicates whether this channel has been verified or not. On a ListNotificationChannels or GetNotificationChannel operation, this field is expected to be populated.If the value is UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.If the channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type.This field cannot be modified using a standard UpdateNotificationChannel operation. To change the value of this field, you must call VerifyNotificationChannel.

deletion_policystringWhether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.descriptionstringAn optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.display_namestringAn optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.enabledboolWhether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.force_deleteboolIf true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.labelsmap(string)Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor corresponding to the type field. Labels with sensitive data are obfuscated by the API and therefore the provider cannot determine if there are upstream changes to these fields. They can also be configured via the sensitiveLabels block, but cannot be configured in both places.namestringThe full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.projectChanges to this property will trigger replacement.stringThe ID of the project in which the resource belongs. If it is not provided, the provider project is used.sensitive_labels objectDifferent notification type behaviors are configured primarily using the the labels field on this resource. This block contains the labels which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: password, will be the key in the labels map in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below.typestringThe type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field. See https://cloud.google.com/monitoring/api/ref\_v3/rest/v3/projects.notificationChannelDescriptors/list to get the list of valid values such as "email", "slack", etc...user_labelsmap(string)User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.verification_statusstringIndicates whether this channel has been verified or not. On a ListNotificationChannels or GetNotificationChannel operation, this field is expected to be populated.If the value is UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.If the channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type.This field cannot be modified using a standard UpdateNotificationChannel operation. To change the value of this field, you must call VerifyNotificationChannel.

deletionPolicyStringWhether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.descriptionStringAn optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.displayNameStringAn optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.enabledBooleanWhether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.forceDeleteBooleanIf true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.labelsMap<String,String>Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor corresponding to the type field. Labels with sensitive data are obfuscated by the API and therefore the provider cannot determine if there are upstream changes to these fields. They can also be configured via the sensitiveLabels block, but cannot be configured in both places.nameStringThe full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.projectChanges to this property will trigger replacement.StringThe ID of the project in which the resource belongs. If it is not provided, the provider project is used.sensitiveLabels NotificationChannelSensitiveLabelsDifferent notification type behaviors are configured primarily using the the labels field on this resource. This block contains the labels which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: password, will be the key in the labels map in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below.typeStringThe type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field. See https://cloud.google.com/monitoring/api/ref\_v3/rest/v3/projects.notificationChannelDescriptors/list to get the list of valid values such as "email", "slack", etc...userLabelsMap<String,String>User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.verificationStatusStringIndicates whether this channel has been verified or not. On a ListNotificationChannels or GetNotificationChannel operation, this field is expected to be populated.If the value is UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.If the channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type.This field cannot be modified using a standard UpdateNotificationChannel operation. To change the value of this field, you must call VerifyNotificationChannel.

deletionPolicystringWhether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.descriptionstringAn optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.displayNamestringAn optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.enabledbooleanWhether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.forceDeletebooleanIf true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.labels{[key: string]: string}Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor corresponding to the type field. Labels with sensitive data are obfuscated by the API and therefore the provider cannot determine if there are upstream changes to these fields. They can also be configured via the sensitiveLabels block, but cannot be configured in both places.namestringThe full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.projectChanges to this property will trigger replacement.stringThe ID of the project in which the resource belongs. If it is not provided, the provider project is used.sensitiveLabels NotificationChannelSensitiveLabelsDifferent notification type behaviors are configured primarily using the the labels field on this resource. This block contains the labels which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: password, will be the key in the labels map in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below.typestringThe type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field. See https://cloud.google.com/monitoring/api/ref\_v3/rest/v3/projects.notificationChannelDescriptors/list to get the list of valid values such as "email", "slack", etc...userLabels{[key: string]: string}User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.verificationStatusstringIndicates whether this channel has been verified or not. On a ListNotificationChannels or GetNotificationChannel operation, this field is expected to be populated.If the value is UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.If the channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type.This field cannot be modified using a standard UpdateNotificationChannel operation. To change the value of this field, you must call VerifyNotificationChannel.

deletion_policystrWhether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.descriptionstrAn optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.display_namestrAn optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.enabledboolWhether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.force_deleteboolIf true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.labelsMapping[str, str]Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor corresponding to the type field. Labels with sensitive data are obfuscated by the API and therefore the provider cannot determine if there are upstream changes to these fields. They can also be configured via the sensitiveLabels block, but cannot be configured in both places.namestrThe full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.projectChanges to this property will trigger replacement.strThe ID of the project in which the resource belongs. If it is not provided, the provider project is used.sensitive_labels NotificationChannelSensitiveLabelsArgsDifferent notification type behaviors are configured primarily using the the labels field on this resource. This block contains the labels which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: password, will be the key in the labels map in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below.typestrThe type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field. See https://cloud.google.com/monitoring/api/ref\_v3/rest/v3/projects.notificationChannelDescriptors/list to get the list of valid values such as "email", "slack", etc...user_labelsMapping[str, str]User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.verification_statusstrIndicates whether this channel has been verified or not. On a ListNotificationChannels or GetNotificationChannel operation, this field is expected to be populated.If the value is UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.If the channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type.This field cannot be modified using a standard UpdateNotificationChannel operation. To change the value of this field, you must call VerifyNotificationChannel.

deletionPolicyStringWhether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.descriptionStringAn optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.displayNameStringAn optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.enabledBooleanWhether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.forceDeleteBooleanIf true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.labelsMapConfiguration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor corresponding to the type field. Labels with sensitive data are obfuscated by the API and therefore the provider cannot determine if there are upstream changes to these fields. They can also be configured via the sensitiveLabels block, but cannot be configured in both places.nameStringThe full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.projectChanges to this property will trigger replacement.StringThe ID of the project in which the resource belongs. If it is not provided, the provider project is used.sensitiveLabels Property MapDifferent notification type behaviors are configured primarily using the the labels field on this resource. This block contains the labels which contain secrets or passwords so that they can be marked sensitive and hidden from plan output. The name of the field, eg: password, will be the key in the labels map in the api request. Credentials may not be specified in both locations and will cause an error. Changing from one location to a different credential configuration in the config will require an apply to update state. Structure is documented below.typeStringThe type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field. See https://cloud.google.com/monitoring/api/ref\_v3/rest/v3/projects.notificationChannelDescriptors/list to get the list of valid values such as "email", "slack", etc...userLabelsMapUser-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.verificationStatusStringIndicates whether this channel has been verified or not. On a ListNotificationChannels or GetNotificationChannel operation, this field is expected to be populated.If the value is UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.If the channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type.This field cannot be modified using a standard UpdateNotificationChannel operation. To change the value of this field, you must call VerifyNotificationChannel.

Supporting Types Anchor

NotificationChannelSensitiveLabels , NotificationChannelSensitiveLabelsArgs Anchor

AuthTokenstringAn authorization token for a notification channel. Channel types that support this field include: slack Note: This property is sensitive and will not be displayed in the plan.AuthTokenWostring

NOTE: This field is write-only and its value will not be updated in state as part of read operations. (Optional, Write-Only) An authorization token for a notification channel. Channel types that support this field include: slack Note: This property is write-only and will not be read from the API.

Note: One of authToken or authTokenWo can only be set.

AuthTokenWoVersionstringTriggers update of authTokenWo write-only. Increment this value when an update to authTokenWo is needed. For more info see updating write-only arguments PasswordstringAn password for a notification channel. Channel types that support this field include: webhookBasicauth Note: This property is sensitive and will not be displayed in the plan.PasswordWostring

NOTE: This field is write-only and its value will not be updated in state as part of read operations. (Optional, Write-Only) An password for a notification channel. Channel types that support this field include: webhookBasicauth Note: This property is write-only and will not be read from the API.

Note: One of password or passwordWo can only be set.

PasswordWoVersionstringTriggers update of passwordWo write-only. Increment this value when an update to passwordWo is needed. For more info see updating write-only arguments ServiceKeystringAn servicekey token for a notification channel. Channel types that support this field include: pagerduty Note: This property is sensitive and will not be displayed in the plan.ServiceKeyWostring

NOTE: This field is write-only and its value will not be updated in state as part of read operations. (Optional, Write-Only) An servicekey token for a notification channel. Channel types that support this field include: pagerduty Note: This property is write-only and will not be read from the API.

Note: One of serviceKey or serviceKeyWo can only be set.

ServiceKeyWoVersionstringTriggers update of serviceKeyWo write-only. Increment this value when an update to serviceKeyWo is needed. For more info see updating write-only arguments

Note: One of authToken or authTokenWo can only be set.

Note: One of password or passwordWo can only be set.

Note: One of serviceKey or serviceKeyWo can only be set.

ServiceKeyWoVersionstringTriggers update of serviceKeyWo write-only. Increment this value when an update to serviceKeyWo is needed. For more info see updating write-only arguments

auth_tokenstringAn authorization token for a notification channel. Channel types that support this field include: slack Note: This property is sensitive and will not be displayed in the plan.auth_token_wostring

Note: One of authToken or authTokenWo can only be set.

auth_token_wo_versionstringTriggers update of authTokenWo write-only. Increment this value when an update to authTokenWo is needed. For more info see updating write-only arguments passwordstringAn password for a notification channel. Channel types that support this field include: webhookBasicauth Note: This property is sensitive and will not be displayed in the plan.password_wostring

Note: One of password or passwordWo can only be set.

password_wo_versionstringTriggers update of passwordWo write-only. Increment this value when an update to passwordWo is needed. For more info see updating write-only arguments service_keystringAn servicekey token for a notification channel. Channel types that support this field include: pagerduty Note: This property is sensitive and will not be displayed in the plan.service_key_wostring

Note: One of serviceKey or serviceKeyWo can only be set.

service_key_wo_versionstringTriggers update of serviceKeyWo write-only. Increment this value when an update to serviceKeyWo is needed. For more info see updating write-only arguments

authTokenStringAn authorization token for a notification channel. Channel types that support this field include: slack Note: This property is sensitive and will not be displayed in the plan.authTokenWoString

Note: One of authToken or authTokenWo can only be set.

authTokenWoVersionStringTriggers update of authTokenWo write-only. Increment this value when an update to authTokenWo is needed. For more info see updating write-only arguments passwordStringAn password for a notification channel. Channel types that support this field include: webhookBasicauth Note: This property is sensitive and will not be displayed in the plan.passwordWoString

Note: One of password or passwordWo can only be set.

passwordWoVersionStringTriggers update of passwordWo write-only. Increment this value when an update to passwordWo is needed. For more info see updating write-only arguments serviceKeyStringAn servicekey token for a notification channel. Channel types that support this field include: pagerduty Note: This property is sensitive and will not be displayed in the plan.serviceKeyWoString

Note: One of serviceKey or serviceKeyWo can only be set.

serviceKeyWoVersionStringTriggers update of serviceKeyWo write-only. Increment this value when an update to serviceKeyWo is needed. For more info see updating write-only arguments

authTokenstringAn authorization token for a notification channel. Channel types that support this field include: slack Note: This property is sensitive and will not be displayed in the plan.authTokenWostring

Note: One of authToken or authTokenWo can only be set.

authTokenWoVersionstringTriggers update of authTokenWo write-only. Increment this value when an update to authTokenWo is needed. For more info see updating write-only arguments passwordstringAn password for a notification channel. Channel types that support this field include: webhookBasicauth Note: This property is sensitive and will not be displayed in the plan.passwordWostring

Note: One of password or passwordWo can only be set.

passwordWoVersionstringTriggers update of passwordWo write-only. Increment this value when an update to passwordWo is needed. For more info see updating write-only arguments serviceKeystringAn servicekey token for a notification channel. Channel types that support this field include: pagerduty Note: This property is sensitive and will not be displayed in the plan.serviceKeyWostring

Note: One of serviceKey or serviceKeyWo can only be set.

serviceKeyWoVersionstringTriggers update of serviceKeyWo write-only. Increment this value when an update to serviceKeyWo is needed. For more info see updating write-only arguments

auth_tokenstrAn authorization token for a notification channel. Channel types that support this field include: slack Note: This property is sensitive and will not be displayed in the plan.auth_token_wostr

Note: One of authToken or authTokenWo can only be set.

auth_token_wo_versionstrTriggers update of authTokenWo write-only. Increment this value when an update to authTokenWo is needed. For more info see updating write-only arguments passwordstrAn password for a notification channel. Channel types that support this field include: webhookBasicauth Note: This property is sensitive and will not be displayed in the plan.password_wostr

Note: One of password or passwordWo can only be set.

password_wo_versionstrTriggers update of passwordWo write-only. Increment this value when an update to passwordWo is needed. For more info see updating write-only arguments service_keystrAn servicekey token for a notification channel. Channel types that support this field include: pagerduty Note: This property is sensitive and will not be displayed in the plan.service_key_wostr

Note: One of serviceKey or serviceKeyWo can only be set.

service_key_wo_versionstrTriggers update of serviceKeyWo write-only. Increment this value when an update to serviceKeyWo is needed. For more info see updating write-only arguments

Note: One of authToken or authTokenWo can only be set.

Note: One of password or passwordWo can only be set.

Note: One of serviceKey or serviceKeyWo can only be set.

serviceKeyWoVersionStringTriggers update of serviceKeyWo write-only. Increment this value when an update to serviceKeyWo is needed. For more info see updating write-only arguments

Import Anchor

NotificationChannel can be imported using any of these accepted formats:

{{name}}

When using the pulumi import command, NotificationChannel can be imported using one of the formats above. For example:

$ pulumi import gcp:monitoring/notificationChannel:NotificationChannel default {{name}}

Copy

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

Package Details Anchor

Viewing docs for Google Cloud v9.26.0

published on Tuesday, Jun 9, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-gcp

v9.26.0 (9.x, latest)v8.41.1 (8.x)v7.38.0 (7.x)

gcp.monitoring.NotificationChannel Anchor

On this page

On this page

Example Usage Anchor

Notification Channel Basic Anchor

Notification Channel Sensitive Anchor

Create NotificationChannel Resource Anchor

Constructor syntax Anchor

Parameters Anchor

Constructor example Anchor

NotificationChannel Resource Properties Anchor

Inputs Anchor

Outputs Anchor

Look up Existing NotificationChannel Resource Anchor

Supporting Types Anchor

NotificationChannelSensitiveLabels , NotificationChannelSensitiveLabelsArgs Anchor

Import Anchor

Package Details Anchor

On this page

On this page

Try Pulumi Cloud free. Your team will thank you.