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

Class MonitoringAlertPolicy.Builder

    • Method Detail

      • create

        @Stability(Stable)
public static MonitoringAlertPolicy.Builder create​(software.constructs.Construct scope,
                                                   String id)
        Parameters:
        scope - The scope in which to define this construct. This parameter is required.
        id - The scoped construct ID. This parameter is required.
        Returns:
        a new instance of MonitoringAlertPolicy.Builder.

      • connection

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

      • connection

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

      • count

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

      • dependsOn

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

      • forEach

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

      • lifecycle

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

      • provider

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

      • provisioners

        @Stability(Experimental)
public MonitoringAlertPolicy.Builder provisioners​(List<? extends Object> provisioners)
        Parameters:
        provisioners - This parameter is required.
        Returns:
        this

      • combiner

        @Stability(Stable)
public MonitoringAlertPolicy.Builder combiner​(String combiner)
        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}

        Parameters:
        combiner - How to combine the results of multiple conditions to determine if an incident should be opened. This parameter is required.
        Returns:
        this

      • conditions

        @Stability(Stable)
public MonitoringAlertPolicy.Builder conditions​(com.hashicorp.cdktf.IResolvable conditions)
        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}

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

      • conditions

        @Stability(Stable)
public MonitoringAlertPolicy.Builder conditions​(List<? extends MonitoringAlertPolicyConditions> conditions)
        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}

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

      • displayName

        @Stability(Stable)
public MonitoringAlertPolicy.Builder displayName​(String displayName)
        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}

        Parameters:
        displayName - A short name or phrase used to identify the policy in dashboards, notifications, and incidents. This parameter is required.
        Returns:
        this

      • alertStrategy

        @Stability(Stable)
public MonitoringAlertPolicy.Builder alertStrategy​(MonitoringAlertPolicyAlertStrategy alertStrategy)
        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}

        Parameters:
        alertStrategy - alert_strategy block. This parameter is required.
        Returns:
        this

      • documentation

        @Stability(Stable)
public MonitoringAlertPolicy.Builder documentation​(MonitoringAlertPolicyDocumentation documentation)
        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}

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

      • enabled

        @Stability(Stable)
public MonitoringAlertPolicy.Builder enabled​(Boolean enabled)
        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}

        Parameters:
        enabled - Whether or not the policy is enabled. The default is true. This parameter is required.
        Returns:
        this

      • enabled

        @Stability(Stable)
public MonitoringAlertPolicy.Builder enabled​(com.hashicorp.cdktf.IResolvable enabled)
        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}

        Parameters:
        enabled - Whether or not the policy is enabled. The default is true. This parameter is required.
        Returns:
        this

      • id

        @Stability(Stable)
public MonitoringAlertPolicy.Builder id​(String id)
        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.

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

      • notificationChannels

        @Stability(Stable)
public MonitoringAlertPolicy.Builder notificationChannels​(List<String> notificationChannels)
        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}

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

      • project

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

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

      • severity

        @Stability(Stable)
public MonitoringAlertPolicy.Builder severity​(String severity)
        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}

        Parameters:
        severity - The severity of an alert policy indicates how important incidents generated by that policy are. This parameter is required.
        Returns:
        this

      • timeouts

        @Stability(Stable)
public MonitoringAlertPolicy.Builder timeouts​(MonitoringAlertPolicyTimeouts timeouts)
        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}

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

      • userLabels

        @Stability(Stable)
public MonitoringAlertPolicy.Builder userLabels​(Map<String,​String> userLabels)
        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}

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