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
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testPingMonitor = new oci.healthchecks.PingMonitor("test_ping_monitor", {
    compartmentId: compartmentId,
    displayName: pingMonitorDisplayName,
    intervalInSeconds: pingMonitorIntervalInSeconds,
    protocol: pingMonitorProtocol,
    targets: pingMonitorTargets,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    freeformTags: {
        Department: "Finance",
    },
    isEnabled: pingMonitorIsEnabled,
    port: pingMonitorPort,
    timeoutInSeconds: pingMonitorTimeoutInSeconds,
    vantagePointNames: pingMonitorVantagePointNames,
});
import pulumi
import pulumi_oci as oci
test_ping_monitor = oci.healthchecks.PingMonitor("test_ping_monitor",
    compartment_id=compartment_id,
    display_name=ping_monitor_display_name,
    interval_in_seconds=ping_monitor_interval_in_seconds,
    protocol=ping_monitor_protocol,
    targets=ping_monitor_targets,
    defined_tags={
        "Operations.CostCenter": "42",
    },
    freeform_tags={
        "Department": "Finance",
    },
    is_enabled=ping_monitor_is_enabled,
    port=ping_monitor_port,
    timeout_in_seconds=ping_monitor_timeout_in_seconds,
    vantage_point_names=ping_monitor_vantage_point_names)
package main
import (
	"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/healthchecks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := healthchecks.NewPingMonitor(ctx, "test_ping_monitor", &healthchecks.PingMonitorArgs{
			CompartmentId:     pulumi.Any(compartmentId),
			DisplayName:       pulumi.Any(pingMonitorDisplayName),
			IntervalInSeconds: pulumi.Any(pingMonitorIntervalInSeconds),
			Protocol:          pulumi.Any(pingMonitorProtocol),
			Targets:           pulumi.Any(pingMonitorTargets),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
			IsEnabled:         pulumi.Any(pingMonitorIsEnabled),
			Port:              pulumi.Any(pingMonitorPort),
			TimeoutInSeconds:  pulumi.Any(pingMonitorTimeoutInSeconds),
			VantagePointNames: pulumi.Any(pingMonitorVantagePointNames),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() => 
{
    var testPingMonitor = new Oci.HealthChecks.PingMonitor("test_ping_monitor", new()
    {
        CompartmentId = compartmentId,
        DisplayName = pingMonitorDisplayName,
        IntervalInSeconds = pingMonitorIntervalInSeconds,
        Protocol = pingMonitorProtocol,
        Targets = pingMonitorTargets,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
        IsEnabled = pingMonitorIsEnabled,
        Port = pingMonitorPort,
        TimeoutInSeconds = pingMonitorTimeoutInSeconds,
        VantagePointNames = pingMonitorVantagePointNames,
    });
});
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(compartmentId)
            .displayName(pingMonitorDisplayName)
            .intervalInSeconds(pingMonitorIntervalInSeconds)
            .protocol(pingMonitorProtocol)
            .targets(pingMonitorTargets)
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .freeformTags(Map.of("Department", "Finance"))
            .isEnabled(pingMonitorIsEnabled)
            .port(pingMonitorPort)
            .timeoutInSeconds(pingMonitorTimeoutInSeconds)
            .vantagePointNames(pingMonitorVantagePointNames)
            .build());
    }
}
resources:
  testPingMonitor:
    type: oci:HealthChecks:PingMonitor
    name: test_ping_monitor
    properties:
      compartmentId: ${compartmentId}
      displayName: ${pingMonitorDisplayName}
      intervalInSeconds: ${pingMonitorIntervalInSeconds}
      protocol: ${pingMonitorProtocol}
      targets: ${pingMonitorTargets}
      definedTags:
        Operations.CostCenter: '42'
      freeformTags:
        Department: Finance
      isEnabled: ${pingMonitorIsEnabled}
      port: ${pingMonitorPort}
      timeoutInSeconds: ${pingMonitorTimeoutInSeconds}
      vantagePointNames: ${pingMonitorVantagePointNames}
Create PingMonitor Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PingMonitor(name: string, args: PingMonitorArgs, opts?: CustomResourceOptions);@overload
def PingMonitor(resource_name: str,
                args: PingMonitorArgs,
                opts: Optional[ResourceOptions] = None)
