Oracle Cloud Infrastructure v0.13.0, Mar 28 23

oci.HealthChecks.PingMonitor

This resource provides the Ping Monitor resource in Oracle Cloud Infrastructure Health Checks service.

Creates a ping monitor. Vantage points will be automatically selected if not specified, and probes will be initiated from each vantage point to each of the targets at the frequency specified by intervalInSeconds.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testPingMonitor = new Oci.HealthChecks.PingMonitor("testPingMonitor", new()
    {
        CompartmentId = @var.Compartment_id,
        DisplayName = @var.Ping_monitor_display_name,
        IntervalInSeconds = @var.Ping_monitor_interval_in_seconds,
        Protocol = @var.Ping_monitor_protocol,
        Targets = @var.Ping_monitor_targets,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        IsEnabled = @var.Ping_monitor_is_enabled,
        Port = @var.Ping_monitor_port,
        TimeoutInSeconds = @var.Ping_monitor_timeout_in_seconds,
        VantagePointNames = @var.Ping_monitor_vantage_point_names,
    });

});

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/HealthChecks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := HealthChecks.NewPingMonitor(ctx, "testPingMonitor", &HealthChecks.PingMonitorArgs{
			CompartmentId:     pulumi.Any(_var.Compartment_id),
			DisplayName:       pulumi.Any(_var.Ping_monitor_display_name),
			IntervalInSeconds: pulumi.Any(_var.Ping_monitor_interval_in_seconds),
			Protocol:          pulumi.Any(_var.Ping_monitor_protocol),
			Targets:           pulumi.Any(_var.Ping_monitor_targets),
			DefinedTags: pulumi.AnyMap{
				"Operations.CostCenter": pulumi.Any("42"),
			},
			FreeformTags: pulumi.AnyMap{
				"Department": pulumi.Any("Finance"),
			},
			IsEnabled:         pulumi.Any(_var.Ping_monitor_is_enabled),
			Port:              pulumi.Any(_var.Ping_monitor_port),
			TimeoutInSeconds:  pulumi.Any(_var.Ping_monitor_timeout_in_seconds),
			VantagePointNames: pulumi.Any(_var.Ping_monitor_vantage_point_names),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.HealthChecks.PingMonitor;
import com.pulumi.oci.HealthChecks.PingMonitorArgs;
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 testPingMonitor = new PingMonitor("testPingMonitor", PingMonitorArgs.builder()        
            .compartmentId(var_.compartment_id())
            .displayName(var_.ping_monitor_display_name())
            .intervalInSeconds(var_.ping_monitor_interval_in_seconds())
            .protocol(var_.ping_monitor_protocol())
            .targets(var_.ping_monitor_targets())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .freeformTags(Map.of("Department", "Finance"))
            .isEnabled(var_.ping_monitor_is_enabled())
            .port(var_.ping_monitor_port())
            .timeoutInSeconds(var_.ping_monitor_timeout_in_seconds())
            .vantagePointNames(var_.ping_monitor_vantage_point_names())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_ping_monitor = oci.health_checks.PingMonitor("testPingMonitor",
    compartment_id=var["compartment_id"],
    display_name=var["ping_monitor_display_name"],
    interval_in_seconds=var["ping_monitor_interval_in_seconds"],
    protocol=var["ping_monitor_protocol"],
    targets=var["ping_monitor_targets"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    freeform_tags={
        "Department": "Finance",
    },
    is_enabled=var["ping_monitor_is_enabled"],
    port=var["ping_monitor_port"],
    timeout_in_seconds=var["ping_monitor_timeout_in_seconds"],
    vantage_point_names=var["ping_monitor_vantage_point_names"])

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

const testPingMonitor = new oci.healthchecks.PingMonitor("testPingMonitor", {
    compartmentId: _var.compartment_id,
    displayName: _var.ping_monitor_display_name,
    intervalInSeconds: _var.ping_monitor_interval_in_seconds,
    protocol: _var.ping_monitor_protocol,
    targets: _var.ping_monitor_targets,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    freeformTags: {
        Department: "Finance",
    },
    isEnabled: _var.ping_monitor_is_enabled,
    port: _var.ping_monitor_port,
    timeoutInSeconds: _var.ping_monitor_timeout_in_seconds,
    vantagePointNames: _var.ping_monitor_vantage_point_names,
});

resources:
  testPingMonitor:
    type: oci:HealthChecks:PingMonitor
    properties:
      #Required
      compartmentId: ${var.compartment_id}
      displayName: ${var.ping_monitor_display_name}
      intervalInSeconds: ${var.ping_monitor_interval_in_seconds}
      protocol: ${var.ping_monitor_protocol}
      targets: ${var.ping_monitor_targets}
      #Optional
      definedTags:
        Operations.CostCenter: '42'
      freeformTags:
        Department: Finance
      isEnabled: ${var.ping_monitor_is_enabled}
      port: ${var.ping_monitor_port}
      timeoutInSeconds: ${var.ping_monitor_timeout_in_seconds}
      vantagePointNames: ${var.ping_monitor_vantage_point_names}

Create PingMonitor Resource

new PingMonitor(name: string, args: PingMonitorArgs, opts?: CustomResourceOptions);

@overload
def PingMonitor(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                compartment_id: Optional[str] = None,
                defined_tags: Optional[Mapping[str, Any]] = None,
                display_name: Optional[str] = None,
                freeform_tags: Optional[Mapping[str, Any]] = None,
                interval_in_seconds: Optional[int] = None,
                is_enabled: Optional[bool] = None,
                port: Optional[int] = None,
                protocol: Optional[str] = None,
                targets: Optional[Sequence[str]] = None,
                timeout_in_seconds: Optional[int] = None,
                vantage_point_names: Optional[Sequence[str]] = None)
@overload
def PingMonitor(resource_name: str,
                args: PingMonitorArgs,
                opts: Optional[ResourceOptions] = None)

func NewPingMonitor(ctx *Context, name string, args PingMonitorArgs, opts ...ResourceOption) (*PingMonitor, error)

public PingMonitor(string name, PingMonitorArgs args, CustomResourceOptions? opts = null)

public PingMonitor(String name, PingMonitorArgs args)
public PingMonitor(String name, PingMonitorArgs args, CustomResourceOptions options)

type: oci:HealthChecks:PingMonitor
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PingMonitorArgs: 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 PingMonitorArgs: 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 PingMonitorArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PingMonitorArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args PingMonitorArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

PingMonitor Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The PingMonitor resource accepts the following input properties:

CompartmentId string: (Updatable) The OCID of the compartment.
DisplayName string: (Updatable) A user-friendly and mutable name suitable for display in a user interface.
IntervalInSeconds int: (Updatable) The monitor interval in seconds. Valid values: 10, 30, and 60.
Protocol string: (Updatable) The protocols for ping probes.
Targets List<string>: (Updatable) A list of targets (hostnames or IP addresses) of the probe.
DefinedTags Dictionary<string, object>: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
FreeformTags Dictionary<string, object>: (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
IsEnabled bool: (Updatable) Enables or disables the monitor. Set to 'true' to launch monitoring.
Port int: (Updatable) The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
TimeoutInSeconds int: (Updatable) The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors.
VantagePointNames List<string>: (Updatable) A list of names of vantage points from which to execute the probe.

CompartmentId string: (Updatable) The OCID of the compartment.
DisplayName string: (Updatable) A user-friendly and mutable name suitable for display in a user interface.
IntervalInSeconds int: (Updatable) The monitor interval in seconds. Valid values: 10, 30, and 60.
Protocol string: (Updatable) The protocols for ping probes.
Targets []string: (Updatable) A list of targets (hostnames or IP addresses) of the probe.
DefinedTags map[string]interface{}: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
FreeformTags map[string]interface{}: (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
IsEnabled bool: (Updatable) Enables or disables the monitor. Set to 'true' to launch monitoring.
Port int: (Updatable) The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
TimeoutInSeconds int: (Updatable) The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors.
VantagePointNames []string: (Updatable) A list of names of vantage points from which to execute the probe.

compartmentId String: (Updatable) The OCID of the compartment.
displayName String: (Updatable) A user-friendly and mutable name suitable for display in a user interface.
intervalInSeconds Integer: (Updatable) The monitor interval in seconds. Valid values: 10, 30, and 60.
protocol String: (Updatable) The protocols for ping probes.
targets List<String>: (Updatable) A list of targets (hostnames or IP addresses) of the probe.
definedTags Map<String,Object>: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
freeformTags Map<String,Object>: (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
isEnabled Boolean: (Updatable) Enables or disables the monitor. Set to 'true' to launch monitoring.
port Integer: (Updatable) The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
timeoutInSeconds Integer: (Updatable) The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors.
vantagePointNames List<String>: (Updatable) A list of names of vantage points from which to execute the probe.

compartmentId string: (Updatable) The OCID of the compartment.
displayName string: (Updatable) A user-friendly and mutable name suitable for display in a user interface.
intervalInSeconds number: (Updatable) The monitor interval in seconds. Valid values: 10, 30, and 60.
protocol string: (Updatable) The protocols for ping probes.
targets string[]: (Updatable) A list of targets (hostnames or IP addresses) of the probe.
definedTags {[key: string]: any}: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
freeformTags {[key: string]: any}: (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
isEnabled boolean: (Updatable) Enables or disables the monitor. Set to 'true' to launch monitoring.
port number: (Updatable) The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
timeoutInSeconds number: (Updatable) The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors.
vantagePointNames string[]: (Updatable) A list of names of vantage points from which to execute the probe.

compartment_id str: (Updatable) The OCID of the compartment.
display_name str: (Updatable) A user-friendly and mutable name suitable for display in a user interface.
interval_in_seconds int: (Updatable) The monitor interval in seconds. Valid values: 10, 30, and 60.
protocol str: (Updatable) The protocols for ping probes.
targets Sequence[str]: (Updatable) A list of targets (hostnames or IP addresses) of the probe.
defined_tags Mapping[str, Any]: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
freeform_tags Mapping[str, Any]: (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
is_enabled bool: (Updatable) Enables or disables the monitor. Set to 'true' to launch monitoring.
port int: (Updatable) The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
timeout_in_seconds int: (Updatable) The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors.
vantage_point_names Sequence[str]: (Updatable) A list of names of vantage points from which to execute the probe.

compartmentId String: (Updatable) The OCID of the compartment.
displayName String: (Updatable) A user-friendly and mutable name suitable for display in a user interface.
intervalInSeconds Number: (Updatable) The monitor interval in seconds. Valid values: 10, 30, and 60.
protocol String: (Updatable) The protocols for ping probes.
targets List<String>: (Updatable) A list of targets (hostnames or IP addresses) of the probe.
definedTags Map<Any>: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
freeformTags Map<Any>: (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
isEnabled Boolean: (Updatable) Enables or disables the monitor. Set to 'true' to launch monitoring.
port Number: (Updatable) The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
timeoutInSeconds Number: (Updatable) The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors.
vantagePointNames List<String>: (Updatable) A list of names of vantage points from which to execute the probe.

Outputs

All input properties are implicitly available as output properties. Additionally, the PingMonitor resource produces the following output properties:

HomeRegion string: The region where updates must be made and where results must be fetched from.
Id string: The provider-assigned unique ID for this managed resource.
ResultsUrl string: A URL for fetching the probe results.
TimeCreated string: The RFC 3339-formatted creation date and time of the probe.

HomeRegion string: The region where updates must be made and where results must be fetched from.
Id string: The provider-assigned unique ID for this managed resource.
ResultsUrl string: A URL for fetching the probe results.
TimeCreated string: The RFC 3339-formatted creation date and time of the probe.

homeRegion String: The region where updates must be made and where results must be fetched from.
id String: The provider-assigned unique ID for this managed resource.
resultsUrl String: A URL for fetching the probe results.
timeCreated String: The RFC 3339-formatted creation date and time of the probe.

homeRegion string: The region where updates must be made and where results must be fetched from.
id string: The provider-assigned unique ID for this managed resource.
resultsUrl string: A URL for fetching the probe results.
timeCreated string: The RFC 3339-formatted creation date and time of the probe.

home_region str: The region where updates must be made and where results must be fetched from.
id str: The provider-assigned unique ID for this managed resource.
results_url str: A URL for fetching the probe results.
time_created str: The RFC 3339-formatted creation date and time of the probe.

homeRegion String: The region where updates must be made and where results must be fetched from.
id String: The provider-assigned unique ID for this managed resource.
resultsUrl String: A URL for fetching the probe results.
timeCreated String: The RFC 3339-formatted creation date and time of the probe.

Look up Existing PingMonitor Resource

Get an existing PingMonitor 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?: PingMonitorState, opts?: CustomResourceOptions): PingMonitor

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        home_region: Optional[str] = None,
        interval_in_seconds: Optional[int] = None,
        is_enabled: Optional[bool] = None,
        port: Optional[int] = None,
        protocol: Optional[str] = None,
        results_url: Optional[str] = None,
        targets: Optional[Sequence[str]] = None,
        time_created: Optional[str] = None,
        timeout_in_seconds: Optional[int] = None,
        vantage_point_names: Optional[Sequence[str]] = None) -> PingMonitor

func GetPingMonitor(ctx *Context, name string, id IDInput, state *PingMonitorState, opts ...ResourceOption) (*PingMonitor, error)

public static PingMonitor Get(string name, Input<string> id, PingMonitorState? state, CustomResourceOptions? opts = null)

public static PingMonitor get(String name, Output<String> id, PingMonitorState 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.

The following state arguments are supported:

CompartmentId string: (Updatable) The OCID of the compartment.
DefinedTags Dictionary<string, object>: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DisplayName string: (Updatable) A user-friendly and mutable name suitable for display in a user interface.
FreeformTags Dictionary<string, object>: (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
HomeRegion string: The region where updates must be made and where results must be fetched from.
IntervalInSeconds int: (Updatable) The monitor interval in seconds. Valid values: 10, 30, and 60.
IsEnabled bool: (Updatable) Enables or disables the monitor. Set to 'true' to launch monitoring.
Port int: (Updatable) The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
Protocol string: (Updatable) The protocols for ping probes.
ResultsUrl string: A URL for fetching the probe results.
Targets List<string>: (Updatable) A list of targets (hostnames or IP addresses) of the probe.
TimeCreated string: The RFC 3339-formatted creation date and time of the probe.
TimeoutInSeconds int: (Updatable) The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors.
VantagePointNames List<string>: (Updatable) A list of names of vantage points from which to execute the probe.

CompartmentId string: (Updatable) The OCID of the compartment.
DefinedTags map[string]interface{}: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DisplayName string: (Updatable) A user-friendly and mutable name suitable for display in a user interface.
FreeformTags map[string]interface{}: (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
HomeRegion string: The region where updates must be made and where results must be fetched from.
IntervalInSeconds int: (Updatable) The monitor interval in seconds. Valid values: 10, 30, and 60.
IsEnabled bool: (Updatable) Enables or disables the monitor. Set to 'true' to launch monitoring.
Port int: (Updatable) The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
Protocol string: (Updatable) The protocols for ping probes.
ResultsUrl string: A URL for fetching the probe results.
Targets []string: (Updatable) A list of targets (hostnames or IP addresses) of the probe.
TimeCreated string: The RFC 3339-formatted creation date and time of the probe.
TimeoutInSeconds int: (Updatable) The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors.
VantagePointNames []string: (Updatable) A list of names of vantage points from which to execute the probe.

compartmentId String: (Updatable) The OCID of the compartment.
definedTags Map<String,Object>: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName String: (Updatable) A user-friendly and mutable name suitable for display in a user interface.
freeformTags Map<String,Object>: (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
homeRegion String: The region where updates must be made and where results must be fetched from.
intervalInSeconds Integer: (Updatable) The monitor interval in seconds. Valid values: 10, 30, and 60.
isEnabled Boolean: (Updatable) Enables or disables the monitor. Set to 'true' to launch monitoring.
port Integer: (Updatable) The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
protocol String: (Updatable) The protocols for ping probes.
resultsUrl String: A URL for fetching the probe results.
targets List<String>: (Updatable) A list of targets (hostnames or IP addresses) of the probe.
timeCreated String: The RFC 3339-formatted creation date and time of the probe.
timeoutInSeconds Integer: (Updatable) The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors.
vantagePointNames List<String>: (Updatable) A list of names of vantage points from which to execute the probe.

compartmentId string: (Updatable) The OCID of the compartment.
definedTags {[key: string]: any}: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName string: (Updatable) A user-friendly and mutable name suitable for display in a user interface.
freeformTags {[key: string]: any}: (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
homeRegion string: The region where updates must be made and where results must be fetched from.
intervalInSeconds number: (Updatable) The monitor interval in seconds. Valid values: 10, 30, and 60.
isEnabled boolean: (Updatable) Enables or disables the monitor. Set to 'true' to launch monitoring.
port number: (Updatable) The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
protocol string: (Updatable) The protocols for ping probes.
resultsUrl string: A URL for fetching the probe results.
targets string[]: (Updatable) A list of targets (hostnames or IP addresses) of the probe.
timeCreated string: The RFC 3339-formatted creation date and time of the probe.
timeoutInSeconds number: (Updatable) The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors.
vantagePointNames string[]: (Updatable) A list of names of vantage points from which to execute the probe.

compartment_id str: (Updatable) The OCID of the compartment.
defined_tags Mapping[str, Any]: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
display_name str: (Updatable) A user-friendly and mutable name suitable for display in a user interface.
freeform_tags Mapping[str, Any]: (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
home_region str: The region where updates must be made and where results must be fetched from.
interval_in_seconds int: (Updatable) The monitor interval in seconds. Valid values: 10, 30, and 60.
is_enabled bool: (Updatable) Enables or disables the monitor. Set to 'true' to launch monitoring.
port int: (Updatable) The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
protocol str: (Updatable) The protocols for ping probes.
results_url str: A URL for fetching the probe results.
targets Sequence[str]: (Updatable) A list of targets (hostnames or IP addresses) of the probe.
time_created str: The RFC 3339-formatted creation date and time of the probe.
timeout_in_seconds int: (Updatable) The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors.
vantage_point_names Sequence[str]: (Updatable) A list of names of vantage points from which to execute the probe.

compartmentId String: (Updatable) The OCID of the compartment.
definedTags Map<Any>: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName String: (Updatable) A user-friendly and mutable name suitable for display in a user interface.
freeformTags Map<Any>: (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
homeRegion String: The region where updates must be made and where results must be fetched from.
intervalInSeconds Number: (Updatable) The monitor interval in seconds. Valid values: 10, 30, and 60.
isEnabled Boolean: (Updatable) Enables or disables the monitor. Set to 'true' to launch monitoring.
port Number: (Updatable) The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
protocol String: (Updatable) The protocols for ping probes.
resultsUrl String: A URL for fetching the probe results.
targets List<String>: (Updatable) A list of targets (hostnames or IP addresses) of the probe.
timeCreated String: The RFC 3339-formatted creation date and time of the probe.
timeoutInSeconds Number: (Updatable) The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors.
vantagePointNames List<String>: (Updatable) A list of names of vantage points from which to execute the probe.

Import

PingMonitors can be imported using the id, e.g.

 $ pulumi import oci:HealthChecks/pingMonitor:PingMonitor test_ping_monitor "id"

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.