elasticstack.KibanaSyntheticsMonitor
Explore with Pulumi AI
Creates or updates a Kibana synthetics monitor. See API docs
Supported monitor types
http
tcp
icmp
browser
NOTE: Due-to nature of partial update API, reset values to defaults is not supported. In case you would like to reset an optional monitor value, please set it explicitly or delete and create new monitor.
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.KibanaSyntheticsMonitor;
import com.pulumi.elasticstack.KibanaSyntheticsMonitorArgs;
import com.pulumi.elasticstack.inputs.KibanaSyntheticsMonitorAlertArgs;
import com.pulumi.elasticstack.inputs.KibanaSyntheticsMonitorAlertStatusArgs;
import com.pulumi.elasticstack.inputs.KibanaSyntheticsMonitorAlertTlsArgs;
import com.pulumi.elasticstack.inputs.KibanaSyntheticsMonitorHttpArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var myMonitor = new KibanaSyntheticsMonitor("myMonitor", KibanaSyntheticsMonitorArgs.builder()
.alert(KibanaSyntheticsMonitorAlertArgs.builder()
.status(KibanaSyntheticsMonitorAlertStatusArgs.builder()
.enabled(true)
.build())
.tls(KibanaSyntheticsMonitorAlertTlsArgs.builder()
.enabled(false)
.build())
.build())
.enabled(false)
.http(KibanaSyntheticsMonitorHttpArgs.builder()
.ipv4(true)
.ipv6(true)
.max_redirects("10")
.mode("all")
.ssl_supported_protocols("TLSv1.2")
.ssl_verification_mode("full")
.url("http://localhost:8080")
.build())
.locations("us_west")
.schedule(10)
.serviceName("example apm service")
.spaceId("default")
.tags("tag")
.timeout(30)
.build());
}
}
resources:
myMonitor:
type: elasticstack:KibanaSyntheticsMonitor
properties:
alert:
status:
enabled: true
tls:
enabled: false
enabled: false
http:
ipv4: true
ipv6: true
max_redirects: '10'
mode: all
ssl_supported_protocols:
- TLSv1.2
ssl_verification_mode: full
url: http://localhost:8080
locations:
- us_west
schedule: 10
serviceName: example apm service
spaceId: default
tags:
- tag
timeout: 30
Create KibanaSyntheticsMonitor Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new KibanaSyntheticsMonitor(name: string, args?: KibanaSyntheticsMonitorArgs, opts?: CustomResourceOptions);
@overload
def KibanaSyntheticsMonitor(resource_name: str,
args: Optional[KibanaSyntheticsMonitorArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def KibanaSyntheticsMonitor(resource_name: str,
opts: Optional[ResourceOptions] = None,
alert: Optional[KibanaSyntheticsMonitorAlertArgs] = None,
browser: Optional[KibanaSyntheticsMonitorBrowserArgs] = None,
enabled: Optional[bool] = None,
http: Optional[KibanaSyntheticsMonitorHttpArgs] = None,
icmp: Optional[KibanaSyntheticsMonitorIcmpArgs] = None,
locations: Optional[Sequence[str]] = None,
name: Optional[str] = None,
params: Optional[str] = None,
private_locations: Optional[Sequence[str]] = None,
retest_on_failure: Optional[bool] = None,
schedule: Optional[float] = None,
service_name: Optional[str] = None,
space_id: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
tcp: Optional[KibanaSyntheticsMonitorTcpArgs] = None,
timeout: Optional[float] = None)
func NewKibanaSyntheticsMonitor(ctx *Context, name string, args *KibanaSyntheticsMonitorArgs, opts ...ResourceOption) (*KibanaSyntheticsMonitor, error)
public KibanaSyntheticsMonitor(string name, KibanaSyntheticsMonitorArgs? args = null, CustomResourceOptions? opts = null)
public KibanaSyntheticsMonitor(String name, KibanaSyntheticsMonitorArgs args)
public KibanaSyntheticsMonitor(String name, KibanaSyntheticsMonitorArgs args, CustomResourceOptions options)
type: elasticstack:KibanaSyntheticsMonitor
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args KibanaSyntheticsMonitorArgs
- 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 KibanaSyntheticsMonitorArgs
- 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 KibanaSyntheticsMonitorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args KibanaSyntheticsMonitorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args KibanaSyntheticsMonitorArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var kibanaSyntheticsMonitorResource = new Elasticstack.KibanaSyntheticsMonitor("kibanaSyntheticsMonitorResource", new()
{
Alert = new Elasticstack.Inputs.KibanaSyntheticsMonitorAlertArgs
{
Status = new Elasticstack.Inputs.KibanaSyntheticsMonitorAlertStatusArgs
{
Enabled = false,
},
Tls = new Elasticstack.Inputs.KibanaSyntheticsMonitorAlertTlsArgs
{
Enabled = false,
},
},
Browser = new Elasticstack.Inputs.KibanaSyntheticsMonitorBrowserArgs
{
InlineScript = "string",
IgnoreHttpsErrors = false,
PlaywrightOptions = "string",
Screenshots = "string",
SyntheticsArgs = new[]
{
"string",
},
},
Enabled = false,
Http = new Elasticstack.Inputs.KibanaSyntheticsMonitorHttpArgs
{
Url = "string",
Response = "string",
SslCertificateAuthorities = new[]
{
"string",
},
MaxRedirects = 0,
Mode = "string",
Password = "string",
ProxyHeader = "string",
Ipv6 = false,
ProxyUrl = "string",
SslCertificate = "string",
Check = "string",
SslKey = "string",
SslKeyPassphrase = "string",
SslSupportedProtocols = new[]
{
"string",
},
SslVerificationMode = "string",
Ipv4 = false,
Username = "string",
},
Icmp = new Elasticstack.Inputs.KibanaSyntheticsMonitorIcmpArgs
{
Host = "string",
Wait = 0,
},
Locations = new[]
{
"string",
},
Name = "string",
Params = "string",
PrivateLocations = new[]
{
"string",
},
RetestOnFailure = false,
Schedule = 0,
ServiceName = "string",
SpaceId = "string",
Tags = new[]
{
"string",
},
Tcp = new Elasticstack.Inputs.KibanaSyntheticsMonitorTcpArgs
{
Host = "string",
CheckReceive = "string",
CheckSend = "string",
ProxyUrl = "string",
ProxyUseLocalResolver = false,
SslCertificate = "string",
SslCertificateAuthorities = new[]
{
"string",
},
SslKey = "string",
SslKeyPassphrase = "string",
SslSupportedProtocols = new[]
{
"string",
},
SslVerificationMode = "string",
},
Timeout = 0,
});
example, err := elasticstack.NewKibanaSyntheticsMonitor(ctx, "kibanaSyntheticsMonitorResource", &elasticstack.KibanaSyntheticsMonitorArgs{
Alert: &elasticstack.KibanaSyntheticsMonitorAlertArgs{
Status: &elasticstack.KibanaSyntheticsMonitorAlertStatusArgs{
Enabled: pulumi.Bool(false),
},
Tls: &elasticstack.KibanaSyntheticsMonitorAlertTlsArgs{
Enabled: pulumi.Bool(false),
},
},
Browser: &elasticstack.KibanaSyntheticsMonitorBrowserArgs{
InlineScript: pulumi.String("string"),
IgnoreHttpsErrors: pulumi.Bool(false),
PlaywrightOptions: pulumi.String("string"),
Screenshots: pulumi.String("string"),
SyntheticsArgs: pulumi.StringArray{
pulumi.String("string"),
},
},
Enabled: pulumi.Bool(false),
Http: &elasticstack.KibanaSyntheticsMonitorHttpArgs{
Url: pulumi.String("string"),
Response: pulumi.String("string"),
SslCertificateAuthorities: pulumi.StringArray{
pulumi.String("string"),
},
MaxRedirects: pulumi.Float64(0),
Mode: pulumi.String("string"),
Password: pulumi.String("string"),
ProxyHeader: pulumi.String("string"),
Ipv6: pulumi.Bool(false),
ProxyUrl: pulumi.String("string"),
SslCertificate: pulumi.String("string"),
Check: pulumi.String("string"),
SslKey: pulumi.String("string"),
SslKeyPassphrase: pulumi.String("string"),
SslSupportedProtocols: pulumi.StringArray{
pulumi.String("string"),
},
SslVerificationMode: pulumi.String("string"),
Ipv4: pulumi.Bool(false),
Username: pulumi.String("string"),
},
Icmp: &elasticstack.KibanaSyntheticsMonitorIcmpArgs{
Host: pulumi.String("string"),
Wait: pulumi.Float64(0),
},
Locations: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
Params: pulumi.String("string"),
PrivateLocations: pulumi.StringArray{
pulumi.String("string"),
},
RetestOnFailure: pulumi.Bool(false),
Schedule: pulumi.Float64(0),
ServiceName: pulumi.String("string"),
SpaceId: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Tcp: &elasticstack.KibanaSyntheticsMonitorTcpArgs{
Host: pulumi.String("string"),
CheckReceive: pulumi.String("string"),
CheckSend: pulumi.String("string"),
ProxyUrl: pulumi.String("string"),
ProxyUseLocalResolver: pulumi.Bool(false),
SslCertificate: pulumi.String("string"),
SslCertificateAuthorities: pulumi.StringArray{
pulumi.String("string"),
},
SslKey: pulumi.String("string"),
SslKeyPassphrase: pulumi.String("string"),
SslSupportedProtocols: pulumi.StringArray{
pulumi.String("string"),
},
SslVerificationMode: pulumi.String("string"),
},
Timeout: pulumi.Float64(0),
})
var kibanaSyntheticsMonitorResource = new KibanaSyntheticsMonitor("kibanaSyntheticsMonitorResource", KibanaSyntheticsMonitorArgs.builder()
.alert(KibanaSyntheticsMonitorAlertArgs.builder()
.status(KibanaSyntheticsMonitorAlertStatusArgs.builder()
.enabled(false)
.build())
.tls(KibanaSyntheticsMonitorAlertTlsArgs.builder()
.enabled(false)
.build())
.build())
.browser(KibanaSyntheticsMonitorBrowserArgs.builder()
.inlineScript("string")
.ignoreHttpsErrors(false)
.playwrightOptions("string")
.screenshots("string")
.syntheticsArgs("string")
.build())
.enabled(false)
.http(KibanaSyntheticsMonitorHttpArgs.builder()
.url("string")
.response("string")
.sslCertificateAuthorities("string")
.maxRedirects(0)
.mode("string")
.password("string")
.proxyHeader("string")
.ipv6(false)
.proxyUrl("string")
.sslCertificate("string")
.check("string")
.sslKey("string")
.sslKeyPassphrase("string")
.sslSupportedProtocols("string")
.sslVerificationMode("string")
.ipv4(false)
.username("string")
.build())
.icmp(KibanaSyntheticsMonitorIcmpArgs.builder()
.host("string")
.wait(0)
.build())
.locations("string")
.name("string")
.params("string")
.privateLocations("string")
.retestOnFailure(false)
.schedule(0)
.serviceName("string")
.spaceId("string")
.tags("string")
.tcp(KibanaSyntheticsMonitorTcpArgs.builder()
.host("string")
.checkReceive("string")
.checkSend("string")
.proxyUrl("string")
.proxyUseLocalResolver(false)
.sslCertificate("string")
.sslCertificateAuthorities("string")
.sslKey("string")
.sslKeyPassphrase("string")
.sslSupportedProtocols("string")
.sslVerificationMode("string")
.build())
.timeout(0)
.build());
kibana_synthetics_monitor_resource = elasticstack.KibanaSyntheticsMonitor("kibanaSyntheticsMonitorResource",
alert={
"status": {
"enabled": False,
},
"tls": {
"enabled": False,
},
},
browser={
"inline_script": "string",
"ignore_https_errors": False,
"playwright_options": "string",
"screenshots": "string",
"synthetics_args": ["string"],
},
enabled=False,
http={
"url": "string",
"response": "string",
"ssl_certificate_authorities": ["string"],
"max_redirects": 0,
"mode": "string",
"password": "string",
"proxy_header": "string",
"ipv6": False,
"proxy_url": "string",
"ssl_certificate": "string",
"check": "string",
"ssl_key": "string",
"ssl_key_passphrase": "string",
"ssl_supported_protocols": ["string"],
"ssl_verification_mode": "string",
"ipv4": False,
"username": "string",
},
icmp={
"host": "string",
"wait": 0,
},
locations=["string"],
name="string",
params="string",
private_locations=["string"],
retest_on_failure=False,
schedule=0,
service_name="string",
space_id="string",
tags=["string"],
tcp={
"host": "string",
"check_receive": "string",
"check_send": "string",
"proxy_url": "string",
"proxy_use_local_resolver": False,
"ssl_certificate": "string",
"ssl_certificate_authorities": ["string"],
"ssl_key": "string",
"ssl_key_passphrase": "string",
"ssl_supported_protocols": ["string"],
"ssl_verification_mode": "string",
},
timeout=0)
const kibanaSyntheticsMonitorResource = new elasticstack.KibanaSyntheticsMonitor("kibanaSyntheticsMonitorResource", {
alert: {
status: {
enabled: false,
},
tls: {
enabled: false,
},
},
browser: {
inlineScript: "string",
ignoreHttpsErrors: false,
playwrightOptions: "string",
screenshots: "string",
syntheticsArgs: ["string"],
},
enabled: false,
http: {
url: "string",
response: "string",
sslCertificateAuthorities: ["string"],
maxRedirects: 0,
mode: "string",
password: "string",
proxyHeader: "string",
ipv6: false,
proxyUrl: "string",
sslCertificate: "string",
check: "string",
sslKey: "string",
sslKeyPassphrase: "string",
sslSupportedProtocols: ["string"],
sslVerificationMode: "string",
ipv4: false,
username: "string",
},
icmp: {
host: "string",
wait: 0,
},
locations: ["string"],
name: "string",
params: "string",
privateLocations: ["string"],
retestOnFailure: false,
schedule: 0,
serviceName: "string",
spaceId: "string",
tags: ["string"],
tcp: {
host: "string",
checkReceive: "string",
checkSend: "string",
proxyUrl: "string",
proxyUseLocalResolver: false,
sslCertificate: "string",
sslCertificateAuthorities: ["string"],
sslKey: "string",
sslKeyPassphrase: "string",
sslSupportedProtocols: ["string"],
sslVerificationMode: "string",
},
timeout: 0,
});
type: elasticstack:KibanaSyntheticsMonitor
properties:
alert:
status:
enabled: false
tls:
enabled: false
browser:
ignoreHttpsErrors: false
inlineScript: string
playwrightOptions: string
screenshots: string
syntheticsArgs:
- string
enabled: false
http:
check: string
ipv4: false
ipv6: false
maxRedirects: 0
mode: string
password: string
proxyHeader: string
proxyUrl: string
response: string
sslCertificate: string
sslCertificateAuthorities:
- string
sslKey: string
sslKeyPassphrase: string
sslSupportedProtocols:
- string
sslVerificationMode: string
url: string
username: string
icmp:
host: string
wait: 0
locations:
- string
name: string
params: string
privateLocations:
- string
retestOnFailure: false
schedule: 0
serviceName: string
spaceId: string
tags:
- string
tcp:
checkReceive: string
checkSend: string
host: string
proxyUrl: string
proxyUseLocalResolver: false
sslCertificate: string
sslCertificateAuthorities:
- string
sslKey: string
sslKeyPassphrase: string
sslSupportedProtocols:
- string
sslVerificationMode: string
timeout: 0
KibanaSyntheticsMonitor Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The KibanaSyntheticsMonitor resource accepts the following input properties:
- Alert
Kibana
Synthetics Monitor Alert - Alert configuration. Default:
{ status: { enabled: true }, tls: { enabled: true } }
. - Browser
Kibana
Synthetics Monitor Browser - Browser Monitor specific fields
- Enabled bool
- Whether the monitor is enabled. Default:
true
- Http
Kibana
Synthetics Monitor Http - HTTP Monitor specific fields
- Icmp
Kibana
Synthetics Monitor Icmp - ICMP Monitor specific fields
- Locations List<string>
- Where to deploy the monitor. Monitors can be deployed in multiple locations so that you can detect differences in availability and response times across those locations.
- Name string
- The monitor’s name.
- Params string
- Monitor parameters. Raw JSON object, use
jsonencode
function to represent JSON - Private
Locations List<string> - These Private Locations refer to locations hosted and managed by you, whereas locations are hosted by Elastic. You can specify a Private Location using the location’s name.
- Retest
On boolFailure - Enable or disable retesting when a monitor fails. By default, monitors are automatically retested if the monitor goes from "up" to "down". If the result of the retest is also "down", an error will be created, and if configured, an alert sent. Then the monitor will resume running according to the defined schedule. Using retestonfailure can reduce noise related to transient problems. Default:
true
. - Schedule double
- The monitor’s schedule in minutes. Supported values are 1, 3, 5, 10, 15, 30, 60, 120 and 240.
- Service
Name string - The APM service name.
- Space
Id string - The namespace field should be lowercase and not contain spaces. The namespace must not include any of the following characters: *, , /, ?, ", <, >, |, whitespace, ,, #, :, or -. Default:
default
- List<string>
- An array of tags.
- Tcp
Kibana
Synthetics Monitor Tcp - TCP Monitor specific fields
- Timeout double
- The monitor timeout in seconds, monitor will fail if it doesn’t complete within this time. Default:
16
- Alert
Kibana
Synthetics Monitor Alert Args - Alert configuration. Default:
{ status: { enabled: true }, tls: { enabled: true } }
. - Browser
Kibana
Synthetics Monitor Browser Args - Browser Monitor specific fields
- Enabled bool
- Whether the monitor is enabled. Default:
true
- Http
Kibana
Synthetics Monitor Http Args - HTTP Monitor specific fields
- Icmp
Kibana
Synthetics Monitor Icmp Args - ICMP Monitor specific fields
- Locations []string
- Where to deploy the monitor. Monitors can be deployed in multiple locations so that you can detect differences in availability and response times across those locations.
- Name string
- The monitor’s name.
- Params string
- Monitor parameters. Raw JSON object, use
jsonencode
function to represent JSON - Private
Locations []string - These Private Locations refer to locations hosted and managed by you, whereas locations are hosted by Elastic. You can specify a Private Location using the location’s name.
- Retest
On boolFailure - Enable or disable retesting when a monitor fails. By default, monitors are automatically retested if the monitor goes from "up" to "down". If the result of the retest is also "down", an error will be created, and if configured, an alert sent. Then the monitor will resume running according to the defined schedule. Using retestonfailure can reduce noise related to transient problems. Default:
true
. - Schedule float64
- The monitor’s schedule in minutes. Supported values are 1, 3, 5, 10, 15, 30, 60, 120 and 240.
- Service
Name string - The APM service name.
- Space
Id string - The namespace field should be lowercase and not contain spaces. The namespace must not include any of the following characters: *, , /, ?, ", <, >, |, whitespace, ,, #, :, or -. Default:
default
- []string
- An array of tags.
- Tcp
Kibana
Synthetics Monitor Tcp Args - TCP Monitor specific fields
- Timeout float64
- The monitor timeout in seconds, monitor will fail if it doesn’t complete within this time. Default:
16
- alert
Kibana
Synthetics Monitor Alert - Alert configuration. Default:
{ status: { enabled: true }, tls: { enabled: true } }
. - browser
Kibana
Synthetics Monitor Browser - Browser Monitor specific fields
- enabled Boolean
- Whether the monitor is enabled. Default:
true
- http
Kibana
Synthetics Monitor Http - HTTP Monitor specific fields
- icmp
Kibana
Synthetics Monitor Icmp - ICMP Monitor specific fields
- locations List<String>
- Where to deploy the monitor. Monitors can be deployed in multiple locations so that you can detect differences in availability and response times across those locations.
- name String
- The monitor’s name.
- params String
- Monitor parameters. Raw JSON object, use
jsonencode
function to represent JSON - private
Locations List<String> - These Private Locations refer to locations hosted and managed by you, whereas locations are hosted by Elastic. You can specify a Private Location using the location’s name.
- retest
On BooleanFailure - Enable or disable retesting when a monitor fails. By default, monitors are automatically retested if the monitor goes from "up" to "down". If the result of the retest is also "down", an error will be created, and if configured, an alert sent. Then the monitor will resume running according to the defined schedule. Using retestonfailure can reduce noise related to transient problems. Default:
true
. - schedule Double
- The monitor’s schedule in minutes. Supported values are 1, 3, 5, 10, 15, 30, 60, 120 and 240.
- service
Name String - The APM service name.
- space
Id String - The namespace field should be lowercase and not contain spaces. The namespace must not include any of the following characters: *, , /, ?, ", <, >, |, whitespace, ,, #, :, or -. Default:
default
- List<String>
- An array of tags.
- tcp
Kibana
Synthetics Monitor Tcp - TCP Monitor specific fields
- timeout Double
- The monitor timeout in seconds, monitor will fail if it doesn’t complete within this time. Default:
16
- alert
Kibana
Synthetics Monitor Alert - Alert configuration. Default:
{ status: { enabled: true }, tls: { enabled: true } }
. - browser
Kibana
Synthetics Monitor Browser - Browser Monitor specific fields
- enabled boolean
- Whether the monitor is enabled. Default:
true
- http
Kibana
Synthetics Monitor Http - HTTP Monitor specific fields
- icmp
Kibana
Synthetics Monitor Icmp - ICMP Monitor specific fields
- locations string[]
- Where to deploy the monitor. Monitors can be deployed in multiple locations so that you can detect differences in availability and response times across those locations.
- name string
- The monitor’s name.
- params string
- Monitor parameters. Raw JSON object, use
jsonencode
function to represent JSON - private
Locations string[] - These Private Locations refer to locations hosted and managed by you, whereas locations are hosted by Elastic. You can specify a Private Location using the location’s name.
- retest
On booleanFailure - Enable or disable retesting when a monitor fails. By default, monitors are automatically retested if the monitor goes from "up" to "down". If the result of the retest is also "down", an error will be created, and if configured, an alert sent. Then the monitor will resume running according to the defined schedule. Using retestonfailure can reduce noise related to transient problems. Default:
true
. - schedule number
- The monitor’s schedule in minutes. Supported values are 1, 3, 5, 10, 15, 30, 60, 120 and 240.
- service
Name string - The APM service name.
- space
Id string - The namespace field should be lowercase and not contain spaces. The namespace must not include any of the following characters: *, , /, ?, ", <, >, |, whitespace, ,, #, :, or -. Default:
default
- string[]
- An array of tags.
- tcp
Kibana
Synthetics Monitor Tcp - TCP Monitor specific fields
- timeout number
- The monitor timeout in seconds, monitor will fail if it doesn’t complete within this time. Default:
16
- alert
Kibana
Synthetics Monitor Alert Args - Alert configuration. Default:
{ status: { enabled: true }, tls: { enabled: true } }
. - browser
Kibana
Synthetics Monitor Browser Args - Browser Monitor specific fields
- enabled bool
- Whether the monitor is enabled. Default:
true
- http
Kibana
Synthetics Monitor Http Args - HTTP Monitor specific fields
- icmp
Kibana
Synthetics Monitor Icmp Args - ICMP Monitor specific fields
- locations Sequence[str]
- Where to deploy the monitor. Monitors can be deployed in multiple locations so that you can detect differences in availability and response times across those locations.
- name str
- The monitor’s name.
- params str
- Monitor parameters. Raw JSON object, use
jsonencode
function to represent JSON - private_
locations Sequence[str] - These Private Locations refer to locations hosted and managed by you, whereas locations are hosted by Elastic. You can specify a Private Location using the location’s name.
- retest_
on_ boolfailure - Enable or disable retesting when a monitor fails. By default, monitors are automatically retested if the monitor goes from "up" to "down". If the result of the retest is also "down", an error will be created, and if configured, an alert sent. Then the monitor will resume running according to the defined schedule. Using retestonfailure can reduce noise related to transient problems. Default:
true
. - schedule float
- The monitor’s schedule in minutes. Supported values are 1, 3, 5, 10, 15, 30, 60, 120 and 240.
- service_
name str - The APM service name.
- space_
id str - The namespace field should be lowercase and not contain spaces. The namespace must not include any of the following characters: *, , /, ?, ", <, >, |, whitespace, ,, #, :, or -. Default:
default
- Sequence[str]
- An array of tags.
- tcp
Kibana
Synthetics Monitor Tcp Args - TCP Monitor specific fields
- timeout float
- The monitor timeout in seconds, monitor will fail if it doesn’t complete within this time. Default:
16
- alert Property Map
- Alert configuration. Default:
{ status: { enabled: true }, tls: { enabled: true } }
. - browser Property Map
- Browser Monitor specific fields
- enabled Boolean
- Whether the monitor is enabled. Default:
true
- http Property Map
- HTTP Monitor specific fields
- icmp Property Map
- ICMP Monitor specific fields
- locations List<String>
- Where to deploy the monitor. Monitors can be deployed in multiple locations so that you can detect differences in availability and response times across those locations.
- name String
- The monitor’s name.
- params String
- Monitor parameters. Raw JSON object, use
jsonencode
function to represent JSON - private
Locations List<String> - These Private Locations refer to locations hosted and managed by you, whereas locations are hosted by Elastic. You can specify a Private Location using the location’s name.
- retest
On BooleanFailure - Enable or disable retesting when a monitor fails. By default, monitors are automatically retested if the monitor goes from "up" to "down". If the result of the retest is also "down", an error will be created, and if configured, an alert sent. Then the monitor will resume running according to the defined schedule. Using retestonfailure can reduce noise related to transient problems. Default:
true
. - schedule Number
- The monitor’s schedule in minutes. Supported values are 1, 3, 5, 10, 15, 30, 60, 120 and 240.
- service
Name String - The APM service name.
- space
Id String - The namespace field should be lowercase and not contain spaces. The namespace must not include any of the following characters: *, , /, ?, ", <, >, |, whitespace, ,, #, :, or -. Default:
default
- List<String>
- An array of tags.
- tcp Property Map
- TCP Monitor specific fields
- timeout Number
- The monitor timeout in seconds, monitor will fail if it doesn’t complete within this time. Default:
16
Outputs
All input properties are implicitly available as output properties. Additionally, the KibanaSyntheticsMonitor resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing KibanaSyntheticsMonitor Resource
Get an existing KibanaSyntheticsMonitor 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?: KibanaSyntheticsMonitorState, opts?: CustomResourceOptions): KibanaSyntheticsMonitor
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
alert: Optional[KibanaSyntheticsMonitorAlertArgs] = None,
browser: Optional[KibanaSyntheticsMonitorBrowserArgs] = None,
enabled: Optional[bool] = None,
http: Optional[KibanaSyntheticsMonitorHttpArgs] = None,
icmp: Optional[KibanaSyntheticsMonitorIcmpArgs] = None,
locations: Optional[Sequence[str]] = None,
name: Optional[str] = None,
params: Optional[str] = None,
private_locations: Optional[Sequence[str]] = None,
retest_on_failure: Optional[bool] = None,
schedule: Optional[float] = None,
service_name: Optional[str] = None,
space_id: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
tcp: Optional[KibanaSyntheticsMonitorTcpArgs] = None,
timeout: Optional[float] = None) -> KibanaSyntheticsMonitor
func GetKibanaSyntheticsMonitor(ctx *Context, name string, id IDInput, state *KibanaSyntheticsMonitorState, opts ...ResourceOption) (*KibanaSyntheticsMonitor, error)
public static KibanaSyntheticsMonitor Get(string name, Input<string> id, KibanaSyntheticsMonitorState? state, CustomResourceOptions? opts = null)
public static KibanaSyntheticsMonitor get(String name, Output<String> id, KibanaSyntheticsMonitorState state, CustomResourceOptions options)
resources: _: type: elasticstack:KibanaSyntheticsMonitor get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Alert
Kibana
Synthetics Monitor Alert - Alert configuration. Default:
{ status: { enabled: true }, tls: { enabled: true } }
. - Browser
Kibana
Synthetics Monitor Browser - Browser Monitor specific fields
- Enabled bool
- Whether the monitor is enabled. Default:
true
- Http
Kibana
Synthetics Monitor Http - HTTP Monitor specific fields
- Icmp
Kibana
Synthetics Monitor Icmp - ICMP Monitor specific fields
- Locations List<string>
- Where to deploy the monitor. Monitors can be deployed in multiple locations so that you can detect differences in availability and response times across those locations.
- Name string
- The monitor’s name.
- Params string
- Monitor parameters. Raw JSON object, use
jsonencode
function to represent JSON - Private
Locations List<string> - These Private Locations refer to locations hosted and managed by you, whereas locations are hosted by Elastic. You can specify a Private Location using the location’s name.
- Retest
On boolFailure - Enable or disable retesting when a monitor fails. By default, monitors are automatically retested if the monitor goes from "up" to "down". If the result of the retest is also "down", an error will be created, and if configured, an alert sent. Then the monitor will resume running according to the defined schedule. Using retestonfailure can reduce noise related to transient problems. Default:
true
. - Schedule double
- The monitor’s schedule in minutes. Supported values are 1, 3, 5, 10, 15, 30, 60, 120 and 240.
- Service
Name string - The APM service name.
- Space
Id string - The namespace field should be lowercase and not contain spaces. The namespace must not include any of the following characters: *, , /, ?, ", <, >, |, whitespace, ,, #, :, or -. Default:
default
- List<string>
- An array of tags.
- Tcp
Kibana
Synthetics Monitor Tcp - TCP Monitor specific fields
- Timeout double
- The monitor timeout in seconds, monitor will fail if it doesn’t complete within this time. Default:
16
- Alert
Kibana
Synthetics Monitor Alert Args - Alert configuration. Default:
{ status: { enabled: true }, tls: { enabled: true } }
. - Browser
Kibana
Synthetics Monitor Browser Args - Browser Monitor specific fields
- Enabled bool
- Whether the monitor is enabled. Default:
true
- Http
Kibana
Synthetics Monitor Http Args - HTTP Monitor specific fields
- Icmp
Kibana
Synthetics Monitor Icmp Args - ICMP Monitor specific fields
- Locations []string
- Where to deploy the monitor. Monitors can be deployed in multiple locations so that you can detect differences in availability and response times across those locations.
- Name string
- The monitor’s name.
- Params string
- Monitor parameters. Raw JSON object, use
jsonencode
function to represent JSON - Private
Locations []string - These Private Locations refer to locations hosted and managed by you, whereas locations are hosted by Elastic. You can specify a Private Location using the location’s name.
- Retest
On boolFailure - Enable or disable retesting when a monitor fails. By default, monitors are automatically retested if the monitor goes from "up" to "down". If the result of the retest is also "down", an error will be created, and if configured, an alert sent. Then the monitor will resume running according to the defined schedule. Using retestonfailure can reduce noise related to transient problems. Default:
true
. - Schedule float64
- The monitor’s schedule in minutes. Supported values are 1, 3, 5, 10, 15, 30, 60, 120 and 240.
- Service
Name string - The APM service name.
- Space
Id string - The namespace field should be lowercase and not contain spaces. The namespace must not include any of the following characters: *, , /, ?, ", <, >, |, whitespace, ,, #, :, or -. Default:
default
- []string
- An array of tags.
- Tcp
Kibana
Synthetics Monitor Tcp Args - TCP Monitor specific fields
- Timeout float64
- The monitor timeout in seconds, monitor will fail if it doesn’t complete within this time. Default:
16
- alert
Kibana
Synthetics Monitor Alert - Alert configuration. Default:
{ status: { enabled: true }, tls: { enabled: true } }
. - browser
Kibana
Synthetics Monitor Browser - Browser Monitor specific fields
- enabled Boolean
- Whether the monitor is enabled. Default:
true
- http
Kibana
Synthetics Monitor Http - HTTP Monitor specific fields
- icmp
Kibana
Synthetics Monitor Icmp - ICMP Monitor specific fields
- locations List<String>
- Where to deploy the monitor. Monitors can be deployed in multiple locations so that you can detect differences in availability and response times across those locations.
- name String
- The monitor’s name.
- params String
- Monitor parameters. Raw JSON object, use
jsonencode
function to represent JSON - private
Locations List<String> - These Private Locations refer to locations hosted and managed by you, whereas locations are hosted by Elastic. You can specify a Private Location using the location’s name.
- retest
On BooleanFailure - Enable or disable retesting when a monitor fails. By default, monitors are automatically retested if the monitor goes from "up" to "down". If the result of the retest is also "down", an error will be created, and if configured, an alert sent. Then the monitor will resume running according to the defined schedule. Using retestonfailure can reduce noise related to transient problems. Default:
true
. - schedule Double
- The monitor’s schedule in minutes. Supported values are 1, 3, 5, 10, 15, 30, 60, 120 and 240.
- service
Name String - The APM service name.
- space
Id String - The namespace field should be lowercase and not contain spaces. The namespace must not include any of the following characters: *, , /, ?, ", <, >, |, whitespace, ,, #, :, or -. Default:
default
- List<String>
- An array of tags.
- tcp
Kibana
Synthetics Monitor Tcp - TCP Monitor specific fields
- timeout Double
- The monitor timeout in seconds, monitor will fail if it doesn’t complete within this time. Default:
16
- alert
Kibana
Synthetics Monitor Alert - Alert configuration. Default:
{ status: { enabled: true }, tls: { enabled: true } }
. - browser
Kibana
Synthetics Monitor Browser - Browser Monitor specific fields
- enabled boolean
- Whether the monitor is enabled. Default:
true
- http
Kibana
Synthetics Monitor Http - HTTP Monitor specific fields
- icmp
Kibana
Synthetics Monitor Icmp - ICMP Monitor specific fields
- locations string[]
- Where to deploy the monitor. Monitors can be deployed in multiple locations so that you can detect differences in availability and response times across those locations.
- name string
- The monitor’s name.
- params string
- Monitor parameters. Raw JSON object, use
jsonencode
function to represent JSON - private
Locations string[] - These Private Locations refer to locations hosted and managed by you, whereas locations are hosted by Elastic. You can specify a Private Location using the location’s name.
- retest
On booleanFailure - Enable or disable retesting when a monitor fails. By default, monitors are automatically retested if the monitor goes from "up" to "down". If the result of the retest is also "down", an error will be created, and if configured, an alert sent. Then the monitor will resume running according to the defined schedule. Using retestonfailure can reduce noise related to transient problems. Default:
true
. - schedule number
- The monitor’s schedule in minutes. Supported values are 1, 3, 5, 10, 15, 30, 60, 120 and 240.
- service
Name string - The APM service name.
- space
Id string - The namespace field should be lowercase and not contain spaces. The namespace must not include any of the following characters: *, , /, ?, ", <, >, |, whitespace, ,, #, :, or -. Default:
default
- string[]
- An array of tags.
- tcp
Kibana
Synthetics Monitor Tcp - TCP Monitor specific fields
- timeout number
- The monitor timeout in seconds, monitor will fail if it doesn’t complete within this time. Default:
16
- alert
Kibana
Synthetics Monitor Alert Args - Alert configuration. Default:
{ status: { enabled: true }, tls: { enabled: true } }
. - browser
Kibana
Synthetics Monitor Browser Args - Browser Monitor specific fields
- enabled bool
- Whether the monitor is enabled. Default:
true
- http
Kibana
Synthetics Monitor Http Args - HTTP Monitor specific fields
- icmp
Kibana
Synthetics Monitor Icmp Args - ICMP Monitor specific fields
- locations Sequence[str]
- Where to deploy the monitor. Monitors can be deployed in multiple locations so that you can detect differences in availability and response times across those locations.
- name str
- The monitor’s name.
- params str
- Monitor parameters. Raw JSON object, use
jsonencode
function to represent JSON - private_
locations Sequence[str] - These Private Locations refer to locations hosted and managed by you, whereas locations are hosted by Elastic. You can specify a Private Location using the location’s name.
- retest_
on_ boolfailure - Enable or disable retesting when a monitor fails. By default, monitors are automatically retested if the monitor goes from "up" to "down". If the result of the retest is also "down", an error will be created, and if configured, an alert sent. Then the monitor will resume running according to the defined schedule. Using retestonfailure can reduce noise related to transient problems. Default:
true
. - schedule float
- The monitor’s schedule in minutes. Supported values are 1, 3, 5, 10, 15, 30, 60, 120 and 240.
- service_
name str - The APM service name.
- space_
id str - The namespace field should be lowercase and not contain spaces. The namespace must not include any of the following characters: *, , /, ?, ", <, >, |, whitespace, ,, #, :, or -. Default:
default
- Sequence[str]
- An array of tags.
- tcp
Kibana
Synthetics Monitor Tcp Args - TCP Monitor specific fields
- timeout float
- The monitor timeout in seconds, monitor will fail if it doesn’t complete within this time. Default:
16
- alert Property Map
- Alert configuration. Default:
{ status: { enabled: true }, tls: { enabled: true } }
. - browser Property Map
- Browser Monitor specific fields
- enabled Boolean
- Whether the monitor is enabled. Default:
true
- http Property Map
- HTTP Monitor specific fields
- icmp Property Map
- ICMP Monitor specific fields
- locations List<String>
- Where to deploy the monitor. Monitors can be deployed in multiple locations so that you can detect differences in availability and response times across those locations.
- name String
- The monitor’s name.
- params String
- Monitor parameters. Raw JSON object, use
jsonencode
function to represent JSON - private
Locations List<String> - These Private Locations refer to locations hosted and managed by you, whereas locations are hosted by Elastic. You can specify a Private Location using the location’s name.
- retest
On BooleanFailure - Enable or disable retesting when a monitor fails. By default, monitors are automatically retested if the monitor goes from "up" to "down". If the result of the retest is also "down", an error will be created, and if configured, an alert sent. Then the monitor will resume running according to the defined schedule. Using retestonfailure can reduce noise related to transient problems. Default:
true
. - schedule Number
- The monitor’s schedule in minutes. Supported values are 1, 3, 5, 10, 15, 30, 60, 120 and 240.
- service
Name String - The APM service name.
- space
Id String - The namespace field should be lowercase and not contain spaces. The namespace must not include any of the following characters: *, , /, ?, ", <, >, |, whitespace, ,, #, :, or -. Default:
default
- List<String>
- An array of tags.
- tcp Property Map
- TCP Monitor specific fields
- timeout Number
- The monitor timeout in seconds, monitor will fail if it doesn’t complete within this time. Default:
16
Supporting Types
KibanaSyntheticsMonitorAlert, KibanaSyntheticsMonitorAlertArgs
KibanaSyntheticsMonitorAlertStatus, KibanaSyntheticsMonitorAlertStatusArgs
- Enabled bool
- Enabled bool
- enabled Boolean
- enabled boolean
- enabled bool
- enabled Boolean
KibanaSyntheticsMonitorAlertTls, KibanaSyntheticsMonitorAlertTlsArgs
- Enabled bool
- Enabled bool
- enabled Boolean
- enabled boolean
- enabled bool
- enabled Boolean
KibanaSyntheticsMonitorBrowser, KibanaSyntheticsMonitorBrowserArgs
- Inline
Script string - The inline script.
- Ignore
Https boolErrors - Whether to ignore HTTPS errors.
- Playwright
Options string - Playwright options.. Raw JSON object, use
jsonencode
function to represent JSON - Screenshots string
- Controls the behavior of the screenshots feature.
- Synthetics
Args List<string> - Synthetics agent CLI arguments.
- Inline
Script string - The inline script.
- Ignore
Https boolErrors - Whether to ignore HTTPS errors.
- Playwright
Options string - Playwright options.. Raw JSON object, use
jsonencode
function to represent JSON - Screenshots string
- Controls the behavior of the screenshots feature.
- Synthetics
Args []string - Synthetics agent CLI arguments.
- inline
Script String - The inline script.
- ignore
Https BooleanErrors - Whether to ignore HTTPS errors.
- playwright
Options String - Playwright options.. Raw JSON object, use
jsonencode
function to represent JSON - screenshots String
- Controls the behavior of the screenshots feature.
- synthetics
Args List<String> - Synthetics agent CLI arguments.
- inline
Script string - The inline script.
- ignore
Https booleanErrors - Whether to ignore HTTPS errors.
- playwright
Options string - Playwright options.. Raw JSON object, use
jsonencode
function to represent JSON - screenshots string
- Controls the behavior of the screenshots feature.
- synthetics
Args string[] - Synthetics agent CLI arguments.
- inline_
script str - The inline script.
- ignore_
https_ boolerrors - Whether to ignore HTTPS errors.
- playwright_
options str - Playwright options.. Raw JSON object, use
jsonencode
function to represent JSON - screenshots str
- Controls the behavior of the screenshots feature.
- synthetics_
args Sequence[str] - Synthetics agent CLI arguments.
- inline
Script String - The inline script.
- ignore
Https BooleanErrors - Whether to ignore HTTPS errors.
- playwright
Options String - Playwright options.. Raw JSON object, use
jsonencode
function to represent JSON - screenshots String
- Controls the behavior of the screenshots feature.
- synthetics
Args List<String> - Synthetics agent CLI arguments.
KibanaSyntheticsMonitorHttp, KibanaSyntheticsMonitorHttpArgs
- Url string
- URL to monitor.
- Check string
- The check request settings.. Raw JSON object, use
jsonencode
function to represent JSON - Ipv4 bool
- Whether to ping using the ipv4 protocol.
- Ipv6 bool
- Whether to ping using the ipv6 protocol.
- Max
Redirects double - The maximum number of redirects to follow. Default:
0
- Mode string
- The mode of the monitor. Can be "all" or "any". If you’re using a DNS-load balancer and want to ping every IP address for the specified hostname, you should use all.
- Password string
- The password for authenticating with the server. The credentials are passed with the request.
- Proxy
Header string - Additional headers to send to proxies during CONNECT requests.. Raw JSON object, use
jsonencode
function to represent JSON - Proxy
Url string - The URL of the proxy to use for this monitor.
- Response string
- Controls the indexing of the HTTP response body contents to the
http.response.body.contents
field.. Raw JSON object, usejsonencode
function to represent JSON - Ssl
Certificate string - Certificate.
- List<string>
- The list of root certificates for verifications is required.
- Ssl
Key string - Certificate key.
- Ssl
Key stringPassphrase - Key passphrase.
- Ssl
Supported List<string>Protocols - List of allowed SSL/TLS versions.
- Ssl
Verification stringMode - Controls the verification of server certificates.
- Username string
- The username for authenticating with the server. The credentials are passed with the request.
- Url string
- URL to monitor.
- Check string
- The check request settings.. Raw JSON object, use
jsonencode
function to represent JSON - Ipv4 bool
- Whether to ping using the ipv4 protocol.
- Ipv6 bool
- Whether to ping using the ipv6 protocol.
- Max
Redirects float64 - The maximum number of redirects to follow. Default:
0
- Mode string
- The mode of the monitor. Can be "all" or "any". If you’re using a DNS-load balancer and want to ping every IP address for the specified hostname, you should use all.
- Password string
- The password for authenticating with the server. The credentials are passed with the request.
- Proxy
Header string - Additional headers to send to proxies during CONNECT requests.. Raw JSON object, use
jsonencode
function to represent JSON - Proxy
Url string - The URL of the proxy to use for this monitor.
- Response string
- Controls the indexing of the HTTP response body contents to the
http.response.body.contents
field.. Raw JSON object, usejsonencode
function to represent JSON - Ssl
Certificate string - Certificate.
- []string
- The list of root certificates for verifications is required.
- Ssl
Key string - Certificate key.
- Ssl
Key stringPassphrase - Key passphrase.
- Ssl
Supported []stringProtocols - List of allowed SSL/TLS versions.
- Ssl
Verification stringMode - Controls the verification of server certificates.
- Username string
- The username for authenticating with the server. The credentials are passed with the request.
- url String
- URL to monitor.
- check String
- The check request settings.. Raw JSON object, use
jsonencode
function to represent JSON - ipv4 Boolean
- Whether to ping using the ipv4 protocol.
- ipv6 Boolean
- Whether to ping using the ipv6 protocol.
- max
Redirects Double - The maximum number of redirects to follow. Default:
0
- mode String
- The mode of the monitor. Can be "all" or "any". If you’re using a DNS-load balancer and want to ping every IP address for the specified hostname, you should use all.
- password String
- The password for authenticating with the server. The credentials are passed with the request.
- proxy
Header String - Additional headers to send to proxies during CONNECT requests.. Raw JSON object, use
jsonencode
function to represent JSON - proxy
Url String - The URL of the proxy to use for this monitor.
- response String
- Controls the indexing of the HTTP response body contents to the
http.response.body.contents
field.. Raw JSON object, usejsonencode
function to represent JSON - ssl
Certificate String - Certificate.
- List<String>
- The list of root certificates for verifications is required.
- ssl
Key String - Certificate key.
- ssl
Key StringPassphrase - Key passphrase.
- ssl
Supported List<String>Protocols - List of allowed SSL/TLS versions.
- ssl
Verification StringMode - Controls the verification of server certificates.
- username String
- The username for authenticating with the server. The credentials are passed with the request.
- url string
- URL to monitor.
- check string
- The check request settings.. Raw JSON object, use
jsonencode
function to represent JSON - ipv4 boolean
- Whether to ping using the ipv4 protocol.
- ipv6 boolean
- Whether to ping using the ipv6 protocol.
- max
Redirects number - The maximum number of redirects to follow. Default:
0
- mode string
- The mode of the monitor. Can be "all" or "any". If you’re using a DNS-load balancer and want to ping every IP address for the specified hostname, you should use all.
- password string
- The password for authenticating with the server. The credentials are passed with the request.
- proxy
Header string - Additional headers to send to proxies during CONNECT requests.. Raw JSON object, use
jsonencode
function to represent JSON - proxy
Url string - The URL of the proxy to use for this monitor.
- response string
- Controls the indexing of the HTTP response body contents to the
http.response.body.contents
field.. Raw JSON object, usejsonencode
function to represent JSON - ssl
Certificate string - Certificate.
- string[]
- The list of root certificates for verifications is required.
- ssl
Key string - Certificate key.
- ssl
Key stringPassphrase - Key passphrase.
- ssl
Supported string[]Protocols - List of allowed SSL/TLS versions.
- ssl
Verification stringMode - Controls the verification of server certificates.
- username string
- The username for authenticating with the server. The credentials are passed with the request.
- url str
- URL to monitor.
- check str
- The check request settings.. Raw JSON object, use
jsonencode
function to represent JSON - ipv4 bool
- Whether to ping using the ipv4 protocol.
- ipv6 bool
- Whether to ping using the ipv6 protocol.
- max_
redirects float - The maximum number of redirects to follow. Default:
0
- mode str
- The mode of the monitor. Can be "all" or "any". If you’re using a DNS-load balancer and want to ping every IP address for the specified hostname, you should use all.
- password str
- The password for authenticating with the server. The credentials are passed with the request.
- proxy_
header str - Additional headers to send to proxies during CONNECT requests.. Raw JSON object, use
jsonencode
function to represent JSON - proxy_
url str - The URL of the proxy to use for this monitor.
- response str
- Controls the indexing of the HTTP response body contents to the
http.response.body.contents
field.. Raw JSON object, usejsonencode
function to represent JSON - ssl_
certificate str - Certificate.
- Sequence[str]
- The list of root certificates for verifications is required.
- ssl_
key str - Certificate key.
- ssl_
key_ strpassphrase - Key passphrase.
- ssl_
supported_ Sequence[str]protocols - List of allowed SSL/TLS versions.
- ssl_
verification_ strmode - Controls the verification of server certificates.
- username str
- The username for authenticating with the server. The credentials are passed with the request.
- url String
- URL to monitor.
- check String
- The check request settings.. Raw JSON object, use
jsonencode
function to represent JSON - ipv4 Boolean
- Whether to ping using the ipv4 protocol.
- ipv6 Boolean
- Whether to ping using the ipv6 protocol.
- max
Redirects Number - The maximum number of redirects to follow. Default:
0
- mode String
- The mode of the monitor. Can be "all" or "any". If you’re using a DNS-load balancer and want to ping every IP address for the specified hostname, you should use all.
- password String
- The password for authenticating with the server. The credentials are passed with the request.
- proxy
Header String - Additional headers to send to proxies during CONNECT requests.. Raw JSON object, use
jsonencode
function to represent JSON - proxy
Url String - The URL of the proxy to use for this monitor.
- response String
- Controls the indexing of the HTTP response body contents to the
http.response.body.contents
field.. Raw JSON object, usejsonencode
function to represent JSON - ssl
Certificate String - Certificate.
- List<String>
- The list of root certificates for verifications is required.
- ssl
Key String - Certificate key.
- ssl
Key StringPassphrase - Key passphrase.
- ssl
Supported List<String>Protocols - List of allowed SSL/TLS versions.
- ssl
Verification StringMode - Controls the verification of server certificates.
- username String
- The username for authenticating with the server. The credentials are passed with the request.
KibanaSyntheticsMonitorIcmp, KibanaSyntheticsMonitorIcmpArgs
KibanaSyntheticsMonitorTcp, KibanaSyntheticsMonitorTcpArgs
- Host string
- The host to monitor; it can be an IP address or a hostname. The host can include the port using a colon (e.g., "example.com:9200").
- Check
Receive string - The expected answer.
- Check
Send string - An optional payload string to send to the remote host.
- Proxy
Url string - The URL of the SOCKS5 proxy to use when connecting to the server. The value must be a URL with a scheme of
socks5://
. If the SOCKS5 proxy server requires client authentication, then a username and password can be embedded in the URL. When using a proxy, hostnames are resolved on the proxy server instead of on the client. You can change this behavior by setting theproxy_use_local_resolver
option. - Proxy
Use boolLocal Resolver - A Boolean value that determines whether hostnames are resolved locally instead of being resolved on the proxy server. The default value is false, which means that name resolution occurs on the proxy server.
- Ssl
Certificate string - Certificate.
- List<string>
- The list of root certificates for verifications is required.
- Ssl
Key string - Certificate key.
- Ssl
Key stringPassphrase - Key passphrase.
- Ssl
Supported List<string>Protocols - List of allowed SSL/TLS versions.
- Ssl
Verification stringMode - Controls the verification of server certificates.
- Host string
- The host to monitor; it can be an IP address or a hostname. The host can include the port using a colon (e.g., "example.com:9200").
- Check
Receive string - The expected answer.
- Check
Send string - An optional payload string to send to the remote host.
- Proxy
Url string - The URL of the SOCKS5 proxy to use when connecting to the server. The value must be a URL with a scheme of
socks5://
. If the SOCKS5 proxy server requires client authentication, then a username and password can be embedded in the URL. When using a proxy, hostnames are resolved on the proxy server instead of on the client. You can change this behavior by setting theproxy_use_local_resolver
option. - Proxy
Use boolLocal Resolver - A Boolean value that determines whether hostnames are resolved locally instead of being resolved on the proxy server. The default value is false, which means that name resolution occurs on the proxy server.
- Ssl
Certificate string - Certificate.
- []string
- The list of root certificates for verifications is required.
- Ssl
Key string - Certificate key.
- Ssl
Key stringPassphrase - Key passphrase.
- Ssl
Supported []stringProtocols - List of allowed SSL/TLS versions.
- Ssl
Verification stringMode - Controls the verification of server certificates.
- host String
- The host to monitor; it can be an IP address or a hostname. The host can include the port using a colon (e.g., "example.com:9200").
- check
Receive String - The expected answer.
- check
Send String - An optional payload string to send to the remote host.
- proxy
Url String - The URL of the SOCKS5 proxy to use when connecting to the server. The value must be a URL with a scheme of
socks5://
. If the SOCKS5 proxy server requires client authentication, then a username and password can be embedded in the URL. When using a proxy, hostnames are resolved on the proxy server instead of on the client. You can change this behavior by setting theproxy_use_local_resolver
option. - proxy
Use BooleanLocal Resolver - A Boolean value that determines whether hostnames are resolved locally instead of being resolved on the proxy server. The default value is false, which means that name resolution occurs on the proxy server.
- ssl
Certificate String - Certificate.
- List<String>
- The list of root certificates for verifications is required.
- ssl
Key String - Certificate key.
- ssl
Key StringPassphrase - Key passphrase.
- ssl
Supported List<String>Protocols - List of allowed SSL/TLS versions.
- ssl
Verification StringMode - Controls the verification of server certificates.
- host string
- The host to monitor; it can be an IP address or a hostname. The host can include the port using a colon (e.g., "example.com:9200").
- check
Receive string - The expected answer.
- check
Send string - An optional payload string to send to the remote host.
- proxy
Url string - The URL of the SOCKS5 proxy to use when connecting to the server. The value must be a URL with a scheme of
socks5://
. If the SOCKS5 proxy server requires client authentication, then a username and password can be embedded in the URL. When using a proxy, hostnames are resolved on the proxy server instead of on the client. You can change this behavior by setting theproxy_use_local_resolver
option. - proxy
Use booleanLocal Resolver - A Boolean value that determines whether hostnames are resolved locally instead of being resolved on the proxy server. The default value is false, which means that name resolution occurs on the proxy server.
- ssl
Certificate string - Certificate.
- string[]
- The list of root certificates for verifications is required.
- ssl
Key string - Certificate key.
- ssl
Key stringPassphrase - Key passphrase.
- ssl
Supported string[]Protocols - List of allowed SSL/TLS versions.
- ssl
Verification stringMode - Controls the verification of server certificates.
- host str
- The host to monitor; it can be an IP address or a hostname. The host can include the port using a colon (e.g., "example.com:9200").
- check_
receive str - The expected answer.
- check_
send str - An optional payload string to send to the remote host.
- proxy_
url str - The URL of the SOCKS5 proxy to use when connecting to the server. The value must be a URL with a scheme of
socks5://
. If the SOCKS5 proxy server requires client authentication, then a username and password can be embedded in the URL. When using a proxy, hostnames are resolved on the proxy server instead of on the client. You can change this behavior by setting theproxy_use_local_resolver
option. - proxy_
use_ boollocal_ resolver - A Boolean value that determines whether hostnames are resolved locally instead of being resolved on the proxy server. The default value is false, which means that name resolution occurs on the proxy server.
- ssl_
certificate str - Certificate.
- Sequence[str]
- The list of root certificates for verifications is required.
- ssl_
key str - Certificate key.
- ssl_
key_ strpassphrase - Key passphrase.
- ssl_
supported_ Sequence[str]protocols - List of allowed SSL/TLS versions.
- ssl_
verification_ strmode - Controls the verification of server certificates.
- host String
- The host to monitor; it can be an IP address or a hostname. The host can include the port using a colon (e.g., "example.com:9200").
- check
Receive String - The expected answer.
- check
Send String - An optional payload string to send to the remote host.
- proxy
Url String - The URL of the SOCKS5 proxy to use when connecting to the server. The value must be a URL with a scheme of
socks5://
. If the SOCKS5 proxy server requires client authentication, then a username and password can be embedded in the URL. When using a proxy, hostnames are resolved on the proxy server instead of on the client. You can change this behavior by setting theproxy_use_local_resolver
option. - proxy
Use BooleanLocal Resolver - A Boolean value that determines whether hostnames are resolved locally instead of being resolved on the proxy server. The default value is false, which means that name resolution occurs on the proxy server.
- ssl
Certificate String - Certificate.
- List<String>
- The list of root certificates for verifications is required.
- ssl
Key String - Certificate key.
- ssl
Key StringPassphrase - Key passphrase.
- ssl
Supported List<String>Protocols - List of allowed SSL/TLS versions.
- ssl
Verification StringMode - Controls the verification of server certificates.
Import
$ pulumi import elasticstack:index/kibanaSyntheticsMonitor:KibanaSyntheticsMonitor my_monitor <space id>/<monitor_id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- elasticstack elastic/terraform-provider-elasticstack
- License
- Notes
- This Pulumi package is based on the
elasticstack
Terraform Provider.