← All packages

Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi
Source code
  1. Pulumi Registry
  2. Oracle Cloud Infrastructure
  3. Oracle Cloud Infrastructure
  4. ApmSynthetics
  5. Config

Config

This resource provides the Monitor resource in Oracle Cloud Infrastructure Apm Synthetics service.

Creates a new monitor.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testMonitor = new Oci.ApmSynthetics.Config("testMonitor", new Oci.ApmSynthetics.ConfigArgs
        {
            ApmDomainId = oci_apm_synthetics_apm_domain.Test_apm_domain.Id,
            DisplayName = @var.Monitor_display_name,
            MonitorType = @var.Monitor_monitor_type,
            RepeatIntervalInSeconds = @var.Monitor_repeat_interval_in_seconds,
            VantagePoints = {},
            Configuration = new Oci.ApmSynthetics.Inputs.ConfigConfigurationArgs
            {
                ConfigType = @var.Monitor_configuration_config_type,
                IsCertificateValidationEnabled = @var.Monitor_configuration_is_certificate_validation_enabled,
                IsFailureRetried = @var.Monitor_configuration_is_failure_retried,
                IsRedirectionEnabled = @var.Monitor_configuration_is_redirection_enabled,
                NetworkConfiguration = new Oci.ApmSynthetics.Inputs.ConfigConfigurationNetworkConfigurationArgs
                {
                    NumberOfHops = @var.Monitor_configuration_network_configuration_number_of_hops,
                    ProbeMode = @var.Monitor_configuration_network_configuration_probe_mode,
                    ProbePerHop = @var.Monitor_configuration_network_configuration_probe_per_hop,
                    Protocol = @var.Monitor_configuration_network_configuration_protocol,
                    TransmissionRate = @var.Monitor_configuration_network_configuration_transmission_rate,
                },
                ReqAuthenticationDetails = new Oci.ApmSynthetics.Inputs.ConfigConfigurationReqAuthenticationDetailsArgs
                {
                    AuthHeaders = 
                    {
                        new Oci.ApmSynthetics.Inputs.ConfigConfigurationReqAuthenticationDetailsAuthHeaderArgs
                        {
                            HeaderName = @var.Monitor_configuration_req_authentication_details_auth_headers_header_name,
                            HeaderValue = @var.Monitor_configuration_req_authentication_details_auth_headers_header_value,
                        },
                    },
                    AuthRequestMethod = @var.Monitor_configuration_req_authentication_details_auth_request_method,
                    AuthRequestPostBody = @var.Monitor_configuration_req_authentication_details_auth_request_post_body,
                    AuthToken = @var.Monitor_configuration_req_authentication_details_auth_token,
                    AuthUrl = @var.Monitor_configuration_req_authentication_details_auth_url,
                    AuthUserName = oci_identity_user.Test_user.Name,
                    AuthUserPassword = @var.Monitor_configuration_req_authentication_details_auth_user_password,
                    OauthScheme = @var.Monitor_configuration_req_authentication_details_oauth_scheme,
                },
                ReqAuthenticationScheme = @var.Monitor_configuration_req_authentication_scheme,
                RequestHeaders = 
                {
                    new Oci.ApmSynthetics.Inputs.ConfigConfigurationRequestHeaderArgs
                    {
                        HeaderName = @var.Monitor_configuration_request_headers_header_name,
                        HeaderValue = @var.Monitor_configuration_request_headers_header_value,
                    },
                },
                RequestMethod = @var.Monitor_configuration_request_method,
                RequestPostBody = @var.Monitor_configuration_request_post_body,
                RequestQueryParams = 
                {
                    new Oci.ApmSynthetics.Inputs.ConfigConfigurationRequestQueryParamArgs
                    {
                        ParamName = @var.Monitor_configuration_request_query_params_param_name,
                        ParamValue = @var.Monitor_configuration_request_query_params_param_value,
                    },
                },
                VerifyResponseCodes = @var.Monitor_configuration_verify_response_codes,
                VerifyResponseContent = @var.Monitor_configuration_verify_response_content,
                VerifyTexts = 
                {
                    new Oci.ApmSynthetics.Inputs.ConfigConfigurationVerifyTextArgs
                    {
                        Text = @var.Monitor_configuration_verify_texts_text,
                    },
                },
            },
            DefinedTags = 
            {
                { "foo-namespace.bar-key", "value" },
            },
            FreeformTags = 
            {
                { "bar-key", "value" },
            },
            IsRunOnce = @var.Monitor_is_run_once,
            ScriptId = oci_apm_synthetics_script.Test_script.Id,
            ScriptParameters = 
            {
                new Oci.ApmSynthetics.Inputs.ConfigScriptParameterArgs
                {
                    ParamName = @var.Monitor_script_parameters_param_name,
                    ParamValue = @var.Monitor_script_parameters_param_value,
                },
            },
            Status = @var.Monitor_status,
            Target = @var.Monitor_target,
            TimeoutInSeconds = @var.Monitor_timeout_in_seconds,
        });
    }

}

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ApmSynthetics.NewConfig(ctx, "testMonitor", &ApmSynthetics.ConfigArgs{
			ApmDomainId:             pulumi.Any(oci_apm_synthetics_apm_domain.Test_apm_domain.Id),
			DisplayName:             pulumi.Any(_var.Monitor_display_name),
			MonitorType:             pulumi.Any(_var.Monitor_monitor_type),
			RepeatIntervalInSeconds: pulumi.Any(_var.Monitor_repeat_interval_in_seconds),
			VantagePoints:           pulumi.StringArray{},
			Configuration: &apmsynthetics.ConfigConfigurationArgs{
				ConfigType:                     pulumi.Any(_var.Monitor_configuration_config_type),
				IsCertificateValidationEnabled: pulumi.Any(_var.Monitor_configuration_is_certificate_validation_enabled),
				IsFailureRetried:               pulumi.Any(_var.Monitor_configuration_is_failure_retried),
				IsRedirectionEnabled:           pulumi.Any(_var.Monitor_configuration_is_redirection_enabled),
				NetworkConfiguration: &apmsynthetics.ConfigConfigurationNetworkConfigurationArgs{
					NumberOfHops:     pulumi.Any(_var.Monitor_configuration_network_configuration_number_of_hops),
					ProbeMode:        pulumi.Any(_var.Monitor_configuration_network_configuration_probe_mode),
					ProbePerHop:      pulumi.Any(_var.Monitor_configuration_network_configuration_probe_per_hop),
					Protocol:         pulumi.Any(_var.Monitor_configuration_network_configuration_protocol),
					TransmissionRate: pulumi.Any(_var.Monitor_configuration_network_configuration_transmission_rate),
				},
				ReqAuthenticationDetails: &apmsynthetics.ConfigConfigurationReqAuthenticationDetailsArgs{
					AuthHeaders: apmsynthetics.ConfigConfigurationReqAuthenticationDetailsAuthHeaderArray{
						&apmsynthetics.ConfigConfigurationReqAuthenticationDetailsAuthHeaderArgs{
							HeaderName:  pulumi.Any(_var.Monitor_configuration_req_authentication_details_auth_headers_header_name),
							HeaderValue: pulumi.Any(_var.Monitor_configuration_req_authentication_details_auth_headers_header_value),
						},
					},
					AuthRequestMethod:   pulumi.Any(_var.Monitor_configuration_req_authentication_details_auth_request_method),
					AuthRequestPostBody: pulumi.Any(_var.Monitor_configuration_req_authentication_details_auth_request_post_body),
					AuthToken:           pulumi.Any(_var.Monitor_configuration_req_authentication_details_auth_token),
					AuthUrl:             pulumi.Any(_var.Monitor_configuration_req_authentication_details_auth_url),
					AuthUserName:        pulumi.Any(oci_identity_user.Test_user.Name),
					AuthUserPassword:    pulumi.Any(_var.Monitor_configuration_req_authentication_details_auth_user_password),
					OauthScheme:         pulumi.Any(_var.Monitor_configuration_req_authentication_details_oauth_scheme),
				},
				ReqAuthenticationScheme: pulumi.Any(_var.Monitor_configuration_req_authentication_scheme),
				RequestHeaders: apmsynthetics.ConfigConfigurationRequestHeaderArray{
					&apmsynthetics.ConfigConfigurationRequestHeaderArgs{
						HeaderName:  pulumi.Any(_var.Monitor_configuration_request_headers_header_name),
						HeaderValue: pulumi.Any(_var.Monitor_configuration_request_headers_header_value),
					},
				},
				RequestMethod:   pulumi.Any(_var.Monitor_configuration_request_method),
				RequestPostBody: pulumi.Any(_var.Monitor_configuration_request_post_body),
				RequestQueryParams: apmsynthetics.ConfigConfigurationRequestQueryParamArray{
					&apmsynthetics.ConfigConfigurationRequestQueryParamArgs{
						ParamName:  pulumi.Any(_var.Monitor_configuration_request_query_params_param_name),
						ParamValue: pulumi.Any(_var.Monitor_configuration_request_query_params_param_value),
					},
				},
				VerifyResponseCodes:   pulumi.Any(_var.Monitor_configuration_verify_response_codes),
				VerifyResponseContent: pulumi.Any(_var.Monitor_configuration_verify_response_content),
				VerifyTexts: apmsynthetics.ConfigConfigurationVerifyTextArray{
					&apmsynthetics.ConfigConfigurationVerifyTextArgs{
						Text: pulumi.Any(_var.Monitor_configuration_verify_texts_text),
					},
				},
			},
			DefinedTags: pulumi.AnyMap{
				"foo-namespace.bar-key": pulumi.Any("value"),
			},
			FreeformTags: pulumi.AnyMap{
				"bar-key": pulumi.Any("value"),
			},
			IsRunOnce: pulumi.Any(_var.Monitor_is_run_once),
			ScriptId:  pulumi.Any(oci_apm_synthetics_script.Test_script.Id),
			ScriptParameters: apmsynthetics.ConfigScriptParameterArray{
				&apmsynthetics.ConfigScriptParameterArgs{
					ParamName:  pulumi.Any(_var.Monitor_script_parameters_param_name),
					ParamValue: pulumi.Any(_var.Monitor_script_parameters_param_value),
				},
			},
			Status:           pulumi.Any(_var.Monitor_status),
			Target:           pulumi.Any(_var.Monitor_target),
			TimeoutInSeconds: pulumi.Any(_var.Monitor_timeout_in_seconds),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_monitor = oci.apm_synthetics.Config("testMonitor",
    apm_domain_id=oci_apm_synthetics_apm_domain["test_apm_domain"]["id"],
    display_name=var["monitor_display_name"],
    monitor_type=var["monitor_monitor_type"],
    repeat_interval_in_seconds=var["monitor_repeat_interval_in_seconds"],
    vantage_points=[],
    configuration=oci.apm.synthetics.ConfigConfigurationArgs(
        config_type=var["monitor_configuration_config_type"],
        is_certificate_validation_enabled=var["monitor_configuration_is_certificate_validation_enabled"],
        is_failure_retried=var["monitor_configuration_is_failure_retried"],
        is_redirection_enabled=var["monitor_configuration_is_redirection_enabled"],
        network_configuration=oci.apm.synthetics.ConfigConfigurationNetworkConfigurationArgs(
            number_of_hops=var["monitor_configuration_network_configuration_number_of_hops"],
            probe_mode=var["monitor_configuration_network_configuration_probe_mode"],
            probe_per_hop=var["monitor_configuration_network_configuration_probe_per_hop"],
            protocol=var["monitor_configuration_network_configuration_protocol"],
            transmission_rate=var["monitor_configuration_network_configuration_transmission_rate"],
        ),
        req_authentication_details=oci.apm.synthetics.ConfigConfigurationReqAuthenticationDetailsArgs(
            auth_headers=[oci.apm.synthetics.ConfigConfigurationReqAuthenticationDetailsAuthHeaderArgs(
                header_name=var["monitor_configuration_req_authentication_details_auth_headers_header_name"],
                header_value=var["monitor_configuration_req_authentication_details_auth_headers_header_value"],
            )],
            auth_request_method=var["monitor_configuration_req_authentication_details_auth_request_method"],
            auth_request_post_body=var["monitor_configuration_req_authentication_details_auth_request_post_body"],
            auth_token=var["monitor_configuration_req_authentication_details_auth_token"],
            auth_url=var["monitor_configuration_req_authentication_details_auth_url"],
            auth_user_name=oci_identity_user["test_user"]["name"],
            auth_user_password=var["monitor_configuration_req_authentication_details_auth_user_password"],
            oauth_scheme=var["monitor_configuration_req_authentication_details_oauth_scheme"],
        ),
        req_authentication_scheme=var["monitor_configuration_req_authentication_scheme"],
        request_headers=[oci.apm.synthetics.ConfigConfigurationRequestHeaderArgs(
            header_name=var["monitor_configuration_request_headers_header_name"],
            header_value=var["monitor_configuration_request_headers_header_value"],
        )],
        request_method=var["monitor_configuration_request_method"],
        request_post_body=var["monitor_configuration_request_post_body"],
        request_query_params=[oci.apm.synthetics.ConfigConfigurationRequestQueryParamArgs(
            param_name=var["monitor_configuration_request_query_params_param_name"],
            param_value=var["monitor_configuration_request_query_params_param_value"],
        )],
        verify_response_codes=var["monitor_configuration_verify_response_codes"],
        verify_response_content=var["monitor_configuration_verify_response_content"],
        verify_texts=[oci.apm.synthetics.ConfigConfigurationVerifyTextArgs(
            text=var["monitor_configuration_verify_texts_text"],
        )],
    ),
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    freeform_tags={
        "bar-key": "value",
    },
    is_run_once=var["monitor_is_run_once"],
    script_id=oci_apm_synthetics_script["test_script"]["id"],
    script_parameters=[oci.apm.synthetics.ConfigScriptParameterArgs(
        param_name=var["monitor_script_parameters_param_name"],
        param_value=var["monitor_script_parameters_param_value"],
    )],
    status=var["monitor_status"],
    target=var["monitor_target"],
    timeout_in_seconds=var["monitor_timeout_in_seconds"])

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

const testMonitor = new oci.apmsynthetics.Config("testMonitor", {
    apmDomainId: oci_apm_synthetics_apm_domain.test_apm_domain.id,
    displayName: _var.monitor_display_name,
    monitorType: _var.monitor_monitor_type,
    repeatIntervalInSeconds: _var.monitor_repeat_interval_in_seconds,
    vantagePoints: [],
    configuration: {
        configType: _var.monitor_configuration_config_type,
        isCertificateValidationEnabled: _var.monitor_configuration_is_certificate_validation_enabled,
        isFailureRetried: _var.monitor_configuration_is_failure_retried,
        isRedirectionEnabled: _var.monitor_configuration_is_redirection_enabled,
        networkConfiguration: {
            numberOfHops: _var.monitor_configuration_network_configuration_number_of_hops,
            probeMode: _var.monitor_configuration_network_configuration_probe_mode,
            probePerHop: _var.monitor_configuration_network_configuration_probe_per_hop,
            protocol: _var.monitor_configuration_network_configuration_protocol,
            transmissionRate: _var.monitor_configuration_network_configuration_transmission_rate,
        },
        reqAuthenticationDetails: {
            authHeaders: [{
                headerName: _var.monitor_configuration_req_authentication_details_auth_headers_header_name,
                headerValue: _var.monitor_configuration_req_authentication_details_auth_headers_header_value,
            }],
            authRequestMethod: _var.monitor_configuration_req_authentication_details_auth_request_method,
            authRequestPostBody: _var.monitor_configuration_req_authentication_details_auth_request_post_body,
            authToken: _var.monitor_configuration_req_authentication_details_auth_token,
            authUrl: _var.monitor_configuration_req_authentication_details_auth_url,
            authUserName: oci_identity_user.test_user.name,
            authUserPassword: _var.monitor_configuration_req_authentication_details_auth_user_password,
            oauthScheme: _var.monitor_configuration_req_authentication_details_oauth_scheme,
        },
        reqAuthenticationScheme: _var.monitor_configuration_req_authentication_scheme,
        requestHeaders: [{
            headerName: _var.monitor_configuration_request_headers_header_name,
            headerValue: _var.monitor_configuration_request_headers_header_value,
        }],
        requestMethod: _var.monitor_configuration_request_method,
        requestPostBody: _var.monitor_configuration_request_post_body,
        requestQueryParams: [{
            paramName: _var.monitor_configuration_request_query_params_param_name,
            paramValue: _var.monitor_configuration_request_query_params_param_value,
        }],
        verifyResponseCodes: _var.monitor_configuration_verify_response_codes,
        verifyResponseContent: _var.monitor_configuration_verify_response_content,
        verifyTexts: [{
            text: _var.monitor_configuration_verify_texts_text,
        }],
    },
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    freeformTags: {
        "bar-key": "value",
    },
    isRunOnce: _var.monitor_is_run_once,
    scriptId: oci_apm_synthetics_script.test_script.id,
    scriptParameters: [{
        paramName: _var.monitor_script_parameters_param_name,
        paramValue: _var.monitor_script_parameters_param_value,
    }],
    status: _var.monitor_status,
    target: _var.monitor_target,
    timeoutInSeconds: _var.monitor_timeout_in_seconds,
});

Coming soon!

Create a Config Resource

new Config(name: string, args: ConfigArgs, opts?: CustomResourceOptions);
@overload
def Config(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           apm_domain_id: Optional[str] = None,
           configuration: Optional[_apmsynthetics.ConfigConfigurationArgs] = None,
           defined_tags: Optional[Mapping[str, Any]] = None,
           display_name: Optional[str] = None,
           freeform_tags: Optional[Mapping[str, Any]] = None,
           is_run_once: Optional[bool] = None,
           monitor_type: Optional[str] = None,
           repeat_interval_in_seconds: Optional[int] = None,
           script_id: Optional[str] = None,
           script_name: Optional[str] = None,
           script_parameters: Optional[Sequence[_apmsynthetics.ConfigScriptParameterArgs]] = None,
           status: Optional[str] = None,
           target: Optional[str] = None,
           timeout_in_seconds: Optional[int] = None,
           vantage_points: Optional[Sequence[str]] = None)
@overload
def Config(resource_name: str,
           args: ConfigArgs,
           opts: Optional[ResourceOptions] = None)
func NewConfig(ctx *Context, name string, args ConfigArgs, opts ...ResourceOption) (*Config, error)
public Config(string name, ConfigArgs args, CustomResourceOptions? opts = null)
public Config(String name, ConfigArgs args)
public Config(String name, ConfigArgs args, CustomResourceOptions options)

type: oci:ApmSynthetics:Config
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ConfigArgs
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 ConfigArgs
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 ConfigArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ConfigArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ConfigArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Config Resource Properties

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

Inputs

The Config resource accepts the following input properties:

ApmDomainId string

(Updatable) The APM domain ID the request is intended for.

DisplayName string

(Updatable) Unique name that can be edited. The name should not contain any confidential information.

MonitorType string

Type of monitor.

RepeatIntervalInSeconds int

(Updatable) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.

VantagePoints List<string>

(Updatable) A list of vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points.

Configuration ConfigConfigurationArgs

(Updatable) Details of monitor configuration.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

FreeformTags Dictionary<string, object>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

IsRunOnce bool

(Updatable) If runOnce is enabled, then the monitor will run once.

ScriptId string

(Updatable) 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<ConfigScriptParameterArgs>

(Updatable) List of script parameters in the monitor. This is valid only for SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null. Example: [{"paramName": "userid", "paramValue":"testuser"}]

Status string

(Updatable) Enables or disables the monitor.

Target string

(Updatable) Specify the endpoint on which to run the monitor. For BROWSER and REST 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.

TimeoutInSeconds int

(Updatable) Timeout in seconds. Timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.

ApmDomainId string

(Updatable) The APM domain ID the request is intended for.

DisplayName string

(Updatable) Unique name that can be edited. The name should not contain any confidential information.

MonitorType string

Type of monitor.

RepeatIntervalInSeconds int

(Updatable) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.

VantagePoints []string

(Updatable) A list of vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points.

Configuration ConfigConfigurationArgs

(Updatable) Details of monitor configuration.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

FreeformTags map[string]interface{}

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

IsRunOnce bool

(Updatable) If runOnce is enabled, then the monitor will run once.

ScriptId string

(Updatable) 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 []ConfigScriptParameterArgs

(Updatable) List of script parameters in the monitor. This is valid only for SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null. Example: [{"paramName": "userid", "paramValue":"testuser"}]

Status string

(Updatable) Enables or disables the monitor.

Target string

(Updatable) Specify the endpoint on which to run the monitor. For BROWSER and REST 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.

TimeoutInSeconds int

(Updatable) Timeout in seconds. Timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.

apmDomainId String

(Updatable) The APM domain ID the request is intended for.

displayName String

(Updatable) Unique name that can be edited. The name should not contain any confidential information.

monitorType String

Type of monitor.

repeatIntervalInSeconds Integer

(Updatable) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.

vantagePoints List<String>

(Updatable) A list of vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points.

configuration ConfigConfigurationArgs

(Updatable) Details of monitor configuration.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

freeformTags Map<String,Object>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

isRunOnce Boolean

(Updatable) If runOnce is enabled, then the monitor will run once.

scriptId String

(Updatable) 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<ConfigScriptParameterArgs>

(Updatable) List of script parameters in the monitor. This is valid only for SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null. Example: [{"paramName": "userid", "paramValue":"testuser"}]

status String

(Updatable) Enables or disables the monitor.

target String

(Updatable) Specify the endpoint on which to run the monitor. For BROWSER and REST 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.

timeoutInSeconds Integer

(Updatable) Timeout in seconds. Timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.

apmDomainId string

(Updatable) The APM domain ID the request is intended for.

displayName string

(Updatable) Unique name that can be edited. The name should not contain any confidential information.

monitorType string

Type of monitor.

repeatIntervalInSeconds number

(Updatable) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.

vantagePoints string[]

(Updatable) A list of vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points.

configuration ConfigConfigurationArgs

(Updatable) Details of monitor configuration.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

freeformTags {[key: string]: any}

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

isRunOnce boolean

(Updatable) If runOnce is enabled, then the monitor will run once.

scriptId string

(Updatable) 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 ConfigScriptParameterArgs[]

(Updatable) List of script parameters in the monitor. This is valid only for SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null. Example: [{"paramName": "userid", "paramValue":"testuser"}]

status string

(Updatable) Enables or disables the monitor.

target string

(Updatable) Specify the endpoint on which to run the monitor. For BROWSER and REST 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.

timeoutInSeconds number

(Updatable) Timeout in seconds. Timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.

apm_domain_id str

(Updatable) The APM domain ID the request is intended for.

display_name str

(Updatable) Unique name that can be edited. The name should not contain any confidential information.

monitor_type str

Type of monitor.

repeat_interval_in_seconds int

(Updatable) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.

vantage_points Sequence[str]

(Updatable) A list of vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points.

configuration ConfigConfigurationArgs

(Updatable) Details of monitor configuration.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

freeform_tags Mapping[str, Any]

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

is_run_once bool

(Updatable) If runOnce is enabled, then the monitor will run once.

script_id str

(Updatable) 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 ConfigScriptParameterArgs]

(Updatable) List of script parameters in the monitor. This is valid only for SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null. Example: [{"paramName": "userid", "paramValue":"testuser"}]

status str

(Updatable) Enables or disables the monitor.

target str

(Updatable) Specify the endpoint on which to run the monitor. For BROWSER and REST 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.

timeout_in_seconds int

(Updatable) Timeout in seconds. Timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.

apmDomainId String

(Updatable) The APM domain ID the request is intended for.

displayName String

(Updatable) Unique name that can be edited. The name should not contain any confidential information.

monitorType String

Type of monitor.

repeatIntervalInSeconds Number

(Updatable) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.

vantagePoints List<String>

(Updatable) A list of vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points.

configuration Property Map

(Updatable) Details of monitor configuration.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

freeformTags Map<Any>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

isRunOnce Boolean

(Updatable) If runOnce is enabled, then the monitor will run once.

scriptId String

(Updatable) 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>

(Updatable) List of script parameters in the monitor. This is valid only for SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null. Example: [{"paramName": "userid", "paramValue":"testuser"}]

status String

(Updatable) Enables or disables the monitor.

target String

(Updatable) Specify the endpoint on which to run the monitor. For BROWSER and REST 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.

timeoutInSeconds Number

(Updatable) Timeout in seconds. Timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

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

VantagePointCount int

Number of vantage points where monitor is running.

Id string

The provider-assigned unique ID for this managed resource.

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

VantagePointCount int

Number of vantage points where monitor is running.

id String

The provider-assigned unique ID for this managed resource.

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

vantagePointCount Integer

Number of vantage points where monitor is running.

id string

The provider-assigned unique ID for this managed resource.

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

vantagePointCount number

Number of vantage points where monitor is running.

id str

The provider-assigned unique ID for this managed resource.

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

vantage_point_count int

Number of vantage points where monitor is running.

id String

The provider-assigned unique ID for this managed resource.

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

vantagePointCount Number

Number of vantage points where monitor is running.

Look up an Existing Config Resource

Get an existing Config 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?: ConfigState, opts?: CustomResourceOptions): Config
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        apm_domain_id: Optional[str] = None,
        configuration: Optional[_apmsynthetics.ConfigConfigurationArgs] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        is_run_once: Optional[bool] = None,
        monitor_type: Optional[str] = None,
        repeat_interval_in_seconds: Optional[int] = None,
        script_id: Optional[str] = None,
        script_name: Optional[str] = None,
        script_parameters: Optional[Sequence[_apmsynthetics.ConfigScriptParameterArgs]] = None,
        status: Optional[str] = None,
        target: Optional[str] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        timeout_in_seconds: Optional[int] = None,
        vantage_point_count: Optional[int] = None,
        vantage_points: Optional[Sequence[str]] = None) -> Config
