GetNotificationChannel

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.

To get more information about NotificationChannel, see:

Using GetNotificationChannel

function getNotificationChannel(args: GetNotificationChannelArgs, opts?: InvokeOptions): Promise<GetNotificationChannelResult>
function  get_notification_channel(display_name=None, labels=None, project=None, type=None, user_labels=None, opts=None)
func LookupNotificationChannel(ctx *Context, args *LookupNotificationChannelArgs, opts ...InvokeOption) (*LookupNotificationChannelResult, error)

Note: This function is named LookupNotificationChannel in the Go SDK.

public static class GetNotificationChannel {
    public static Task<GetNotificationChannelResult> InvokeAsync(GetNotificationChannelArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

DisplayName string

The display name for this notification channel.

Labels Dictionary<string, string>

Labels (corresponding to the NotificationChannelDescriptor schema) to filter the notification channels by.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Type string

The type of the notification channel.

UserLabels Dictionary<string, string>

User-provided key-value labels to filter by.

DisplayName string

The display name for this notification channel.

Labels map[string]string

Labels (corresponding to the NotificationChannelDescriptor schema) to filter the notification channels by.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Type string

The type of the notification channel.

UserLabels map[string]string

User-provided key-value labels to filter by.

displayName string

The display name for this notification channel.

labels {[key: string]: string}

Labels (corresponding to the NotificationChannelDescriptor schema) to filter the notification channels by.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

type string

The type of the notification channel.

userLabels {[key: string]: string}

User-provided key-value labels to filter by.

display_name str

The display name for this notification channel.

labels Dict[str, str]

Labels (corresponding to the NotificationChannelDescriptor schema) to filter the notification channels by.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

type str

The type of the notification channel.

user_labels Dict[str, str]

User-provided key-value labels to filter by.

GetNotificationChannel Result

The following output properties are available:

Description string
Enabled bool
Id string

The provider-assigned unique ID for this managed resource.

Name string
SensitiveLabels List<GetNotificationChannelSensitiveLabel>
VerificationStatus string
DisplayName string
Labels Dictionary<string, string>
Project string
Type string
UserLabels Dictionary<string, string>
Description string
Enabled bool
Id string

The provider-assigned unique ID for this managed resource.

Name string
SensitiveLabels []GetNotificationChannelSensitiveLabel
VerificationStatus string
DisplayName string
Labels map[string]string
Project string
Type string
UserLabels map[string]string
description string
enabled boolean
id string

The provider-assigned unique ID for this managed resource.

name string
sensitiveLabels GetNotificationChannelSensitiveLabel[]
verificationStatus string
displayName string
labels {[key: string]: string}
project string
type string
userLabels {[key: string]: string}
description str
enabled bool
id str

The provider-assigned unique ID for this managed resource.

name str
sensitive_labels List[GetNotificationChannelSensitiveLabel]
verification_status str
display_name str
labels Dict[str, str]
project str
type str
user_labels Dict[str, str]

Supporting Types

GetNotificationChannelSensitiveLabel

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

AuthToken string
Password string
ServiceKey string
AuthToken string
Password string
ServiceKey string
authToken string
password string
serviceKey string
authToken str
password str
serviceKey str

Package Details

Repository
https://github.com/pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.