Cloud Monitoring Uptime Check Config

This table represents the Cloud Monitoring Uptime Check Config resource from Google Cloud Platform.

gcp.monitoring_uptime_check_config

Fields

TitleIDTypeData TypeDescription
_keycorestring
ancestorscorearray<string>
checker_typecorestringThe type of checkers to use to execute the Uptime check. Possible values: ['CHECKER_TYPE_UNSPECIFIED', 'STATIC_IP_CHECKERS', 'VPC_CHECKERS']. Values descriptions: ['The default checker type. Currently converted to STATIC_IP_CHECKERS on creation, the default conversion behavior may change in the future.', 'STATIC_IP_CHECKERS are used for uptime checks that perform egress across the public internet. STATIC_IP_CHECKERS use the static IP addresses returned by ListUptimeCheckIps.', 'VPC_CHECKERS are used for uptime checks that perform egress using Service Directory and private network access. When using VPC_CHECKERS, the monitored resource type must be servicedirectory_service.']
content_matcherscorejsonThe content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the content_matchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check.
datadog_display_namecorestring
gcp_display_namecorestringA human-friendly name for the Uptime check configuration. The display name should be unique within a Cloud Monitoring Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required.
http_checkcorejsonContains information needed to make an HTTP or HTTPS check.
internal_checkerscorejsonThe internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig.
is_internalcoreboolIf this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false.
labelscorearray<string>
monitored_resourcecorejsonThe monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are valid for this field: uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer k8s_service servicedirectory_service cloud_run_revision
namecorestringIdentifier. A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] [PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check.This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response.
organization_idcorestring
parentcorestring
periodcorestringHow 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 60s.
project_idcorestring
project_numbercorestring
resource_groupcorejsonThe group resource associated with the configuration.
resource_namecorestring
selected_regionscorearray<string>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 must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions.
synthetic_monitorcorejsonSpecifies a Synthetic Monitor to invoke.
tagscorehstore
tcp_checkcorejsonContains information needed to make a TCP check.
timeoutcorestringThe maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.
user_labelscorehstoreUser-supplied key/value data to be used for organizing and identifying the UptimeCheckConfig 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.