func GetConfig(ctx *Context, name string, id IDInput, state *ConfigState, opts ...ResourceOption) (*Config, error)
public static Config Get(string name, Input<string> id, ConfigState? state, CustomResourceOptions? opts = null)
public static Config get(String name, Output<String> id, ConfigState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ApmDomainId string

(Updatable) The APM domain ID the request is intended for.

Configuration ConfigConfigurationArgs

(Updatable) Details of monitor configuration.

DefinedTags Dictionary<string, object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

DisplayName string

(Updatable) Unique name that can be edited. The name should not contain any confidential information.

FreeformTags Dictionary<string, object>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

IsRunOnce bool

(Updatable) If runOnce is enabled, then the monitor will run once.

MonitorType string

Type of monitor.

RepeatIntervalInSeconds int

(Updatable) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.

ScriptId string

(Updatable) 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<ConfigScriptParameterArgs>

(Updatable) List of script parameters in the monitor. This is valid only for SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null. Example: [{"paramName": "userid", "paramValue":"testuser"}]

Status string

(Updatable) Enables or disables the monitor.

Target string

(Updatable) Specify the endpoint on which to run the monitor. For BROWSER and REST 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.

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

TimeoutInSeconds int

(Updatable) Timeout in seconds. Timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.

VantagePointCount int

Number of vantage points where monitor is running.

VantagePoints List<string>

(Updatable) A list of vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points.

ApmDomainId string

(Updatable) The APM domain ID the request is intended for.

Configuration ConfigConfigurationArgs

(Updatable) Details of monitor configuration.

DefinedTags map[string]interface{}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

DisplayName string

(Updatable) Unique name that can be edited. The name should not contain any confidential information.

FreeformTags map[string]interface{}

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

IsRunOnce bool

(Updatable) If runOnce is enabled, then the monitor will run once.

MonitorType string

Type of monitor.

RepeatIntervalInSeconds int

(Updatable) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.

ScriptId string

(Updatable) 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 []ConfigScriptParameterArgs

(Updatable) List of script parameters in the monitor. This is valid only for SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null. Example: [{"paramName": "userid", "paramValue":"testuser"}]

Status string

(Updatable) Enables or disables the monitor.

Target string

(Updatable) Specify the endpoint on which to run the monitor. For BROWSER and REST 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.

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

TimeoutInSeconds int

(Updatable) Timeout in seconds. Timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.

VantagePointCount int

Number of vantage points where monitor is running.

VantagePoints []string

(Updatable) A list of vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points.

apmDomainId String

(Updatable) The APM domain ID the request is intended for.

configuration ConfigConfigurationArgs

(Updatable) Details of monitor configuration.

definedTags Map<String,Object>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

displayName String

(Updatable) Unique name that can be edited. The name should not contain any confidential information.

freeformTags Map<String,Object>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

isRunOnce Boolean

(Updatable) If runOnce is enabled, then the monitor will run once.

monitorType String

Type of monitor.

repeatIntervalInSeconds Integer

(Updatable) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.

scriptId String

(Updatable) 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<ConfigScriptParameterArgs>

(Updatable) List of script parameters in the monitor. This is valid only for SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null. Example: [{"paramName": "userid", "paramValue":"testuser"}]

status String

(Updatable) Enables or disables the monitor.

target String

(Updatable) Specify the endpoint on which to run the monitor. For BROWSER and REST 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.

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

timeoutInSeconds Integer

(Updatable) Timeout in seconds. Timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.

vantagePointCount Integer

Number of vantage points where monitor is running.

vantagePoints List<String>

(Updatable) A list of vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points.

apmDomainId string

(Updatable) The APM domain ID the request is intended for.

configuration ConfigConfigurationArgs

(Updatable) Details of monitor configuration.

definedTags {[key: string]: any}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

displayName string

(Updatable) Unique name that can be edited. The name should not contain any confidential information.

freeformTags {[key: string]: any}

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

isRunOnce boolean

(Updatable) If runOnce is enabled, then the monitor will run once.

monitorType string

Type of monitor.

repeatIntervalInSeconds number

(Updatable) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.

scriptId string

(Updatable) 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 ConfigScriptParameterArgs[]

(Updatable) List of script parameters in the monitor. This is valid only for SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null. Example: [{"paramName": "userid", "paramValue":"testuser"}]

status string

(Updatable) Enables or disables the monitor.

target string

(Updatable) Specify the endpoint on which to run the monitor. For BROWSER and REST 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.

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

timeoutInSeconds number

(Updatable) Timeout in seconds. Timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.

vantagePointCount number

Number of vantage points where monitor is running.

vantagePoints string[]

(Updatable) A list of vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points.

apm_domain_id str

(Updatable) The APM domain ID the request is intended for.

configuration ConfigConfigurationArgs

(Updatable) Details of monitor configuration.

defined_tags Mapping[str, Any]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

display_name str

(Updatable) Unique name that can be edited. The name should not contain any confidential information.

freeform_tags Mapping[str, Any]

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

is_run_once bool

(Updatable) If runOnce is enabled, then the monitor will run once.

monitor_type str

Type of monitor.

repeat_interval_in_seconds int

(Updatable) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.

script_id str

(Updatable) 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 ConfigScriptParameterArgs]

