Module monitoring

This page documents the language specification for the gcp package. If you're looking for help working with the inputs, outputs, or functions of gcp resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

AlertPolicy
CustomService
Dashboard
Group
NotificationChannel
Slo
UptimeCheckConfig

Others

Resources

Resource AlertPolicy

class AlertPolicy extends CustomResource

A description of the conditions under which some aspect of your system is considered to be “unhealthy” and the ways to notify people or services about this state.

To get more information about AlertPolicy, see:

API documentation
How-to Guides
- Official Documentation

Example Usage - Monitoring Alert Policy Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const alertPolicy = new gcp.monitoring.AlertPolicy("alertPolicy", {
    combiner: "OR",
    conditions: [{
        conditionThreshold: {
            aggregations: [{
                alignmentPeriod: "60s",
                perSeriesAligner: "ALIGN_RATE",
            }],
            comparison: "COMPARISON_GT",
            duration: "60s",
            filter: "metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\"",
        },
        displayName: "test condition",
    }],
    displayName: "My Alert Policy",
    userLabels: {
        foo: "bar",
    },
});

constructor

new AlertPolicy(name: string, args: AlertPolicyArgs, opts?: pulumi.CustomResourceOptions)

Create a AlertPolicy resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AlertPolicyState, opts?: pulumi.CustomResourceOptions): AlertPolicy

Get an existing AlertPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AlertPolicy

Returns true if the given object is an instance of AlertPolicy. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property combiner

public combiner: pulumi.Output<string>;

How to combine the results of multiple conditions to determine if an incident should be opened.

property conditions

public conditions: pulumi.Output<AlertPolicyCondition[]>;

A list of conditions for the policy. The conditions are combined by AND or OR according to the combiner field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions. Structure is documented below.

property creationRecord

public creationRecord: pulumi.Output<AlertPolicyCreationRecord>;

A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored.

property displayName

public displayName: pulumi.Output<string>;

A short name or phrase used to identify the condition in dashboards, notifications, and incidents. To avoid confusion, don’t use the same display name for multiple conditions in the same policy.

property documentation

public documentation: pulumi.Output<AlertPolicyDocumentation | undefined>;

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. Structure is documented below.

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Whether or not the policy is enabled. The default is true.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

- The unique resource name for this condition. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.

property notificationChannels

public notificationChannels: pulumi.Output<string[] | undefined>;

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]

property project

public project: pulumi.Output<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userLabels

public userLabels: pulumi.Output<{[key: string]: string} | undefined>;

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.

Resource CustomService

class CustomService extends CustomResource

A Service is a discrete, autonomous, and network-accessible unit, designed to solve an individual concern (Wikipedia). In Cloud Monitoring, a Service acts as the root resource under which operational aspects of the service are accessible

To get more information about Service, see:

API documentation
How-to Guides
- Service Monitoring
- Monitoring API Documentation

Example Usage - Monitoring Service Custom

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const custom = new gcp.monitoring.CustomService("custom", {
    displayName: "My Custom Service custom-srv",
    serviceId: "custom-srv",
    telemetry: {
        resourceName: "//product.googleapis.com/foo/foo/services/test",
    },
});

constructor

new CustomService(name: string, args?: CustomServiceArgs, opts?: pulumi.CustomResourceOptions)

Create a CustomService resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CustomServiceState, opts?: pulumi.CustomResourceOptions): CustomService

Get an existing CustomService resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is CustomService

Returns true if the given object is an instance of CustomService. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property displayName

public displayName: pulumi.Output<string | undefined>;

Name used for UI elements listing this Service.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The full resource name for this service. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].

property project

public project: pulumi.Output<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property serviceId

public serviceId: pulumi.Output<string>;

An optional service ID to use. If not given, the server will generate a service ID.

property telemetry

public telemetry: pulumi.Output<CustomServiceTelemetry | undefined>;

Configuration for how to query telemetry on a Service. Structure is documented below.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Dashboard

class Dashboard extends CustomResource

A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.

To get more information about Dashboards, see:

API documentation
How-to Guides
- Official Documentation

Example Usage - Monitoring Dashboard Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const dashboard = new gcp.monitoring.Dashboard("dashboard", {
    dashboardJson: `{
  "displayName": "Demo Dashboard",
  "gridLayout": {
    "widgets": [
      {
        "blank": {}
      }
    ]
  }
}

`,
});

