gcp.monitoring.UptimeCheckConfig
Explore with Pulumi AI
This message configures which resources and services to monitor for availability.
To get more information about UptimeCheckConfig, see:
- API documentation
- How-to Guides
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", {
displayName: "http-uptime-check",
timeout: "60s",
userLabels: {
"example-key": "example-value",
},
httpCheck: {
path: "some-path",
port: 8010,
requestMethod: "POST",
contentType: "USER_PROVIDED",
customContentType: "application/json",
body: "Zm9vJTI1M0RiYXI=",
pingConfig: {
pingsCount: 1,
},
},
monitoredResource: {
type: "uptime_url",
labels: {
project_id: "my-project-name",
host: "192.168.1.1",
},
},
contentMatchers: [{
content: "\"example\"",
matcher: "MATCHES_JSON_PATH",
jsonPathMatcher: {
jsonPath: "$.path",
jsonMatcher: "EXACT_MATCH",
},
}],
checkerType: "STATIC_IP_CHECKERS",
});
import pulumi
import pulumi_gcp as gcp
http = gcp.monitoring.UptimeCheckConfig("http",
display_name="http-uptime-check",
timeout="60s",
user_labels={
"example-key": "example-value",
},
http_check={
"path": "some-path",
"port": 8010,
"request_method": "POST",
"content_type": "USER_PROVIDED",
"custom_content_type": "application/json",
"body": "Zm9vJTI1M0RiYXI=",
"ping_config": {
"pings_count": 1,
},
},
monitored_resource={
"type": "uptime_url",
"labels": {
"project_id": "my-project-name",
"host": "192.168.1.1",
},
},
content_matchers=[{
"content": "\"example\"",
"matcher": "MATCHES_JSON_PATH",
"json_path_matcher": {
"json_path": "$.path",
"json_matcher": "EXACT_MATCH",
},
}],
checker_type="STATIC_IP_CHECKERS")
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/monitoring"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := monitoring.NewUptimeCheckConfig(ctx, "http", &monitoring.UptimeCheckConfigArgs{
DisplayName: pulumi.String("http-uptime-check"),
Timeout: pulumi.String("60s"),
UserLabels: pulumi.StringMap{
"example-key": pulumi.String("example-value"),
},
HttpCheck: &monitoring.UptimeCheckConfigHttpCheckArgs{
Path: pulumi.String("some-path"),
Port: pulumi.Int(8010),
RequestMethod: pulumi.String("POST"),
ContentType: pulumi.String("USER_PROVIDED"),
CustomContentType: pulumi.String("application/json"),
Body: pulumi.String("Zm9vJTI1M0RiYXI="),
PingConfig: &monitoring.UptimeCheckConfigHttpCheckPingConfigArgs{
PingsCount: pulumi.Int(1),
},
},
MonitoredResource: &monitoring.UptimeCheckConfigMonitoredResourceArgs{
Type: pulumi.String("uptime_url"),
Labels: pulumi.StringMap{
"project_id": pulumi.String("my-project-name"),
"host": pulumi.String("192.168.1.1"),
},
},
ContentMatchers: monitoring.UptimeCheckConfigContentMatcherArray{
&monitoring.UptimeCheckConfigContentMatcherArgs{
Content: pulumi.String("\"example\""),
Matcher: pulumi.String("MATCHES_JSON_PATH"),
JsonPathMatcher: &monitoring.UptimeCheckConfigContentMatcherJsonPathMatcherArgs{
JsonPath: pulumi.String("$.path"),
JsonMatcher: pulumi.String("EXACT_MATCH"),
},
},
},
CheckerType: pulumi.String("STATIC_IP_CHECKERS"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var http = new Gcp.Monitoring.UptimeCheckConfig("http", new()
{
DisplayName = "http-uptime-check",
Timeout = "60s",
UserLabels =
{
{ "example-key", "example-value" },
},
HttpCheck = new Gcp.Monitoring.Inputs.UptimeCheckConfigHttpCheckArgs
{
Path = "some-path",
Port = 8010,
RequestMethod = "POST",
ContentType = "USER_PROVIDED",
CustomContentType = "application/json",
Body = "Zm9vJTI1M0RiYXI=",
PingConfig = new Gcp.Monitoring.Inputs.UptimeCheckConfigHttpCheckPingConfigArgs
{
PingsCount = 1,
},
},
MonitoredResource = new Gcp.Monitoring.Inputs.UptimeCheckConfigMonitoredResourceArgs
{
Type = "uptime_url",
Labels =
{
{ "project_id", "my-project-name" },
{ "host", "192.168.1.1" },
},
},
ContentMatchers = new[]
{
new Gcp.Monitoring.Inputs.UptimeCheckConfigContentMatcherArgs
{
Content = "\"example\"",
Matcher = "MATCHES_JSON_PATH",
JsonPathMatcher = new Gcp.Monitoring.Inputs.UptimeCheckConfigContentMatcherJsonPathMatcherArgs
{
JsonPath = "$.path",
JsonMatcher = "EXACT_MATCH",
},
},
},
CheckerType = "STATIC_IP_CHECKERS",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.monitoring.UptimeCheckConfig;
import com.pulumi.gcp.monitoring.UptimeCheckConfigArgs;
import com.pulumi.gcp.monitoring.inputs.UptimeCheckConfigHttpCheckArgs;
import com.pulumi.gcp.monitoring.inputs.UptimeCheckConfigHttpCheckPingConfigArgs;
import com.pulumi.gcp.monitoring.inputs.UptimeCheckConfigMonitoredResourceArgs;
import com.pulumi.gcp.monitoring.inputs.UptimeCheckConfigContentMatcherArgs;
import com.pulumi.gcp.monitoring.inputs.UptimeCheckConfigContentMatcherJsonPathMatcherArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var http = new UptimeCheckConfig("http", UptimeCheckConfigArgs.builder()
.displayName("http-uptime-check")
.timeout("60s")
.userLabels(Map.of("example-key", "example-value"))
.httpCheck(UptimeCheckConfigHttpCheckArgs.builder()
.path("some-path")
.port("8010")
.requestMethod("POST")
.contentType("USER_PROVIDED")
.customContentType("application/json")
.body("Zm9vJTI1M0RiYXI=")
.pingConfig(UptimeCheckConfigHttpCheckPingConfigArgs.builder()
.pingsCount(1)
.build())
.build())
.monitoredResource(UptimeCheckConfigMonitoredResourceArgs.builder()
.type("uptime_url")
.labels(Map.ofEntries(
Map.entry("project_id", "my-project-name"),
Map.entry("host", "192.168.1.1")
))
.build())
.contentMatchers(UptimeCheckConfigContentMatcherArgs.builder()
.content("\"example\"")
.matcher("MATCHES_JSON_PATH")
.jsonPathMatcher(UptimeCheckConfigContentMatcherJsonPathMatcherArgs.builder()
.jsonPath("$.path")
.jsonMatcher("EXACT_MATCH")
.build())
.build())
.checkerType("STATIC_IP_CHECKERS")
.build());
}
}
resources:
http:
type: gcp:monitoring:UptimeCheckConfig
properties:
displayName: http-uptime-check
timeout: 60s
userLabels:
example-key: example-value
httpCheck:
path: some-path
port: '8010'
requestMethod: POST
contentType: USER_PROVIDED
customContentType: application/json
body: Zm9vJTI1M0RiYXI=
pingConfig:
pingsCount: 1
monitoredResource:
type: uptime_url
labels:
project_id: my-project-name
host: 192.168.1.1
contentMatchers:
- content: '"example"'
matcher: MATCHES_JSON_PATH
jsonPathMatcher:
jsonPath: $.path
jsonMatcher: EXACT_MATCH
checkerType: STATIC_IP_CHECKERS
Uptime Check Config Status Code
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const statusCode = new gcp.monitoring.UptimeCheckConfig("status_code", {
displayName: "http-uptime-check",
timeout: "60s",
httpCheck: {
path: "some-path",
port: 8010,
requestMethod: "POST",
contentType: "URL_ENCODED",
body: "Zm9vJTI1M0RiYXI=",
acceptedResponseStatusCodes: [
{
statusClass: "STATUS_CLASS_2XX",
},
{
statusValue: 301,
},
{
statusValue: 302,
},
],
},
monitoredResource: {
type: "uptime_url",
labels: {
project_id: "my-project-name",
host: "192.168.1.1",
},
},
contentMatchers: [{
content: "\"example\"",
matcher: "MATCHES_JSON_PATH",
jsonPathMatcher: {
jsonPath: "$.path",
jsonMatcher: "EXACT_MATCH",
},
}],
checkerType: "STATIC_IP_CHECKERS",
});
import pulumi
import pulumi_gcp as gcp
status_code = gcp.monitoring.UptimeCheckConfig("status_code",
display_name="http-uptime-check",
timeout="60s",
http_check={
"path": "some-path",
"port": 8010,
"request_method": "POST",
"content_type": "URL_ENCODED",
"body": "Zm9vJTI1M0RiYXI=",
"accepted_response_status_codes": [
{
"status_class": "STATUS_CLASS_2XX",
},
{
"status_value": 301,
},
{
"status_value": 302,
},
],
},
monitored_resource={
"type": "uptime_url",
"labels": {
"project_id": "my-project-name",
"host": "192.168.1.1",
},
},
content_matchers=[{
"content": "\"example\"",
"matcher": "MATCHES_JSON_PATH",
"json_path_matcher": {
"json_path": "$.path",
"json_matcher": "EXACT_MATCH",
},
}],
checker_type="STATIC_IP_CHECKERS")
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/monitoring"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := monitoring.NewUptimeCheckConfig(ctx, "status_code", &monitoring.UptimeCheckConfigArgs{
DisplayName: pulumi.String("http-uptime-check"),
Timeout: pulumi.String("60s"),
HttpCheck: &monitoring.UptimeCheckConfigHttpCheckArgs{
Path: pulumi.String("some-path"),
Port: pulumi.Int(8010),
RequestMethod: pulumi.String("POST"),
ContentType: pulumi.String("URL_ENCODED"),
Body: pulumi.String("Zm9vJTI1M0RiYXI="),
AcceptedResponseStatusCodes: monitoring.UptimeCheckConfigHttpCheckAcceptedResponseStatusCodeArray{
&monitoring.UptimeCheckConfigHttpCheckAcceptedResponseStatusCodeArgs{
StatusClass: pulumi.String("STATUS_CLASS_2XX"),
},
&monitoring.UptimeCheckConfigHttpCheckAcceptedResponseStatusCodeArgs{
StatusValue: pulumi.Int(301),
},
&monitoring.UptimeCheckConfigHttpCheckAcceptedResponseStatusCodeArgs{
StatusValue: pulumi.Int(302),
},
},
},
MonitoredResource: &monitoring.UptimeCheckConfigMonitoredResourceArgs{
Type: pulumi.String("uptime_url"),
Labels: pulumi.StringMap{
"project_id": pulumi.String("my-project-name"),
"host": pulumi.String("192.168.1.1"),
},
},
ContentMatchers: monitoring.UptimeCheckConfigContentMatcherArray{
&monitoring.UptimeCheckConfigContentMatcherArgs{
Content: pulumi.String("\"example\""),
Matcher: pulumi.String("MATCHES_JSON_PATH"),
JsonPathMatcher: &monitoring.UptimeCheckConfigContentMatcherJsonPathMatcherArgs{
JsonPath: pulumi.String("$.path"),
JsonMatcher: pulumi.String("EXACT_MATCH"),
},
},
},
CheckerType: pulumi.String("STATIC_IP_CHECKERS"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var statusCode = new Gcp.Monitoring.UptimeCheckConfig("status_code", new()
{
DisplayName = "http-uptime-check",
Timeout = "60s",
HttpCheck = new Gcp.Monitoring.Inputs.UptimeCheckConfigHttpCheckArgs
{
Path = "some-path",
Port = 8010,
RequestMethod = "POST",
ContentType = "URL_ENCODED",
Body = "Zm9vJTI1M0RiYXI=",
AcceptedResponseStatusCodes = new[]
{
new Gcp.Monitoring.Inputs.UptimeCheckConfigHttpCheckAcceptedResponseStatusCodeArgs
{
StatusClass = "STATUS_CLASS_2XX",
},
new Gcp.Monitoring.Inputs.UptimeCheckConfigHttpCheckAcceptedResponseStatusCodeArgs
{
StatusValue = 301,
},
new Gcp.Monitoring.Inputs.UptimeCheckConfigHttpCheckAcceptedResponseStatusCodeArgs
{
StatusValue = 302,
},
},
},
MonitoredResource = new Gcp.Monitoring.Inputs.UptimeCheckConfigMonitoredResourceArgs
{
Type = "uptime_url",
Labels =
{
{ "project_id", "my-project-name" },
{ "host", "192.168.1.1" },
},
},
ContentMatchers = new[]
{
new Gcp.Monitoring.Inputs.UptimeCheckConfigContentMatcherArgs
{
Content = "\"example\"",
Matcher = "MATCHES_JSON_PATH",
JsonPathMatcher = new Gcp.Monitoring.Inputs.UptimeCheckConfigContentMatcherJsonPathMatcherArgs
{
JsonPath = "$.path",
JsonMatcher = "EXACT_MATCH",
},
},
},
CheckerType = "STATIC_IP_CHECKERS",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.monitoring.UptimeCheckConfig;
import com.pulumi.gcp.monitoring.UptimeCheckConfigArgs;
import com.pulumi.gcp.monitoring.inputs.UptimeCheckConfigHttpCheckArgs;
import com.pulumi.gcp.monitoring.inputs.UptimeCheckConfigMonitoredResourceArgs;
import com.pulumi.gcp.monitoring.inputs.UptimeCheckConfigContentMatcherArgs;
import com.pulumi.gcp.monitoring.inputs.UptimeCheckConfigContentMatcherJsonPathMatcherArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var statusCode = new UptimeCheckConfig("statusCode", UptimeCheckConfigArgs.builder()
.displayName("http-uptime-check")
.timeout("60s")
.httpCheck(UptimeCheckConfigHttpCheckArgs.builder()
.path("some-path")
.port("8010")
.requestMethod("POST")
.contentType("URL_ENCODED")
.body("Zm9vJTI1M0RiYXI=")
.acceptedResponseStatusCodes(
UptimeCheckConfigHttpCheckAcceptedResponseStatusCodeArgs.builder()
.statusClass("STATUS_CLASS_2XX")
.build(),
UptimeCheckConfigHttpCheckAcceptedResponseStatusCodeArgs.builder()
.statusValue(301)
.build(),
UptimeCheckConfigHttpCheckAcceptedResponseStatusCodeArgs.builder()
.statusValue(302)
.build())
.build())
.monitoredResource(UptimeCheckConfigMonitoredResourceArgs.builder()
.type("uptime_url")
.labels(Map.ofEntries(
Map.entry("project_id", "my-project-name"),
Map.entry("host", "192.168.1.1")
))
.build())
.contentMatchers(UptimeCheckConfigContentMatcherArgs.builder()
.content("\"example\"")
.matcher("MATCHES_JSON_PATH")
.jsonPathMatcher(UptimeCheckConfigContentMatcherJsonPathMatcherArgs.builder()
.jsonPath("$.path")
.jsonMatcher("EXACT_MATCH")
.build())
.build())
.checkerType("STATIC_IP_CHECKERS")
.build());
}
}
resources:
statusCode:
type: gcp:monitoring:UptimeCheckConfig
name: status_code
properties:
displayName: http-uptime-check
timeout: 60s
httpCheck:
path: some-path
port: '8010'
requestMethod: POST
contentType: URL_ENCODED
body: Zm9vJTI1M0RiYXI=
acceptedResponseStatusCodes:
- statusClass: STATUS_CLASS_2XX
- statusValue: 301
- statusValue: 302
monitoredResource:
type: uptime_url
labels:
project_id: my-project-name
host: 192.168.1.1
contentMatchers:
- content: '"example"'
matcher: MATCHES_JSON_PATH
jsonPathMatcher:
jsonPath: $.path
jsonMatcher: EXACT_MATCH
checkerType: STATIC_IP_CHECKERS
Uptime Check Config Https
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const https = new gcp.monitoring.UptimeCheckConfig("https", {
displayName: "https-uptime-check",
timeout: "60s",
httpCheck: {
path: "/some-path",
port: 443,
useSsl: true,
validateSsl: true,
serviceAgentAuthentication: {
type: "OIDC_TOKEN",
},
},
monitoredResource: {
type: "uptime_url",
labels: {
project_id: "my-project-name",
host: "192.168.1.1",
},
},
contentMatchers: [{
content: "example",
matcher: "MATCHES_JSON_PATH",
jsonPathMatcher: {
jsonPath: "$.path",
jsonMatcher: "REGEX_MATCH",
},
}],
});
import pulumi
import pulumi_gcp as gcp
https = gcp.monitoring.UptimeCheckConfig("https",
display_name="https-uptime-check",
timeout="60s",
http_check={
"path": "/some-path",
"port": 443,
"use_ssl": True,
"validate_ssl": True,
"service_agent_authentication": {
"type": "OIDC_TOKEN",
},
},
monitored_resource={
"type": "uptime_url",
"labels": {
"project_id": "my-project-name",
"host": "192.168.1.1",
},
},
content_matchers=[{
"content": "example",
"matcher": "MATCHES_JSON_PATH",
"json_path_matcher": {
"json_path": "$.path",
"json_matcher": "REGEX_MATCH",
},
}])
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/monitoring"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := monitoring.NewUptimeCheckConfig(ctx, "https", &monitoring.UptimeCheckConfigArgs{
DisplayName: pulumi.String("https-uptime-check"),
Timeout: pulumi.String("60s"),
HttpCheck: &monitoring.UptimeCheckConfigHttpCheckArgs{
Path: pulumi.String("/some-path"),
Port: pulumi.Int(443),
UseSsl: pulumi.Bool(true),
ValidateSsl: pulumi.Bool(true),
ServiceAgentAuthentication: &monitoring.UptimeCheckConfigHttpCheckServiceAgentAuthenticationArgs{
Type: pulumi.String("OIDC_TOKEN"),
},
},
MonitoredResource: &monitoring.UptimeCheckConfigMonitoredResourceArgs{
Type: pulumi.String("uptime_url"),
Labels: pulumi.StringMap{
"project_id": pulumi.String("my-project-name"),
"host": pulumi.String("192.168.1.1"),
},
},
ContentMatchers: monitoring.UptimeCheckConfigContentMatcherArray{
&monitoring.UptimeCheckConfigContentMatcherArgs{
Content: pulumi.String("example"),
Matcher: pulumi.String("MATCHES_JSON_PATH"),
JsonPathMatcher: &monitoring.UptimeCheckConfigContentMatcherJsonPathMatcherArgs{
JsonPath: pulumi.String("$.path"),
JsonMatcher: pulumi.String("REGEX_MATCH"),
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var https = new Gcp.Monitoring.UptimeCheckConfig("https", new()
{
DisplayName = "https-uptime-check",
Timeout = "60s",
HttpCheck = new Gcp.Monitoring.Inputs.UptimeCheckConfigHttpCheckArgs
{
Path = "/some-path",
Port = 443,
UseSsl = true,
ValidateSsl = true,
ServiceAgentAuthentication = new Gcp.Monitoring.Inputs.UptimeCheckConfigHttpCheckServiceAgentAuthenticationArgs
{
Type = "OIDC_TOKEN",
},
},
MonitoredResource = new Gcp.Monitoring.Inputs.UptimeCheckConfigMonitoredResourceArgs
{
Type = "uptime_url",
Labels =
{
{ "project_id", "my-project-name" },
{ "host", "192.168.1.1" },
},
},
ContentMatchers = new[]
{
new Gcp.Monitoring.Inputs.UptimeCheckConfigContentMatcherArgs
{
Content = "example",
Matcher = "MATCHES_JSON_PATH",
JsonPathMatcher = new Gcp.Monitoring.Inputs.UptimeCheckConfigContentMatcherJsonPathMatcherArgs
{
JsonPath = "$.path",
JsonMatcher = "REGEX_MATCH",
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.monitoring.UptimeCheckConfig;
import com.pulumi.gcp.monitoring.UptimeCheckConfigArgs;
import com.pulumi.gcp.monitoring.inputs.UptimeCheckConfigHttpCheckArgs;
import com.pulumi.gcp.monitoring.inputs.UptimeCheckConfigHttpCheckServiceAgentAuthenticationArgs;
import com.pulumi.gcp.monitoring.inputs.UptimeCheckConfigMonitoredResourceArgs;
import com.pulumi.gcp.monitoring.inputs.UptimeCheckConfigContentMatcherArgs;
import com.pulumi.gcp.monitoring.inputs.UptimeCheckConfigContentMatcherJsonPathMatcherArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var https = new UptimeCheckConfig("https", UptimeCheckConfigArgs.builder()
.displayName("https-uptime-check")
.timeout("60s")
.httpCheck(UptimeCheckConfigHttpCheckArgs.builder()
.path("/some-path")
.port("443")
.useSsl(true)
.validateSsl(true)
.serviceAgentAuthentication(UptimeCheckConfigHttpCheckServiceAgentAuthenticationArgs.builder()
.type("OIDC_TOKEN")
.build())
.build())
.monitoredResource(UptimeCheckConfigMonitoredResourceArgs.builder()
.type("uptime_url")
.labels(Map.ofEntries(
Map.entry("project_id", "my-project-name"),
Map.entry("host", "192.168.1.1")
))
.build())
.contentMatchers(UptimeCheckConfigContentMatcherArgs.builder()
.content("example")
.matcher("MATCHES_JSON_PATH")
.jsonPathMatcher(UptimeCheckConfigContentMatcherJsonPathMatcherArgs.builder()
.jsonPath("$.path")
.jsonMatcher("REGEX_MATCH")
.build())
.build())
.build());
}
}
resources:
https:
type: gcp:monitoring:UptimeCheckConfig
properties:
displayName: https-uptime-check
timeout: 60s
httpCheck:
path: /some-path
port: '443'
useSsl: true
validateSsl: true
serviceAgentAuthentication:
type: OIDC_TOKEN
monitoredResource:
type: uptime_url
labels:
project_id: my-project-name
host: 192.168.1.1
contentMatchers:
- content: example
matcher: MATCHES_JSON_PATH
jsonPathMatcher:
jsonPath: $.path
jsonMatcher: REGEX_MATCH
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("tcp_group", {
displayName: "tcp-uptime-check",
timeout: "60s",
tcpCheck: {
port: 888,
pingConfig: {
pingsCount: 2,
},
},
resourceGroup: {
resourceType: "INSTANCE",
groupId: check.name,
},
});
import pulumi
import pulumi_gcp as gcp
check = gcp.monitoring.Group("check",
display_name="uptime-check-group",
filter="resource.metadata.name=has_substring(\"foo\")")
tcp_group = gcp.monitoring.UptimeCheckConfig("tcp_group",
display_name="tcp-uptime-check",
timeout="60s",
tcp_check={
"port": 888,
"ping_config": {
"pings_count": 2,
},
},
resource_group={
"resource_type": "INSTANCE",
"group_id": check.name,
})
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/monitoring"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
check, err := monitoring.NewGroup(ctx, "check", &monitoring.GroupArgs{
DisplayName: pulumi.String("uptime-check-group"),
Filter: pulumi.String("resource.metadata.name=has_substring(\"foo\")"),
})
if err != nil {
return err
}
_, err = monitoring.NewUptimeCheckConfig(ctx, "tcp_group", &monitoring.UptimeCheckConfigArgs{
DisplayName: pulumi.String("tcp-uptime-check"),
Timeout: pulumi.String("60s"),
TcpCheck: &monitoring.UptimeCheckConfigTcpCheckArgs{
Port: pulumi.Int(888),
PingConfig: &monitoring.UptimeCheckConfigTcpCheckPingConfigArgs{
PingsCount: pulumi.Int(2),
},
},
ResourceGroup: &monitoring.UptimeCheckConfigResourceGroupArgs{
ResourceType: pulumi.String("INSTANCE"),
GroupId: check.Name,
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var check = new Gcp.Monitoring.Group("check", new()
{
DisplayName = "uptime-check-group",
Filter = "resource.metadata.name=has_substring(\"foo\")",
});
var tcpGroup = new Gcp.Monitoring.UptimeCheckConfig("tcp_group", new()
{
DisplayName = "tcp-uptime-check",
Timeout = "60s",
TcpCheck = new Gcp.Monitoring.Inputs.UptimeCheckConfigTcpCheckArgs
{
Port = 888,
PingConfig = new Gcp.Monitoring.Inputs.UptimeCheckConfigTcpCheckPingConfigArgs
{
PingsCount = 2,
},
},
ResourceGroup = new Gcp.Monitoring.Inputs.UptimeCheckConfigResourceGroupArgs
{
ResourceType = "INSTANCE",
GroupId = check.Name,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.monitoring.Group;
import com.pulumi.gcp.monitoring.GroupArgs;
import com.pulumi.gcp.monitoring.UptimeCheckConfig;
import com.pulumi.gcp.monitoring.UptimeCheckConfigArgs;
import com.pulumi.gcp.monitoring.inputs.UptimeCheckConfigTcpCheckArgs;
import com.pulumi.gcp.monitoring.inputs.UptimeCheckConfigTcpCheckPingConfigArgs;
import com.pulumi.gcp.monitoring.inputs.UptimeCheckConfigResourceGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var check = new Group("check", GroupArgs.builder()
.displayName("uptime-check-group")
.filter("resource.metadata.name=has_substring(\"foo\")")
.build());
var tcpGroup = new UptimeCheckConfig("tcpGroup", UptimeCheckConfigArgs.builder()
.displayName("tcp-uptime-check")
.timeout("60s")
.tcpCheck(UptimeCheckConfigTcpCheckArgs.builder()
.port(888)
.pingConfig(UptimeCheckConfigTcpCheckPingConfigArgs.builder()
.pingsCount(2)
.build())
.build())
.resourceGroup(UptimeCheckConfigResourceGroupArgs.builder()
.resourceType("INSTANCE")
.groupId(check.name())
.build())
.build());
}
}
resources:
tcpGroup:
type: gcp:monitoring:UptimeCheckConfig
name: tcp_group
properties:
displayName: tcp-uptime-check
timeout: 60s
tcpCheck:
port: 888
pingConfig:
pingsCount: 2
resourceGroup:
resourceType: INSTANCE
groupId: ${check.name}
check:
type: gcp:monitoring:Group
properties:
displayName: uptime-check-group
filter: resource.metadata.name=has_substring("foo")
Uptime Check Config Synthetic Monitor
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const bucket = new gcp.storage.Bucket("bucket", {
name: "my-project-name-gcf-source",
location: "US",
uniformBucketLevelAccess: true,
});
const object = new gcp.storage.BucketObject("object", {
name: "function-source.zip",
bucket: bucket.name,
source: new pulumi.asset.FileAsset("synthetic-fn-source.zip"),
});
const _function = new gcp.cloudfunctionsv2.Function("function", {
name: "synthetic_function",
location: "us-central1",
buildConfig: {
runtime: "nodejs16",
entryPoint: "SyntheticFunction",
source: {
storageSource: {
bucket: bucket.name,
object: object.name,
},
},
},
serviceConfig: {
maxInstanceCount: 1,
availableMemory: "256M",
timeoutSeconds: 60,
},
});
const syntheticMonitor = new gcp.monitoring.UptimeCheckConfig("synthetic_monitor", {
displayName: "synthetic_monitor",
timeout: "60s",
syntheticMonitor: {
cloudFunctionV2: {
name: _function.id,
},
},
});
import pulumi
import pulumi_gcp as gcp
bucket = gcp.storage.Bucket("bucket",
name="my-project-name-gcf-source",
location="US",
uniform_bucket_level_access=True)
object = gcp.storage.BucketObject("object",
name="function-source.zip",
bucket=bucket.name,
source=pulumi.FileAsset("synthetic-fn-source.zip"))
function = gcp.cloudfunctionsv2.Function("function",
name="synthetic_function",
location="us-central1",
build_config={
"runtime": "nodejs16",
"entry_point": "SyntheticFunction",
"source": {
"storage_source": {
"bucket": bucket.name,
"object": object.name,
},
},
},
service_config={
"max_instance_count": 1,
"available_memory": "256M",
"timeout_seconds": 60,
})
synthetic_monitor = gcp.monitoring.UptimeCheckConfig("synthetic_monitor",
display_name="synthetic_monitor",
timeout="60s",
synthetic_monitor={
"cloud_function_v2": {
"name": function.id,
},
})
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/cloudfunctionsv2"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/monitoring"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/storage"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
bucket, err := storage.NewBucket(ctx, "bucket", &storage.BucketArgs{
Name: pulumi.String("my-project-name-gcf-source"),
Location: pulumi.String("US"),
UniformBucketLevelAccess: pulumi.Bool(true),
})
if err != nil {
return err
}
object, err := storage.NewBucketObject(ctx, "object", &storage.BucketObjectArgs{
Name: pulumi.String("function-source.zip"),
Bucket: bucket.Name,
Source: pulumi.NewFileAsset("synthetic-fn-source.zip"),
})
if err != nil {
return err
}
function, err := cloudfunctionsv2.NewFunction(ctx, "function", &cloudfunctionsv2.FunctionArgs{
Name: pulumi.String("synthetic_function"),
Location: pulumi.String("us-central1"),
BuildConfig: &cloudfunctionsv2.FunctionBuildConfigArgs{
Runtime: pulumi.String("nodejs16"),
EntryPoint: pulumi.String("SyntheticFunction"),
Source: &cloudfunctionsv2.FunctionBuildConfigSourceArgs{
StorageSource: &cloudfunctionsv2.FunctionBuildConfigSourceStorageSourceArgs{
Bucket: bucket.Name,
Object: object.Name,
},
},
},
ServiceConfig: &cloudfunctionsv2.FunctionServiceConfigArgs{
MaxInstanceCount: pulumi.Int(1),
AvailableMemory: pulumi.String("256M"),
TimeoutSeconds: pulumi.Int(60),
},
})
if err != nil {
return err
}
_, err = monitoring.NewUptimeCheckConfig(ctx, "synthetic_monitor", &monitoring.UptimeCheckConfigArgs{
DisplayName: pulumi.String("synthetic_monitor"),
Timeout: pulumi.String("60s"),
SyntheticMonitor: &monitoring.UptimeCheckConfigSyntheticMonitorArgs{
CloudFunctionV2: &monitoring.UptimeCheckConfigSyntheticMonitorCloudFunctionV2Args{
Name: function.ID(),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var bucket = new Gcp.Storage.Bucket("bucket", new()
{
Name = "my-project-name-gcf-source",
Location = "US",
UniformBucketLevelAccess = true,
});
var @object = new Gcp.Storage.BucketObject("object", new()
{
Name = "function-source.zip",
Bucket = bucket.Name,
Source = new FileAsset("synthetic-fn-source.zip"),
});
var function = new Gcp.CloudFunctionsV2.Function("function", new()
{
Name = "synthetic_function",
Location = "us-central1",
BuildConfig = new Gcp.CloudFunctionsV2.Inputs.FunctionBuildConfigArgs
{
Runtime = "nodejs16",
EntryPoint = "SyntheticFunction",
Source = new Gcp.CloudFunctionsV2.Inputs.FunctionBuildConfigSourceArgs
{
StorageSource = new Gcp.CloudFunctionsV2.Inputs.FunctionBuildConfigSourceStorageSourceArgs
{
Bucket = bucket.Name,
Object = @object.Name,
},
},
},
ServiceConfig = new Gcp.CloudFunctionsV2.Inputs.FunctionServiceConfigArgs
{
MaxInstanceCount = 1,
AvailableMemory = "256M",
TimeoutSeconds = 60,
},
});
var syntheticMonitor = new Gcp.Monitoring.UptimeCheckConfig("synthetic_monitor", new()
{
DisplayName = "synthetic_monitor",
Timeout = "60s",
SyntheticMonitor = new Gcp.Monitoring.Inputs.UptimeCheckConfigSyntheticMonitorArgs
{
CloudFunctionV2 = new Gcp.Monitoring.Inputs.UptimeCheckConfigSyntheticMonitorCloudFunctionV2Args
{
Name = function.Id,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.storage.Bucket;
import com.pulumi.gcp.storage.BucketArgs;
import com.pulumi.gcp.storage.BucketObject;
import com.pulumi.gcp.storage.BucketObjectArgs;
import com.pulumi.gcp.cloudfunctionsv2.Function;
import com.pulumi.gcp.cloudfunctionsv2.FunctionArgs;
import com.pulumi.gcp.cloudfunctionsv2.inputs.FunctionBuildConfigArgs;
import com.pulumi.gcp.cloudfunctionsv2.inputs.FunctionBuildConfigSourceArgs;
import com.pulumi.gcp.cloudfunctionsv2.inputs.FunctionBuildConfigSourceStorageSourceArgs;
import com.pulumi.gcp.cloudfunctionsv2.inputs.FunctionServiceConfigArgs;
import com.pulumi.gcp.monitoring.UptimeCheckConfig;
import com.pulumi.gcp.monitoring.UptimeCheckConfigArgs;
import com.pulumi.gcp.monitoring.inputs.UptimeCheckConfigSyntheticMonitorArgs;
import com.pulumi.gcp.monitoring.inputs.UptimeCheckConfigSyntheticMonitorCloudFunctionV2Args;
import com.pulumi.asset.FileAsset;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var bucket = new Bucket("bucket", BucketArgs.builder()
.name("my-project-name-gcf-source")
.location("US")
.uniformBucketLevelAccess(true)
.build());
var object = new BucketObject("object", BucketObjectArgs.builder()
.name("function-source.zip")
.bucket(bucket.name())
.source(new FileAsset("synthetic-fn-source.zip"))
.build());
var function = new Function("function", FunctionArgs.builder()
.name("synthetic_function")
.location("us-central1")
.buildConfig(FunctionBuildConfigArgs.builder()
.runtime("nodejs16")
.entryPoint("SyntheticFunction")
.source(FunctionBuildConfigSourceArgs.builder()
.storageSource(FunctionBuildConfigSourceStorageSourceArgs.builder()
.bucket(bucket.name())
.object(object.name())
.build())
.build())
.build())
.serviceConfig(FunctionServiceConfigArgs.builder()
.maxInstanceCount(1)
.availableMemory("256M")
.timeoutSeconds(60)
.build())
.build());
var syntheticMonitor = new UptimeCheckConfig("syntheticMonitor", UptimeCheckConfigArgs.builder()
.displayName("synthetic_monitor")
.timeout("60s")
.syntheticMonitor(UptimeCheckConfigSyntheticMonitorArgs.builder()
.cloudFunctionV2(UptimeCheckConfigSyntheticMonitorCloudFunctionV2Args.builder()
.name(function.id())
.build())
.build())
.build());
}
}
resources:
bucket:
type: gcp:storage:Bucket
properties:
name: my-project-name-gcf-source
location: US
uniformBucketLevelAccess: true
object:
type: gcp:storage:BucketObject
properties:
name: function-source.zip
bucket: ${bucket.name}
source:
fn::FileAsset: synthetic-fn-source.zip
function:
type: gcp:cloudfunctionsv2:Function
properties:
name: synthetic_function
location: us-central1
buildConfig:
runtime: nodejs16
entryPoint: SyntheticFunction
source:
storageSource:
bucket: ${bucket.name}
object: ${object.name}
serviceConfig:
maxInstanceCount: 1
availableMemory: 256M
timeoutSeconds: 60
syntheticMonitor:
type: gcp:monitoring:UptimeCheckConfig
name: synthetic_monitor
properties:
displayName: synthetic_monitor
timeout: 60s
syntheticMonitor:
cloudFunctionV2:
name: ${function.id}
Create UptimeCheckConfig Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new UptimeCheckConfig(name: string, args: UptimeCheckConfigArgs, opts?: CustomResourceOptions);
@overload
def UptimeCheckConfig(resource_name: str,
args: UptimeCheckConfigArgs,
opts: Optional[ResourceOptions] = None)
@overload
def UptimeCheckConfig(resource_name: str,
opts: Optional[ResourceOptions] = None,
display_name: Optional[str] = None,
timeout: Optional[str] = None,
project: Optional[str] = None,
http_check: Optional[UptimeCheckConfigHttpCheckArgs] = None,
monitored_resource: Optional[UptimeCheckConfigMonitoredResourceArgs] = None,
period: Optional[str] = None,
checker_type: Optional[str] = None,
resource_group: Optional[UptimeCheckConfigResourceGroupArgs] = None,
selected_regions: Optional[Sequence[str]] = None,
synthetic_monitor: Optional[UptimeCheckConfigSyntheticMonitorArgs] = None,
tcp_check: Optional[UptimeCheckConfigTcpCheckArgs] = None,
content_matchers: Optional[Sequence[UptimeCheckConfigContentMatcherArgs]] = None,
user_labels: Optional[Mapping[str, str]] = None)
func NewUptimeCheckConfig(ctx *Context, name string, args UptimeCheckConfigArgs, opts ...ResourceOption) (*UptimeCheckConfig, error)
public UptimeCheckConfig(string name, UptimeCheckConfigArgs args, CustomResourceOptions? opts = null)
public UptimeCheckConfig(String name, UptimeCheckConfigArgs args)
public UptimeCheckConfig(String name, UptimeCheckConfigArgs args, CustomResourceOptions options)
type: gcp:monitoring:UptimeCheckConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args UptimeCheckConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args UptimeCheckConfigArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args UptimeCheckConfigArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args UptimeCheckConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args UptimeCheckConfigArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var uptimeCheckConfigResource = new Gcp.Monitoring.UptimeCheckConfig("uptimeCheckConfigResource", new()
{
DisplayName = "string",
Timeout = "string",
Project = "string",
HttpCheck = new Gcp.Monitoring.Inputs.UptimeCheckConfigHttpCheckArgs
{
AcceptedResponseStatusCodes = new[]
{
new Gcp.Monitoring.Inputs.UptimeCheckConfigHttpCheckAcceptedResponseStatusCodeArgs
{
StatusClass = "string",
StatusValue = 0,
},
},
AuthInfo = new Gcp.Monitoring.Inputs.UptimeCheckConfigHttpCheckAuthInfoArgs
{
Password = "string",
Username = "string",
},
Body = "string",
ContentType = "string",
CustomContentType = "string",
Headers =
{
{ "string", "string" },
},
MaskHeaders = false,
Path = "string",
PingConfig = new Gcp.Monitoring.Inputs.UptimeCheckConfigHttpCheckPingConfigArgs
{
PingsCount = 0,
},
Port = 0,
RequestMethod = "string",
ServiceAgentAuthentication = new Gcp.Monitoring.Inputs.UptimeCheckConfigHttpCheckServiceAgentAuthenticationArgs
{
Type = "string",
},
UseSsl = false,
ValidateSsl = false,
},
MonitoredResource = new Gcp.Monitoring.Inputs.UptimeCheckConfigMonitoredResourceArgs
{
Labels =
{
{ "string", "string" },
},
Type = "string",
},
Period = "string",
CheckerType = "string",
ResourceGroup = new Gcp.Monitoring.Inputs.UptimeCheckConfigResourceGroupArgs
{
GroupId = "string",
ResourceType = "string",
},
SelectedRegions = new[]
{
"string",
},
SyntheticMonitor = new Gcp.Monitoring.Inputs.UptimeCheckConfigSyntheticMonitorArgs
{
CloudFunctionV2 = new Gcp.Monitoring.Inputs.UptimeCheckConfigSyntheticMonitorCloudFunctionV2Args
{
Name = "string",
},
},
TcpCheck = new Gcp.Monitoring.Inputs.UptimeCheckConfigTcpCheckArgs
{
Port = 0,
PingConfig = new Gcp.Monitoring.Inputs.UptimeCheckConfigTcpCheckPingConfigArgs
{
PingsCount = 0,
},
},
ContentMatchers = new[]
{
new Gcp.Monitoring.Inputs.UptimeCheckConfigContentMatcherArgs
{
Content = "string",
JsonPathMatcher = new Gcp.Monitoring.Inputs.UptimeCheckConfigContentMatcherJsonPathMatcherArgs
{
JsonPath = "string",
JsonMatcher = "string",
},
Matcher = "string",
},
},
UserLabels =
{
{ "string", "string" },
},
});
example, err := monitoring.NewUptimeCheckConfig(ctx, "uptimeCheckConfigResource", &monitoring.UptimeCheckConfigArgs{
DisplayName: pulumi.String("string"),
Timeout: pulumi.String("string"),
Project: pulumi.String("string"),
HttpCheck: &monitoring.UptimeCheckConfigHttpCheckArgs{
AcceptedResponseStatusCodes: monitoring.UptimeCheckConfigHttpCheckAcceptedResponseStatusCodeArray{
&monitoring.UptimeCheckConfigHttpCheckAcceptedResponseStatusCodeArgs{
StatusClass: pulumi.String("string"),
StatusValue: pulumi.Int(0),
},
},
AuthInfo: &monitoring.UptimeCheckConfigHttpCheckAuthInfoArgs{
Password: pulumi.String("string"),
Username: pulumi.String("string"),
},
Body: pulumi.String("string"),
ContentType: pulumi.String("string"),
CustomContentType: pulumi.String("string"),
Headers: pulumi.StringMap{
"string": pulumi.String("string"),
},
MaskHeaders: pulumi.Bool(false),
Path: pulumi.String("string"),
PingConfig: &monitoring.UptimeCheckConfigHttpCheckPingConfigArgs{
PingsCount: pulumi.Int(0),
},
Port: pulumi.Int(0),
RequestMethod: pulumi.String("string"),
ServiceAgentAuthentication: &monitoring.UptimeCheckConfigHttpCheckServiceAgentAuthenticationArgs{
Type: pulumi.String("string"),
},
UseSsl: pulumi.Bool(false),
ValidateSsl: pulumi.Bool(false),
},
MonitoredResource: &monitoring.UptimeCheckConfigMonitoredResourceArgs{
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Type: pulumi.String("string"),
},
Period: pulumi.String("string"),
CheckerType: pulumi.String("string"),
ResourceGroup: &monitoring.UptimeCheckConfigResourceGroupArgs{
GroupId: pulumi.String("string"),
ResourceType: pulumi.String("string"),
},
SelectedRegions: pulumi.StringArray{
pulumi.String("string"),
},
SyntheticMonitor: &monitoring.UptimeCheckConfigSyntheticMonitorArgs{
CloudFunctionV2: &monitoring.UptimeCheckConfigSyntheticMonitorCloudFunctionV2Args{
Name: pulumi.String("string"),
},
},
TcpCheck: &monitoring.UptimeCheckConfigTcpCheckArgs{
Port: pulumi.Int(0),
PingConfig: &monitoring.UptimeCheckConfigTcpCheckPingConfigArgs{
PingsCount: pulumi.Int(0),
},
},
ContentMatchers: monitoring.UptimeCheckConfigContentMatcherArray{
&monitoring.UptimeCheckConfigContentMatcherArgs{
Content: pulumi.String("string"),
JsonPathMatcher: &monitoring.UptimeCheckConfigContentMatcherJsonPathMatcherArgs{
JsonPath: pulumi.String("string"),
JsonMatcher: pulumi.String("string"),
},
Matcher: pulumi.String("string"),
},
},
UserLabels: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var uptimeCheckConfigResource = new UptimeCheckConfig("uptimeCheckConfigResource", UptimeCheckConfigArgs.builder()
.displayName("string")
.timeout("string")
.project("string")
.httpCheck(UptimeCheckConfigHttpCheckArgs.builder()
.acceptedResponseStatusCodes(UptimeCheckConfigHttpCheckAcceptedResponseStatusCodeArgs.builder()
.statusClass("string")
.statusValue(0)
.build())
.authInfo(UptimeCheckConfigHttpCheckAuthInfoArgs.builder()
.password("string")
.username("string")
.build())
.body("string")
.contentType("string")
.customContentType("string")
.headers(Map.of("string", "string"))
.maskHeaders(false)
.path("string")
.pingConfig(UptimeCheckConfigHttpCheckPingConfigArgs.builder()
.pingsCount(0)
.build())
.port(0)
.requestMethod("string")
.serviceAgentAuthentication(UptimeCheckConfigHttpCheckServiceAgentAuthenticationArgs.builder()
.type("string")
.build())
.useSsl(false)
.validateSsl(false)
.build())
.monitoredResource(UptimeCheckConfigMonitoredResourceArgs.builder()
.labels(Map.of("string", "string"))
.type("string")
.build())
.period("string")
.checkerType("string")
.resourceGroup(UptimeCheckConfigResourceGroupArgs.builder()
.groupId("string")
.resourceType("string")
.build())
.selectedRegions("string")
.syntheticMonitor(UptimeCheckConfigSyntheticMonitorArgs.builder()
.cloudFunctionV2(UptimeCheckConfigSyntheticMonitorCloudFunctionV2Args.builder()
.name("string")
.build())
.build())
.tcpCheck(UptimeCheckConfigTcpCheckArgs.builder()
.port(0)
.pingConfig(UptimeCheckConfigTcpCheckPingConfigArgs.builder()
.pingsCount(0)
.build())
.build())
.contentMatchers(UptimeCheckConfigContentMatcherArgs.builder()
.content("string")
.jsonPathMatcher(UptimeCheckConfigContentMatcherJsonPathMatcherArgs.builder()
.jsonPath("string")
.jsonMatcher("string")
.build())
.matcher("string")
.build())
.userLabels(Map.of("string", "string"))
.build());
uptime_check_config_resource = gcp.monitoring.UptimeCheckConfig("uptimeCheckConfigResource",
display_name="string",
timeout="string",
project="string",
http_check={
"accepted_response_status_codes": [{
"status_class": "string",
"status_value": 0,
}],
"auth_info": {
"password": "string",
"username": "string",
},
"body": "string",
"content_type": "string",
"custom_content_type": "string",
"headers": {
"string": "string",
},
"mask_headers": False,
"path": "string",
"ping_config": {
"pings_count": 0,
},
"port": 0,
"request_method": "string",
"service_agent_authentication": {
"type": "string",
},
"use_ssl": False,
"validate_ssl": False,
},
monitored_resource={
"labels": {
"string": "string",
},
"type": "string",
},
period="string",
checker_type="string",
resource_group={
"group_id": "string",
"resource_type": "string",
},
selected_regions=["string"],
synthetic_monitor={
"cloud_function_v2": {
"name": "string",
},
},
tcp_check={
"port": 0,
"ping_config": {
"pings_count": 0,
},
},
content_matchers=[{
"content": "string",
"json_path_matcher": {
"json_path": "string",
"json_matcher": "string",
},
"matcher": "string",
}],
user_labels={
"string": "string",
})
const uptimeCheckConfigResource = new gcp.monitoring.UptimeCheckConfig("uptimeCheckConfigResource", {
displayName: "string",
timeout: "string",
project: "string",
httpCheck: {
acceptedResponseStatusCodes: [{
statusClass: "string",
statusValue: 0,
}],
authInfo: {
password: "string",
username: "string",
},
body: "string",
contentType: "string",
customContentType: "string",
headers: {
string: "string",
},
maskHeaders: false,
path: "string",
pingConfig: {
pingsCount: 0,
},
port: 0,
requestMethod: "string",
serviceAgentAuthentication: {
type: "string",
},
useSsl: false,
validateSsl: false,
},
monitoredResource: {
labels: {
string: "string",
},
type: "string",
},
period: "string",
checkerType: "string",
resourceGroup: {
groupId: "string",
resourceType: "string",
},
selectedRegions: ["string"],
syntheticMonitor: {
cloudFunctionV2: {
name: "string",
},
},
tcpCheck: {
port: 0,
pingConfig: {
pingsCount: 0,
},
},
contentMatchers: [{
content: "string",
jsonPathMatcher: {
jsonPath: "string",
jsonMatcher: "string",
},
matcher: "string",
}],
userLabels: {
string: "string",
},
});
type: gcp:monitoring:UptimeCheckConfig
properties:
checkerType: string
contentMatchers:
- content: string
jsonPathMatcher:
jsonMatcher: string
jsonPath: string
matcher: string
displayName: string
httpCheck:
acceptedResponseStatusCodes:
- statusClass: string
statusValue: 0
authInfo:
password: string
username: string
body: string
contentType: string
customContentType: string
headers:
string: string
maskHeaders: false
path: string
pingConfig:
pingsCount: 0
port: 0
requestMethod: string
serviceAgentAuthentication:
type: string
useSsl: false
validateSsl: false
monitoredResource:
labels:
string: string
type: string
period: string
project: string
resourceGroup:
groupId: string
resourceType: string
selectedRegions:
- string
syntheticMonitor:
cloudFunctionV2:
name: string
tcpCheck:
pingConfig:
pingsCount: 0
port: 0
timeout: string
userLabels:
string: string
UptimeCheckConfig Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The UptimeCheckConfig resource accepts the following input properties:
- Display
Name 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.
- Timeout string
- The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). See the accepted formats
- Checker
Type string - The checker type to use for the check. If the monitored resource type is
servicedirectory_service
,checker_type
must be set toVPC_CHECKERS
. Possible values are:STATIC_IP_CHECKERS
,VPC_CHECKERS
. - Content
Matchers List<UptimeCheck Config Content Matcher> - 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.
- Http
Check UptimeCheck Config Http Check - Contains information needed to make an HTTP or HTTPS check. Structure is documented below.
- Monitored
Resource UptimeCheck Config Monitored Resource - The [monitored resource] (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks:
- Period 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.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Resource
Group UptimeCheck Config Resource Group - The group resource associated with the configuration. Structure is documented below.
- Selected
Regions List<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 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.
- Synthetic
Monitor UptimeCheck Config Synthetic Monitor - A Synthetic Monitor deployed to a Cloud Functions V2 instance. Structure is documented below.
- Tcp
Check UptimeCheck Config Tcp Check - Contains information needed to make a TCP check. Structure is documented below.
- User
Labels Dictionary<string, string> - User-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.
- Display
Name 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.
- Timeout string
- The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). See the accepted formats
- Checker
Type string - The checker type to use for the check. If the monitored resource type is
servicedirectory_service
,checker_type
must be set toVPC_CHECKERS
. Possible values are:STATIC_IP_CHECKERS
,VPC_CHECKERS
. - Content
Matchers []UptimeCheck Config Content Matcher Args - 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.
- Http
Check UptimeCheck Config Http Check Args - Contains information needed to make an HTTP or HTTPS check. Structure is documented below.
- Monitored
Resource UptimeCheck Config Monitored Resource Args - The [monitored resource] (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks:
- Period 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.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Resource
Group UptimeCheck Config Resource Group Args - The group resource associated with the configuration. Structure is documented below.
- Selected
Regions []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 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.
- Synthetic
Monitor UptimeCheck Config Synthetic Monitor Args - A Synthetic Monitor deployed to a Cloud Functions V2 instance. Structure is documented below.
- Tcp
Check UptimeCheck Config Tcp Check Args - Contains information needed to make a TCP check. Structure is documented below.
- User
Labels map[string]string - User-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.
- display
Name 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.
- timeout String
- The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). See the accepted formats
- checker
Type String - The checker type to use for the check. If the monitored resource type is
servicedirectory_service
,checker_type
must be set toVPC_CHECKERS
. Possible values are:STATIC_IP_CHECKERS
,VPC_CHECKERS
. - content
Matchers List<UptimeCheck Config Content Matcher> - 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.
- http
Check UptimeCheck Config Http Check - Contains information needed to make an HTTP or HTTPS check. Structure is documented below.
- monitored
Resource UptimeCheck Config Monitored Resource - The [monitored resource] (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks:
- period 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.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- resource
Group UptimeCheck Config Resource Group - The group resource associated with the configuration. Structure is documented below.
- selected
Regions List<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 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.
- synthetic
Monitor UptimeCheck Config Synthetic Monitor - A Synthetic Monitor deployed to a Cloud Functions V2 instance. Structure is documented below.
- tcp
Check UptimeCheck Config Tcp Check - Contains information needed to make a TCP check. Structure is documented below.
- user
Labels Map<String,String> - User-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.
- display
Name 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.
- timeout string
- The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). See the accepted formats
- checker
Type string - The checker type to use for the check. If the monitored resource type is
servicedirectory_service
,checker_type
must be set toVPC_CHECKERS
. Possible values are:STATIC_IP_CHECKERS
,VPC_CHECKERS
. - content
Matchers UptimeCheck Config Content Matcher[] - 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.
- http
Check UptimeCheck Config Http Check - Contains information needed to make an HTTP or HTTPS check. Structure is documented below.
- monitored
Resource UptimeCheck Config Monitored Resource - The [monitored resource] (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks:
- period 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.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- resource
Group UptimeCheck Config Resource Group - The group resource associated with the configuration. Structure is documented below.
- selected
Regions 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 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.
- synthetic
Monitor UptimeCheck Config Synthetic Monitor - A Synthetic Monitor deployed to a Cloud Functions V2 instance. Structure is documented below.
- tcp
Check UptimeCheck Config Tcp Check - Contains information needed to make a TCP check. Structure is documented below.
- user
Labels {[key: string]: string} - User-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.
- display_
name str - 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.
- timeout str
- The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). See the accepted formats
- checker_
type str - The checker type to use for the check. If the monitored resource type is
servicedirectory_service
,checker_type
must be set toVPC_CHECKERS
. Possible values are:STATIC_IP_CHECKERS
,VPC_CHECKERS
. - content_
matchers Sequence[UptimeCheck Config Content Matcher Args] - 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.
- http_
check UptimeCheck Config Http Check Args - Contains information needed to make an HTTP or HTTPS check. Structure is documented below.
- monitored_
resource UptimeCheck Config Monitored Resource Args - The [monitored resource] (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks:
- period str
- 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.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- resource_
group UptimeCheck Config Resource Group Args - The group resource associated with the configuration. Structure is documented below.
- selected_
regions Sequence[str] - 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.
- synthetic_
monitor UptimeCheck Config Synthetic Monitor Args - A Synthetic Monitor deployed to a Cloud Functions V2 instance. Structure is documented below.
- tcp_
check UptimeCheck Config Tcp Check Args - Contains information needed to make a TCP check. Structure is documented below.
- user_
labels Mapping[str, str] - User-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.
- display
Name 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.
- timeout String
- The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). See the accepted formats
- checker
Type String - The checker type to use for the check. If the monitored resource type is
servicedirectory_service
,checker_type
must be set toVPC_CHECKERS
. Possible values are:STATIC_IP_CHECKERS
,VPC_CHECKERS
. - content
Matchers List<Property Map> - 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.
- http
Check Property Map - Contains information needed to make an HTTP or HTTPS check. Structure is documented below.
- monitored
Resource Property Map - The [monitored resource] (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks:
- period 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.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- resource
Group Property Map - The group resource associated with the configuration. Structure is documented below.
- selected
Regions List<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 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.
- synthetic
Monitor Property Map - A Synthetic Monitor deployed to a Cloud Functions V2 instance. Structure is documented below.
- tcp
Check Property Map - Contains information needed to make a TCP check. Structure is documented below.
- user
Labels Map<String> - User-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.
Outputs
All input properties are implicitly available as output properties. Additionally, the UptimeCheckConfig resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- A unique resource name for this UptimeCheckConfig. The format is
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
. - Uptime
Check stringId - The id of the uptime check
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- A unique resource name for this UptimeCheckConfig. The format is
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
. - Uptime
Check stringId - The id of the uptime check
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- A unique resource name for this UptimeCheckConfig. The format is
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
. - uptime
Check StringId - The id of the uptime check
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- A unique resource name for this UptimeCheckConfig. The format is
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
. - uptime
Check stringId - The id of the uptime check
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- A unique resource name for this UptimeCheckConfig. The format is
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
. - uptime_
check_ strid - The id of the uptime check
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- A unique resource name for this UptimeCheckConfig. The format is
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
. - uptime
Check StringId - The id of the uptime check
Look up Existing UptimeCheckConfig Resource
Get an existing UptimeCheckConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: UptimeCheckConfigState, opts?: CustomResourceOptions): UptimeCheckConfig
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
checker_type: Optional[str] = None,
content_matchers: Optional[Sequence[UptimeCheckConfigContentMatcherArgs]] = None,
display_name: Optional[str] = None,
http_check: Optional[UptimeCheckConfigHttpCheckArgs] = None,
monitored_resource: Optional[UptimeCheckConfigMonitoredResourceArgs] = None,
name: Optional[str] = None,
period: Optional[str] = None,
project: Optional[str] = None,
resource_group: Optional[UptimeCheckConfigResourceGroupArgs] = None,
selected_regions: Optional[Sequence[str]] = None,
synthetic_monitor: Optional[UptimeCheckConfigSyntheticMonitorArgs] = None,
tcp_check: Optional[UptimeCheckConfigTcpCheckArgs] = None,
timeout: Optional[str] = None,
uptime_check_id: Optional[str] = None,
user_labels: Optional[Mapping[str, str]] = None) -> UptimeCheckConfig
func GetUptimeCheckConfig(ctx *Context, name string, id IDInput, state *UptimeCheckConfigState, opts ...ResourceOption) (*UptimeCheckConfig, error)
public static UptimeCheckConfig Get(string name, Input<string> id, UptimeCheckConfigState? state, CustomResourceOptions? opts = null)
public static UptimeCheckConfig get(String name, Output<String> id, UptimeCheckConfigState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Checker
Type string - The checker type to use for the check. If the monitored resource type is
servicedirectory_service
,checker_type
must be set toVPC_CHECKERS
. Possible values are:STATIC_IP_CHECKERS
,VPC_CHECKERS
. - Content
Matchers List<UptimeCheck Config Content Matcher> - 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.
- Display
Name 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.
- Http
Check UptimeCheck Config Http Check - Contains information needed to make an HTTP or HTTPS check. Structure is documented below.
- Monitored
Resource UptimeCheck Config Monitored Resource - The [monitored resource] (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks:
- Name string
- A unique resource name for this UptimeCheckConfig. The format is
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
. - Period 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.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Resource
Group UptimeCheck Config Resource Group - The group resource associated with the configuration. Structure is documented below.
- Selected
Regions List<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 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.
- Synthetic
Monitor UptimeCheck Config Synthetic Monitor - A Synthetic Monitor deployed to a Cloud Functions V2 instance. Structure is documented below.
- Tcp
Check UptimeCheck Config Tcp Check - Contains information needed to make a TCP check. Structure is documented below.
- Timeout string
- The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). See the accepted formats
- Uptime
Check stringId - The id of the uptime check
- User
Labels Dictionary<string, string> - User-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.
- Checker
Type string - The checker type to use for the check. If the monitored resource type is
servicedirectory_service
,checker_type
must be set toVPC_CHECKERS
. Possible values are:STATIC_IP_CHECKERS
,VPC_CHECKERS
. - Content
Matchers []UptimeCheck Config Content Matcher Args - 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.
- Display
Name 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.
- Http
Check UptimeCheck Config Http Check Args - Contains information needed to make an HTTP or HTTPS check. Structure is documented below.
- Monitored
Resource UptimeCheck Config Monitored Resource Args - The [monitored resource] (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks:
- Name string
- A unique resource name for this UptimeCheckConfig. The format is
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
. - Period 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.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Resource
Group UptimeCheck Config Resource Group Args - The group resource associated with the configuration. Structure is documented below.
- Selected
Regions []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 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.
- Synthetic
Monitor UptimeCheck Config Synthetic Monitor Args - A Synthetic Monitor deployed to a Cloud Functions V2 instance. Structure is documented below.
- Tcp
Check UptimeCheck Config Tcp Check Args - Contains information needed to make a TCP check. Structure is documented below.
- Timeout string
- The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). See the accepted formats
- Uptime
Check stringId - The id of the uptime check
- User
Labels map[string]string - User-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.
- checker
Type String - The checker type to use for the check. If the monitored resource type is
servicedirectory_service
,checker_type
must be set toVPC_CHECKERS
. Possible values are:STATIC_IP_CHECKERS
,VPC_CHECKERS
. - content
Matchers List<UptimeCheck Config Content Matcher> - 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.
- display
Name 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.
- http
Check UptimeCheck Config Http Check - Contains information needed to make an HTTP or HTTPS check. Structure is documented below.
- monitored
Resource UptimeCheck Config Monitored Resource - The [monitored resource] (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks:
- name String
- A unique resource name for this UptimeCheckConfig. The format is
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
. - period 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.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- resource
Group UptimeCheck Config Resource Group - The group resource associated with the configuration. Structure is documented below.
- selected
Regions List<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 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.
- synthetic
Monitor UptimeCheck Config Synthetic Monitor - A Synthetic Monitor deployed to a Cloud Functions V2 instance. Structure is documented below.
- tcp
Check UptimeCheck Config Tcp Check - Contains information needed to make a TCP check. Structure is documented below.
- timeout String
- The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). See the accepted formats
- uptime
Check StringId - The id of the uptime check
- user
Labels Map<String,String> - User-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.
- checker
Type string - The checker type to use for the check. If the monitored resource type is
servicedirectory_service
,checker_type
must be set toVPC_CHECKERS
. Possible values are:STATIC_IP_CHECKERS
,VPC_CHECKERS
. - content
Matchers UptimeCheck Config Content Matcher[] - 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.
- display
Name 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.
- http
Check UptimeCheck Config Http Check - Contains information needed to make an HTTP or HTTPS check. Structure is documented below.
- monitored
Resource UptimeCheck Config Monitored Resource - The [monitored resource] (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks:
- name string
- A unique resource name for this UptimeCheckConfig. The format is
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
. - period 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.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- resource
Group UptimeCheck Config Resource Group - The group resource associated with the configuration. Structure is documented below.
- selected
Regions 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 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.
- synthetic
Monitor UptimeCheck Config Synthetic Monitor - A Synthetic Monitor deployed to a Cloud Functions V2 instance. Structure is documented below.
- tcp
Check UptimeCheck Config Tcp Check - Contains information needed to make a TCP check. Structure is documented below.
- timeout string
- The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). See the accepted formats
- uptime
Check stringId - The id of the uptime check
- user
Labels {[key: string]: string} - User-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.
- checker_
type str - The checker type to use for the check. If the monitored resource type is
servicedirectory_service
,checker_type
must be set toVPC_CHECKERS
. Possible values are:STATIC_IP_CHECKERS
,VPC_CHECKERS
. - content_
matchers Sequence[UptimeCheck Config Content Matcher Args] - 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.
- display_
name str - 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.
- http_
check UptimeCheck Config Http Check Args - Contains information needed to make an HTTP or HTTPS check. Structure is documented below.
- monitored_
resource UptimeCheck Config Monitored Resource Args - The [monitored resource] (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks:
- name str
- A unique resource name for this UptimeCheckConfig. The format is
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
. - period str
- 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.
- project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- resource_
group UptimeCheck Config Resource Group Args - The group resource associated with the configuration. Structure is documented below.
- selected_
regions Sequence[str] - 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.
- synthetic_
monitor UptimeCheck Config Synthetic Monitor Args - A Synthetic Monitor deployed to a Cloud Functions V2 instance. Structure is documented below.
- tcp_
check UptimeCheck Config Tcp Check Args - Contains information needed to make a TCP check. Structure is documented below.
- timeout str
- The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). See the accepted formats
- uptime_
check_ strid - The id of the uptime check
- user_
labels Mapping[str, str] - User-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.
- checker
Type String - The checker type to use for the check. If the monitored resource type is
servicedirectory_service
,checker_type
must be set toVPC_CHECKERS
. Possible values are:STATIC_IP_CHECKERS
,VPC_CHECKERS
. - content
Matchers List<Property Map> - 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.
- display
Name 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.
- http
Check Property Map - Contains information needed to make an HTTP or HTTPS check. Structure is documented below.
- monitored
Resource Property Map - The [monitored resource] (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are supported for uptime checks:
- name String
- A unique resource name for this UptimeCheckConfig. The format is
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
. - period 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.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- resource
Group Property Map - The group resource associated with the configuration. Structure is documented below.
- selected
Regions List<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 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.
- synthetic
Monitor Property Map - A Synthetic Monitor deployed to a Cloud Functions V2 instance. Structure is documented below.
- tcp
Check Property Map - Contains information needed to make a TCP check. Structure is documented below.
- timeout String
- The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). See the accepted formats
- uptime
Check StringId - The id of the uptime check
- user
Labels Map<String> - User-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.
Supporting Types
UptimeCheckConfigContentMatcher, UptimeCheckConfigContentMatcherArgs
- Content string
- String or regex content to match (max 1024 bytes)
- Json
Path UptimeMatcher Check Config Content Matcher Json Path Matcher - Information needed to perform a JSONPath content match. Used for
ContentMatcherOption::MATCHES_JSON_PATH
andContentMatcherOption::NOT_MATCHES_JSON_PATH
. Structure is documented below. - Matcher string
- The type of content matcher that will be applied to the server output, compared to the content string when the check is run.
Default value is
CONTAINS_STRING
. Possible values are:CONTAINS_STRING
,NOT_CONTAINS_STRING
,MATCHES_REGEX
,NOT_MATCHES_REGEX
,MATCHES_JSON_PATH
,NOT_MATCHES_JSON_PATH
.
- Content string
- String or regex content to match (max 1024 bytes)
- Json
Path UptimeMatcher Check Config Content Matcher Json Path Matcher - Information needed to perform a JSONPath content match. Used for
ContentMatcherOption::MATCHES_JSON_PATH
andContentMatcherOption::NOT_MATCHES_JSON_PATH
. Structure is documented below. - Matcher string
- The type of content matcher that will be applied to the server output, compared to the content string when the check is run.
Default value is
CONTAINS_STRING
. Possible values are:CONTAINS_STRING
,NOT_CONTAINS_STRING
,MATCHES_REGEX
,NOT_MATCHES_REGEX
,MATCHES_JSON_PATH
,NOT_MATCHES_JSON_PATH
.
- content String
- String or regex content to match (max 1024 bytes)
- json
Path UptimeMatcher Check Config Content Matcher Json Path Matcher - Information needed to perform a JSONPath content match. Used for
ContentMatcherOption::MATCHES_JSON_PATH
andContentMatcherOption::NOT_MATCHES_JSON_PATH
. Structure is documented below. - matcher String
- The type of content matcher that will be applied to the server output, compared to the content string when the check is run.
Default value is
CONTAINS_STRING
. Possible values are:CONTAINS_STRING
,NOT_CONTAINS_STRING
,MATCHES_REGEX
,NOT_MATCHES_REGEX
,MATCHES_JSON_PATH
,NOT_MATCHES_JSON_PATH
.
- content string
- String or regex content to match (max 1024 bytes)
- json
Path UptimeMatcher Check Config Content Matcher Json Path Matcher - Information needed to perform a JSONPath content match. Used for
ContentMatcherOption::MATCHES_JSON_PATH
andContentMatcherOption::NOT_MATCHES_JSON_PATH
. Structure is documented below. - matcher string
- The type of content matcher that will be applied to the server output, compared to the content string when the check is run.
Default value is
CONTAINS_STRING
. Possible values are:CONTAINS_STRING
,NOT_CONTAINS_STRING
,MATCHES_REGEX
,NOT_MATCHES_REGEX
,MATCHES_JSON_PATH
,NOT_MATCHES_JSON_PATH
.
- content str
- String or regex content to match (max 1024 bytes)
- json_
path_ Uptimematcher Check Config Content Matcher Json Path Matcher - Information needed to perform a JSONPath content match. Used for
ContentMatcherOption::MATCHES_JSON_PATH
andContentMatcherOption::NOT_MATCHES_JSON_PATH
. Structure is documented below. - matcher str
- The type of content matcher that will be applied to the server output, compared to the content string when the check is run.
Default value is
CONTAINS_STRING
. Possible values are:CONTAINS_STRING
,NOT_CONTAINS_STRING
,MATCHES_REGEX
,NOT_MATCHES_REGEX
,MATCHES_JSON_PATH
,NOT_MATCHES_JSON_PATH
.
- content String
- String or regex content to match (max 1024 bytes)
- json
Path Property MapMatcher - Information needed to perform a JSONPath content match. Used for
ContentMatcherOption::MATCHES_JSON_PATH
andContentMatcherOption::NOT_MATCHES_JSON_PATH
. Structure is documented below. - matcher String
- The type of content matcher that will be applied to the server output, compared to the content string when the check is run.
Default value is
CONTAINS_STRING
. Possible values are:CONTAINS_STRING
,NOT_CONTAINS_STRING
,MATCHES_REGEX
,NOT_MATCHES_REGEX
,MATCHES_JSON_PATH
,NOT_MATCHES_JSON_PATH
.
UptimeCheckConfigContentMatcherJsonPathMatcher, UptimeCheckConfigContentMatcherJsonPathMatcherArgs
- Json
Path string - JSONPath within the response output pointing to the expected
ContentMatcher::content
to match against. - Json
Matcher string - Options to perform JSONPath content matching.
Default value is
EXACT_MATCH
. Possible values are:EXACT_MATCH
,REGEX_MATCH
.
- Json
Path string - JSONPath within the response output pointing to the expected
ContentMatcher::content
to match against. - Json
Matcher string - Options to perform JSONPath content matching.
Default value is
EXACT_MATCH
. Possible values are:EXACT_MATCH
,REGEX_MATCH
.
- json
Path String - JSONPath within the response output pointing to the expected
ContentMatcher::content
to match against. - json
Matcher String - Options to perform JSONPath content matching.
Default value is
EXACT_MATCH
. Possible values are:EXACT_MATCH
,REGEX_MATCH
.
- json
Path string - JSONPath within the response output pointing to the expected
ContentMatcher::content
to match against. - json
Matcher string - Options to perform JSONPath content matching.
Default value is
EXACT_MATCH
. Possible values are:EXACT_MATCH
,REGEX_MATCH
.
- json_
path str - JSONPath within the response output pointing to the expected
ContentMatcher::content
to match against. - json_
matcher str - Options to perform JSONPath content matching.
Default value is
EXACT_MATCH
. Possible values are:EXACT_MATCH
,REGEX_MATCH
.
- json
Path String - JSONPath within the response output pointing to the expected
ContentMatcher::content
to match against. - json
Matcher String - Options to perform JSONPath content matching.
Default value is
EXACT_MATCH
. Possible values are:EXACT_MATCH
,REGEX_MATCH
.
UptimeCheckConfigHttpCheck, UptimeCheckConfigHttpCheckArgs
- Accepted
Response List<UptimeStatus Codes Check Config Http Check Accepted Response Status Code> - If present, the check will only pass if the HTTP response status code is in this set of status codes. If empty, the HTTP status code will only pass if the HTTP status code is 200-299. Structure is documented below.
- Auth
Info UptimeCheck Config Http Check Auth Info - The authentication information using username and password. Optional when creating an HTTP check; defaults to empty. Do not use with other authentication fields. Structure is documented below.
- Body string
- The request body associated with the HTTP POST request. If
content_type
isURL_ENCODED
, the body passed in must be URL-encoded. Users can provide aContent-Length
header via theheaders
field or the API will do so. If therequest_method
isGET
andbody
is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note - As with all bytes fields JSON representations are base64 encoded. e.g.foo=bar
in URL-encoded form isfoo%3Dbar
and in base64 encoding isZm9vJTI1M0RiYXI=
. - Content
Type string - The content type to use for the check.
Possible values are:
TYPE_UNSPECIFIED
,URL_ENCODED
,USER_PROVIDED
. - Custom
Content stringType - A user provided content type header to use for the check. The invalid configurations outlined in the
content_type
field apply to custom_content_type, as well as the following 1.
content_typeis
URL_ENCODEDand
custom_content_typeis set. 2.
content_typeis
USER_PROVIDEDand
custom_content_type` is not set. - Headers Dictionary<string, string>
- The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described in RFC 2616 (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100.
- Mask
Headers bool - Boolean specifying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if
mask_headers
is set totrue
then the headers will be obscured with******
. - Path string
- The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. If the provided path does not begin with
/
, a/
will be prepended automatically. Optional (defaults to/
). - Ping
Config UptimeCheck Config Http Check Ping Config - Contains information needed to add pings to an HTTP check. Structure is documented below.
- Port int
- The port to the page to run the check against. Will be combined with
host
(specified within themonitored_resource
) and path to construct the full URL. Optional (defaults to 80 without SSL, or 443 with SSL). - Request
Method string - The HTTP request method to use for the check. If set to
METHOD_UNSPECIFIED
thenrequest_method
defaults toGET
. Default value isGET
. Possible values are:METHOD_UNSPECIFIED
,GET
,POST
. - Service
Agent UptimeAuthentication Check Config Http Check Service Agent Authentication - The authentication information using the Monitoring Service Agent. Optional when creating an HTTPS check; defaults to empty. Do not use with other authentication fields. Structure is documented below.
- Use
Ssl bool - If true, use HTTPS instead of HTTP to run the check.
- Validate
Ssl bool - Boolean specifying whether to include SSL certificate validation as a part of the Uptime check. Only applies to checks where
monitored_resource
is set touptime_url
. Ifuse_ssl
isfalse
, settingvalidate_ssl
totrue
has no effect.
- Accepted
Response []UptimeStatus Codes Check Config Http Check Accepted Response Status Code - If present, the check will only pass if the HTTP response status code is in this set of status codes. If empty, the HTTP status code will only pass if the HTTP status code is 200-299. Structure is documented below.
- Auth
Info UptimeCheck Config Http Check Auth Info - The authentication information using username and password. Optional when creating an HTTP check; defaults to empty. Do not use with other authentication fields. Structure is documented below.
- Body string
- The request body associated with the HTTP POST request. If
content_type
isURL_ENCODED
, the body passed in must be URL-encoded. Users can provide aContent-Length
header via theheaders
field or the API will do so. If therequest_method
isGET
andbody
is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note - As with all bytes fields JSON representations are base64 encoded. e.g.foo=bar
in URL-encoded form isfoo%3Dbar
and in base64 encoding isZm9vJTI1M0RiYXI=
. - Content
Type string - The content type to use for the check.
Possible values are:
TYPE_UNSPECIFIED
,URL_ENCODED
,USER_PROVIDED
. - Custom
Content stringType - A user provided content type header to use for the check. The invalid configurations outlined in the
content_type
field apply to custom_content_type, as well as the following 1.
content_typeis
URL_ENCODEDand
custom_content_typeis set. 2.
content_typeis
USER_PROVIDEDand
custom_content_type` is not set. - Headers map[string]string
- The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described in RFC 2616 (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100.
- Mask
Headers bool - Boolean specifying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if
mask_headers
is set totrue
then the headers will be obscured with******
. - Path string
- The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. If the provided path does not begin with
/
, a/
will be prepended automatically. Optional (defaults to/
). - Ping
Config UptimeCheck Config Http Check Ping Config - Contains information needed to add pings to an HTTP check. Structure is documented below.
- Port int
- The port to the page to run the check against. Will be combined with
host
(specified within themonitored_resource
) and path to construct the full URL. Optional (defaults to 80 without SSL, or 443 with SSL). - Request
Method string - The HTTP request method to use for the check. If set to
METHOD_UNSPECIFIED
thenrequest_method
defaults toGET
. Default value isGET
. Possible values are:METHOD_UNSPECIFIED
,GET
,POST
. - Service
Agent UptimeAuthentication Check Config Http Check Service Agent Authentication - The authentication information using the Monitoring Service Agent. Optional when creating an HTTPS check; defaults to empty. Do not use with other authentication fields. Structure is documented below.
- Use
Ssl bool - If true, use HTTPS instead of HTTP to run the check.
- Validate
Ssl bool - Boolean specifying whether to include SSL certificate validation as a part of the Uptime check. Only applies to checks where
monitored_resource
is set touptime_url
. Ifuse_ssl
isfalse
, settingvalidate_ssl
totrue
has no effect.
- accepted
Response List<UptimeStatus Codes Check Config Http Check Accepted Response Status Code> - If present, the check will only pass if the HTTP response status code is in this set of status codes. If empty, the HTTP status code will only pass if the HTTP status code is 200-299. Structure is documented below.
- auth
Info UptimeCheck Config Http Check Auth Info - The authentication information using username and password. Optional when creating an HTTP check; defaults to empty. Do not use with other authentication fields. Structure is documented below.
- body String
- The request body associated with the HTTP POST request. If
content_type
isURL_ENCODED
, the body passed in must be URL-encoded. Users can provide aContent-Length
header via theheaders
field or the API will do so. If therequest_method
isGET
andbody
is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note - As with all bytes fields JSON representations are base64 encoded. e.g.foo=bar
in URL-encoded form isfoo%3Dbar
and in base64 encoding isZm9vJTI1M0RiYXI=
. - content
Type String - The content type to use for the check.
Possible values are:
TYPE_UNSPECIFIED
,URL_ENCODED
,USER_PROVIDED
. - custom
Content StringType - A user provided content type header to use for the check. The invalid configurations outlined in the
content_type
field apply to custom_content_type, as well as the following 1.
content_typeis
URL_ENCODEDand
custom_content_typeis set. 2.
content_typeis
USER_PROVIDEDand
custom_content_type` is not set. - headers Map<String,String>
- The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described in RFC 2616 (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100.
- mask
Headers Boolean - Boolean specifying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if
mask_headers
is set totrue
then the headers will be obscured with******
. - path String
- The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. If the provided path does not begin with
/
, a/
will be prepended automatically. Optional (defaults to/
). - ping
Config UptimeCheck Config Http Check Ping Config - Contains information needed to add pings to an HTTP check. Structure is documented below.
- port Integer
- The port to the page to run the check against. Will be combined with
host
(specified within themonitored_resource
) and path to construct the full URL. Optional (defaults to 80 without SSL, or 443 with SSL). - request
Method String - The HTTP request method to use for the check. If set to
METHOD_UNSPECIFIED
thenrequest_method
defaults toGET
. Default value isGET
. Possible values are:METHOD_UNSPECIFIED
,GET
,POST
. - service
Agent UptimeAuthentication Check Config Http Check Service Agent Authentication - The authentication information using the Monitoring Service Agent. Optional when creating an HTTPS check; defaults to empty. Do not use with other authentication fields. Structure is documented below.
- use
Ssl Boolean - If true, use HTTPS instead of HTTP to run the check.
- validate
Ssl Boolean - Boolean specifying whether to include SSL certificate validation as a part of the Uptime check. Only applies to checks where
monitored_resource
is set touptime_url
. Ifuse_ssl
isfalse
, settingvalidate_ssl
totrue
has no effect.
- accepted
Response UptimeStatus Codes Check Config Http Check Accepted Response Status Code[] - If present, the check will only pass if the HTTP response status code is in this set of status codes. If empty, the HTTP status code will only pass if the HTTP status code is 200-299. Structure is documented below.
- auth
Info UptimeCheck Config Http Check Auth Info - The authentication information using username and password. Optional when creating an HTTP check; defaults to empty. Do not use with other authentication fields. Structure is documented below.
- body string
- The request body associated with the HTTP POST request. If
content_type
isURL_ENCODED
, the body passed in must be URL-encoded. Users can provide aContent-Length
header via theheaders
field or the API will do so. If therequest_method
isGET
andbody
is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note - As with all bytes fields JSON representations are base64 encoded. e.g.foo=bar
in URL-encoded form isfoo%3Dbar
and in base64 encoding isZm9vJTI1M0RiYXI=
. - content
Type string - The content type to use for the check.
Possible values are:
TYPE_UNSPECIFIED
,URL_ENCODED
,USER_PROVIDED
. - custom
Content stringType - A user provided content type header to use for the check. The invalid configurations outlined in the
content_type
field apply to custom_content_type, as well as the following 1.
content_typeis
URL_ENCODEDand
custom_content_typeis set. 2.
content_typeis
USER_PROVIDEDand
custom_content_type` is not set. - headers {[key: string]: string}
- The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described in RFC 2616 (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100.
- mask
Headers boolean - Boolean specifying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if
mask_headers
is set totrue
then the headers will be obscured with******
. - path string
- The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. If the provided path does not begin with
/
, a/
will be prepended automatically. Optional (defaults to/
). - ping
Config UptimeCheck Config Http Check Ping Config - Contains information needed to add pings to an HTTP check. Structure is documented below.
- port number
- The port to the page to run the check against. Will be combined with
host
(specified within themonitored_resource
) and path to construct the full URL. Optional (defaults to 80 without SSL, or 443 with SSL). - request
Method string - The HTTP request method to use for the check. If set to
METHOD_UNSPECIFIED
thenrequest_method
defaults toGET
. Default value isGET
. Possible values are:METHOD_UNSPECIFIED
,GET
,POST
. - service
Agent UptimeAuthentication Check Config Http Check Service Agent Authentication - The authentication information using the Monitoring Service Agent. Optional when creating an HTTPS check; defaults to empty. Do not use with other authentication fields. Structure is documented below.
- use
Ssl boolean - If true, use HTTPS instead of HTTP to run the check.
- validate
Ssl boolean - Boolean specifying whether to include SSL certificate validation as a part of the Uptime check. Only applies to checks where
monitored_resource
is set touptime_url
. Ifuse_ssl
isfalse
, settingvalidate_ssl
totrue
has no effect.
- accepted_
response_ Sequence[Uptimestatus_ codes Check Config Http Check Accepted Response Status Code] - If present, the check will only pass if the HTTP response status code is in this set of status codes. If empty, the HTTP status code will only pass if the HTTP status code is 200-299. Structure is documented below.
- auth_
info UptimeCheck Config Http Check Auth Info - The authentication information using username and password. Optional when creating an HTTP check; defaults to empty. Do not use with other authentication fields. Structure is documented below.
- body str
- The request body associated with the HTTP POST request. If
content_type
isURL_ENCODED
, the body passed in must be URL-encoded. Users can provide aContent-Length
header via theheaders
field or the API will do so. If therequest_method
isGET
andbody
is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note - As with all bytes fields JSON representations are base64 encoded. e.g.foo=bar
in URL-encoded form isfoo%3Dbar
and in base64 encoding isZm9vJTI1M0RiYXI=
. - content_
type str - The content type to use for the check.
Possible values are:
TYPE_UNSPECIFIED
,URL_ENCODED
,USER_PROVIDED
. - custom_
content_ strtype - A user provided content type header to use for the check. The invalid configurations outlined in the
content_type
field apply to custom_content_type, as well as the following 1.
content_typeis
URL_ENCODEDand
custom_content_typeis set. 2.
content_typeis
USER_PROVIDEDand
custom_content_type` is not set. - headers Mapping[str, str]
- The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described in RFC 2616 (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100.
- mask_
headers bool - Boolean specifying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if
mask_headers
is set totrue
then the headers will be obscured with******
. - path str
- The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. If the provided path does not begin with
/
, a/
will be prepended automatically. Optional (defaults to/
). - ping_
config UptimeCheck Config Http Check Ping Config - Contains information needed to add pings to an HTTP check. Structure is documented below.
- port int
- The port to the page to run the check against. Will be combined with
host
(specified within themonitored_resource
) and path to construct the full URL. Optional (defaults to 80 without SSL, or 443 with SSL). - request_
method str - The HTTP request method to use for the check. If set to
METHOD_UNSPECIFIED
thenrequest_method
defaults toGET
. Default value isGET
. Possible values are:METHOD_UNSPECIFIED
,GET
,POST
. - service_
agent_ Uptimeauthentication Check Config Http Check Service Agent Authentication - The authentication information using the Monitoring Service Agent. Optional when creating an HTTPS check; defaults to empty. Do not use with other authentication fields. Structure is documented below.
- use_
ssl bool - If true, use HTTPS instead of HTTP to run the check.
- validate_
ssl bool - Boolean specifying whether to include SSL certificate validation as a part of the Uptime check. Only applies to checks where
monitored_resource
is set touptime_url
. Ifuse_ssl
isfalse
, settingvalidate_ssl
totrue
has no effect.
- accepted
Response List<Property Map>Status Codes - If present, the check will only pass if the HTTP response status code is in this set of status codes. If empty, the HTTP status code will only pass if the HTTP status code is 200-299. Structure is documented below.
- auth
Info Property Map - The authentication information using username and password. Optional when creating an HTTP check; defaults to empty. Do not use with other authentication fields. Structure is documented below.
- body String
- The request body associated with the HTTP POST request. If
content_type
isURL_ENCODED
, the body passed in must be URL-encoded. Users can provide aContent-Length
header via theheaders
field or the API will do so. If therequest_method
isGET
andbody
is not empty, the API will return an error. The maximum byte size is 1 megabyte. Note - As with all bytes fields JSON representations are base64 encoded. e.g.foo=bar
in URL-encoded form isfoo%3Dbar
and in base64 encoding isZm9vJTI1M0RiYXI=
. - content
Type String - The content type to use for the check.
Possible values are:
TYPE_UNSPECIFIED
,URL_ENCODED
,USER_PROVIDED
. - custom
Content StringType - A user provided content type header to use for the check. The invalid configurations outlined in the
content_type
field apply to custom_content_type, as well as the following 1.
content_typeis
URL_ENCODEDand
custom_content_typeis set. 2.
content_typeis
USER_PROVIDEDand
custom_content_type` is not set. - headers Map<String>
- The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described in RFC 2616 (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100.
- mask
Headers Boolean - Boolean specifying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if
mask_headers
is set totrue
then the headers will be obscured with******
. - path String
- The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. If the provided path does not begin with
/
, a/
will be prepended automatically. Optional (defaults to/
). - ping
Config Property Map - Contains information needed to add pings to an HTTP check. Structure is documented below.
- port Number
- The port to the page to run the check against. Will be combined with
host
(specified within themonitored_resource
) and path to construct the full URL. Optional (defaults to 80 without SSL, or 443 with SSL). - request
Method String - The HTTP request method to use for the check. If set to
METHOD_UNSPECIFIED
thenrequest_method
defaults toGET
. Default value isGET
. Possible values are:METHOD_UNSPECIFIED
,GET
,POST
. - service
Agent Property MapAuthentication - The authentication information using the Monitoring Service Agent. Optional when creating an HTTPS check; defaults to empty. Do not use with other authentication fields. Structure is documented below.
- use
Ssl Boolean - If true, use HTTPS instead of HTTP to run the check.
- validate
Ssl Boolean - Boolean specifying whether to include SSL certificate validation as a part of the Uptime check. Only applies to checks where
monitored_resource
is set touptime_url
. Ifuse_ssl
isfalse
, settingvalidate_ssl
totrue
has no effect.
UptimeCheckConfigHttpCheckAcceptedResponseStatusCode, UptimeCheckConfigHttpCheckAcceptedResponseStatusCodeArgs
- Status
Class string - A class of status codes to accept.
Possible values are:
STATUS_CLASS_1XX
,STATUS_CLASS_2XX
,STATUS_CLASS_3XX
,STATUS_CLASS_4XX
,STATUS_CLASS_5XX
,STATUS_CLASS_ANY
. - Status
Value int - A status code to accept.
- Status
Class string - A class of status codes to accept.
Possible values are:
STATUS_CLASS_1XX
,STATUS_CLASS_2XX
,STATUS_CLASS_3XX
,STATUS_CLASS_4XX
,STATUS_CLASS_5XX
,STATUS_CLASS_ANY
. - Status
Value int - A status code to accept.
- status
Class String - A class of status codes to accept.
Possible values are:
STATUS_CLASS_1XX
,STATUS_CLASS_2XX
,STATUS_CLASS_3XX
,STATUS_CLASS_4XX
,STATUS_CLASS_5XX
,STATUS_CLASS_ANY
. - status
Value Integer - A status code to accept.
- status
Class string - A class of status codes to accept.
Possible values are:
STATUS_CLASS_1XX
,STATUS_CLASS_2XX
,STATUS_CLASS_3XX
,STATUS_CLASS_4XX
,STATUS_CLASS_5XX
,STATUS_CLASS_ANY
. - status
Value number - A status code to accept.
- status_
class str - A class of status codes to accept.
Possible values are:
STATUS_CLASS_1XX
,STATUS_CLASS_2XX
,STATUS_CLASS_3XX
,STATUS_CLASS_4XX
,STATUS_CLASS_5XX
,STATUS_CLASS_ANY
. - status_
value int - A status code to accept.
- status
Class String - A class of status codes to accept.
Possible values are:
STATUS_CLASS_1XX
,STATUS_CLASS_2XX
,STATUS_CLASS_3XX
,STATUS_CLASS_4XX
,STATUS_CLASS_5XX
,STATUS_CLASS_ANY
. - status
Value Number - A status code to accept.
UptimeCheckConfigHttpCheckAuthInfo, UptimeCheckConfigHttpCheckAuthInfoArgs
UptimeCheckConfigHttpCheckPingConfig, UptimeCheckConfigHttpCheckPingConfigArgs
- Pings
Count int - Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
- Pings
Count int - Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
- pings
Count Integer - Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
- pings
Count number - Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
- pings_
count int - Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
- pings
Count Number - Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
UptimeCheckConfigHttpCheckServiceAgentAuthentication, UptimeCheckConfigHttpCheckServiceAgentAuthenticationArgs
- Type string
- The type of authentication to use.
Possible values are:
SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED
,OIDC_TOKEN
.
- Type string
- The type of authentication to use.
Possible values are:
SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED
,OIDC_TOKEN
.
- type String
- The type of authentication to use.
Possible values are:
SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED
,OIDC_TOKEN
.
- type string
- The type of authentication to use.
Possible values are:
SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED
,OIDC_TOKEN
.
- type str
- The type of authentication to use.
Possible values are:
SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED
,OIDC_TOKEN
.
- type String
- The type of authentication to use.
Possible values are:
SERVICE_AGENT_AUTHENTICATION_TYPE_UNSPECIFIED
,OIDC_TOKEN
.
UptimeCheckConfigMonitoredResource, UptimeCheckConfigMonitoredResourceArgs
- Labels Dictionary<string, string>
- Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels
project_id
,instance_id
, andzone
. - Type string
- The monitored resource type. This field must match the type field of a
MonitoredResourceDescriptor
object. For example, the type of a Compute Engine VM instance isgce_instance
. For a list of types, see Monitoring resource types and Logging resource types.
- Labels map[string]string
- Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels
project_id
,instance_id
, andzone
. - Type string
- The monitored resource type. This field must match the type field of a
MonitoredResourceDescriptor
object. For example, the type of a Compute Engine VM instance isgce_instance
. For a list of types, see Monitoring resource types and Logging resource types.
- labels Map<String,String>
- Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels
project_id
,instance_id
, andzone
. - type String
- The monitored resource type. This field must match the type field of a
MonitoredResourceDescriptor
object. For example, the type of a Compute Engine VM instance isgce_instance
. For a list of types, see Monitoring resource types and Logging resource types.
- labels {[key: string]: string}
- Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels
project_id
,instance_id
, andzone
. - type string
- The monitored resource type. This field must match the type field of a
MonitoredResourceDescriptor
object. For example, the type of a Compute Engine VM instance isgce_instance
. For a list of types, see Monitoring resource types and Logging resource types.
- labels Mapping[str, str]
- Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels
project_id
,instance_id
, andzone
. - type str
- The monitored resource type. This field must match the type field of a
MonitoredResourceDescriptor
object. For example, the type of a Compute Engine VM instance isgce_instance
. For a list of types, see Monitoring resource types and Logging resource types.
- labels Map<String>
- Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels
project_id
,instance_id
, andzone
. - type String
- The monitored resource type. This field must match the type field of a
MonitoredResourceDescriptor
object. For example, the type of a Compute Engine VM instance isgce_instance
. For a list of types, see Monitoring resource types and Logging resource types.
UptimeCheckConfigResourceGroup, UptimeCheckConfigResourceGroupArgs
- Group
Id string - The group of resources being monitored. Should be the
name
of a group - Resource
Type string - The resource type of the group members.
Possible values are:
RESOURCE_TYPE_UNSPECIFIED
,INSTANCE
,AWS_ELB_LOAD_BALANCER
.
- Group
Id string - The group of resources being monitored. Should be the
name
of a group - Resource
Type string - The resource type of the group members.
Possible values are:
RESOURCE_TYPE_UNSPECIFIED
,INSTANCE
,AWS_ELB_LOAD_BALANCER
.
- group
Id String - The group of resources being monitored. Should be the
name
of a group - resource
Type String - The resource type of the group members.
Possible values are:
RESOURCE_TYPE_UNSPECIFIED
,INSTANCE
,AWS_ELB_LOAD_BALANCER
.
- group
Id string - The group of resources being monitored. Should be the
name
of a group - resource
Type string - The resource type of the group members.
Possible values are:
RESOURCE_TYPE_UNSPECIFIED
,INSTANCE
,AWS_ELB_LOAD_BALANCER
.
- group_
id str - The group of resources being monitored. Should be the
name
of a group - resource_
type str - The resource type of the group members.
Possible values are:
RESOURCE_TYPE_UNSPECIFIED
,INSTANCE
,AWS_ELB_LOAD_BALANCER
.
- group
Id String - The group of resources being monitored. Should be the
name
of a group - resource
Type String - The resource type of the group members.
Possible values are:
RESOURCE_TYPE_UNSPECIFIED
,INSTANCE
,AWS_ELB_LOAD_BALANCER
.
UptimeCheckConfigSyntheticMonitor, UptimeCheckConfigSyntheticMonitorArgs
- Cloud
Function UptimeV2 Check Config Synthetic Monitor Cloud Function V2 Target a Synthetic Monitor GCFv2 Instance Structure is documented below.
The
cloud_function_v2
block supports:
- Cloud
Function UptimeV2 Check Config Synthetic Monitor Cloud Function V2 Target a Synthetic Monitor GCFv2 Instance Structure is documented below.
The
cloud_function_v2
block supports:
- cloud
Function UptimeV2 Check Config Synthetic Monitor Cloud Function V2 Target a Synthetic Monitor GCFv2 Instance Structure is documented below.
The
cloud_function_v2
block supports:
- cloud
Function UptimeV2 Check Config Synthetic Monitor Cloud Function V2 Target a Synthetic Monitor GCFv2 Instance Structure is documented below.
The
cloud_function_v2
block supports:
- cloud_
function_ Uptimev2 Check Config Synthetic Monitor Cloud Function V2 Target a Synthetic Monitor GCFv2 Instance Structure is documented below.
The
cloud_function_v2
block supports:
- cloud
Function Property MapV2 Target a Synthetic Monitor GCFv2 Instance Structure is documented below.
The
cloud_function_v2
block supports:
UptimeCheckConfigSyntheticMonitorCloudFunctionV2, UptimeCheckConfigSyntheticMonitorCloudFunctionV2Args
- Name string
- A unique resource name for this UptimeCheckConfig. The format is
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
.
- Name string
- A unique resource name for this UptimeCheckConfig. The format is
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
.
- name String
- A unique resource name for this UptimeCheckConfig. The format is
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
.
- name string
- A unique resource name for this UptimeCheckConfig. The format is
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
.
- name str
- A unique resource name for this UptimeCheckConfig. The format is
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
.
- name String
- A unique resource name for this UptimeCheckConfig. The format is
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
.
UptimeCheckConfigTcpCheck, UptimeCheckConfigTcpCheckArgs
- Port int
- The port to the page to run the check against. Will be combined with host (specified within the
monitored_resource
) to construct the full URL. - Ping
Config UptimeCheck Config Tcp Check Ping Config - Contains information needed to add pings to a TCP check. Structure is documented below.
- Port int
- The port to the page to run the check against. Will be combined with host (specified within the
monitored_resource
) to construct the full URL. - Ping
Config UptimeCheck Config Tcp Check Ping Config - Contains information needed to add pings to a TCP check. Structure is documented below.
- port Integer
- The port to the page to run the check against. Will be combined with host (specified within the
monitored_resource
) to construct the full URL. - ping
Config UptimeCheck Config Tcp Check Ping Config - Contains information needed to add pings to a TCP check. Structure is documented below.
- port number
- The port to the page to run the check against. Will be combined with host (specified within the
monitored_resource
) to construct the full URL. - ping
Config UptimeCheck Config Tcp Check Ping Config - Contains information needed to add pings to a TCP check. Structure is documented below.
- port int
- The port to the page to run the check against. Will be combined with host (specified within the
monitored_resource
) to construct the full URL. - ping_
config UptimeCheck Config Tcp Check Ping Config - Contains information needed to add pings to a TCP check. Structure is documented below.
- port Number
- The port to the page to run the check against. Will be combined with host (specified within the
monitored_resource
) to construct the full URL. - ping
Config Property Map - Contains information needed to add pings to a TCP check. Structure is documented below.
UptimeCheckConfigTcpCheckPingConfig, UptimeCheckConfigTcpCheckPingConfigArgs
- Pings
Count int - Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
- Pings
Count int - Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
- pings
Count Integer - Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
- pings
Count number - Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
- pings_
count int - Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
- pings
Count Number - Number of ICMP pings. A maximum of 3 ICMP pings is currently supported.
Import
UptimeCheckConfig can be imported using any of these accepted formats:
{{project}}/{{name}}
{{project}} {{name}}
{{name}}
When using the pulumi import
command, UptimeCheckConfig can be imported using one of the formats above. For example:
$ pulumi import gcp:monitoring/uptimeCheckConfig:UptimeCheckConfig default {{project}}/{{name}}
$ pulumi import gcp:monitoring/uptimeCheckConfig:UptimeCheckConfig default "{{project}} {{name}}"
$ pulumi import gcp:monitoring/uptimeCheckConfig:UptimeCheckConfig default {{name}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-beta
Terraform Provider.