Package com.hashicorp.cdktf.providers.google.monitoring_alert_policy

Interface MonitoringAlertPolicyConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    MonitoringAlertPolicyConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:21.932Z")
@Stability(Stable)
public interface MonitoringAlertPolicyConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getCombiner

        @Stability(Stable)
@NotNull
String getCombiner()
        How to combine the results of multiple conditions to determine if an incident should be opened.

        Possible values: ["AND", "OR", "AND_WITH_MATCHING_RESOURCE"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_alert_policy#combiner MonitoringAlertPolicy#combiner}

      • getConditions

        @Stability(Stable)
@NotNull
Object getConditions()
        conditions block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_alert_policy#conditions MonitoringAlertPolicy#conditions}

      • getDisplayName

        @Stability(Stable)
@NotNull
String getDisplayName()
        A short name or phrase used to identify the policy in dashboards, notifications, and incidents.

        To avoid confusion, don't use the same display name for multiple policies in the same project. The 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_alert_policy#display_name MonitoringAlertPolicy#display_name}

      • getAlertStrategy

        @Stability(Stable)
@Nullable
default MonitoringAlertPolicyAlertStrategy getAlertStrategy()
        alert_strategy block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_alert_policy#alert_strategy MonitoringAlertPolicy#alert_strategy}

      • getDocumentation

        @Stability(Stable)
@Nullable
default MonitoringAlertPolicyDocumentation getDocumentation()
        documentation block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_alert_policy#documentation MonitoringAlertPolicy#documentation}

      • getEnabled

        @Stability(Stable)
@Nullable
default Object getEnabled()
        Whether or not the policy is enabled. The default is true.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_alert_policy#enabled MonitoringAlertPolicy#enabled}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_alert_policy#id MonitoringAlertPolicy#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.

      • getNotificationChannels

        @Stability(Stable)
@Nullable
default List<String> getNotificationChannels()
        Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident.

        Each element of this array corresponds to the name field in each of the NotificationChannel objects that are returned from the notificationChannels.list method. The syntax of the entries in this field is 'projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]' Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_alert_policy#notification_channels MonitoringAlertPolicy#notification_channels}

      • getProject

        @Stability(Stable)
@Nullable
default String getProject()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_alert_policy#project MonitoringAlertPolicy#project}.

      • getSeverity

        @Stability(Stable)
@Nullable
default String getSeverity()
        The severity of an alert policy indicates how important incidents generated by that policy are.

        The severity level will be displayed on the Incident detail page and in notifications. Possible values: ["CRITICAL", "ERROR", "WARNING"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_alert_policy#severity MonitoringAlertPolicy#severity}

      • getTimeouts

        @Stability(Stable)
@Nullable
default MonitoringAlertPolicyTimeouts getTimeouts()
        timeouts block.

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

      • getUserLabels

        @Stability(Stable)
@Nullable
default Map<String,​String> getUserLabels()
        This field is intended to be used for organizing and identifying the AlertPolicy 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_alert_policy#user_labels MonitoringAlertPolicy#user_labels}