Example Usage - Monitoring Dashboard GridLayout

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const dashboard = new gcp.monitoring.Dashboard("dashboard", {
    dashboardJson: `{
  "displayName": "Grid Layout Example",
  "gridLayout": {
    "columns": "2",
    "widgets": [
      {
        "title": "Widget 1",
        "xyChart": {
          "dataSets": [{
            "timeSeriesQuery": {
              "timeSeriesFilter": {
                "filter": "metric.type=\\"agent.googleapis.com/nginx/connections/accepted_count\\"",
                "aggregation": {
                  "perSeriesAligner": "ALIGN_RATE"
                }
              },
              "unitOverride": "1"
            },
            "plotType": "LINE"
          }],
          "timeshiftDuration": "0s",
          "yAxis": {
            "label": "y1Axis",
            "scale": "LINEAR"
          }
        }
      },
      {
        "text": {
          "content": "Widget 2",
          "format": "MARKDOWN"
        }
      },
      {
        "title": "Widget 3",
        "xyChart": {
          "dataSets": [{
            "timeSeriesQuery": {
              "timeSeriesFilter": {
                "filter": "metric.type=\\"agent.googleapis.com/nginx/connections/accepted_count\\"",
                "aggregation": {
                  "perSeriesAligner": "ALIGN_RATE"
                }
              },
              "unitOverride": "1"
            },
            "plotType": "STACKED_BAR"
          }],
          "timeshiftDuration": "0s",
          "yAxis": {
            "label": "y1Axis",
            "scale": "LINEAR"
          }
        }
      }
    ]
  }
}

`,
});

constructor

new Dashboard(name: string, args: DashboardArgs, opts?: pulumi.CustomResourceOptions)

Create a Dashboard resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DashboardState, opts?: pulumi.CustomResourceOptions): Dashboard

Get an existing Dashboard resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Dashboard

Returns true if the given object is an instance of Dashboard. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property dashboardJson

public dashboardJson: pulumi.Output<string>;

The JSON representation of a dashboard, following the format at https://cloud.google.com/monitoring/api/ref_v3/rest/v1/projects.dashboards. The representation of an existing dashboard can be found by using the API Explorer

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property project

public project: pulumi.Output<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Group

class Group extends CustomResource

The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group’s filter matches an available monitored resource, then that resource is a member of that group.

To get more information about Group, see:

API documentation
How-to Guides
- Official Documentation

Example Usage - Monitoring Group Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const basic = new gcp.monitoring.Group("basic", {
    displayName: "tf-test MonitoringGroup",
    filter: "resource.metadata.region=\"europe-west2\"",
});

Example Usage - Monitoring Group Subgroup

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const parent = new gcp.monitoring.Group("parent", {
    displayName: "tf-test MonitoringParentGroup",
    filter: "resource.metadata.region=\"europe-west2\"",
});
const subgroup = new gcp.monitoring.Group("subgroup", {
    displayName: "tf-test MonitoringSubGroup",
    filter: "resource.metadata.region=\"europe-west2\"",
    parentName: parent.name,
});

constructor

new Group(name: string, args: GroupArgs, opts?: pulumi.CustomResourceOptions)

Create a Group resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GroupState, opts?: pulumi.CustomResourceOptions): Group

Get an existing Group resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Group

Returns true if the given object is an instance of Group. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property displayName

public displayName: pulumi.Output<string>;

A user-assigned name for this group, used only for display purposes.

property filter

public filter: pulumi.Output<string>;

The filter used to determine which monitored resources belong to this group.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property isCluster

public isCluster: pulumi.Output<boolean | undefined>;

If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.

property name

public name: pulumi.Output<string>;

A unique identifier for this group. The format is “projects/{project_id_or_number}/groups/{group_id}“.

property parentName

public parentName: pulumi.Output<string | undefined>;

The name of the group’s parent, if it has one. The format is “projects/{project_id_or_number}/groups/{group_id}“. For groups with no parent, parentName is the empty string, “”.

property project

public project: pulumi.Output<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NotificationChannel

class NotificationChannel extends CustomResource

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
How-to Guides
- Notification Options
- Monitoring API Documentation

Example Usage - Notification Channel Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const basic = new gcp.monitoring.NotificationChannel("basic", {
    displayName: "Test Notification Channel",
    labels: {
        email_address: "fake_email@blahblah.com",
    },
    type: "email",
});

