Oracle Cloud Infrastructure
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:
- Apm
Domain stringId (Updatable) The APM domain ID the request is intended for.
- Display
Name string (Updatable) Unique name that can be edited. The name should not contain any confidential information.
- Monitor
Type string Type of monitor.
- Repeat
Interval intIn Seconds (Updatable) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.
- Vantage
Points List<string> (Updatable) A list of vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points.
- Configuration
Config
Configuration Args (Updatable) Details of monitor configuration.
- Dictionary<string, object>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- 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"}
- Is
Run boolOnce (Updatable) If runOnce is enabled, then the monitor will run once.
- Script
Id 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.
- Script
Name string Name of the script.
- Script
Parameters List<ConfigScript Parameter Args> (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.
- Timeout
In intSeconds (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 stringId (Updatable) The APM domain ID the request is intended for.
- Display
Name string (Updatable) Unique name that can be edited. The name should not contain any confidential information.
- Monitor
Type string Type of monitor.
- Repeat
Interval intIn Seconds (Updatable) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.
- Vantage
Points []string (Updatable) A list of vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points.
- Configuration
Config
Configuration Args (Updatable) Details of monitor configuration.
- map[string]interface{}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- 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"}
- Is
Run boolOnce (Updatable) If runOnce is enabled, then the monitor will run once.
- Script
Id 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.
- Script
Name string Name of the script.
- Script
Parameters []ConfigScript Parameter Args (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.
- Timeout
In intSeconds (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 StringId (Updatable) The APM domain ID the request is intended for.
- display
Name String (Updatable) Unique name that can be edited. The name should not contain any confidential information.
- monitor
Type String Type of monitor.
- repeat
Interval IntegerIn Seconds (Updatable) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.
- vantage
Points List<String> (Updatable) A list of vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points.
- configuration
Config
Configuration Args (Updatable) Details of monitor configuration.
- Map<String,Object>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- 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"}
- is
Run BooleanOnce (Updatable) If runOnce is enabled, then the monitor will run once.
- script
Id 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.
- script
Name String Name of the script.
- script
Parameters List<ConfigScript Parameter Args> (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.
- timeout
In IntegerSeconds (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 stringId (Updatable) The APM domain ID the request is intended for.
- display
Name string (Updatable) Unique name that can be edited. The name should not contain any confidential information.
- monitor
Type string Type of monitor.
- repeat
Interval numberIn Seconds (Updatable) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.
- vantage
Points string[] (Updatable) A list of vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points.
- configuration
Config
Configuration Args (Updatable) Details of monitor configuration.
- {[key: string]: any}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- {[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"}
- is
Run booleanOnce (Updatable) If runOnce is enabled, then the monitor will run once.
- script
Id 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.
- script
Name string Name of the script.
- script
Parameters ConfigScript Parameter Args[] (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.
- timeout
In numberSeconds (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_ strid (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_ intin_ seconds (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
Config
Configuration Args (Updatable) Details of monitor configuration.
- Mapping[str, Any]
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- 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_ boolonce (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 ConfigScript Parameter Args] (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_ intseconds (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 StringId (Updatable) The APM domain ID the request is intended for.
- display
Name String (Updatable) Unique name that can be edited. The name should not contain any confidential information.
- monitor
Type String Type of monitor.
- repeat
Interval NumberIn Seconds (Updatable) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.
- vantage
Points 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.
- Map<Any>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- 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"}
- is
Run BooleanOnce (Updatable) If runOnce is enabled, then the monitor will run once.
- script
Id 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.
- script
Name String Name of the script.
- script
Parameters 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.
- timeout
In NumberSeconds (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.
- Time
Created string The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- Time
Updated string The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- Vantage
Point intCount Number of vantage points where monitor is running.
- Id string
The provider-assigned unique ID for this managed resource.
- Time
Created string The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- Time
Updated string The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- Vantage
Point intCount Number of vantage points where monitor is running.
- id String
The provider-assigned unique ID for this managed resource.
- time
Created String The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Updated String The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- vantage
Point IntegerCount Number of vantage points where monitor is running.
- id string
The provider-assigned unique ID for this managed resource.
- time
Created string The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Updated string The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- vantage
Point numberCount 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_ intcount Number of vantage points where monitor is running.
- id String
The provider-assigned unique ID for this managed resource.
- time
Created String The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Updated String The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- vantage
Point NumberCount 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.
- Apm
Domain stringId (Updatable) The APM domain ID the request is intended for.
- Configuration
Config
Configuration Args (Updatable) Details of monitor configuration.
- Dictionary<string, object>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Display
Name string (Updatable) Unique name that can be edited. The name should not contain any confidential information.
- 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"}
- Is
Run boolOnce (Updatable) If runOnce is enabled, then the monitor will run once.
- Monitor
Type string Type of monitor.
- Repeat
Interval intIn Seconds (Updatable) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.
- Script
Id 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.
- Script
Name string Name of the script.
- Script
Parameters List<ConfigScript Parameter Args> (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.
- Time
Created string The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- Time
Updated string The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- Timeout
In intSeconds (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 intCount Number of vantage points where monitor is running.
- Vantage
Points List<string> (Updatable) A list of vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points.
- Apm
Domain stringId (Updatable) The APM domain ID the request is intended for.
- Configuration
Config
Configuration Args (Updatable) Details of monitor configuration.
- map[string]interface{}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Display
Name string (Updatable) Unique name that can be edited. The name should not contain any confidential information.
- 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"}
- Is
Run boolOnce (Updatable) If runOnce is enabled, then the monitor will run once.
- Monitor
Type string Type of monitor.
- Repeat
Interval intIn Seconds (Updatable) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.
- Script
Id 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.
- Script
Name string Name of the script.
- Script
Parameters []ConfigScript Parameter Args (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.
- Time
Created string The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- Time
Updated string The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- Timeout
In intSeconds (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 intCount Number of vantage points where monitor is running.
- Vantage
Points []string (Updatable) A list of vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points.
- apm
Domain StringId (Updatable) The APM domain ID the request is intended for.
- configuration
Config
Configuration Args (Updatable) Details of monitor configuration.
- Map<String,Object>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display
Name String (Updatable) Unique name that can be edited. The name should not contain any confidential information.
- 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"}
- is
Run BooleanOnce (Updatable) If runOnce is enabled, then the monitor will run once.
- monitor
Type String Type of monitor.
- repeat
Interval IntegerIn Seconds (Updatable) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.
- script
Id 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.
- script
Name String Name of the script.
- script
Parameters List<ConfigScript Parameter Args> (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.
- time
Created String The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Updated String The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- timeout
In IntegerSeconds (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 IntegerCount Number of vantage points where monitor is running.
- vantage
Points List<String> (Updatable) A list of vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points.
- apm
Domain stringId (Updatable) The APM domain ID the request is intended for.
- configuration
Config
Configuration Args (Updatable) Details of monitor configuration.
- {[key: string]: any}
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display
Name string (Updatable) Unique name that can be edited. The name should not contain any confidential information.
- {[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"}
- is
Run booleanOnce (Updatable) If runOnce is enabled, then the monitor will run once.
- monitor
Type string Type of monitor.
- repeat
Interval numberIn Seconds (Updatable) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.
- script
Id 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.
- script
Name string Name of the script.
- script
Parameters ConfigScript Parameter Args[] (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.
- time
Created string The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Updated string The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- timeout
In numberSeconds (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 numberCount Number of vantage points where monitor is running.
- vantage
Points string[] (Updatable) A list of vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points.
- apm_
domain_ strid (Updatable) The APM domain ID the request is intended for.
- configuration
Config
Configuration Args (Updatable) Details of monitor configuration.
- 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.
- 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_ boolonce (Updatable) If runOnce is enabled, then the monitor will run once.
- monitor_
type str Type of monitor.
- repeat_
interval_ intin_ seconds (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 ConfigScript Parameter Args] (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_ intseconds (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_ intcount 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.
- apm
Domain StringId (Updatable) The APM domain ID the request is intended for.
- configuration Property Map
(Updatable) Details of monitor configuration.
- Map<Any>
(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display
Name String (Updatable) Unique name that can be edited. The name should not contain any confidential information.
- 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"}
- is
Run BooleanOnce (Updatable) If runOnce is enabled, then the monitor will run once.
- monitor
Type String Type of monitor.
- repeat
Interval NumberIn Seconds (Updatable) Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.
- script
Id 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.
- script
Name String Name of the script.
- script
Parameters 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.
- time
Created String The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Updated String The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- timeout
In NumberSeconds (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 NumberCount Number of vantage points where monitor is running.
- vantage
Points List<String> (Updatable) A list of vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points.
Supporting Types
ConfigConfiguration
- Config
Type string (Updatable) Type of configuration.
- Is
Certificate boolValidation Enabled (Updatable) If certificate validation is enabled, then the call will fail in case of certification errors.
- Is
Failure boolRetried (Updatable) If isFailureRetried is enabled, then a failed call will be retried.
- Is
Redirection boolEnabled (Updatable) If redirection enabled, then redirects will be allowed while accessing target URL.
- Network
Configuration ConfigConfiguration Network Configuration (Updatable) Details of the network configuration.
- Req
Authentication ConfigDetails Configuration Req Authentication Details (Updatable) Details for request HTTP authentication.
- Req
Authentication stringScheme (Updatable) Request http authentication scheme.
- Request
Headers List<ConfigConfiguration Request Header> (Updatable) List of request headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- Request
Method string (Updatable) Request HTTP method.
- Request
Post stringBody (Updatable) Request post body content.
- Request
Query List<ConfigParams Configuration Request Query Param> (Updatable) List of request query params. Example:
[{"paramName": "sortOrder", "paramValue": "asc"}]
- Verify
Response List<string>Codes (Updatable) Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
- Verify
Response stringContent (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 List<ConfigConfiguration Verify Text> (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 string (Updatable) Type of configuration.
- Is
Certificate boolValidation Enabled (Updatable) If certificate validation is enabled, then the call will fail in case of certification errors.
- Is
Failure boolRetried (Updatable) If isFailureRetried is enabled, then a failed call will be retried.
- Is
Redirection boolEnabled (Updatable) If redirection enabled, then redirects will be allowed while accessing target URL.
- Network
Configuration ConfigConfiguration Network Configuration (Updatable) Details of the network configuration.
- Req
Authentication ConfigDetails Configuration Req Authentication Details (Updatable) Details for request HTTP authentication.
- Req
Authentication stringScheme (Updatable) Request http authentication scheme.
- Request
Headers []ConfigConfiguration Request Header (Updatable) List of request headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- Request
Method string (Updatable) Request HTTP method.
- Request
Post stringBody (Updatable) Request post body content.
- Request
Query []ConfigParams Configuration Request Query Param (Updatable) List of request query params. Example:
[{"paramName": "sortOrder", "paramValue": "asc"}]
- Verify
Response []stringCodes (Updatable) Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
- Verify
Response stringContent (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 []ConfigConfiguration Verify Text (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 String (Updatable) Type of configuration.
- is
Certificate BooleanValidation Enabled (Updatable) If certificate validation is enabled, then the call will fail in case of certification errors.
- is
Failure BooleanRetried (Updatable) If isFailureRetried is enabled, then a failed call will be retried.
- is
Redirection BooleanEnabled (Updatable) If redirection enabled, then redirects will be allowed while accessing target URL.
- network
Configuration ConfigConfiguration Network Configuration (Updatable) Details of the network configuration.
- req
Authentication ConfigDetails Configuration Req Authentication Details (Updatable) Details for request HTTP authentication.
- req
Authentication StringScheme (Updatable) Request http authentication scheme.
- request
Headers List<ConfigConfiguration Request Header> (Updatable) List of request headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- request
Method String (Updatable) Request HTTP method.
- request
Post StringBody (Updatable) Request post body content.
- request
Query List<ConfigParams Configuration Request Query Param> (Updatable) List of request query params. Example:
[{"paramName": "sortOrder", "paramValue": "asc"}]
- verify
Response List<String>Codes (Updatable) Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
- verify
Response StringContent (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 List<ConfigConfiguration Verify Text> (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 string (Updatable) Type of configuration.
- is
Certificate booleanValidation Enabled (Updatable) If certificate validation is enabled, then the call will fail in case of certification errors.
- is
Failure booleanRetried (Updatable) If isFailureRetried is enabled, then a failed call will be retried.
- is
Redirection booleanEnabled (Updatable) If redirection enabled, then redirects will be allowed while accessing target URL.
- network
Configuration ConfigConfiguration Network Configuration (Updatable) Details of the network configuration.
- req
Authentication ConfigDetails Configuration Req Authentication Details (Updatable) Details for request HTTP authentication.
- req
Authentication stringScheme (Updatable) Request http authentication scheme.
- request
Headers ConfigConfiguration Request Header[] (Updatable) List of request headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- request
Method string (Updatable) Request HTTP method.
- request
Post stringBody (Updatable) Request post body content.
- request
Query ConfigParams Configuration Request Query Param[] (Updatable) List of request query params. Example:
[{"paramName": "sortOrder", "paramValue": "asc"}]
- verify
Response string[]Codes (Updatable) Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
- verify
Response stringContent (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 ConfigConfiguration Verify Text[] (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_ boolvalidation_ enabled (Updatable) If certificate validation is enabled, then the call will fail in case of certification errors.
- is_
failure_ boolretried (Updatable) If isFailureRetried is enabled, then a failed call will be retried.
- is_
redirection_ boolenabled (Updatable) If redirection enabled, then redirects will be allowed while accessing target URL.
- network_
configuration ConfigConfiguration Network Configuration (Updatable) Details of the network configuration.
- req_
authentication_ Configdetails Configuration Req Authentication Details (Updatable) Details for request HTTP authentication.
- req_
authentication_ strscheme (Updatable) Request http authentication scheme.
- request_
headers ConfigConfiguration Request Header] (Updatable) List of request headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- request_
method str (Updatable) Request HTTP method.
- request_
post_ strbody (Updatable) Request post body content.
- request_
query_ Configparams Configuration Request Query Param] (Updatable) List of request query params. Example:
[{"paramName": "sortOrder", "paramValue": "asc"}]
- verify_
response_ Sequence[str]codes (Updatable) Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
- verify_
response_ strcontent (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 ConfigConfiguration Verify Text] (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 String (Updatable) Type of configuration.
- is
Certificate BooleanValidation Enabled (Updatable) If certificate validation is enabled, then the call will fail in case of certification errors.
- is
Failure BooleanRetried (Updatable) If isFailureRetried is enabled, then a failed call will be retried.
- is
Redirection BooleanEnabled (Updatable) If redirection enabled, then redirects will be allowed while accessing target URL.
- network
Configuration Property Map (Updatable) Details of the network configuration.
- req
Authentication Property MapDetails (Updatable) Details for request HTTP authentication.
- req
Authentication StringScheme (Updatable) Request http authentication scheme.
- request
Headers List<Property Map> (Updatable) List of request headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- request
Method String (Updatable) Request HTTP method.
- request
Post StringBody (Updatable) Request post body content.
- request
Query List<Property Map>Params (Updatable) List of request query params. Example:
[{"paramName": "sortOrder", "paramValue": "asc"}]
- verify
Response List<String>Codes (Updatable) Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
- verify
Response StringContent (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 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
- Number
Of intHops (Updatable) Number of hops.
- Probe
Mode string (Updatable) Type of probe mode when TCP protocol is selected.
- Probe
Per intHop (Updatable) Number of probes per hop.
- Protocol string
(Updatable) Type of protocol.
- Transmission
Rate int (Updatable) Number of probe packets sent out simultaneously.
- Number
Of intHops (Updatable) Number of hops.
- Probe
Mode string (Updatable) Type of probe mode when TCP protocol is selected.
- Probe
Per intHop (Updatable) Number of probes per hop.
- Protocol string
(Updatable) Type of protocol.
- Transmission
Rate int (Updatable) Number of probe packets sent out simultaneously.
- number
Of IntegerHops (Updatable) Number of hops.
- probe
Mode String (Updatable) Type of probe mode when TCP protocol is selected.
- probe
Per IntegerHop (Updatable) Number of probes per hop.
- protocol String
(Updatable) Type of protocol.
- transmission
Rate Integer (Updatable) Number of probe packets sent out simultaneously.
- number
Of numberHops (Updatable) Number of hops.
- probe
Mode string (Updatable) Type of probe mode when TCP protocol is selected.
- probe
Per numberHop (Updatable) Number of probes per hop.
- protocol string
(Updatable) Type of protocol.
- transmission
Rate number (Updatable) Number of probe packets sent out simultaneously.
- number_
of_ inthops (Updatable) Number of hops.
- probe_
mode str (Updatable) Type of probe mode when TCP protocol is selected.
- probe_
per_ inthop (Updatable) Number of probes per hop.
- protocol str
(Updatable) Type of protocol.
- transmission_
rate int (Updatable) Number of probe packets sent out simultaneously.
- number
Of NumberHops (Updatable) Number of hops.
- probe
Mode String (Updatable) Type of probe mode when TCP protocol is selected.
- probe
Per NumberHop (Updatable) Number of probes per hop.
- protocol String
(Updatable) Type of protocol.
- transmission
Rate Number (Updatable) Number of probe packets sent out simultaneously.
ConfigConfigurationReqAuthenticationDetails
- Auth
Headers List<ConfigConfiguration Req Authentication Details Auth Header> (Updatable) List of authentication headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- Auth
Request stringMethod (Updatable) Request method.
- Auth
Request stringPost Body (Updatable) Request post body.
- Auth
Token string (Updatable) Authentication token.
- Auth
Url string (Updatable) URL to get authetication token.
- Auth
User stringName (Updatable) Username for authentication.
- Auth
User stringPassword (Updatable) User password for authentication.
- Oauth
Scheme string (Updatable) Request http oauth scheme.
- Auth
Headers []ConfigConfiguration Req Authentication Details Auth Header (Updatable) List of authentication headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- Auth
Request stringMethod (Updatable) Request method.
- Auth
Request stringPost Body (Updatable) Request post body.
- Auth
Token string (Updatable) Authentication token.
- Auth
Url string (Updatable) URL to get authetication token.
- Auth
User stringName (Updatable) Username for authentication.
- Auth
User stringPassword (Updatable) User password for authentication.
- Oauth
Scheme string (Updatable) Request http oauth scheme.
- auth
Headers List<ConfigConfiguration Req Authentication Details Auth Header> (Updatable) List of authentication headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- auth
Request StringMethod (Updatable) Request method.
- auth
Request StringPost Body (Updatable) Request post body.
- auth
Token String (Updatable) Authentication token.
- auth
Url String (Updatable) URL to get authetication token.
- auth
User StringName (Updatable) Username for authentication.
- auth
User StringPassword (Updatable) User password for authentication.
- oauth
Scheme String (Updatable) Request http oauth scheme.
- auth
Headers ConfigConfiguration Req Authentication Details Auth Header[] (Updatable) List of authentication headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- auth
Request stringMethod (Updatable) Request method.
- auth
Request stringPost Body (Updatable) Request post body.
- auth
Token string (Updatable) Authentication token.
- auth
Url string (Updatable) URL to get authetication token.
- auth
User stringName (Updatable) Username for authentication.
- auth
User stringPassword (Updatable) User password for authentication.
- oauth
Scheme string (Updatable) Request http oauth scheme.
- auth_
headers ConfigConfiguration Req Authentication Details Auth Header] (Updatable) List of authentication headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- auth_
request_ strmethod (Updatable) Request method.
- auth_
request_ strpost_ body (Updatable) Request post body.
- auth_
token str (Updatable) Authentication token.
- auth_
url str (Updatable) URL to get authetication token.
- auth_
user_ strname (Updatable) Username for authentication.
- auth_
user_ strpassword (Updatable) User password for authentication.
- oauth_
scheme str (Updatable) Request http oauth scheme.
- auth
Headers List<Property Map> (Updatable) List of authentication headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- auth
Request StringMethod (Updatable) Request method.
- auth
Request StringPost Body (Updatable) Request post body.
- auth
Token String (Updatable) Authentication token.
- auth
Url String (Updatable) URL to get authetication token.
- auth
User StringName (Updatable) Username for authentication.
- auth
User StringPassword (Updatable) User password for authentication.
- oauth
Scheme String (Updatable) Request http oauth scheme.
ConfigConfigurationReqAuthenticationDetailsAuthHeader
- Header
Name string (Updatable) Name of the header.
- Header
Value string (Updatable) Value of the header.
- Header
Name string (Updatable) Name of the header.
- Header
Value string (Updatable) Value of the header.
- header
Name String (Updatable) Name of the header.
- header
Value String (Updatable) Value of the header.
- header
Name string (Updatable) Name of the header.
- header
Value string (Updatable) Value of the header.
- header_
name str (Updatable) Name of the header.
- header_
value str (Updatable) Value of the header.
- header
Name String (Updatable) Name of the header.
- header
Value String (Updatable) Value of the header.
ConfigConfigurationRequestHeader
- Header
Name string (Updatable) Name of the header.
- Header
Value string (Updatable) Value of the header.
- Header
Name string (Updatable) Name of the header.
- Header
Value string (Updatable) Value of the header.
- header
Name String (Updatable) Name of the header.
- header
Value String (Updatable) Value of the header.
- header
Name string (Updatable) Name of the header.
- header
Value string (Updatable) Value of the header.
- header_
name str (Updatable) Name of the header.
- header_
value str (Updatable) Value of the header.
- header
Name String (Updatable) Name of the header.
- header
Value String (Updatable) Value of the header.
ConfigConfigurationRequestQueryParam
- Param
Name string (Updatable) Name of the parameter.
- Param
Value string (Updatable) Value of the parameter.
- Param
Name string (Updatable) Name of the parameter.
- Param
Value string (Updatable) Value of the parameter.
- param
Name String (Updatable) Name of the parameter.
- param
Value String (Updatable) Value of the parameter.
- param
Name string (Updatable) Name of the parameter.
- param
Value string (Updatable) Value of the parameter.
- param_
name str (Updatable) Name of the parameter.
- param_
value str (Updatable) Value of the parameter.
- param
Name String (Updatable) Name of the parameter.
- param
Value 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
- Param
Name string (Updatable) Name of the parameter.
- Param
Value string (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 List<ConfigParameters Script Parameter Monitor Script Parameter> Details of the script parameter that can be used to overwrite the parameter present in the script.
- Param
Name string (Updatable) Name of the parameter.
- Param
Value string (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 []ConfigParameters Script Parameter Monitor Script Parameter Details of the script parameter that can be used to overwrite the parameter present in the script.
- param
Name String (Updatable) Name of the parameter.
- param
Value String (Updatable) Value of the parameter.
- is
Overwritten Boolean If parameter value is default or overwritten.
- is
Secret Boolean Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
- monitor
Script List<ConfigParameters Script Parameter Monitor Script Parameter> Details of the script parameter that can be used to overwrite the parameter present in the script.
- param
Name string (Updatable) Name of the parameter.
- param
Value string (Updatable) Value of the parameter.
- is
Overwritten boolean If parameter value is default or overwritten.
- is
Secret boolean Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
- monitor
Script ConfigParameters 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 (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_ Configparameters Script Parameter Monitor Script Parameter] Details of the script parameter that can be used to overwrite the parameter present in the script.
- param
Name String (Updatable) Name of the parameter.
- param
Value String (Updatable) Value of the parameter.
- is
Overwritten Boolean If parameter value is default or overwritten.
- is
Secret Boolean Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
- monitor
Script List<Property Map>Parameters Details of the script parameter that can be used to overwrite the parameter present in the script.
ConfigScriptParameterMonitorScriptParameter
- Param
Name string (Updatable) Name of the parameter.
- Param
Value string (Updatable) Value of the parameter.
- Param
Name string (Updatable) Name of the parameter.
- Param
Value string (Updatable) Value of the parameter.
- param
Name String (Updatable) Name of the parameter.
- param
Value String (Updatable) Value of the parameter.
- param
Name string (Updatable) Name of the parameter.
- param
Value string (Updatable) Value of the parameter.
- param_
name str (Updatable) Name of the parameter.
- param_
value str (Updatable) Value of the parameter.
- param
Name String (Updatable) Name of the parameter.
- param
Value 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.