(Updatable) List of script parameters in the monitor. This is valid only for SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null. Example: [{"paramName": "userid", "paramValue":"testuser"}]

status str

(Updatable) Enables or disables the monitor.

target str

(Updatable) Specify the endpoint on which to run the monitor. For BROWSER and REST 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.

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_seconds int

(Updatable) Timeout in seconds. Timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.

vantage_point_count int

Number of vantage points where monitor is running.

vantage_points Sequence[str]

(Updatable) A list of vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points.

apmDomainId String

(Updatable) The APM domain ID the request is intended for.

configuration Property Map

(Updatable) Details of monitor configuration.

definedTags Map<Any>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

displayName String

(Updatable) Unique name that can be edited. The name should not contain any confidential information.

freeformTags Map<Any>

(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

isRunOnce Boolean

(Updatable) If runOnce is enabled, then the monitor will run once.

monitorType String

Type of monitor.

repeatIntervalInSeconds Number

(Updatable) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.

scriptId String

(Updatable) 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>

(Updatable) List of script parameters in the monitor. This is valid only for SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null. Example: [{"paramName": "userid", "paramValue":"testuser"}]

status String

(Updatable) Enables or disables the monitor.

target String

(Updatable) Specify the endpoint on which to run the monitor. For BROWSER and REST 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.

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

timeoutInSeconds Number

(Updatable) Timeout in seconds. Timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.

vantagePointCount Number

Number of vantage points where monitor is running.

vantagePoints List<String>

(Updatable) A list of vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points.

Supporting Types

ConfigConfiguration

ConfigType string

(Updatable) Type of configuration.

IsCertificateValidationEnabled bool

(Updatable) If certificate validation is enabled, then the call will fail in case of certification errors.

IsFailureRetried bool

(Updatable) If isFailureRetried is enabled, then a failed call will be retried.

IsRedirectionEnabled bool

(Updatable) If redirection enabled, then redirects will be allowed while accessing target URL.

NetworkConfiguration ConfigConfigurationNetworkConfiguration

(Updatable) Details of the network configuration.

ReqAuthenticationDetails ConfigConfigurationReqAuthenticationDetails

(Updatable) Details for request HTTP authentication.

ReqAuthenticationScheme string

(Updatable) Request http authentication scheme.

RequestHeaders List<ConfigConfigurationRequestHeader>

(Updatable) List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]