Example Usage - Notification Channel Sensitive

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const defaultNotificationChannel = new gcp.monitoring.NotificationChannel("default", {
    displayName: "Test Slack Channel",
    labels: {
        channel_name: "#foobar",
    },
    sensitiveLabels: {
        authToken: "one",
    },
    type: "slack",
});

constructor

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

Create a NotificationChannel resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NotificationChannelState, opts?: pulumi.CustomResourceOptions): NotificationChannel

Get an existing NotificationChannel resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NotificationChannel

Returns true if the given object is an instance of NotificationChannel. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

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

public displayName: pulumi.Output<string | undefined>;

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

public enabled: pulumi.Output<boolean | undefined>;

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 id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<{[key: string]: string} | undefined>;

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 sensitiveLabels block, but cannot be configured in both places.

property name

public name: pulumi.Output<string>;

The full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.

property project

public project: pulumi.Output<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property sensitiveLabels

public sensitiveLabels: pulumi.Output<NotificationChannelSensitiveLabels | undefined>;

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

public type: pulumi.Output<string>;

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 urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userLabels

public userLabels: pulumi.Output<{[key: string]: string} | undefined>;

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.

property verificationStatus

public verificationStatus: pulumi.Output<string>;

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.

Resource Slo

class Slo extends CustomResource

A Service-Level Objective (SLO) describes the level of desired good service. It consists of a service-level indicator (SLI), a performance goal, and a period over which the objective is to be evaluated against that goal. The SLO can use SLIs defined in a number of different manners. Typical SLOs might include “99% of requests in each rolling week have latency below 200 milliseconds” or “99.5% of requests in each calendar month return successfully.”

To get more information about Slo, see:

API documentation
How-to Guides
- Service Monitoring
- Monitoring API Documentation

Example Usage - Monitoring Slo Appengine

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const default = gcp.monitoring.getAppEngineService({
    moduleId: "default",
});
const appengSlo = new gcp.monitoring.Slo("appengSlo", {
    service: _default.then(_default => _default.serviceId),
    sloId: "ae-slo",
    displayName: "Test SLO for App Engine",
    goal: 0.9,
    calendarPeriod: "DAY",
    basic_sli: {
        latency: {
            threshold: "1s",
        },
    },
});

constructor

new Slo(name: string, args: SloArgs, opts?: pulumi.CustomResourceOptions)

Create a Slo resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SloState, opts?: pulumi.CustomResourceOptions): Slo

Get an existing Slo resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Slo

Returns true if the given object is an instance of Slo. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property basicSli

public basicSli: pulumi.Output<SloBasicSli | undefined>;

Basic Service-Level Indicator (SLI) on a well-known service type. Performance will be computed on the basis of pre-defined metrics. SLIs are used to measure and calculate the quality of the Service’s performance with respect to a single aspect of service quality. Exactly one of the following must be set: basicSli, requestBasedSli, windowsBasedSli Structure is documented below.

property calendarPeriod

public calendarPeriod: pulumi.Output<string | undefined>;

A calendar period, semantically “since the start of the current ”.

property displayName

public displayName: pulumi.Output<string | undefined>;

Name used for UI elements listing this SLO.

property goal

public goal: pulumi.Output<number>;

The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.999

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The full resource name for this service. The syntax is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]

property project

public project: pulumi.Output<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property requestBasedSli

public requestBasedSli: pulumi.Output<SloRequestBasedSli | undefined>;

A request-based SLI defines a SLI for which atomic units of service are counted directly. A SLI describes a good service. It is used to measure and calculate the quality of the Service’s performance with respect to a single aspect of service quality. Exactly one of the following must be set: basicSli, requestBasedSli, windowsBasedSli Structure is documented below.

property rollingPeriodDays

public rollingPeriodDays: pulumi.Output<number | undefined>;

A rolling time period, semantically “in the past X days”. Must be between 1 to 30 days, inclusive.

property service

public service: pulumi.Output<string>;

ID of the service to which this SLO belongs.

property sloId

public sloId: pulumi.Output<string>;

The id to use for this ServiceLevelObjective. If omitted, an id will be generated instead.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property windowsBasedSli

public windowsBasedSli: pulumi.Output<SloWindowsBasedSli | undefined>;

