Google Cloud Native v0.28.0, Feb 2 23

google-native.monitoring/v3.NotificationChannel

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.Design your application to single-thread API calls that modify the state of notification channels in a single project. This includes calls to CreateNotificationChannel, DeleteNotificationChannel and UpdateNotificationChannel.

Create NotificationChannel Resource

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

@overload
def NotificationChannel(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        creation_record: Optional[MutationRecordArgs] = None,
                        description: Optional[str] = None,
                        display_name: Optional[str] = None,
                        enabled: Optional[bool] = None,
                        labels: Optional[Mapping[str, str]] = None,
                        mutation_records: Optional[Sequence[MutationRecordArgs]] = None,
                        name: Optional[str] = None,
                        project: Optional[str] = None,
                        type: Optional[str] = None,
                        user_labels: Optional[Mapping[str, str]] = None,
                        verification_status: Optional[NotificationChannelVerificationStatus] = None)
@overload
def NotificationChannel(resource_name: str,
                        args: Optional[NotificationChannelArgs] = None,
                        opts: Optional[ResourceOptions] = None)

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

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

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

type: google-native:monitoring/v3:NotificationChannel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

resource_name str: The unique name of the resource.
args NotificationChannelArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args NotificationChannelArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args NotificationChannelArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

NotificationChannel Resource Properties

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

Inputs

The NotificationChannel resource accepts the following input properties:

CreationRecord Pulumi.GoogleNative.Monitoring.V3.Inputs.MutationRecordArgs: Record of the creation of this channel.
Description string: An 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.
DisplayName string: An 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.
Enabled bool: Whether 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.
Labels Dictionary<string, string>: Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor.labels of the NotificationChannelDescriptor corresponding to the type field.
MutationRecords List<Pulumi.GoogleNative.Monitoring.V3.Inputs.MutationRecordArgs>: Records of the modification of this channel.
Name string: The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.
Project string
Type string: The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field.
UserLabels Dictionary<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.
VerificationStatus Pulumi.GoogleNative.Monitoring.V3.NotificationChannelVerificationStatus: Indicates 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.

CreationRecord MutationRecordArgs: Record of the creation of this channel.
Description string: An 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.
DisplayName string: An 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.
Enabled bool: Whether 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.
Labels map[string]string: Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor.labels of the NotificationChannelDescriptor corresponding to the type field.
MutationRecords []MutationRecordArgs: Records of the modification of this channel.
Name string: The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.
Project string
Type string: The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field.
UserLabels map[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.
VerificationStatus NotificationChannelVerificationStatus: Indicates 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.

creationRecord MutationRecordArgs: Record of the creation of this channel.
description String: An 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.
displayName String: An 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.
enabled Boolean: Whether 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.
labels Map<String,String>: Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor.labels of the NotificationChannelDescriptor corresponding to the type field.
mutationRecords List<MutationRecordArgs>: Records of the modification of this channel.
name String: The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.
project String
type String: The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field.
userLabels Map<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.
verificationStatus NotificationChannelVerificationStatus: Indicates 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.

creationRecord MutationRecordArgs: Record of the creation of this channel.
description string: An 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.
displayName string: An 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.
enabled boolean: Whether 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.
labels {[key: string]: string}: Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor.labels of the NotificationChannelDescriptor corresponding to the type field.
mutationRecords MutationRecordArgs[]: Records of the modification of this channel.
name string: The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.
project string
type string: The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field.
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.
verificationStatus NotificationChannelVerificationStatus: Indicates 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.

creation_record MutationRecordArgs: Record of the creation of this channel.
description str: An 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_name str: An 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.
enabled bool: Whether 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.
labels Mapping[str, str]: Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor.labels of the NotificationChannelDescriptor corresponding to the type field.
mutation_records Sequence[MutationRecordArgs]: Records of the modification of this channel.
name str: The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.
project str
type str: The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field.
user_labels Mapping[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_status NotificationChannelVerificationStatus: Indicates 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.

creationRecord Property Map: Record of the creation of this channel.
description String: An 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.
displayName String: An 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.
enabled Boolean: Whether 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.
labels Map<String>: Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor.labels of the NotificationChannelDescriptor corresponding to the type field.
mutationRecords List<Property Map>: Records of the modification of this channel.
name String: The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.
project String
type String: The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field.
userLabels Map<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.
verificationStatus "VERIFICATION_STATUS_UNSPECIFIED" | "UNVERIFIED" | "VERIFIED": Indicates 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.

Outputs

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

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

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

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

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

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

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

Supporting Types

MutationRecord

MutateTime string: When the change occurred.
MutatedBy string: The email address of the user making the change.

MutateTime string: When the change occurred.
MutatedBy string: The email address of the user making the change.

mutateTime String: When the change occurred.
mutatedBy String: The email address of the user making the change.

mutateTime string: When the change occurred.
mutatedBy string: The email address of the user making the change.

mutate_time str: When the change occurred.
mutated_by str: The email address of the user making the change.

mutateTime String: When the change occurred.
mutatedBy String: The email address of the user making the change.

MutationRecordResponse

MutateTime string: When the change occurred.
MutatedBy string: The email address of the user making the change.

MutateTime string: When the change occurred.
MutatedBy string: The email address of the user making the change.

mutateTime String: When the change occurred.
mutatedBy String: The email address of the user making the change.

mutateTime string: When the change occurred.
mutatedBy string: The email address of the user making the change.

mutate_time str: When the change occurred.
mutated_by str: The email address of the user making the change.

mutateTime String: When the change occurred.
mutatedBy String: The email address of the user making the change.

NotificationChannelVerificationStatus

VerificationStatusUnspecified: VERIFICATION_STATUS_UNSPECIFIED
Sentinel value used to indicate that the state is unknown, omitted, or is not applicable (as in the case of channels that neither support nor require verification in order to function).
Unverified: UNVERIFIED
The channel has yet to be verified and requires verification to function. Note that this state also applies to the case where the verification process has been initiated by sending a verification code but where the verification code has not been submitted to complete the process.
Verified: VERIFIED
It has been proven that notifications can be received on this notification channel and that someone on the project has access to messages that are delivered to that channel.

NotificationChannelVerificationStatusVerificationStatusUnspecified: VERIFICATION_STATUS_UNSPECIFIED
Sentinel value used to indicate that the state is unknown, omitted, or is not applicable (as in the case of channels that neither support nor require verification in order to function).
NotificationChannelVerificationStatusUnverified: UNVERIFIED
The channel has yet to be verified and requires verification to function. Note that this state also applies to the case where the verification process has been initiated by sending a verification code but where the verification code has not been submitted to complete the process.
NotificationChannelVerificationStatusVerified: VERIFIED
It has been proven that notifications can be received on this notification channel and that someone on the project has access to messages that are delivered to that channel.

VerificationStatusUnspecified: VERIFICATION_STATUS_UNSPECIFIED
Sentinel value used to indicate that the state is unknown, omitted, or is not applicable (as in the case of channels that neither support nor require verification in order to function).
Unverified: UNVERIFIED
The channel has yet to be verified and requires verification to function. Note that this state also applies to the case where the verification process has been initiated by sending a verification code but where the verification code has not been submitted to complete the process.
Verified: VERIFIED
It has been proven that notifications can be received on this notification channel and that someone on the project has access to messages that are delivered to that channel.

VerificationStatusUnspecified: VERIFICATION_STATUS_UNSPECIFIED
Sentinel value used to indicate that the state is unknown, omitted, or is not applicable (as in the case of channels that neither support nor require verification in order to function).
Unverified: UNVERIFIED
The channel has yet to be verified and requires verification to function. Note that this state also applies to the case where the verification process has been initiated by sending a verification code but where the verification code has not been submitted to complete the process.
Verified: VERIFIED
It has been proven that notifications can be received on this notification channel and that someone on the project has access to messages that are delivered to that channel.

VERIFICATION_STATUS_UNSPECIFIED: VERIFICATION_STATUS_UNSPECIFIED
Sentinel value used to indicate that the state is unknown, omitted, or is not applicable (as in the case of channels that neither support nor require verification in order to function).
UNVERIFIED: UNVERIFIED
The channel has yet to be verified and requires verification to function. Note that this state also applies to the case where the verification process has been initiated by sending a verification code but where the verification code has not been submitted to complete the process.
VERIFIED: VERIFIED
It has been proven that notifications can be received on this notification channel and that someone on the project has access to messages that are delivered to that channel.

"VERIFICATION_STATUS_UNSPECIFIED": VERIFICATION_STATUS_UNSPECIFIED
Sentinel value used to indicate that the state is unknown, omitted, or is not applicable (as in the case of channels that neither support nor require verification in order to function).
"UNVERIFIED": UNVERIFIED
The channel has yet to be verified and requires verification to function. Note that this state also applies to the case where the verification process has been initiated by sending a verification code but where the verification code has not been submitted to complete the process.
"VERIFIED": VERIFIED
It has been proven that notifications can be received on this notification channel and that someone on the project has access to messages that are delivered to that channel.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0