Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getPingMonitor

This data source provides details about a specific Ping Monitor resource in Oracle Cloud Infrastructure Health Checks service.

Gets the configuration for the specified ping monitor.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testPingMonitor = Output.Create(Oci.HealthChecks.GetPingMonitor.InvokeAsync(new Oci.HealthChecks.GetPingMonitorArgs
        {
            MonitorId = oci_apm_synthetics_monitor.Test_monitor.Id,
        }));
    }

}
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.GetPingMonitor(ctx, &healthchecks.GetPingMonitorArgs{
			MonitorId: oci_apm_synthetics_monitor.Test_monitor.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_ping_monitor = oci.HealthChecks.get_ping_monitor(monitor_id=oci_apm_synthetics_monitor["test_monitor"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testPingMonitor = oci.HealthChecks.getPingMonitor({
    monitorId: oci_apm_synthetics_monitor.test_monitor.id,
});

Coming soon!

Using getPingMonitor

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getPingMonitor(args: GetPingMonitorArgs, opts?: InvokeOptions): Promise<GetPingMonitorResult>
function getPingMonitorOutput(args: GetPingMonitorOutputArgs, opts?: InvokeOptions): Output<GetPingMonitorResult>
def get_ping_monitor(monitor_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetPingMonitorResult
def get_ping_monitor_output(monitor_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetPingMonitorResult]
func GetPingMonitor(ctx *Context, args *GetPingMonitorArgs, opts ...InvokeOption) (*GetPingMonitorResult, error)
func GetPingMonitorOutput(ctx *Context, args *GetPingMonitorOutputArgs, opts ...InvokeOption) GetPingMonitorResultOutput

> Note: This function is named GetPingMonitor in the Go SDK.

public static class GetPingMonitor 
{
    public static Task<GetPingMonitorResult> InvokeAsync(GetPingMonitorArgs args, InvokeOptions? opts = null)
    public static Output<GetPingMonitorResult> Invoke(GetPingMonitorInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPingMonitorResult> getPingMonitor(GetPingMonitorArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:HealthChecks/getPingMonitor:getPingMonitor
  Arguments:
    # Arguments dictionary

The following arguments are supported:

MonitorId string

The OCID of a monitor.

MonitorId string

The OCID of a monitor.

monitorId String

The OCID of a monitor.

monitorId string

The OCID of a monitor.

monitor_id str

The OCID of a monitor.

monitorId String

The OCID of a monitor.

getPingMonitor Result

The following output properties are available:

CompartmentId string

The OCID of the compartment.

DefinedTags Dictionary<string, object>

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

A user-friendly and mutable name suitable for display in a user interface.

FreeformTags Dictionary<string, object>

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.

Id string

The OCID of the resource.

IntervalInSeconds int

The monitor interval in seconds. Valid values: 10, 30, and 60.

IsEnabled bool

Enables or disables the monitor. Set to 'true' to launch monitoring.

MonitorId string
Port int

The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.

Protocol string

The protocols for ping probes.

ResultsUrl string

A URL for fetching the probe results.

Targets List<string>

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

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>

A list of names of vantage points from which to execute the probe.

CompartmentId string

The OCID of the compartment.

DefinedTags map[string]interface{}

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

A user-friendly and mutable name suitable for display in a user interface.

FreeformTags map[string]interface{}

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.

Id string

The OCID of the resource.

IntervalInSeconds int

The monitor interval in seconds. Valid values: 10, 30, and 60.

IsEnabled bool

Enables or disables the monitor. Set to 'true' to launch monitoring.

MonitorId string
Port int

The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.

Protocol string

The protocols for ping probes.

ResultsUrl string

A URL for fetching the probe results.

Targets []string

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

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

A list of names of vantage points from which to execute the probe.

compartmentId String

The OCID of the compartment.

definedTags Map<String,Object>

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

A user-friendly and mutable name suitable for display in a user interface.

freeformTags Map<String,Object>

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.

id String

The OCID of the resource.

intervalInSeconds Integer

The monitor interval in seconds. Valid values: 10, 30, and 60.

isEnabled Boolean

Enables or disables the monitor. Set to 'true' to launch monitoring.

monitorId String
port Integer

The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.

protocol String

The protocols for ping probes.

resultsUrl String

A URL for fetching the probe results.

targets List<String>

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

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>

A list of names of vantage points from which to execute the probe.

compartmentId string

The OCID of the compartment.

definedTags {[key: string]: any}

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

A user-friendly and mutable name suitable for display in a user interface.

freeformTags {[key: string]: any}

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.

id string

The OCID of the resource.

intervalInSeconds number

The monitor interval in seconds. Valid values: 10, 30, and 60.

isEnabled boolean

Enables or disables the monitor. Set to 'true' to launch monitoring.

monitorId string
port number

The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.

protocol string

The protocols for ping probes.

resultsUrl string

A URL for fetching the probe results.

targets string[]

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

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[]

A list of names of vantage points from which to execute the probe.

compartment_id str

The OCID of the compartment.

defined_tags Mapping[str, Any]

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

A user-friendly and mutable name suitable for display in a user interface.

freeform_tags Mapping[str, Any]

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.

id str

The OCID of the resource.

interval_in_seconds int

The monitor interval in seconds. Valid values: 10, 30, and 60.

is_enabled bool

Enables or disables the monitor. Set to 'true' to launch monitoring.

monitor_id str
port int

The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.

protocol str

The protocols for ping probes.

results_url str

A URL for fetching the probe results.

targets Sequence[str]

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

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]

A list of names of vantage points from which to execute the probe.

compartmentId String

The OCID of the compartment.

definedTags Map<Any>

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

A user-friendly and mutable name suitable for display in a user interface.

freeformTags Map<Any>

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.

id String

The OCID of the resource.

intervalInSeconds Number

The monitor interval in seconds. Valid values: 10, 30, and 60.

isEnabled Boolean

Enables or disables the monitor. Set to 'true' to launch monitoring.

monitorId String
port Number

The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.

protocol String

The protocols for ping probes.

resultsUrl String

A URL for fetching the probe results.

targets List<String>

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

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>

A list of names of vantage points from which to execute the probe.

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.