A windows-based SLI defines the criteria for time windows. goodService is defined based off the count of these time windows for which the provided service was of good quality. A SLI describes a good service. It is used to measure and calculate the quality of the Service’s performance with respect to a single aspect of service quality. Exactly one of the following must be set: basicSli, requestBasedSli, windowsBasedSli Structure is documented below.

Resource UptimeCheckConfig

class UptimeCheckConfig extends CustomResource

This message configures which resources and services to monitor for availability.

To get more information about UptimeCheckConfig, see:

API documentation
How-to Guides
- Official Documentation

Warning: All arguments including http_check.auth_info.password will be stored in the raw state as plain-text. Read more about secrets in state.

Example Usage - Uptime Check Config Http

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const http = new gcp.monitoring.UptimeCheckConfig("http", {
    contentMatchers: [{
        content: "example",
    }],
    displayName: "http-uptime-check",
    httpCheck: {
        path: "/some-path",
        port: 8010,
    },
    monitoredResource: {
        labels: {
            host: "192.168.1.1",
            project_id: "my-project-name",
        },
        type: "uptimeUrl",
    },
    timeout: "60s",
});

Example Usage - Uptime Check Config Https

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const https = new gcp.monitoring.UptimeCheckConfig("https", {
    contentMatchers: [{
        content: "example",
    }],
    displayName: "https-uptime-check",
    httpCheck: {
        path: "/some-path",
        port: 443,
        useSsl: true,
        validateSsl: true,
    },
    monitoredResource: {
        labels: {
            host: "192.168.1.1",
            project_id: "my-project-name",
        },
        type: "uptimeUrl",
    },
    timeout: "60s",
});

Example Usage - Uptime Check Tcp

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const check = new gcp.monitoring.Group("check", {
    displayName: "uptime-check-group",
    filter: "resource.metadata.name=has_substring(\"foo\")",
});
const tcpGroup = new gcp.monitoring.UptimeCheckConfig("tcpGroup", {
    displayName: "tcp-uptime-check",
    timeout: "60s",
    tcp_check: {
        port: 888,
    },
    resource_group: {
        resourceType: "INSTANCE",
        groupId: check.name,
    },
});

constructor

new UptimeCheckConfig(name: string, args: UptimeCheckConfigArgs, opts?: pulumi.CustomResourceOptions)

Create a UptimeCheckConfig resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UptimeCheckConfigState, opts?: pulumi.CustomResourceOptions): UptimeCheckConfig

Get an existing UptimeCheckConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is UptimeCheckConfig

Returns true if the given object is an instance of UptimeCheckConfig. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property contentMatchers

public contentMatchers: pulumi.Output<UptimeCheckConfigContentMatcher[] | undefined>;

The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response’s content. This field is optional and should only be specified if a content match is required. Structure is documented below.

property displayName

public displayName: pulumi.Output<string>;

A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.

property httpCheck

public httpCheck: pulumi.Output<UptimeCheckConfigHttpCheck | undefined>;

Contains information needed to make an HTTP or HTTPS check. Structure is documented below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property monitoredResource

public monitoredResource: pulumi.Output<UptimeCheckConfigMonitoredResource | undefined>;

The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks: uptimeUrl gceInstance gaeApp awsEc2Instance awsElbLoadBalancer Structure is documented below.

property name

public name: pulumi.Output<string>;

A unique resource name for this UptimeCheckConfig. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].

property period

public period: pulumi.Output<string | undefined>;

How often, in seconds, the uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 300s.

property project

public project: pulumi.Output<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property resourceGroup

public resourceGroup: pulumi.Output<UptimeCheckConfigResourceGroup | undefined>;

The group resource associated with the configuration. Structure is documented below.

property selectedRegions

public selectedRegions: pulumi.Output<string[] | undefined>;

The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.

property tcpCheck

public tcpCheck: pulumi.Output<UptimeCheckConfigTcpCheck | undefined>;

Contains information needed to make a TCP check. Structure is documented below.

property timeout

public timeout: pulumi.Output<string>;

The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Accepted formats https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration

property uptimeCheckId

public uptimeCheckId: pulumi.Output<string>;

The id of the uptime check

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getAppEngineService

getAppEngineService(args: GetAppEngineServiceArgs, opts?: pulumi.InvokeOptions): Promise<GetAppEngineServiceResult>