RequestMethod string

(Updatable) Request HTTP method.

RequestPostBody string

(Updatable) Request post body content.

RequestQueryParams List<ConfigConfigurationRequestQueryParam>

(Updatable) List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]

VerifyResponseCodes List<string>

(Updatable) Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.

VerifyResponseContent string

(Updatable) 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<ConfigConfigurationVerifyText>

(Updatable) Verify all the search strings present in response. If any search string is not present in the response, then it will be considered as a failure.

ConfigType string

(Updatable) Type of configuration.

IsCertificateValidationEnabled bool

(Updatable) If certificate validation is enabled, then the call will fail in case of certification errors.

IsFailureRetried bool

(Updatable) If isFailureRetried is enabled, then a failed call will be retried.

IsRedirectionEnabled bool

(Updatable) If redirection enabled, then redirects will be allowed while accessing target URL.

NetworkConfiguration ConfigConfigurationNetworkConfiguration

(Updatable) Details of the network configuration.

ReqAuthenticationDetails ConfigConfigurationReqAuthenticationDetails

(Updatable) Details for request HTTP authentication.

ReqAuthenticationScheme string

(Updatable) Request http authentication scheme.

RequestHeaders []ConfigConfigurationRequestHeader

(Updatable) List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]

RequestMethod string

(Updatable) Request HTTP method.

RequestPostBody string

(Updatable) Request post body content.

RequestQueryParams []ConfigConfigurationRequestQueryParam

(Updatable) List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]

VerifyResponseCodes []string

(Updatable) Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.

VerifyResponseContent string

(Updatable) 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 []ConfigConfigurationVerifyText

(Updatable) Verify all the search strings present in response. If any search string is not present in the response, then it will be considered as a failure.

configType String

(Updatable) Type of configuration.

isCertificateValidationEnabled Boolean

(Updatable) If certificate validation is enabled, then the call will fail in case of certification errors.

isFailureRetried Boolean

(Updatable) If isFailureRetried is enabled, then a failed call will be retried.

isRedirectionEnabled Boolean

(Updatable) If redirection enabled, then redirects will be allowed while accessing target URL.

networkConfiguration ConfigConfigurationNetworkConfiguration

(Updatable) Details of the network configuration.

reqAuthenticationDetails ConfigConfigurationReqAuthenticationDetails

(Updatable) Details for request HTTP authentication.

reqAuthenticationScheme String

(Updatable) Request http authentication scheme.

requestHeaders List<ConfigConfigurationRequestHeader>

(Updatable) List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]

requestMethod String

(Updatable) Request HTTP method.

requestPostBody String

(Updatable) Request post body content.