@overload
def PingMonitor(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                compartment_id: Optional[str] = None,
                display_name: Optional[str] = None,
                interval_in_seconds: Optional[int] = None,
                protocol: Optional[str] = None,
                targets: Optional[Sequence[str]] = None,
                defined_tags: Optional[Mapping[str, str]] = None,
                freeform_tags: Optional[Mapping[str, str]] = None,
                is_enabled: Optional[bool] = None,
                port: Optional[int] = None,
                timeout_in_seconds: Optional[int] = None,
                vantage_point_names: Optional[Sequence[str]] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var pingMonitorResource = new Oci.HealthChecks.PingMonitor("pingMonitorResource", new()
{
    CompartmentId = "string",
    DisplayName = "string",
    IntervalInSeconds = 0,
    Protocol = "string",
    Targets = new[]
    {
        "string",
    },
    DefinedTags = 
    {
        { "string", "string" },
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
    IsEnabled = false,
    Port = 0,
    TimeoutInSeconds = 0,
    VantagePointNames = new[]
    {
        "string",
    },
});
example, err := healthchecks.NewPingMonitor(ctx, "pingMonitorResource", &healthchecks.PingMonitorArgs{
	CompartmentId:     pulumi.String("string"),
	DisplayName:       pulumi.String("string"),
	IntervalInSeconds: pulumi.Int(0),
	Protocol:          pulumi.String("string"),
	Targets: pulumi.StringArray{
		pulumi.String("string"),
	},
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IsEnabled:        pulumi.Bool(false),
	Port:             pulumi.Int(0),
	TimeoutInSeconds: pulumi.Int(0),
	VantagePointNames: pulumi.StringArray{
		pulumi.String("string"),
	},
})
var pingMonitorResource = new PingMonitor("pingMonitorResource", PingMonitorArgs.builder()
    .compartmentId("string")
    .displayName("string")
    .intervalInSeconds(0)
    .protocol("string")
    .targets("string")
    .definedTags(Map.of("string", "string"))
    .freeformTags(Map.of("string", "string"))
    .isEnabled(false)
    .port(0)
    .timeoutInSeconds(0)
    .vantagePointNames("string")
    .build());
ping_monitor_resource = oci.healthchecks.PingMonitor("pingMonitorResource",
    compartment_id="string",
    display_name="string",
    interval_in_seconds=0,
    protocol="string",
    targets=["string"],
    defined_tags={
        "string": "string",
    },
    freeform_tags={
        "string": "string",
    },
    is_enabled=False,
    port=0,
    timeout_in_seconds=0,
    vantage_point_names=["string"])
const pingMonitorResource = new oci.healthchecks.PingMonitor("pingMonitorResource", {
    compartmentId: "string",
    displayName: "string",
    intervalInSeconds: 0,
    protocol: "string",
    targets: ["string"],
    definedTags: {
        string: "string",
    },
    freeformTags: {
        string: "string",
    },
    isEnabled: false,
    port: 0,
    timeoutInSeconds: 0,
    vantagePointNames: ["string"],
});
type: oci:HealthChecks:PingMonitor
properties:
    compartmentId: string
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string
    intervalInSeconds: 0
    isEnabled: false
    port: 0
    protocol: string
    targets:
        - string
    timeoutInSeconds: 0
    vantagePointNames:
        - string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
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.
- IntervalIn intSeconds 
- (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.
- Dictionary<string, string>
- (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"}
- Dictionary<string, string>
- (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.
- TimeoutIn intSeconds 
- (Updatable) The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSecondsfor monitors.
- VantagePoint List<string>Names 
- (Updatable) A list of names of vantage points from which to execute the probe. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- CompartmentId string
- (Updatable) The OCID of the compartment.
- DisplayName string
- (Updatable) A user-friendly and mutable name suitable for display in a user interface.
- IntervalIn intSeconds 
- (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.
- map[string]string
- (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"}
- map[string]string
- (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.
- TimeoutIn intSeconds 
- (Updatable) The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSecondsfor monitors.
- VantagePoint []stringNames 
- (Updatable) A list of names of vantage points from which to execute the probe. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- compartmentId String
- (Updatable) The OCID of the compartment.
- displayName String
- (Updatable) A user-friendly and mutable name suitable for display in a user interface.
- intervalIn IntegerSeconds 
- (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.
- Map<String,String>
- (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"}
- Map<String,String>
- (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.
- timeoutIn IntegerSeconds 
- (Updatable) The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSecondsfor monitors.
- vantagePoint List<String>Names 
- (Updatable) A list of names of vantage points from which to execute the probe. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- compartmentId string
- (Updatable) The OCID of the compartment.
- displayName string
- (Updatable) A user-friendly and mutable name suitable for display in a user interface.
- intervalIn numberSeconds 
- (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.
- {[key: string]: string}
- (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"}
- {[key: string]: string}
- (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.
- timeoutIn numberSeconds 
- (Updatable) The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSecondsfor monitors.
- vantagePoint string[]Names 
- (Updatable) A list of names of vantage points from which to execute the probe. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- 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_ intseconds 
- (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.
- Mapping[str, str]
- (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"}
- Mapping[str, str]
- (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_ intseconds 
- (Updatable) The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSecondsfor monitors.
- vantage_point_ Sequence[str]names 
- (Updatable) A list of names of vantage points from which to execute the probe. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- compartmentId String
- (Updatable) The OCID of the compartment.
- displayName String
- (Updatable) A user-friendly and mutable name suitable for display in a user interface.
- intervalIn NumberSeconds 
- (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.
- Map<String>
- (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"}
- Map<String>
- (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.
- timeoutIn NumberSeconds 
- (Updatable) The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSecondsfor monitors.
- vantagePoint List<String>Names 
- (Updatable) A list of names of vantage points from which to execute the probe. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
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, str]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = 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) -> PingMonitorfunc 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)resources:  _:    type: oci:HealthChecks:PingMonitor    get:      id: ${id}- 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.
- CompartmentId string
- (Updatable) The OCID of the compartment.
- Dictionary<string, string>
- (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.
- Dictionary<string, string>
- (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.
- IntervalIn intSeconds 
- (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.
- TimeoutIn intSeconds 
- (Updatable) The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSecondsfor monitors.
- VantagePoint List<string>Names 
- (Updatable) A list of names of vantage points from which to execute the probe. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- CompartmentId string
- (Updatable) The OCID of the compartment.
- map[string]string
- (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.
- map[string]string
- (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.
- IntervalIn intSeconds 
- (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.
- TimeoutIn intSeconds 
- (Updatable) The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSecondsfor monitors.
- VantagePoint []stringNames 
- (Updatable) A list of names of vantage points from which to execute the probe. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- compartmentId String
- (Updatable) The OCID of the compartment.
- Map<String,String>
- (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.
- Map<String,String>
- (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.
- intervalIn IntegerSeconds 
- (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.
- timeoutIn IntegerSeconds 
- (Updatable) The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSecondsfor monitors.
- vantagePoint List<String>Names 
- (Updatable) A list of names of vantage points from which to execute the probe. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- compartmentId string
- (Updatable) The OCID of the compartment.
- {[key: string]: string}
- (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.
- {[key: string]: string}
- (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.
- intervalIn numberSeconds 
- (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.
- timeoutIn numberSeconds 
- (Updatable) The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSecondsfor monitors.
- vantagePoint string[]Names 
- (Updatable) A list of names of vantage points from which to execute the probe. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- compartment_id str
- (Updatable) The OCID of the compartment.
- Mapping[str, str]
- (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.
- Mapping[str, str]
- (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_ intseconds 
- (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_ intseconds 
- (Updatable) The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSecondsfor monitors.
- vantage_point_ Sequence[str]names 
- (Updatable) A list of names of vantage points from which to execute the probe. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
- compartmentId String
- (Updatable) The OCID of the compartment.
- Map<String>
- (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.
- Map<String>
- (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.
- intervalIn NumberSeconds 
- (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.
- timeoutIn NumberSeconds 
- (Updatable) The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSecondsfor monitors.
- vantagePoint List<String>Names 
- (Updatable) A list of names of vantage points from which to execute the probe. - ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values 
Import
PingMonitors can be imported using the id, e.g.
$ pulumi import oci:HealthChecks/pingMonitor:PingMonitor test_ping_monitor "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.