A Monitoring Service is the root resource under which operational aspects of a generic service are accessible. A service is some discrete, autonomous, and network-accessible unit, designed to solve an individual concern

An App Engine monitoring service is automatically created by GCP to monitor App Engine services.

To get more information about Service, see:

API documentation
How-to Guides
- Service Monitoring
- Monitoring API Documentation

Example Usage - Monitoring App Engine Service

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const bucket = new gcp.storage.Bucket("bucket", {});
const object = new gcp.storage.BucketObject("object", {
    bucket: bucket.name,
    source: new pulumi.asset.FileAsset("./test-fixtures/appengine/hello-world.zip"),
});
const myapp = new gcp.appengine.StandardAppVersion("myapp", {
    versionId: "v1",
    service: "myapp",
    runtime: "nodejs10",
    entrypoint: {
        shell: "node ./app.js",
    },
    deployment: {
        zip: {
            sourceUrl: pulumi.interpolate`https://storage.googleapis.com/${bucket.name}/${object.name}`,
        },
    },
    envVariables: {
        port: "8080",
    },
    deleteServiceOnDestroy: false,
});
const srv = myapp.service.apply(service => gcp.monitoring.getAppEngineService({
    moduleId: service,
}));

Function getNotificationChannel

getNotificationChannel(args?: GetNotificationChannelArgs, opts?: pulumi.InvokeOptions): Promise<GetNotificationChannelResult>

To get more information about NotificationChannel, see:

API documentation
How-to Guides
- Notification Options
- Monitoring API Documentation

Example Usage - Notification Channel Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const basic = gcp.monitoring.getNotificationChannel({
    displayName: "Test Notification Channel",
});
const alertPolicy = new gcp.monitoring.AlertPolicy("alertPolicy", {
    displayName: "My Alert Policy",
    notificationChannels: [basic.then(basic => basic.name)],
    combiner: "OR",
    conditions: [{
        displayName: "test condition",
        condition_threshold: {
            filter: "metric.type=\"compute.googleapis.com/instance/disk/write_bytes_count\" AND resource.type=\"gce_instance\"",
            duration: "60s",
            comparison: "COMPARISON_GT",
            aggregations: [{
                alignmentPeriod: "60s",
                perSeriesAligner: "ALIGN_RATE",
            }],
        },
    }],
});

Function getSecretVersion

DEPRECATED gcp.monitoring.getSecretVersion has been deprecated in favor of gcp.secretmanager.getSecretVersion

getSecretVersion(args: GetSecretVersionArgs, opts?: pulumi.InvokeOptions): Promise<GetSecretVersionResult>

Function getUptimeCheckIPs

getUptimeCheckIPs(opts?: pulumi.InvokeOptions): Promise<GetUptimeCheckIPsResult>

Returns the list of IP addresses that checkers run from. For more information see the official documentation.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const ips = gcp.monitoring.getUptimeCheckIPs({});
export const ipList = ips.then(ips => ips.uptimeCheckIps);

Others

interface AlertPolicyArgs

interface AlertPolicyArgs

The set of arguments for constructing a AlertPolicy resource.

property combiner

combiner: pulumi.Input<string>;

How to combine the results of multiple conditions to determine if an incident should be opened.

property conditions

conditions: pulumi.Input<pulumi.Input<AlertPolicyCondition>[]>;

property displayName

displayName: pulumi.Input<string>;

A short name or phrase used to identify the condition in dashboards, notifications, and incidents. To avoid confusion, don’t use the same display name for multiple conditions in the same policy.

property documentation

documentation?: pulumi.Input<AlertPolicyDocumentation>;

property enabled

enabled?: pulumi.Input<boolean>;

Whether or not the policy is enabled. The default is true.

property notificationChannels

notificationChannels?: pulumi.Input<pulumi.Input<string>[]>;

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property userLabels

userLabels?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

interface AlertPolicyState

interface AlertPolicyState

Input properties used for looking up and filtering AlertPolicy resources.

property combiner

combiner?: pulumi.Input<string>;

How to combine the results of multiple conditions to determine if an incident should be opened.

property conditions

conditions?: pulumi.Input<pulumi.Input<AlertPolicyCondition>[]>;

property creationRecord

creationRecord?: pulumi.Input<AlertPolicyCreationRecord>;

A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored.

property displayName

displayName?: pulumi.Input<string>;

A short name or phrase used to identify the condition in dashboards, notifications, and incidents. To avoid confusion, don’t use the same display name for multiple conditions in the same policy.

property documentation

documentation?: pulumi.Input<AlertPolicyDocumentation>;

property enabled

enabled?: pulumi.Input<boolean>;

Whether or not the policy is enabled. The default is true.

property name

name?: pulumi.Input<string>;

property notificationChannels

notificationChannels?: pulumi.Input<pulumi.Input<string>[]>;

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property userLabels

userLabels?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

interface CustomServiceArgs

interface CustomServiceArgs

The set of arguments for constructing a CustomService resource.

property displayName

displayName?: pulumi.Input<string>;

Name used for UI elements listing this Service.

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property serviceId

serviceId?: pulumi.Input<string>;

An optional service ID to use. If not given, the server will generate a service ID.

property telemetry

telemetry?: pulumi.Input<CustomServiceTelemetry>;

Configuration for how to query telemetry on a Service. Structure is documented below.

interface CustomServiceState

interface CustomServiceState

Input properties used for looking up and filtering CustomService resources.

property displayName

displayName?: pulumi.Input<string>;

Name used for UI elements listing this Service.

property name

name?: pulumi.Input<string>;

The full resource name for this service. The syntax is: projects/[PROJECT_ID]/services/[SERVICE_ID].

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property serviceId

serviceId?: pulumi.Input<string>;

An optional service ID to use. If not given, the server will generate a service ID.

property telemetry

telemetry?: pulumi.Input<CustomServiceTelemetry>;

Configuration for how to query telemetry on a Service. Structure is documented below.

interface DashboardArgs

interface DashboardArgs

The set of arguments for constructing a Dashboard resource.

property dashboardJson

dashboardJson: pulumi.Input<string>;

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

interface DashboardState

interface DashboardState

Input properties used for looking up and filtering Dashboard resources.

property dashboardJson

dashboardJson?: pulumi.Input<string>;

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

interface GetAppEngineServiceArgs

interface GetAppEngineServiceArgs

A collection of arguments for invoking getAppEngineService.

property moduleId

moduleId: string;

The ID of the App Engine module underlying this service. Corresponds to the moduleId resource label in the gaeApp monitored resource, or the service/module name.

property project

project?: undefined | string;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

interface GetAppEngineServiceResult

interface GetAppEngineServiceResult

A collection of values returned by getAppEngineService.

property displayName

displayName: string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property moduleId

moduleId: string;

property name

name: string;

property project

project?: undefined | string;

property serviceId

serviceId: string;

property telemetries

telemetries: GetAppEngineServiceTelemetry[];

interface GetNotificationChannelArgs

interface GetNotificationChannelArgs

A collection of arguments for invoking getNotificationChannel.

property displayName

displayName?: undefined | string;

The display name for this notification channel.

property labels

labels?: undefined | {[key: string]: string};

Labels (corresponding to the NotificationChannelDescriptor schema) to filter the notification channels by.

property project

project?: undefined | string;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property type

type?: undefined | string;

The type of the notification channel.

property userLabels

userLabels?: undefined | {[key: string]: string};

User-provided key-value labels to filter by.

interface GetNotificationChannelResult

interface GetNotificationChannelResult

A collection of values returned by getNotificationChannel.

property description

description: string;

property displayName

displayName?: undefined | string;

property enabled

enabled: boolean;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property labels

labels?: undefined | {[key: string]: string};

property name

name: string;

property project

project?: undefined | string;

property sensitiveLabels

sensitiveLabels: GetNotificationChannelSensitiveLabel[];

property type

type?: undefined | string;

property userLabels

userLabels?: undefined | {[key: string]: string};

property verificationStatus

verificationStatus: string;

interface GetSecretVersionArgs

interface GetSecretVersionArgs

A collection of arguments for invoking getSecretVersion.

property project

project?: undefined | string;

The project to get the secret version for. If it is not provided, the provider project is used.

property secret

secret: string;

The secret to get the secret version for.

property version

version?: undefined | string;

The version of the secret to get. If it is not provided, the latest version is retrieved.

interface GetSecretVersionResult

interface GetSecretVersionResult

A collection of values returned by getSecretVersion.

property createTime

createTime: string;

The time at which the Secret was created.

property destroyTime

destroyTime: string;

The time at which the Secret was destroyed. Only present if state is DESTROYED.

property enabled

enabled: boolean;

True if the current state of the SecretVersion is enabled.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

The resource name of the SecretVersion. Format: projects/{{project}}/secrets/{{secret_id}}/versions/{{version}}

property project

project: string;

property secret

secret: string;

property secretData

secretData: string;

The secret data. No larger than 64KiB.

property version

version: string;

interface GetUptimeCheckIPsResult

interface GetUptimeCheckIPsResult

A collection of values returned by getUptimeCheckIPs.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property uptimeCheckIps

uptimeCheckIps: GetUptimeCheckIPsUptimeCheckIp[];

A list of uptime check IPs used by Stackdriver Monitoring. Each uptimeCheckIp contains:

interface GroupArgs

interface GroupArgs

The set of arguments for constructing a Group resource.

property displayName

displayName: pulumi.Input<string>;

A user-assigned name for this group, used only for display purposes.

property filter

filter: pulumi.Input<string>;

The filter used to determine which monitored resources belong to this group.

property isCluster

isCluster?: pulumi.Input<boolean>;

If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.

property parentName

parentName?: pulumi.Input<string>;

The name of the group’s parent, if it has one. The format is “projects/{project_id_or_number}/groups/{group_id}“. For groups with no parent, parentName is the empty string, “”.

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

interface GroupState

interface GroupState

Input properties used for looking up and filtering Group resources.

property displayName

displayName?: pulumi.Input<string>;

A user-assigned name for this group, used only for display purposes.

property filter

filter?: pulumi.Input<string>;

The filter used to determine which monitored resources belong to this group.

property isCluster

isCluster?: pulumi.Input<boolean>;

If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.

property name

name?: pulumi.Input<string>;

A unique identifier for this group. The format is “projects/{project_id_or_number}/groups/{group_id}“.

property parentName

parentName?: pulumi.Input<string>;

The name of the group’s parent, if it has one. The format is “projects/{project_id_or_number}/groups/{group_id}“. For groups with no parent, parentName is the empty string, “”.

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

interface NotificationChannelArgs

interface NotificationChannelArgs

The set of arguments for constructing a NotificationChannel resource.

property description

description?: pulumi.Input<string>;

property displayName

displayName?: pulumi.Input<string>;

property enabled

enabled?: pulumi.Input<boolean>;

property labels

labels?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property sensitiveLabels

sensitiveLabels?: pulumi.Input<NotificationChannelSensitiveLabels>;

property type

type: pulumi.Input<string>;

property userLabels

userLabels?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

interface NotificationChannelState

interface NotificationChannelState

Input properties used for looking up and filtering NotificationChannel resources.

property description

description?: pulumi.Input<string>;

property displayName

displayName?: pulumi.Input<string>;

property enabled

enabled?: pulumi.Input<boolean>;

property labels

labels?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

property name

name?: pulumi.Input<string>;

The full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation.

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property sensitiveLabels

sensitiveLabels?: pulumi.Input<NotificationChannelSensitiveLabels>;

property type

type?: pulumi.Input<string>;

property userLabels

userLabels?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

property verificationStatus

verificationStatus?: pulumi.Input<string>;

interface SloArgs

interface SloArgs

The set of arguments for constructing a Slo resource.

property basicSli

basicSli?: pulumi.Input<SloBasicSli>;

property calendarPeriod

calendarPeriod?: pulumi.Input<string>;

A calendar period, semantically “since the start of the current ”.

property displayName

displayName?: pulumi.Input<string>;

Name used for UI elements listing this SLO.

property goal

goal: pulumi.Input<number>;

The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.999

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property requestBasedSli

requestBasedSli?: pulumi.Input<SloRequestBasedSli>;

property rollingPeriodDays

rollingPeriodDays?: pulumi.Input<number>;

A rolling time period, semantically “in the past X days”. Must be between 1 to 30 days, inclusive.

property service

service: pulumi.Input<string>;

ID of the service to which this SLO belongs.

property sloId

sloId?: pulumi.Input<string>;

The id to use for this ServiceLevelObjective. If omitted, an id will be generated instead.

property windowsBasedSli

windowsBasedSli?: pulumi.Input<SloWindowsBasedSli>;

interface SloState

interface SloState

Input properties used for looking up and filtering Slo resources.

property basicSli

