monitoring

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-gcp repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-google repo.

class pulumi_gcp.monitoring.AlertPolicy(resource_name, opts=None, combiner=None, conditions=None, display_name=None, documentation=None, enabled=None, labels=None, notification_channels=None, project=None, user_labels=None, __props__=None, __name__=None, __opts__=None)

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:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

The conditions object supports the following:

  • conditionAbsent (pulumi.Input[dict])

    • aggregations (pulumi.Input[list])

      • alignmentPeriod (pulumi.Input[str])

      • crossSeriesReducer (pulumi.Input[str])

      • groupByFields (pulumi.Input[list])

      • perSeriesAligner (pulumi.Input[str])

    • duration (pulumi.Input[str])

    • filter (pulumi.Input[str])

    • trigger (pulumi.Input[dict])

      • count (pulumi.Input[float])

      • percent (pulumi.Input[float])

  • conditionThreshold (pulumi.Input[dict])

    • aggregations (pulumi.Input[list])

      • alignmentPeriod (pulumi.Input[str])

      • crossSeriesReducer (pulumi.Input[str])

      • groupByFields (pulumi.Input[list])

      • perSeriesAligner (pulumi.Input[str])

    • comparison (pulumi.Input[str])

    • denominatorAggregations (pulumi.Input[list])

      • alignmentPeriod (pulumi.Input[str])

      • crossSeriesReducer (pulumi.Input[str])

      • groupByFields (pulumi.Input[list])

      • perSeriesAligner (pulumi.Input[str])

    • denominatorFilter (pulumi.Input[str])

    • duration (pulumi.Input[str])

    • filter (pulumi.Input[str])

    • thresholdValue (pulumi.Input[float])

    • trigger (pulumi.Input[dict])

      • count (pulumi.Input[float])

      • percent (pulumi.Input[float])

  • display_name (pulumi.Input[str])

  • name (pulumi.Input[str])

The documentation object supports the following:

  • content (pulumi.Input[str])

  • mimeType (pulumi.Input[str])

static get(resource_name, id, opts=None, combiner=None, conditions=None, creation_record=None, display_name=None, documentation=None, enabled=None, labels=None, name=None, notification_channels=None, project=None, user_labels=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

The conditions object supports the following:

  • conditionAbsent (pulumi.Input[dict])

    • aggregations (pulumi.Input[list])

      • alignmentPeriod (pulumi.Input[str])

      • crossSeriesReducer (pulumi.Input[str])

      • groupByFields (pulumi.Input[list])

      • perSeriesAligner (pulumi.Input[str])

    • duration (pulumi.Input[str])

    • filter (pulumi.Input[str])

    • trigger (pulumi.Input[dict])

      • count (pulumi.Input[float])

      • percent (pulumi.Input[float])

  • conditionThreshold (pulumi.Input[dict])

    • aggregations (pulumi.Input[list])

      • alignmentPeriod (pulumi.Input[str])

      • crossSeriesReducer (pulumi.Input[str])

      • groupByFields (pulumi.Input[list])

      • perSeriesAligner (pulumi.Input[str])

    • comparison (pulumi.Input[str])

    • denominatorAggregations (pulumi.Input[list])

      • alignmentPeriod (pulumi.Input[str])

      • crossSeriesReducer (pulumi.Input[str])

      • groupByFields (pulumi.Input[list])

      • perSeriesAligner (pulumi.Input[str])

    • denominatorFilter (pulumi.Input[str])

    • duration (pulumi.Input[str])

    • filter (pulumi.Input[str])

    • thresholdValue (pulumi.Input[float])

    • trigger (pulumi.Input[dict])

      • count (pulumi.Input[float])

      • percent (pulumi.Input[float])

  • display_name (pulumi.Input[str])

  • name (pulumi.Input[str])

The creation_record object supports the following:

  • mutateTime (pulumi.Input[str])

  • mutatedBy (pulumi.Input[str])

The documentation object supports the following:

  • content (pulumi.Input[str])

  • mimeType (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.monitoring.Group(resource_name, opts=None, display_name=None, filter=None, is_cluster=None, parent_name=None, project=None, __props__=None, __name__=None, __opts__=None)

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:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

project = None

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

static get(resource_name, id, opts=None, display_name=None, filter=None, is_cluster=None, name=None, parent_name=None, project=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.monitoring.NotificationChannel(resource_name, opts=None, description=None, display_name=None, enabled=None, labels=None, project=None, type=None, user_labels=None, __props__=None, __name__=None, __opts__=None)

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 requried for another. Due to these loose constraints it’s often best to set up a channel through the UI and import 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 programatically 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:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

project = None

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

static get(resource_name, id, opts=None, description=None, display_name=None, enabled=None, labels=None, name=None, project=None, type=None, user_labels=None, verification_status=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.monitoring.UptimeCheckConfig(resource_name, opts=None, content_matchers=None, display_name=None, http_check=None, internal_checkers=None, is_internal=None, monitored_resource=None, period=None, project=None, resource_group=None, selected_regions=None, tcp_check=None, timeout=None, __props__=None, __name__=None, __opts__=None)

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

To get more information about UptimeCheckConfig, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The content_matchers object supports the following:

  • content (pulumi.Input[str])

The http_check object supports the following:

  • authInfo (pulumi.Input[dict])

    • password (pulumi.Input[str])

    • username (pulumi.Input[str])

  • headers (pulumi.Input[dict])

  • maskHeaders (pulumi.Input[bool])

  • path (pulumi.Input[str])

  • port (pulumi.Input[float])

  • useSsl (pulumi.Input[bool])

The internal_checkers object supports the following:

  • display_name (pulumi.Input[str])

  • gcpZone (pulumi.Input[str])

  • name (pulumi.Input[str])

  • network (pulumi.Input[str])

  • peerProjectId (pulumi.Input[str])

The monitored_resource object supports the following:

  • labels (pulumi.Input[dict])

  • type (pulumi.Input[str])

The resource_group object supports the following:

  • groupId (pulumi.Input[str])

  • resourceType (pulumi.Input[str])

The tcp_check object supports the following:

  • port (pulumi.Input[float])

project = None

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

static get(resource_name, id, opts=None, content_matchers=None, display_name=None, http_check=None, internal_checkers=None, is_internal=None, monitored_resource=None, name=None, period=None, project=None, resource_group=None, selected_regions=None, tcp_check=None, timeout=None, uptime_check_id=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The content_matchers object supports the following:

  • content (pulumi.Input[str])

The http_check object supports the following:

  • authInfo (pulumi.Input[dict])

    • password (pulumi.Input[str])

    • username (pulumi.Input[str])

  • headers (pulumi.Input[dict])

  • maskHeaders (pulumi.Input[bool])

  • path (pulumi.Input[str])

  • port (pulumi.Input[float])

  • useSsl (pulumi.Input[bool])

The internal_checkers object supports the following:

  • display_name (pulumi.Input[str])

  • gcpZone (pulumi.Input[str])

  • name (pulumi.Input[str])

  • network (pulumi.Input[str])

  • peerProjectId (pulumi.Input[str])

The monitored_resource object supports the following:

  • labels (pulumi.Input[dict])

  • type (pulumi.Input[str])

The resource_group object supports the following:

  • groupId (pulumi.Input[str])

  • resourceType (pulumi.Input[str])

The tcp_check object supports the following:

  • port (pulumi.Input[float])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str