Package com.hashicorp.cdktf.providers.google.monitoring_notification_channel

Class MonitoringNotificationChannel.Builder

    • Method Detail

      • connection

        @Stability(Experimental)
public MonitoringNotificationChannel.Builder connection​(com.hashicorp.cdktf.SSHProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • connection

        @Stability(Experimental)
public MonitoringNotificationChannel.Builder connection​(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
        Parameters:
        connection - This parameter is required.
        Returns:
        this

      • count

        @Stability(Experimental)
public MonitoringNotificationChannel.Builder count​(com.hashicorp.cdktf.TerraformCount count)
        Parameters:
        count - This parameter is required.
        Returns:
        this

      • dependsOn

        @Stability(Experimental)
public MonitoringNotificationChannel.Builder dependsOn​(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
        Parameters:
        dependsOn - This parameter is required.
        Returns:
        this

      • forEach

        @Stability(Experimental)
public MonitoringNotificationChannel.Builder forEach​(com.hashicorp.cdktf.ITerraformIterator forEach)
        Parameters:
        forEach - This parameter is required.
        Returns:
        this

      • lifecycle

        @Stability(Experimental)
public MonitoringNotificationChannel.Builder lifecycle​(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
        Parameters:
        lifecycle - This parameter is required.
        Returns:
        this

      • provider

        @Stability(Experimental)
public MonitoringNotificationChannel.Builder provider​(com.hashicorp.cdktf.TerraformProvider provider)
        Parameters:
        provider - This parameter is required.
        Returns:
        this

      • type

        @Stability(Stable)
public MonitoringNotificationChannel.Builder type​(String 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... Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_notification_channel#type MonitoringNotificationChannel#type}

        Parameters:
        type - The type of the notification channel. This parameter is required.
        Returns:
        this

      • description

        @Stability(Stable)
public MonitoringNotificationChannel.Builder description​(String 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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_notification_channel#description MonitoringNotificationChannel#description}

        Parameters:
        description - An optional human-readable description of this notification channel. This parameter is required.
        Returns:
        this

      • displayName

        @Stability(Stable)
public MonitoringNotificationChannel.Builder displayName​(String 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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_notification_channel#display_name MonitoringNotificationChannel#display_name}

        Parameters:
        displayName - An optional human-readable name for this notification channel. This parameter is required.
        Returns:
        this

      • enabled

        @Stability(Stable)
public MonitoringNotificationChannel.Builder enabled​(Boolean 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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_notification_channel#enabled MonitoringNotificationChannel#enabled}

        Parameters:
        enabled - Whether notifications are forwarded to the described channel. This parameter is required.
        Returns:
        this

      • enabled

        @Stability(Stable)
public MonitoringNotificationChannel.Builder enabled​(com.hashicorp.cdktf.IResolvable 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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_notification_channel#enabled MonitoringNotificationChannel#enabled}

        Parameters:
        enabled - Whether notifications are forwarded to the described channel. This parameter is required.
        Returns:
        this

      • forceDelete

        @Stability(Stable)
public MonitoringNotificationChannel.Builder forceDelete​(Boolean 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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_notification_channel#force_delete MonitoringNotificationChannel#force_delete}

        Parameters:
        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). This parameter is required.
        Returns:
        this

      • forceDelete

        @Stability(Stable)
public MonitoringNotificationChannel.Builder forceDelete​(com.hashicorp.cdktf.IResolvable 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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_notification_channel#force_delete MonitoringNotificationChannel#force_delete}

        Parameters:
        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). This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public MonitoringNotificationChannel.Builder id​(String id)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_notification_channel#id MonitoringNotificationChannel#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

        Parameters:
        id - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_notification_channel#id MonitoringNotificationChannel#id}. This parameter is required.
        Returns:
        this

      • labels

        @Stability(Stable)
public MonitoringNotificationChannel.Builder labels​(Map<String,​String> 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 Terraform 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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_notification_channel#labels MonitoringNotificationChannel#labels}

        Parameters:
        labels - Configuration fields that define the channel and its behavior. This parameter is required.
        Returns:
        this

      • project

        @Stability(Stable)
public MonitoringNotificationChannel.Builder project​(String project)
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_notification_channel#project MonitoringNotificationChannel#project}.

        Parameters:
        project - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_notification_channel#project MonitoringNotificationChannel#project}. This parameter is required.
        Returns:
        this

      • sensitiveLabels

        @Stability(Stable)
public MonitoringNotificationChannel.Builder sensitiveLabels​(MonitoringNotificationChannelSensitiveLabels sensitiveLabels)
        sensitive_labels block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_notification_channel#sensitive_labels MonitoringNotificationChannel#sensitive_labels}

        Parameters:
        sensitiveLabels - sensitive_labels block. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public MonitoringNotificationChannel.Builder timeouts​(MonitoringNotificationChannelTimeouts timeouts)
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_notification_channel#timeouts MonitoringNotificationChannel#timeouts}

        Parameters:
        timeouts - timeouts block. This parameter is required.
        Returns:
        this

      • userLabels

        @Stability(Stable)
public MonitoringNotificationChannel.Builder userLabels​(Map<String,​String> 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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_notification_channel#user_labels MonitoringNotificationChannel#user_labels}

        Parameters:
        userLabels - User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This parameter is required.
        Returns:
        this