basicSli?: pulumi.Input<SloBasicSli>;

property calendarPeriod

calendarPeriod?: pulumi.Input<string>;

A calendar period, semantically “since the start of the current ”.

property displayName

displayName?: pulumi.Input<string>;

Name used for UI elements listing this SLO.

property goal

goal?: pulumi.Input<number>;

The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.999

property name

name?: pulumi.Input<string>;

The full resource name for this service. The syntax is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property requestBasedSli

requestBasedSli?: pulumi.Input<SloRequestBasedSli>;

property rollingPeriodDays

rollingPeriodDays?: pulumi.Input<number>;

A rolling time period, semantically “in the past X days”. Must be between 1 to 30 days, inclusive.

property service

service?: pulumi.Input<string>;

ID of the service to which this SLO belongs.

property sloId

sloId?: pulumi.Input<string>;

The id to use for this ServiceLevelObjective. If omitted, an id will be generated instead.

property windowsBasedSli

windowsBasedSli?: pulumi.Input<SloWindowsBasedSli>;

interface UptimeCheckConfigArgs

interface UptimeCheckConfigArgs

The set of arguments for constructing a UptimeCheckConfig resource.

property contentMatchers

contentMatchers?: pulumi.Input<pulumi.Input<UptimeCheckConfigContentMatcher>[]>;

property displayName

displayName: pulumi.Input<string>;

A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.

property httpCheck

httpCheck?: pulumi.Input<UptimeCheckConfigHttpCheck>;

Contains information needed to make an HTTP or HTTPS check. Structure is documented below.

property monitoredResource

monitoredResource?: pulumi.Input<UptimeCheckConfigMonitoredResource>;

property period

period?: pulumi.Input<string>;

How often, in seconds, the uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 300s.

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property resourceGroup

resourceGroup?: pulumi.Input<UptimeCheckConfigResourceGroup>;

The group resource associated with the configuration. Structure is documented below.

property selectedRegions

selectedRegions?: pulumi.Input<pulumi.Input<string>[]>;

property tcpCheck

tcpCheck?: pulumi.Input<UptimeCheckConfigTcpCheck>;

Contains information needed to make a TCP check. Structure is documented below.

property timeout

timeout: pulumi.Input<string>;

interface UptimeCheckConfigState

interface UptimeCheckConfigState

Input properties used for looking up and filtering UptimeCheckConfig resources.

property contentMatchers

contentMatchers?: pulumi.Input<pulumi.Input<UptimeCheckConfigContentMatcher>[]>;

property displayName

displayName?: pulumi.Input<string>;

A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.

property httpCheck

httpCheck?: pulumi.Input<UptimeCheckConfigHttpCheck>;

Contains information needed to make an HTTP or HTTPS check. Structure is documented below.

property monitoredResource

monitoredResource?: pulumi.Input<UptimeCheckConfigMonitoredResource>;

property name

name?: pulumi.Input<string>;

A unique resource name for this UptimeCheckConfig. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].

property period

period?: pulumi.Input<string>;

How often, in seconds, the uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 300s.

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property resourceGroup

resourceGroup?: pulumi.Input<UptimeCheckConfigResourceGroup>;

The group resource associated with the configuration. Structure is documented below.

property selectedRegions

selectedRegions?: pulumi.Input<pulumi.Input<string>[]>;

property tcpCheck

tcpCheck?: pulumi.Input<UptimeCheckConfigTcpCheck>;

Contains information needed to make a TCP check. Structure is documented below.

property timeout

timeout?: pulumi.Input<string>;

property uptimeCheckId

uptimeCheckId?: pulumi.Input<string>;

The id of the uptime check

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module monitoring

Resources

Functions

Others

Resources

Example Usage - Monitoring Alert Policy Basic

Example Usage - Monitoring Service Custom

Example Usage - Monitoring Dashboard Basic

Example Usage - Monitoring Dashboard GridLayout

Example Usage - Monitoring Group Basic

Example Usage - Monitoring Group Subgroup

Example Usage - Notification Channel Basic

Example Usage - Notification Channel Sensitive

Example Usage - Monitoring Slo Appengine

Example Usage - Uptime Check Config Http

Example Usage - Uptime Check Config Https

Example Usage - Uptime Check Tcp

Functions

Example Usage - Monitoring App Engine Service

Example Usage - Notification Channel Basic

Example Usage

Others