com.pulumi.gcp.monitoring.kotlin.NotificationChannelArgs.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.monitoring.kotlin
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gcp.monitoring.NotificationChannelArgs.builder
import com.pulumi.gcp.monitoring.kotlin.inputs.NotificationChannelSensitiveLabelsArgs
import com.pulumi.gcp.monitoring.kotlin.inputs.NotificationChannelSensitiveLabelsArgsBuilder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Boolean
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* 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](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.notificationChannels)
* * How-to Guides
* * [Notification Options](https://cloud.google.com/monitoring/support/notification-options)
* * [Monitoring API Documentation](https://cloud.google.com/monitoring/api/v3/)
* ## Example Usage
* ### Notification Channel Basic
*
* ```typescript
* 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: "[email protected]",
* },
* forceDelete: false,
* });
* ```
* ```python
* import pulumi
* import pulumi_gcp as gcp
* basic = gcp.monitoring.NotificationChannel("basic",
* display_name="Test Notification Channel",
* type="email",
* labels={
* "email_address": "[email protected]",
* },
* force_delete=False)
* ```
* ```csharp
* 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", "[email protected]" },
* },
* ForceDelete = false,
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/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("[email protected]"),
* },
* ForceDelete: pulumi.Bool(false),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* 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.List;
* import java.util.ArrayList;
* 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", "[email protected]"))
* .forceDelete(false)
* .build());
* }
* }
* ```
* ```yaml
* resources:
* basic:
* type: gcp:monitoring:NotificationChannel
* properties:
* displayName: Test Notification Channel
* type: email
* labels:
* email_address: [email protected]
* forceDelete: false
* ```
*
* ### Notification Channel Sensitive
*
* ```typescript
* 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",
* },
* });
* ```
* ```python
* 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=gcp.monitoring.NotificationChannelSensitiveLabelsArgs(
* auth_token="one",
* ))
* ```
* ```csharp
* 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",
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-gcp/sdk/v7/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
* })
* }
* ```
* ```java
* 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.List;
* import java.util.ArrayList;
* 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());
* }
* }
* ```
* ```yaml
* resources:
* default:
* type: gcp:monitoring:NotificationChannel
* properties:
* displayName: Test Slack Channel
* type: slack
* labels:
* channel_name: '#foobar'
* sensitiveLabels:
* authToken: one
* ```
*
* ## Import
* 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:
* ```sh
* $ pulumi import gcp:monitoring/notificationChannel:NotificationChannel default {{name}}
* ```
* @property description 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.
* @property displayName 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.
* @property enabled 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.
* @property forceDelete If 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.
* @property labels 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 sensitive_labels block, but cannot be configured in both places.
* @property project The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
* @property sensitiveLabels Different 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.
* @property type The 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...
* - - -
* @property userLabels 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.
*/
public data class NotificationChannelArgs(
public val description: Output? = null,
public val displayName: Output? = null,
public val enabled: Output? = null,
public val forceDelete: Output? = null,
public val labels: Output>? = null,
public val project: Output? = null,
public val sensitiveLabels: Output? = null,
public val type: Output? = null,
public val userLabels: Output>? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.gcp.monitoring.NotificationChannelArgs =
com.pulumi.gcp.monitoring.NotificationChannelArgs.builder()
.description(description?.applyValue({ args0 -> args0 }))
.displayName(displayName?.applyValue({ args0 -> args0 }))
.enabled(enabled?.applyValue({ args0 -> args0 }))
.forceDelete(forceDelete?.applyValue({ args0 -> args0 }))
.labels(labels?.applyValue({ args0 -> args0.map({ args0 -> args0.key.to(args0.value) }).toMap() }))
.project(project?.applyValue({ args0 -> args0 }))
.sensitiveLabels(sensitiveLabels?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.type(type?.applyValue({ args0 -> args0 }))
.userLabels(
userLabels?.applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}),
).build()
}
/**
* Builder for [NotificationChannelArgs].
*/
@PulumiTagMarker
public class NotificationChannelArgsBuilder internal constructor() {
private var description: Output? = null
private var displayName: Output? = null
private var enabled: Output? = null
private var forceDelete: Output? = null
private var labels: Output>? = null
private var project: Output? = null
private var sensitiveLabels: Output? = null
private var type: Output? = null
private var userLabels: Output>? = null
/**
* @param value 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.
*/
@JvmName("pvjsfugdxtocqcfo")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value 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.
*/
@JvmName("fodktxsscogvbpgj")
public suspend fun displayName(`value`: Output) {
this.displayName = value
}
/**
* @param value 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.
*/
@JvmName("mxfohpkorluvojvc")
public suspend fun enabled(`value`: Output) {
this.enabled = value
}
/**
* @param value If 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.
*/
@JvmName("dpgjltfesrlkvlnm")
public suspend fun forceDelete(`value`: Output) {
this.forceDelete = value
}
/**
* @param value 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 sensitive_labels block, but cannot be configured in both places.
*/
@JvmName("tdbxqrkveclrcnbs")
public suspend fun labels(`value`: Output>) {
this.labels = value
}
/**
* @param value The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
@JvmName("jwjxqaoqfomegxho")
public suspend fun project(`value`: Output) {
this.project = value
}
/**
* @param value Different 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.
*/
@JvmName("vkamrhuovxamenel")
public suspend fun sensitiveLabels(`value`: Output) {
this.sensitiveLabels = value
}
/**
* @param value The 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...
* - - -
*/
@JvmName("lanomwcpmaeixsbp")
public suspend fun type(`value`: Output) {
this.type = value
}
/**
* @param value 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.
*/
@JvmName("xesdffqwmtdycgyv")
public suspend fun userLabels(`value`: Output>) {
this.userLabels = value
}
/**
* @param value 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.
*/
@JvmName("elkmodqyphoccdot")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value 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.
*/
@JvmName("mpwpjveygcvofkii")
public suspend fun displayName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.displayName = mapped
}
/**
* @param value 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.
*/
@JvmName("tesfsuvycqgdnevd")
public suspend fun enabled(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.enabled = mapped
}
/**
* @param value If 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.
*/
@JvmName("gkpwwmawpgeqnkdn")
public suspend fun forceDelete(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.forceDelete = mapped
}
/**
* @param value 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 sensitive_labels block, but cannot be configured in both places.
*/
@JvmName("oeunlroevyhsynxy")
public suspend fun labels(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.labels = mapped
}
/**
* @param values 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 sensitive_labels block, but cannot be configured in both places.
*/
@JvmName("jkhqstvykkshnhyu")
public fun labels(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.labels = mapped
}
/**
* @param value The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
@JvmName("nqubddsdbjqwhavx")
public suspend fun project(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.project = mapped
}
/**
* @param value Different 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.
*/
@JvmName("bilrkyttqnkwfioj")
public suspend fun sensitiveLabels(`value`: NotificationChannelSensitiveLabelsArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.sensitiveLabels = mapped
}
/**
* @param argument Different 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.
*/
@JvmName("whokeyamexdwqgqk")
public suspend fun sensitiveLabels(argument: suspend NotificationChannelSensitiveLabelsArgsBuilder.() -> Unit) {
val toBeMapped = NotificationChannelSensitiveLabelsArgsBuilder().applySuspend {
argument()
}.build()
val mapped = of(toBeMapped)
this.sensitiveLabels = mapped
}
/**
* @param value The 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...
* - - -
*/
@JvmName("jjeacocfhahlpiyx")
public suspend fun type(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.type = mapped
}
/**
* @param value 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.
*/
@JvmName("icgicwlweehcecjl")
public suspend fun userLabels(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.userLabels = mapped
}
/**
* @param values 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.
*/
@JvmName("mqaskrthxcltndxr")
public fun userLabels(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.userLabels = mapped
}
internal fun build(): NotificationChannelArgs = NotificationChannelArgs(
description = description,
displayName = displayName,
enabled = enabled,
forceDelete = forceDelete,
labels = labels,
project = project,
sensitiveLabels = sensitiveLabels,
type = type,
userLabels = userLabels,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy