Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
oci.ApmSynthetics.getMonitor
Explore with Pulumi AI
This data source provides details about a specific Monitor resource in Oracle Cloud Infrastructure APM Availability Monitoring service (aka APM Synthetics Service).
Gets the configuration of the monitor identified by the OCID.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testMonitor = oci.ApmSynthetics.getMonitor({
    apmDomainId: testApmDomain.id,
    monitorId: testMonitorOciApmSyntheticsMonitor.id,
});
import pulumi
import pulumi_oci as oci
test_monitor = oci.ApmSynthetics.get_monitor(apm_domain_id=test_apm_domain["id"],
    monitor_id=test_monitor_oci_apm_synthetics_monitor["id"])
package main
import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/apmsynthetics"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apmsynthetics.GetMonitor(ctx, &apmsynthetics.GetMonitorArgs{
			ApmDomainId: testApmDomain.Id,
			MonitorId:   testMonitorOciApmSyntheticsMonitor.Id,
		}, nil)
		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 testMonitor = Oci.ApmSynthetics.GetMonitor.Invoke(new()
    {
        ApmDomainId = testApmDomain.Id,
        MonitorId = testMonitorOciApmSyntheticsMonitor.Id,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ApmSynthetics.ApmSyntheticsFunctions;
import com.pulumi.oci.ApmSynthetics.inputs.GetMonitorArgs;
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) {
        final var testMonitor = ApmSyntheticsFunctions.getMonitor(GetMonitorArgs.builder()
            .apmDomainId(testApmDomain.id())
            .monitorId(testMonitorOciApmSyntheticsMonitor.id())
            .build());
    }
}
variables:
  testMonitor:
    fn::invoke:
      function: oci:ApmSynthetics:getMonitor
      arguments:
        apmDomainId: ${testApmDomain.id}
        monitorId: ${testMonitorOciApmSyntheticsMonitor.id}
Using getMonitor
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 getMonitor(args: GetMonitorArgs, opts?: InvokeOptions): Promise<GetMonitorResult>
function getMonitorOutput(args: GetMonitorOutputArgs, opts?: InvokeOptions): Output<GetMonitorResult>def get_monitor(apm_domain_id: Optional[str] = None,
                monitor_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetMonitorResult
def get_monitor_output(apm_domain_id: Optional[pulumi.Input[str]] = None,
                monitor_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetMonitorResult]func GetMonitor(ctx *Context, args *GetMonitorArgs, opts ...InvokeOption) (*GetMonitorResult, error)
func GetMonitorOutput(ctx *Context, args *GetMonitorOutputArgs, opts ...InvokeOption) GetMonitorResultOutput> Note: This function is named GetMonitor in the Go SDK.
public static class GetMonitor 
{
    public static Task<GetMonitorResult> InvokeAsync(GetMonitorArgs args, InvokeOptions? opts = null)
    public static Output<GetMonitorResult> Invoke(GetMonitorInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetMonitorResult> getMonitor(GetMonitorArgs args, InvokeOptions options)
public static Output<GetMonitorResult> getMonitor(GetMonitorArgs args, InvokeOptions options)
fn::invoke:
  function: oci:ApmSynthetics/getMonitor:getMonitor
  arguments:
    # arguments dictionaryThe following arguments are supported:
- ApmDomain stringId 
- The APM domain ID the request is intended for.
- MonitorId string
- The OCID of the monitor.
- ApmDomain stringId 
- The APM domain ID the request is intended for.
- MonitorId string
- The OCID of the monitor.
- apmDomain StringId 
- The APM domain ID the request is intended for.
- monitorId String
- The OCID of the monitor.
- apmDomain stringId 
- The APM domain ID the request is intended for.
- monitorId string
- The OCID of the monitor.
- apm_domain_ strid 
- The APM domain ID the request is intended for.
- monitor_id str
- The OCID of the monitor.
- apmDomain StringId 
- The APM domain ID the request is intended for.
- monitorId String
- The OCID of the monitor.
getMonitor Result
The following output properties are available:
- ApmDomain stringId 
- AvailabilityConfigurations List<GetMonitor Availability Configuration> 
- Monitor availability configuration details.
- BatchInterval intIn Seconds 
- Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
- Configurations
List<GetMonitor Configuration> 
- Details of monitor configuration.
- CreatedBy string
- Name of the user that created the monitor.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- DisplayName string
- Unique name that can be edited. The name should not contain any confidential information.
- Dictionary<string, string>
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- Id string
- The OCID of the monitor.
- IsIpv6 bool
- If enabled, domain name will resolve to an IPv6 address.
- IsRun boolNow 
- If isRunNow is enabled, then the monitor will run immediately.
- IsRun boolOnce 
- If runOnce is enabled, then the monitor will run once.
- LastUpdated stringBy 
- Name of the user that recently updated the monitor.
- MaintenanceWindow List<GetSchedules Monitor Maintenance Window Schedule> 
- Details required to schedule maintenance window.
- MonitorId string
- MonitorType string
- Type of monitor.
- RepeatInterval intIn Seconds 
- Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
- SchedulingPolicy string
- Scheduling policy to decide the distribution of monitor executions on vantage points.
- ScriptId string
- The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.
- ScriptName string
- Name of the script.
- ScriptParameters List<GetMonitor Script Parameter> 
- List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]
- Status string
- Enables or disables the monitor.
- Target string
- Specify the endpoint on which to run the monitor. For BROWSER, REST, NETWORK, DNS and FTP monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80.
- TimeCreated string
- The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- TimeUpdated string
- The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
- TimeoutIn intSeconds 
- Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.
- VantagePoint intCount 
- Number of vantage points where monitor is running.
- VantagePoints List<GetMonitor Vantage Point> 
- List of public, dedicated and onPremise vantage points where the monitor is running.
- ApmDomain stringId 
- AvailabilityConfigurations []GetMonitor Availability Configuration 
- Monitor availability configuration details.
- BatchInterval intIn Seconds 
- Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
- Configurations
[]GetMonitor Configuration 
- Details of monitor configuration.
- CreatedBy string
- Name of the user that created the monitor.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- DisplayName string
- Unique name that can be edited. The name should not contain any confidential information.
- map[string]string
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- Id string
- The OCID of the monitor.
- IsIpv6 bool
- If enabled, domain name will resolve to an IPv6 address.
- IsRun boolNow 
- If isRunNow is enabled, then the monitor will run immediately.
- IsRun boolOnce 
- If runOnce is enabled, then the monitor will run once.
- LastUpdated stringBy 
- Name of the user that recently updated the monitor.
- MaintenanceWindow []GetSchedules Monitor Maintenance Window Schedule 
- Details required to schedule maintenance window.
- MonitorId string
- MonitorType string
- Type of monitor.
- RepeatInterval intIn Seconds 
- Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
- SchedulingPolicy string
- Scheduling policy to decide the distribution of monitor executions on vantage points.
- ScriptId string
- The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.
- ScriptName string
- Name of the script.
- ScriptParameters []GetMonitor Script Parameter 
- List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]
- Status string
- Enables or disables the monitor.
- Target string
- Specify the endpoint on which to run the monitor. For BROWSER, REST, NETWORK, DNS and FTP monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80.
- TimeCreated string
- The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- TimeUpdated string
- The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
- TimeoutIn intSeconds 
- Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.
- VantagePoint intCount 
- Number of vantage points where monitor is running.
- VantagePoints []GetMonitor Vantage Point 
- List of public, dedicated and onPremise vantage points where the monitor is running.
- apmDomain StringId 
- availabilityConfigurations List<GetMonitor Availability Configuration> 
- Monitor availability configuration details.
- batchInterval IntegerIn Seconds 
- Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
- configurations
List<GetMonitor Configuration> 
- Details of monitor configuration.
- createdBy String
- Name of the user that created the monitor.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- displayName String
- Unique name that can be edited. The name should not contain any confidential information.
- Map<String,String>
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- id String
- The OCID of the monitor.
- isIpv6 Boolean
- If enabled, domain name will resolve to an IPv6 address.
- isRun BooleanNow 
- If isRunNow is enabled, then the monitor will run immediately.
- isRun BooleanOnce 
- If runOnce is enabled, then the monitor will run once.
- lastUpdated StringBy 
- Name of the user that recently updated the monitor.
- maintenanceWindow List<GetSchedules Monitor Maintenance Window Schedule> 
- Details required to schedule maintenance window.
- monitorId String
- monitorType String
- Type of monitor.
- repeatInterval IntegerIn Seconds 
- Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
- schedulingPolicy String
- Scheduling policy to decide the distribution of monitor executions on vantage points.
- scriptId String
- The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.
- scriptName String
- Name of the script.
- scriptParameters List<GetMonitor Script Parameter> 
- List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]
- status String
- Enables or disables the monitor.
- target String
- Specify the endpoint on which to run the monitor. For BROWSER, REST, NETWORK, DNS and FTP monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80.
- timeCreated String
- The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- timeUpdated String
- The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
- timeoutIn IntegerSeconds 
- Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.
- vantagePoint IntegerCount 
- Number of vantage points where monitor is running.
- vantagePoints List<GetMonitor Vantage Point> 
- List of public, dedicated and onPremise vantage points where the monitor is running.
- apmDomain stringId 
- availabilityConfigurations GetMonitor Availability Configuration[] 
- Monitor availability configuration details.
- batchInterval numberIn Seconds 
- Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
- configurations
GetMonitor Configuration[] 
- Details of monitor configuration.
- createdBy string
- Name of the user that created the monitor.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- displayName string
- Unique name that can be edited. The name should not contain any confidential information.
- {[key: string]: string}
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- id string
- The OCID of the monitor.
- isIpv6 boolean
- If enabled, domain name will resolve to an IPv6 address.
- isRun booleanNow 
- If isRunNow is enabled, then the monitor will run immediately.
- isRun booleanOnce 
- If runOnce is enabled, then the monitor will run once.
- lastUpdated stringBy 
- Name of the user that recently updated the monitor.
- maintenanceWindow GetSchedules Monitor Maintenance Window Schedule[] 
- Details required to schedule maintenance window.
- monitorId string
- monitorType string
- Type of monitor.
- repeatInterval numberIn Seconds 
- Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
- schedulingPolicy string
- Scheduling policy to decide the distribution of monitor executions on vantage points.
- scriptId string
- The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.
- scriptName string
- Name of the script.
- scriptParameters GetMonitor Script Parameter[] 
- List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]
- status string
- Enables or disables the monitor.
- target string
- Specify the endpoint on which to run the monitor. For BROWSER, REST, NETWORK, DNS and FTP monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80.
- timeCreated string
- The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- timeUpdated string
- The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
- timeoutIn numberSeconds 
- Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.
- vantagePoint numberCount 
- Number of vantage points where monitor is running.
- vantagePoints GetMonitor Vantage Point[] 
- List of public, dedicated and onPremise vantage points where the monitor is running.
- apm_domain_ strid 
- availability_configurations Sequence[GetMonitor Availability Configuration] 
- Monitor availability configuration details.
- batch_interval_ intin_ seconds 
- Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
- configurations
Sequence[GetMonitor Configuration] 
- Details of monitor configuration.
- created_by str
- Name of the user that created the monitor.
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- display_name str
- Unique name that can be edited. The name should not contain any confidential information.
- Mapping[str, str]
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- id str
- The OCID of the monitor.
- is_ipv6 bool
- If enabled, domain name will resolve to an IPv6 address.
- is_run_ boolnow 
- If isRunNow is enabled, then the monitor will run immediately.
- is_run_ boolonce 
- If runOnce is enabled, then the monitor will run once.
- last_updated_ strby 
- Name of the user that recently updated the monitor.
- maintenance_window_ Sequence[Getschedules Monitor Maintenance Window Schedule] 
- Details required to schedule maintenance window.
- monitor_id str
- monitor_type str
- Type of monitor.
- repeat_interval_ intin_ seconds 
- Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
- scheduling_policy str
- Scheduling policy to decide the distribution of monitor executions on vantage points.
- script_id str
- The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.
- script_name str
- Name of the script.
- script_parameters Sequence[GetMonitor Script Parameter] 
- List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]
- status str
- Enables or disables the monitor.
- target str
- Specify the endpoint on which to run the monitor. For BROWSER, REST, NETWORK, DNS and FTP monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80.
- time_created str
- The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- time_updated str
- The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
- timeout_in_ intseconds 
- Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.
- vantage_point_ intcount 
- Number of vantage points where monitor is running.
- vantage_points Sequence[GetMonitor Vantage Point] 
- List of public, dedicated and onPremise vantage points where the monitor is running.
- apmDomain StringId 
- availabilityConfigurations List<Property Map>
- Monitor availability configuration details.
- batchInterval NumberIn Seconds 
- Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
- configurations List<Property Map>
- Details of monitor configuration.
- createdBy String
- Name of the user that created the monitor.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- displayName String
- Unique name that can be edited. The name should not contain any confidential information.
- Map<String>
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
- id String
- The OCID of the monitor.
- isIpv6 Boolean
- If enabled, domain name will resolve to an IPv6 address.
- isRun BooleanNow 
- If isRunNow is enabled, then the monitor will run immediately.
- isRun BooleanOnce 
- If runOnce is enabled, then the monitor will run once.
- lastUpdated StringBy 
- Name of the user that recently updated the monitor.
- maintenanceWindow List<Property Map>Schedules 
- Details required to schedule maintenance window.
- monitorId String
- monitorType String
- Type of monitor.
- repeatInterval NumberIn Seconds 
- Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
- schedulingPolicy String
- Scheduling policy to decide the distribution of monitor executions on vantage points.
- scriptId String
- The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.
- scriptName String
- Name of the script.
- scriptParameters List<Property Map>
- List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]
- status String
- Enables or disables the monitor.
- target String
- Specify the endpoint on which to run the monitor. For BROWSER, REST, NETWORK, DNS and FTP monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80.
- timeCreated String
- The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- timeUpdated String
- The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
- timeoutIn NumberSeconds 
- Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.
- vantagePoint NumberCount 
- Number of vantage points where monitor is running.
- vantagePoints List<Property Map>
- List of public, dedicated and onPremise vantage points where the monitor is running.
Supporting Types
GetMonitorAvailabilityConfiguration   
- MaxAllowed intFailures Per Interval 
- Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
- MinAllowed intRuns Per Interval 
- Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.
- MaxAllowed intFailures Per Interval 
- Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
- MinAllowed intRuns Per Interval 
- Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.
- maxAllowed IntegerFailures Per Interval 
- Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
- minAllowed IntegerRuns Per Interval 
- Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.
- maxAllowed numberFailures Per Interval 
- Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
- minAllowed numberRuns Per Interval 
- Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.
- max_allowed_ intfailures_ per_ interval 
- Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
- min_allowed_ intruns_ per_ interval 
- Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.
- maxAllowed NumberFailures Per Interval 
- Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
- minAllowed NumberRuns Per Interval 
- Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.
GetMonitorConfiguration  
- ClientCertificate List<GetDetails Monitor Configuration Client Certificate Detail> 
- Details for client certificate.
- ConfigType string
- Type of configuration.
- ConnectionString string
- Database connection string.
- DatabaseAuthentication List<GetDetails Monitor Configuration Database Authentication Detail> 
- Details for basic authentication.
- DatabaseConnection stringType 
- Database connection type. Only CUSTOM_JDBC is supported for MYSQL database type.
- DatabaseRole string
- Database role.
- DatabaseType string
- Database type.
- DatabaseWallet List<GetDetails Monitor Configuration Database Wallet Detail> 
- Details for database wallet.
- DnsConfigurations List<GetMonitor Configuration Dns Configuration> 
- Information about the DNS settings.
- DownloadSize intLimit In Bytes 
- Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB.
- FtpBasic List<GetAuthentication Details Monitor Configuration Ftp Basic Authentication Detail> 
- Details for basic authentication.
- FtpProtocol string
- FTP protocol type.
- FtpRequest stringType 
- FTP monitor request type.
- IsActive boolMode 
- If enabled, Active mode will be used for the FTP connection.
- IsCertificate boolValidation Enabled 
- If certificate validation is enabled, then the call will fail in case of certification errors.
- IsDefault boolSnapshot Enabled 
- If disabled, auto snapshots are not collected.
- IsFailure boolRetried 
- If isFailureRetried is enabled, then a failed call will be retried.
- IsQuery boolRecursive 
- If isQueryRecursive is enabled, then queries will be sent recursively to the target server.
- IsRedirection boolEnabled 
- If redirection is enabled, then redirects will be allowed while accessing target URL.
- NameServer string
- Name of the server that will be used to perform DNS lookup.
- NetworkConfigurations List<GetMonitor Configuration Network Configuration> 
- Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.
- Protocol string
- Type of protocol.
- Query string
- SQL query to be executed.
- RecordType string
- DNS record type.
- ReqAuthentication List<GetDetails Monitor Configuration Req Authentication Detail> 
- Details for request HTTP authentication.
- ReqAuthentication stringScheme 
- Request HTTP authentication scheme.
- RequestHeaders List<GetMonitor Configuration Request Header> 
- List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
- RequestMethod string
- Request HTTP method.
- RequestPost stringBody 
- Request post body content.
- RequestQuery List<GetParams Monitor Configuration Request Query Param> 
- List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]
- UploadFile intSize In Bytes 
- File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB.
- VerifyResponse List<string>Codes 
- Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
- VerifyResponse stringContent 
- Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.
- VerifyTexts List<GetMonitor Configuration Verify Text> 
- Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.
- ClientCertificate []GetDetails Monitor Configuration Client Certificate Detail 
- Details for client certificate.
- ConfigType string
- Type of configuration.
- ConnectionString string
- Database connection string.
- DatabaseAuthentication []GetDetails Monitor Configuration Database Authentication Detail 
- Details for basic authentication.
- DatabaseConnection stringType 
- Database connection type. Only CUSTOM_JDBC is supported for MYSQL database type.
- DatabaseRole string
- Database role.
- DatabaseType string
- Database type.
- DatabaseWallet []GetDetails Monitor Configuration Database Wallet Detail 
- Details for database wallet.
- DnsConfigurations []GetMonitor Configuration Dns Configuration 
- Information about the DNS settings.
- DownloadSize intLimit In Bytes 
- Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB.
- FtpBasic []GetAuthentication Details Monitor Configuration Ftp Basic Authentication Detail 
- Details for basic authentication.
- FtpProtocol string
- FTP protocol type.
- FtpRequest stringType 
- FTP monitor request type.
- IsActive boolMode 
- If enabled, Active mode will be used for the FTP connection.
- IsCertificate boolValidation Enabled 
- If certificate validation is enabled, then the call will fail in case of certification errors.
- IsDefault boolSnapshot Enabled 
- If disabled, auto snapshots are not collected.
- IsFailure boolRetried 
- If isFailureRetried is enabled, then a failed call will be retried.
- IsQuery boolRecursive 
- If isQueryRecursive is enabled, then queries will be sent recursively to the target server.
- IsRedirection boolEnabled 
- If redirection is enabled, then redirects will be allowed while accessing target URL.
- NameServer string
- Name of the server that will be used to perform DNS lookup.
- NetworkConfigurations []GetMonitor Configuration Network Configuration 
- Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.
- Protocol string
- Type of protocol.
- Query string
- SQL query to be executed.
- RecordType string
- DNS record type.
- ReqAuthentication []GetDetails Monitor Configuration Req Authentication Detail 
- Details for request HTTP authentication.
- ReqAuthentication stringScheme 
- Request HTTP authentication scheme.
- RequestHeaders []GetMonitor Configuration Request Header 
- List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
- RequestMethod string
- Request HTTP method.
- RequestPost stringBody 
- Request post body content.
- RequestQuery []GetParams Monitor Configuration Request Query Param 
- List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]
- UploadFile intSize In Bytes 
- File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB.
- VerifyResponse []stringCodes 
- Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
- VerifyResponse stringContent 
- Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.
- VerifyTexts []GetMonitor Configuration Verify Text 
- Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.
- clientCertificate List<GetDetails Monitor Configuration Client Certificate Detail> 
- Details for client certificate.
- configType String
- Type of configuration.
- connectionString String
- Database connection string.
- databaseAuthentication List<GetDetails Monitor Configuration Database Authentication Detail> 
- Details for basic authentication.
- databaseConnection StringType 
- Database connection type. Only CUSTOM_JDBC is supported for MYSQL database type.
- databaseRole String
- Database role.
- databaseType String
- Database type.
- databaseWallet List<GetDetails Monitor Configuration Database Wallet Detail> 
- Details for database wallet.
- dnsConfigurations List<GetMonitor Configuration Dns Configuration> 
- Information about the DNS settings.
- downloadSize IntegerLimit In Bytes 
- Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB.
- ftpBasic List<GetAuthentication Details Monitor Configuration Ftp Basic Authentication Detail> 
- Details for basic authentication.
- ftpProtocol String
- FTP protocol type.
- ftpRequest StringType 
- FTP monitor request type.
- isActive BooleanMode 
- If enabled, Active mode will be used for the FTP connection.
- isCertificate BooleanValidation Enabled 
- If certificate validation is enabled, then the call will fail in case of certification errors.
- isDefault BooleanSnapshot Enabled 
- If disabled, auto snapshots are not collected.
- isFailure BooleanRetried 
- If isFailureRetried is enabled, then a failed call will be retried.
- isQuery BooleanRecursive 
- If isQueryRecursive is enabled, then queries will be sent recursively to the target server.
- isRedirection BooleanEnabled 
- If redirection is enabled, then redirects will be allowed while accessing target URL.
- nameServer String
- Name of the server that will be used to perform DNS lookup.
- networkConfigurations List<GetMonitor Configuration Network Configuration> 
- Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.
- protocol String
- Type of protocol.
- query String
- SQL query to be executed.
- recordType String
- DNS record type.
- reqAuthentication List<GetDetails Monitor Configuration Req Authentication Detail> 
- Details for request HTTP authentication.
- reqAuthentication StringScheme 
- Request HTTP authentication scheme.
- requestHeaders List<GetMonitor Configuration Request Header> 
- List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
- requestMethod String
- Request HTTP method.
- requestPost StringBody 
- Request post body content.
- requestQuery List<GetParams Monitor Configuration Request Query Param> 
- List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]
- uploadFile IntegerSize In Bytes 
- File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB.
- verifyResponse List<String>Codes 
- Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
- verifyResponse StringContent 
- Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.
- verifyTexts List<GetMonitor Configuration Verify Text> 
- Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.
- clientCertificate GetDetails Monitor Configuration Client Certificate Detail[] 
- Details for client certificate.
- configType string
- Type of configuration.
- connectionString string
- Database connection string.
- databaseAuthentication GetDetails Monitor Configuration Database Authentication Detail[] 
- Details for basic authentication.
- databaseConnection stringType 
- Database connection type. Only CUSTOM_JDBC is supported for MYSQL database type.
- databaseRole string
- Database role.
- databaseType string
- Database type.
- databaseWallet GetDetails Monitor Configuration Database Wallet Detail[] 
- Details for database wallet.
- dnsConfigurations GetMonitor Configuration Dns Configuration[] 
- Information about the DNS settings.
- downloadSize numberLimit In Bytes 
- Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB.
- ftpBasic GetAuthentication Details Monitor Configuration Ftp Basic Authentication Detail[] 
- Details for basic authentication.
- ftpProtocol string
- FTP protocol type.
- ftpRequest stringType 
- FTP monitor request type.
- isActive booleanMode 
- If enabled, Active mode will be used for the FTP connection.
- isCertificate booleanValidation Enabled 
- If certificate validation is enabled, then the call will fail in case of certification errors.
- isDefault booleanSnapshot Enabled 
- If disabled, auto snapshots are not collected.
- isFailure booleanRetried 
- If isFailureRetried is enabled, then a failed call will be retried.
- isQuery booleanRecursive 
- If isQueryRecursive is enabled, then queries will be sent recursively to the target server.
- isRedirection booleanEnabled 
- If redirection is enabled, then redirects will be allowed while accessing target URL.
- nameServer string
- Name of the server that will be used to perform DNS lookup.
- networkConfigurations GetMonitor Configuration Network Configuration[] 
- Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.
- protocol string
- Type of protocol.
- query string
- SQL query to be executed.
- recordType string
- DNS record type.
- reqAuthentication GetDetails Monitor Configuration Req Authentication Detail[] 
- Details for request HTTP authentication.
- reqAuthentication stringScheme 
- Request HTTP authentication scheme.
- requestHeaders GetMonitor Configuration Request Header[] 
- List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
- requestMethod string
- Request HTTP method.
- requestPost stringBody 
- Request post body content.
- requestQuery GetParams Monitor Configuration Request Query Param[] 
- List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]
- uploadFile numberSize In Bytes 
- File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB.
- verifyResponse string[]Codes 
- Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
- verifyResponse stringContent 
- Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.
- verifyTexts GetMonitor Configuration Verify Text[] 
- Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.
- client_certificate_ Sequence[Getdetails Monitor Configuration Client Certificate Detail] 
- Details for client certificate.
- config_type str
- Type of configuration.
- connection_string str
- Database connection string.
- database_authentication_ Sequence[Getdetails Monitor Configuration Database Authentication Detail] 
- Details for basic authentication.
- database_connection_ strtype 
- Database connection type. Only CUSTOM_JDBC is supported for MYSQL database type.
- database_role str
- Database role.
- database_type str
- Database type.
- database_wallet_ Sequence[Getdetails Monitor Configuration Database Wallet Detail] 
- Details for database wallet.
- dns_configurations Sequence[GetMonitor Configuration Dns Configuration] 
- Information about the DNS settings.
- download_size_ intlimit_ in_ bytes 
- Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB.
- ftp_basic_ Sequence[Getauthentication_ details Monitor Configuration Ftp Basic Authentication Detail] 
- Details for basic authentication.
- ftp_protocol str
- FTP protocol type.
- ftp_request_ strtype 
- FTP monitor request type.
- is_active_ boolmode 
- If enabled, Active mode will be used for the FTP connection.
- is_certificate_ boolvalidation_ enabled 
- If certificate validation is enabled, then the call will fail in case of certification errors.
- is_default_ boolsnapshot_ enabled 
- If disabled, auto snapshots are not collected.
- is_failure_ boolretried 
- If isFailureRetried is enabled, then a failed call will be retried.
- is_query_ boolrecursive 
- If isQueryRecursive is enabled, then queries will be sent recursively to the target server.
- is_redirection_ boolenabled 
- If redirection is enabled, then redirects will be allowed while accessing target URL.
- name_server str
- Name of the server that will be used to perform DNS lookup.
- network_configurations Sequence[GetMonitor Configuration Network Configuration] 
- Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.
- protocol str
- Type of protocol.
- query str
- SQL query to be executed.
- record_type str
- DNS record type.
- req_authentication_ Sequence[Getdetails Monitor Configuration Req Authentication Detail] 
- Details for request HTTP authentication.
- req_authentication_ strscheme 
- Request HTTP authentication scheme.
- request_headers Sequence[GetMonitor Configuration Request Header] 
- List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
- request_method str
- Request HTTP method.
- request_post_ strbody 
- Request post body content.
- request_query_ Sequence[Getparams Monitor Configuration Request Query Param] 
- List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]
- upload_file_ intsize_ in_ bytes 
- File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB.
- verify_response_ Sequence[str]codes 
- Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
- verify_response_ strcontent 
- Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.
- verify_texts Sequence[GetMonitor Configuration Verify Text] 
- Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.
- clientCertificate List<Property Map>Details 
- Details for client certificate.
- configType String
- Type of configuration.
- connectionString String
- Database connection string.
- databaseAuthentication List<Property Map>Details 
- Details for basic authentication.
- databaseConnection StringType 
- Database connection type. Only CUSTOM_JDBC is supported for MYSQL database type.
- databaseRole String
- Database role.
- databaseType String
- Database type.
- databaseWallet List<Property Map>Details 
- Details for database wallet.
- dnsConfigurations List<Property Map>
- Information about the DNS settings.
- downloadSize NumberLimit In Bytes 
- Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB.
- ftpBasic List<Property Map>Authentication Details 
- Details for basic authentication.
- ftpProtocol String
- FTP protocol type.
- ftpRequest StringType 
- FTP monitor request type.
- isActive BooleanMode 
- If enabled, Active mode will be used for the FTP connection.
- isCertificate BooleanValidation Enabled 
- If certificate validation is enabled, then the call will fail in case of certification errors.
- isDefault BooleanSnapshot Enabled 
- If disabled, auto snapshots are not collected.
- isFailure BooleanRetried 
- If isFailureRetried is enabled, then a failed call will be retried.
- isQuery BooleanRecursive 
- If isQueryRecursive is enabled, then queries will be sent recursively to the target server.
- isRedirection BooleanEnabled 
- If redirection is enabled, then redirects will be allowed while accessing target URL.
- nameServer String
- Name of the server that will be used to perform DNS lookup.
- networkConfigurations List<Property Map>
- Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.
- protocol String
- Type of protocol.
- query String
- SQL query to be executed.
- recordType String
- DNS record type.
- reqAuthentication List<Property Map>Details 
- Details for request HTTP authentication.
- reqAuthentication StringScheme 
- Request HTTP authentication scheme.
- requestHeaders List<Property Map>
- List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
- requestMethod String
- Request HTTP method.
- requestPost StringBody 
- Request post body content.
- requestQuery List<Property Map>Params 
- List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]
- uploadFile NumberSize In Bytes 
- File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB.
- verifyResponse List<String>Codes 
- Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
- verifyResponse StringContent 
- Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.
- verifyTexts List<Property Map>
- Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.
GetMonitorConfigurationClientCertificateDetail     
- ClientCertificates List<GetMonitor Configuration Client Certificate Detail Client Certificate> 
- Client certificate in PEM format.
- PrivateKeys List<GetMonitor Configuration Client Certificate Detail Private Key> 
- The private key associated with the client certificate in PEM format.
- ClientCertificates []GetMonitor Configuration Client Certificate Detail Client Certificate 
- Client certificate in PEM format.
- PrivateKeys []GetMonitor Configuration Client Certificate Detail Private Key 
- The private key associated with the client certificate in PEM format.
- clientCertificates List<GetMonitor Configuration Client Certificate Detail Client Certificate> 
- Client certificate in PEM format.
- privateKeys List<GetMonitor Configuration Client Certificate Detail Private Key> 
- The private key associated with the client certificate in PEM format.
- clientCertificates GetMonitor Configuration Client Certificate Detail Client Certificate[] 
- Client certificate in PEM format.
- privateKeys GetMonitor Configuration Client Certificate Detail Private Key[] 
- The private key associated with the client certificate in PEM format.
- client_certificates Sequence[GetMonitor Configuration Client Certificate Detail Client Certificate] 
- Client certificate in PEM format.
- private_keys Sequence[GetMonitor Configuration Client Certificate Detail Private Key] 
- The private key associated with the client certificate in PEM format.
- clientCertificates List<Property Map>
- Client certificate in PEM format.
- privateKeys List<Property Map>
- The private key associated with the client certificate in PEM format.
GetMonitorConfigurationClientCertificateDetailClientCertificate       
GetMonitorConfigurationClientCertificateDetailPrivateKey       
GetMonitorConfigurationDatabaseAuthenticationDetail     
- Passwords
List<GetMonitor Configuration Database Authentication Detail Password> 
- Password.
- Username string
- Username for authentication.
- Passwords
[]GetMonitor Configuration Database Authentication Detail Password 
- Password.
- Username string
- Username for authentication.
- passwords
List<GetMonitor Configuration Database Authentication Detail Password> 
- Password.
- username String
- Username for authentication.
- passwords
GetMonitor Configuration Database Authentication Detail Password[] 
- Password.
- username string
- Username for authentication.
- passwords
Sequence[GetMonitor Configuration Database Authentication Detail Password] 
- Password.
- username str
- Username for authentication.
- passwords List<Property Map>
- Password.
- username String
- Username for authentication.
GetMonitorConfigurationDatabaseAuthenticationDetailPassword      
- Password string
- Password.
- PasswordType string
- Type of method to pass password.
- VaultSecret stringId 
- Vault secret OCID.
- Password string
- Password.
- PasswordType string
- Type of method to pass password.
- VaultSecret stringId 
- Vault secret OCID.
- password String
- Password.
- passwordType String
- Type of method to pass password.
- vaultSecret StringId 
- Vault secret OCID.
- password string
- Password.
- passwordType string
- Type of method to pass password.
- vaultSecret stringId 
- Vault secret OCID.
- password str
- Password.
- password_type str
- Type of method to pass password.
- vault_secret_ strid 
- Vault secret OCID.
- password String
- Password.
- passwordType String
- Type of method to pass password.
- vaultSecret StringId 
- Vault secret OCID.
GetMonitorConfigurationDatabaseWalletDetail     
- DatabaseWallet string
- The database wallet configuration zip file.
- ServiceName string
- Service name of the database.
- DatabaseWallet string
- The database wallet configuration zip file.
- ServiceName string
- Service name of the database.
- databaseWallet String
- The database wallet configuration zip file.
- serviceName String
- Service name of the database.
- databaseWallet string
- The database wallet configuration zip file.
- serviceName string
- Service name of the database.
- database_wallet str
- The database wallet configuration zip file.
- service_name str
- Service name of the database.
- databaseWallet String
- The database wallet configuration zip file.
- serviceName String
- Service name of the database.
GetMonitorConfigurationDnsConfiguration    
- IsOverride boolDns 
- If isOverrideDns is true, then DNS settings will be overridden.
- OverrideDns stringIp 
- Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.
- IsOverride boolDns 
- If isOverrideDns is true, then DNS settings will be overridden.
- OverrideDns stringIp 
- Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.
- isOverride BooleanDns 
- If isOverrideDns is true, then DNS settings will be overridden.
- overrideDns StringIp 
- Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.
- isOverride booleanDns 
- If isOverrideDns is true, then DNS settings will be overridden.
- overrideDns stringIp 
- Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.
- is_override_ booldns 
- If isOverrideDns is true, then DNS settings will be overridden.
- override_dns_ strip 
- Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.
- isOverride BooleanDns 
- If isOverrideDns is true, then DNS settings will be overridden.
- overrideDns StringIp 
- Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.
GetMonitorConfigurationFtpBasicAuthenticationDetail      
- Passwords
List<GetMonitor Configuration Ftp Basic Authentication Detail Password> 
- Password.
- Username string
- Username for authentication.
- Passwords
[]GetMonitor Configuration Ftp Basic Authentication Detail Password 
- Password.
- Username string
- Username for authentication.
- passwords
List<GetMonitor Configuration Ftp Basic Authentication Detail Password> 
- Password.
- username String
- Username for authentication.
- passwords
GetMonitor Configuration Ftp Basic Authentication Detail Password[] 
- Password.
- username string
- Username for authentication.
- passwords
Sequence[GetMonitor Configuration Ftp Basic Authentication Detail Password] 
- Password.
- username str
- Username for authentication.
- passwords List<Property Map>
- Password.
- username String
- Username for authentication.
GetMonitorConfigurationFtpBasicAuthenticationDetailPassword       
- Password string
- Password.
- PasswordType string
- Type of method to pass password.
- VaultSecret stringId 
- Vault secret OCID.
- Password string
- Password.
- PasswordType string
- Type of method to pass password.
- VaultSecret stringId 
- Vault secret OCID.
- password String
- Password.
- passwordType String
- Type of method to pass password.
- vaultSecret StringId 
- Vault secret OCID.
- password string
- Password.
- passwordType string
- Type of method to pass password.
- vaultSecret stringId 
- Vault secret OCID.
- password str
- Password.
- password_type str
- Type of method to pass password.
- vault_secret_ strid 
- Vault secret OCID.
- password String
- Password.
- passwordType String
- Type of method to pass password.
- vaultSecret StringId 
- Vault secret OCID.
GetMonitorConfigurationNetworkConfiguration    
- NumberOf intHops 
- Number of hops.
- ProbeMode string
- Type of probe mode when TCP protocol is selected.
- ProbePer intHop 
- Number of probes per hop.
- Protocol string
- Type of protocol.
- TransmissionRate int
- Number of probe packets sent out simultaneously.
- NumberOf intHops 
- Number of hops.
- ProbeMode string
- Type of probe mode when TCP protocol is selected.
- ProbePer intHop 
- Number of probes per hop.
- Protocol string
- Type of protocol.
- TransmissionRate int
- Number of probe packets sent out simultaneously.
- numberOf IntegerHops 
- Number of hops.
- probeMode String
- Type of probe mode when TCP protocol is selected.
- probePer IntegerHop 
- Number of probes per hop.
- protocol String
- Type of protocol.
- transmissionRate Integer
- Number of probe packets sent out simultaneously.
- numberOf numberHops 
- Number of hops.
- probeMode string
- Type of probe mode when TCP protocol is selected.
- probePer numberHop 
- Number of probes per hop.
- protocol string
- Type of protocol.
- transmissionRate number
- Number of probe packets sent out simultaneously.
- number_of_ inthops 
- Number of hops.
- probe_mode str
- Type of probe mode when TCP protocol is selected.
- probe_per_ inthop 
- Number of probes per hop.
- protocol str
- Type of protocol.
- transmission_rate int
- Number of probe packets sent out simultaneously.
- numberOf NumberHops 
- Number of hops.
- probeMode String
- Type of probe mode when TCP protocol is selected.
- probePer NumberHop 
- Number of probes per hop.
- protocol String
- Type of protocol.
- transmissionRate Number
- Number of probe packets sent out simultaneously.
GetMonitorConfigurationReqAuthenticationDetail     
- AuthHeaders List<GetMonitor Configuration Req Authentication Detail Auth Header> 
- List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
- AuthRequest stringMethod 
- Request method.
- AuthRequest stringPost Body 
- Request post body.
- AuthToken string
- Authentication token.
- AuthUrl string
- URL to get authentication token.
- AuthUser stringName 
- User name for authentication.
- AuthUser stringPassword 
- User password for authentication.
- OauthScheme string
- Request HTTP OAuth scheme.
- AuthHeaders []GetMonitor Configuration Req Authentication Detail Auth Header 
- List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
- AuthRequest stringMethod 
- Request method.
- AuthRequest stringPost Body 
- Request post body.
- AuthToken string
- Authentication token.
- AuthUrl string
- URL to get authentication token.
- AuthUser stringName 
- User name for authentication.
- AuthUser stringPassword 
- User password for authentication.
- OauthScheme string
- Request HTTP OAuth scheme.
- authHeaders List<GetMonitor Configuration Req Authentication Detail Auth Header> 
- List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
- authRequest StringMethod 
- Request method.
- authRequest StringPost Body 
- Request post body.
- authToken String
- Authentication token.
- authUrl String
- URL to get authentication token.
- authUser StringName 
- User name for authentication.
- authUser StringPassword 
- User password for authentication.
- oauthScheme String
- Request HTTP OAuth scheme.
- authHeaders GetMonitor Configuration Req Authentication Detail Auth Header[] 
- List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
- authRequest stringMethod 
- Request method.
- authRequest stringPost Body 
- Request post body.
- authToken string
- Authentication token.
- authUrl string
- URL to get authentication token.
- authUser stringName 
- User name for authentication.
- authUser stringPassword 
- User password for authentication.
- oauthScheme string
- Request HTTP OAuth scheme.
- auth_headers Sequence[GetMonitor Configuration Req Authentication Detail Auth Header] 
- List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
- auth_request_ strmethod 
- Request method.
- auth_request_ strpost_ body 
- Request post body.
- auth_token str
- Authentication token.
- auth_url str
- URL to get authentication token.
- auth_user_ strname 
- User name for authentication.
- auth_user_ strpassword 
- User password for authentication.
- oauth_scheme str
- Request HTTP OAuth scheme.
- authHeaders List<Property Map>
- List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
- authRequest StringMethod 
- Request method.
- authRequest StringPost Body 
- Request post body.
- authToken String
- Authentication token.
- authUrl String
- URL to get authentication token.
- authUser StringName 
- User name for authentication.
- authUser StringPassword 
- User password for authentication.
- oauthScheme String
- Request HTTP OAuth scheme.
GetMonitorConfigurationReqAuthenticationDetailAuthHeader       
- HeaderName string
- Name of the header.
- HeaderValue string
- Value of the header.
- HeaderName string
- Name of the header.
- HeaderValue string
- Value of the header.
- headerName String
- Name of the header.
- headerValue String
- Value of the header.
- headerName string
- Name of the header.
- headerValue string
- Value of the header.
- header_name str
- Name of the header.
- header_value str
- Value of the header.
- headerName String
- Name of the header.
- headerValue String
- Value of the header.
GetMonitorConfigurationRequestHeader    
- HeaderName string
- Name of the header.
- HeaderValue string
- Value of the header.
- HeaderName string
- Name of the header.
- HeaderValue string
- Value of the header.
- headerName String
- Name of the header.
- headerValue String
- Value of the header.
- headerName string
- Name of the header.
- headerValue string
- Value of the header.
- header_name str
- Name of the header.
- header_value str
- Value of the header.
- headerName String
- Name of the header.
- headerValue String
- Value of the header.
GetMonitorConfigurationRequestQueryParam     
- ParamName string
- Name of the parameter.
- ParamValue string
- Value of the parameter.
- ParamName string
- Name of the parameter.
- ParamValue string
- Value of the parameter.
- paramName String
- Name of the parameter.
- paramValue String
- Value of the parameter.
- paramName string
- Name of the parameter.
- paramValue string
- Value of the parameter.
- param_name str
- Name of the parameter.
- param_value str
- Value of the parameter.
- paramName String
- Name of the parameter.
- paramValue String
- Value of the parameter.
GetMonitorConfigurationVerifyText    
- Text string
- Verification text in the response.
- Text string
- Verification text in the response.
- text String
- Verification text in the response.
- text string
- Verification text in the response.
- text str
- Verification text in the response.
- text String
- Verification text in the response.
GetMonitorMaintenanceWindowSchedule    
- TimeEnded string
- End time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- TimeStarted string
- Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- TimeEnded string
- End time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- TimeStarted string
- Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- timeEnded String
- End time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- timeStarted String
- Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- timeEnded string
- End time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- timeStarted string
- Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- time_ended str
- End time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- time_started str
- Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- timeEnded String
- End time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- timeStarted String
- Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
GetMonitorScriptParameter   
- IsOverwritten bool
- If parameter value is default or overwritten.
- IsSecret bool
- Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
- MonitorScript List<GetParameters Monitor Script Parameter Monitor Script Parameter> 
- Details of the script parameter that can be used to overwrite the parameter present in the script.
- ParamName string
- Name of the parameter.
- ParamValue string
- Value of the parameter.
- IsOverwritten bool
- If parameter value is default or overwritten.
- IsSecret bool
- Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
- MonitorScript []GetParameters Monitor Script Parameter Monitor Script Parameter 
- Details of the script parameter that can be used to overwrite the parameter present in the script.
- ParamName string
- Name of the parameter.
- ParamValue string
- Value of the parameter.
- isOverwritten Boolean
- If parameter value is default or overwritten.
- isSecret Boolean
- Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
- monitorScript List<GetParameters Monitor Script Parameter Monitor Script Parameter> 
- Details of the script parameter that can be used to overwrite the parameter present in the script.
- paramName String
- Name of the parameter.
- paramValue String
- Value of the parameter.
- isOverwritten boolean
- If parameter value is default or overwritten.
- isSecret boolean
- Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
- monitorScript GetParameters Monitor Script Parameter Monitor Script Parameter[] 
- Details of the script parameter that can be used to overwrite the parameter present in the script.
- paramName string
- Name of the parameter.
- paramValue string
- Value of the parameter.
- is_overwritten bool
- If parameter value is default or overwritten.
- is_secret bool
- Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
- monitor_script_ Sequence[Getparameters Monitor Script Parameter Monitor Script Parameter] 
- Details of the script parameter that can be used to overwrite the parameter present in the script.
- param_name str
- Name of the parameter.
- param_value str
- Value of the parameter.
- isOverwritten Boolean
- If parameter value is default or overwritten.
- isSecret Boolean
- Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
- monitorScript List<Property Map>Parameters 
- Details of the script parameter that can be used to overwrite the parameter present in the script.
- paramName String
- Name of the parameter.
- paramValue String
- Value of the parameter.
GetMonitorScriptParameterMonitorScriptParameter      
- ParamName string
- Name of the parameter.
- ParamValue string
- Value of the parameter.
- ParamName string
- Name of the parameter.
- ParamValue string
- Value of the parameter.
- paramName String
- Name of the parameter.
- paramValue String
- Value of the parameter.
- paramName string
- Name of the parameter.
- paramValue string
- Value of the parameter.
- param_name str
- Name of the parameter.
- param_value str
- Value of the parameter.
- paramName String
- Name of the parameter.
- paramValue String
- Value of the parameter.
GetMonitorVantagePoint   
- DisplayName string
- Unique name that can be edited. The name should not contain any confidential information.
- Name string
- Name of the vantage point.
- WorkerLists List<string>
- List of workers running the assigned monitor.
- DisplayName string
- Unique name that can be edited. The name should not contain any confidential information.
- Name string
- Name of the vantage point.
- WorkerLists []string
- List of workers running the assigned monitor.
- displayName String
- Unique name that can be edited. The name should not contain any confidential information.
- name String
- Name of the vantage point.
- workerLists List<String>
- List of workers running the assigned monitor.
- displayName string
- Unique name that can be edited. The name should not contain any confidential information.
- name string
- Name of the vantage point.
- workerLists string[]
- List of workers running the assigned monitor.
- display_name str
- Unique name that can be edited. The name should not contain any confidential information.
- name str
- Name of the vantage point.
- worker_lists Sequence[str]
- List of workers running the assigned monitor.
- displayName String
- Unique name that can be edited. The name should not contain any confidential information.
- name String
- Name of the vantage point.
- workerLists List<String>
- List of workers running the assigned monitor.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.