requestQueryParams List<ConfigConfigurationRequestQueryParam>

(Updatable) List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]

verifyResponseCodes List<String>

(Updatable) Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.

verifyResponseContent String

(Updatable) 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<ConfigConfigurationVerifyText>

(Updatable) Verify all the search strings present in response. If any search string is not present in the response, then it will be considered as a failure.

configType string

(Updatable) Type of configuration.

isCertificateValidationEnabled boolean

(Updatable) If certificate validation is enabled, then the call will fail in case of certification errors.

isFailureRetried boolean

(Updatable) If isFailureRetried is enabled, then a failed call will be retried.

isRedirectionEnabled boolean

(Updatable) If redirection enabled, then redirects will be allowed while accessing target URL.

networkConfiguration ConfigConfigurationNetworkConfiguration

(Updatable) Details of the network configuration.

reqAuthenticationDetails ConfigConfigurationReqAuthenticationDetails

(Updatable) Details for request HTTP authentication.

reqAuthenticationScheme string

(Updatable) Request http authentication scheme.

requestHeaders ConfigConfigurationRequestHeader[]

(Updatable) List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]

requestMethod string

(Updatable) Request HTTP method.

requestPostBody string

(Updatable) Request post body content.

requestQueryParams ConfigConfigurationRequestQueryParam[]

(Updatable) List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]

verifyResponseCodes string[]

(Updatable) Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.

verifyResponseContent string

(Updatable) 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 ConfigConfigurationVerifyText[]

(Updatable) Verify all the search strings present in response. If any search string is not present in the response, then it will be considered as a failure.

config_type str

(Updatable) Type of configuration.

is_certificate_validation_enabled bool

(Updatable) If certificate validation is enabled, then the call will fail in case of certification errors.

is_failure_retried bool

(Updatable) If isFailureRetried is enabled, then a failed call will be retried.

is_redirection_enabled bool

(Updatable) If redirection enabled, then redirects will be allowed while accessing target URL.

network_configuration ConfigConfigurationNetworkConfiguration

(Updatable) Details of the network configuration.

req_authentication_details ConfigConfigurationReqAuthenticationDetails

(Updatable) Details for request HTTP authentication.

req_authentication_scheme str

(Updatable) Request http authentication scheme.

request_headers ConfigConfigurationRequestHeader]

(Updatable) List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]

request_method str

(Updatable) Request HTTP method.

request_post_body str

(Updatable) Request post body content.

request_query_params ConfigConfigurationRequestQueryParam]

(Updatable) List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]

verify_response_codes Sequence[str]

(Updatable) Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.

verify_response_content str

(Updatable) 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 ConfigConfigurationVerifyText]

(Updatable) Verify all the search strings present in response. If any search string is not present in the response, then it will be considered as a failure.

configType String

(Updatable) Type of configuration.

isCertificateValidationEnabled Boolean

(Updatable) If certificate validation is enabled, then the call will fail in case of certification errors.

isFailureRetried Boolean

(Updatable) If isFailureRetried is enabled, then a failed call will be retried.

isRedirectionEnabled Boolean

(Updatable) If redirection enabled, then redirects will be allowed while accessing target URL.

networkConfiguration Property Map

(Updatable) Details of the network configuration.

reqAuthenticationDetails Property Map

(Updatable) Details for request HTTP authentication.

reqAuthenticationScheme String

(Updatable) Request http authentication scheme.

requestHeaders List<Property Map>

(Updatable) List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]

requestMethod String

(Updatable) Request HTTP method.

requestPostBody String

(Updatable) Request post body content.

requestQueryParams List<Property Map>

(Updatable) List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]

verifyResponseCodes List<String>

(Updatable) Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.

verifyResponseContent String

(Updatable) 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>

(Updatable) Verify all the search strings present in response. If any search string is not present in the response, then it will be considered as a failure.

ConfigConfigurationNetworkConfiguration

NumberOfHops int

(Updatable) Number of hops.

ProbeMode string

(Updatable) Type of probe mode when TCP protocol is selected.

ProbePerHop int

(Updatable) Number of probes per hop.

Protocol string

(Updatable) Type of protocol.

TransmissionRate int

(Updatable) Number of probe packets sent out simultaneously.

NumberOfHops int

(Updatable) Number of hops.

ProbeMode string

(Updatable) Type of probe mode when TCP protocol is selected.

ProbePerHop int

(Updatable) Number of probes per hop.

Protocol string

(Updatable) Type of protocol.

TransmissionRate int

(Updatable) Number of probe packets sent out simultaneously.

numberOfHops Integer

(Updatable) Number of hops.

probeMode String

(Updatable) Type of probe mode when TCP protocol is selected.

probePerHop Integer

(Updatable) Number of probes per hop.

protocol String

(Updatable) Type of protocol.

transmissionRate Integer

(Updatable) Number of probe packets sent out simultaneously.

numberOfHops number

(Updatable) Number of hops.

probeMode string

(Updatable) Type of probe mode when TCP protocol is selected.

probePerHop number

(Updatable) Number of probes per hop.

protocol string

(Updatable) Type of protocol.

transmissionRate number

(Updatable) Number of probe packets sent out simultaneously.

number_of_hops int

(Updatable) Number of hops.

probe_mode str

(Updatable) Type of probe mode when TCP protocol is selected.

probe_per_hop int

(Updatable) Number of probes per hop.

protocol str

(Updatable) Type of protocol.

transmission_rate int

(Updatable) Number of probe packets sent out simultaneously.

numberOfHops Number

(Updatable) Number of hops.

probeMode String

(Updatable) Type of probe mode when TCP protocol is selected.

probePerHop Number

(Updatable) Number of probes per hop.

protocol String

(Updatable) Type of protocol.

transmissionRate Number

(Updatable) Number of probe packets sent out simultaneously.

ConfigConfigurationReqAuthenticationDetails

AuthHeaders List<ConfigConfigurationReqAuthenticationDetailsAuthHeader>

(Updatable) List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]

AuthRequestMethod string

(Updatable) Request method.

AuthRequestPostBody string

(Updatable) Request post body.

AuthToken string

(Updatable) Authentication token.

AuthUrl string

(Updatable) URL to get authetication token.

AuthUserName string

(Updatable) Username for authentication.

AuthUserPassword string

(Updatable) User password for authentication.

OauthScheme string

(Updatable) Request http oauth scheme.

AuthHeaders []ConfigConfigurationReqAuthenticationDetailsAuthHeader

(Updatable) List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]

AuthRequestMethod string

(Updatable) Request method.

AuthRequestPostBody string

(Updatable) Request post body.

AuthToken string

(Updatable) Authentication token.

AuthUrl string

(Updatable) URL to get authetication token.

AuthUserName string

(Updatable) Username for authentication.

AuthUserPassword string

(Updatable) User password for authentication.

OauthScheme string

(Updatable) Request http oauth scheme.

authHeaders List<ConfigConfigurationReqAuthenticationDetailsAuthHeader>

(Updatable) List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]

authRequestMethod String

(Updatable) Request method.

authRequestPostBody String

(Updatable) Request post body.

authToken String

(Updatable) Authentication token.

authUrl String

(Updatable) URL to get authetication token.

authUserName String

(Updatable) Username for authentication.

authUserPassword String

(Updatable) User password for authentication.

oauthScheme String

(Updatable) Request http oauth scheme.

authHeaders ConfigConfigurationReqAuthenticationDetailsAuthHeader[]

(Updatable) List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]

authRequestMethod string

(Updatable) Request method.

authRequestPostBody string

(Updatable) Request post body.

authToken string

(Updatable) Authentication token.

authUrl string

(Updatable) URL to get authetication token.

authUserName string

(Updatable) Username for authentication.

authUserPassword string

(Updatable) User password for authentication.

oauthScheme string

(Updatable) Request http oauth scheme.

auth_headers ConfigConfigurationReqAuthenticationDetailsAuthHeader]

(Updatable) List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]

auth_request_method str

(Updatable) Request method.

auth_request_post_body str

(Updatable) Request post body.

auth_token str

(Updatable) Authentication token.

auth_url str

(Updatable) URL to get authetication token.

auth_user_name str

(Updatable) Username for authentication.

auth_user_password str

(Updatable) User password for authentication.

oauth_scheme str

(Updatable) Request http oauth scheme.

authHeaders List<Property Map>

(Updatable) List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]

authRequestMethod String

(Updatable) Request method.

authRequestPostBody String

(Updatable) Request post body.

authToken String

(Updatable) Authentication token.

authUrl String

(Updatable) URL to get authetication token.

authUserName String

(Updatable) Username for authentication.

authUserPassword String

(Updatable) User password for authentication.

oauthScheme String

(Updatable) Request http oauth scheme.

ConfigConfigurationReqAuthenticationDetailsAuthHeader

HeaderName string

(Updatable) Name of the header.

HeaderValue string

(Updatable) Value of the header.

HeaderName string

(Updatable) Name of the header.

HeaderValue string

(Updatable) Value of the header.

headerName String

(Updatable) Name of the header.

headerValue String

(Updatable) Value of the header.

headerName string

(Updatable) Name of the header.

headerValue string

(Updatable) Value of the header.

header_name str

(Updatable) Name of the header.

header_value str

(Updatable) Value of the header.

headerName String

(Updatable) Name of the header.

headerValue String

(Updatable) Value of the header.

ConfigConfigurationRequestHeader

HeaderName string

(Updatable) Name of the header.

HeaderValue string

(Updatable) Value of the header.

HeaderName string

(Updatable) Name of the header.

HeaderValue string

(Updatable) Value of the header.

headerName String

(Updatable) Name of the header.

headerValue String

(Updatable) Value of the header.

headerName string

(Updatable) Name of the header.

headerValue string

(Updatable) Value of the header.

header_name str

(Updatable) Name of the header.

header_value str

(Updatable) Value of the header.

headerName String

(Updatable) Name of the header.

headerValue String

(Updatable) Value of the header.

ConfigConfigurationRequestQueryParam

ParamName string

(Updatable) Name of the parameter.

ParamValue string

(Updatable) Value of the parameter.

ParamName string

(Updatable) Name of the parameter.

ParamValue string

(Updatable) Value of the parameter.

paramName String

(Updatable) Name of the parameter.

paramValue String

(Updatable) Value of the parameter.

paramName string

(Updatable) Name of the parameter.

paramValue string

(Updatable) Value of the parameter.

param_name str

(Updatable) Name of the parameter.

param_value str

(Updatable) Value of the parameter.

paramName String

(Updatable) Name of the parameter.

paramValue String

(Updatable) Value of the parameter.

ConfigConfigurationVerifyText

Text string

(Updatable) Verification text in the response.

Text string

(Updatable) Verification text in the response.

text String

(Updatable) Verification text in the response.

text string

(Updatable) Verification text in the response.

text str

(Updatable) Verification text in the response.

text String

(Updatable) Verification text in the response.

ConfigScriptParameter

ParamName string

(Updatable) Name of the parameter.

ParamValue string

(Updatable) 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.

MonitorScriptParameters List<ConfigScriptParameterMonitorScriptParameter>

Details of the script parameter that can be used to overwrite the parameter present in the script.

ParamName string

(Updatable) Name of the parameter.

ParamValue string

(Updatable) 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.

MonitorScriptParameters []ConfigScriptParameterMonitorScriptParameter

Details of the script parameter that can be used to overwrite the parameter present in the script.

paramName String

(Updatable) Name of the parameter.

paramValue String

(Updatable) 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.

monitorScriptParameters List<ConfigScriptParameterMonitorScriptParameter>

Details of the script parameter that can be used to overwrite the parameter present in the script.

paramName string

(Updatable) Name of the parameter.

paramValue string

(Updatable) 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.

monitorScriptParameters ConfigScriptParameterMonitorScriptParameter[]

Details of the script parameter that can be used to overwrite the parameter present in the script.

param_name str

(Updatable) Name of the parameter.

param_value str

(Updatable) 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_parameters ConfigScriptParameterMonitorScriptParameter]

Details of the script parameter that can be used to overwrite the parameter present in the script.

paramName String

(Updatable) Name of the parameter.

paramValue String

(Updatable) 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.

monitorScriptParameters List<Property Map>

Details of the script parameter that can be used to overwrite the parameter present in the script.

ConfigScriptParameterMonitorScriptParameter

ParamName string

(Updatable) Name of the parameter.

ParamValue string

(Updatable) Value of the parameter.

ParamName string

(Updatable) Name of the parameter.

ParamValue string

(Updatable) Value of the parameter.

paramName String

(Updatable) Name of the parameter.

paramValue String

(Updatable) Value of the parameter.

paramName string

(Updatable) Name of the parameter.

paramValue string

(Updatable) Value of the parameter.

param_name str

(Updatable) Name of the parameter.

param_value str

(Updatable) Value of the parameter.

paramName String

(Updatable) Name of the parameter.

paramValue String

(Updatable) Value of the parameter.

Import

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

 $ pulumi import oci:ApmSynthetics/config:Config test_monitor "monitors/{monitorId}/apmDomainId/{apmDomainId}"

Package Details

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

This Pulumi package is based on the oci Terraform Provider.