This page documents the language specification for the newrelic package. If you're looking for help working with the inputs, outputs, or functions of newrelic resources in a Pulumi program, please see the resource documentation for examples and API reference.

synthetics

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-newrelic repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-newrelic repo.

class pulumi_newrelic.synthetics.AlertCondition(resource_name, opts=None, enabled=None, monitor_id=None, name=None, policy_id=None, runbook_url=None, __props__=None, __name__=None, __opts__=None)

Use this resource to create and manage synthetics alert conditions in New Relic.

import pulumi
import pulumi_newrelic as newrelic

foo_monitor = newrelic.synthetics.get_monitor(name="foo")
foo_alert_condition = newrelic.synthetics.AlertCondition("fooAlertCondition",
    policy_id=newrelic_alert_policy["foo"]["id"],
    monitor_id=foo_monitor.id,
    runbook_url="https://www.example.com")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • enabled (pulumi.Input[bool]) – Set whether to enable the alert condition. Defaults to true.

  • monitor_id (pulumi.Input[str]) – The ID of the Synthetics monitor to be referenced in the alert condition.

  • name (pulumi.Input[str]) – The title of this condition.

  • policy_id (pulumi.Input[float]) – The ID of the policy where this condition should be used.

  • runbook_url (pulumi.Input[str]) – Runbook URL to display in notifications.

enabled: pulumi.Output[bool] = None

Set whether to enable the alert condition. Defaults to true.

monitor_id: pulumi.Output[str] = None

The ID of the Synthetics monitor to be referenced in the alert condition.

name: pulumi.Output[str] = None

The title of this condition.

policy_id: pulumi.Output[float] = None

The ID of the policy where this condition should be used.

runbook_url: pulumi.Output[str] = None

Runbook URL to display in notifications.

static get(resource_name, id, opts=None, enabled=None, monitor_id=None, name=None, policy_id=None, runbook_url=None)

Get an existing AlertCondition resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • enabled (pulumi.Input[bool]) – Set whether to enable the alert condition. Defaults to true.

  • monitor_id (pulumi.Input[str]) – The ID of the Synthetics monitor to be referenced in the alert condition.

  • name (pulumi.Input[str]) – The title of this condition.

  • policy_id (pulumi.Input[float]) – The ID of the policy where this condition should be used.

  • runbook_url (pulumi.Input[str]) – Runbook URL to display in notifications.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_newrelic.synthetics.AwaitableGetMonitorResult(id=None, monitor_id=None, name=None)
class pulumi_newrelic.synthetics.AwaitableGetSecureCredentialResult(created_at=None, description=None, id=None, key=None, last_updated=None)
class pulumi_newrelic.synthetics.GetMonitorResult(id=None, monitor_id=None, name=None)

A collection of values returned by getMonitor.

id = None

The provider-assigned unique ID for this managed resource.

monitor_id = None

The ID of the synthetics monitor.

class pulumi_newrelic.synthetics.GetSecureCredentialResult(created_at=None, description=None, id=None, key=None, last_updated=None)

A collection of values returned by getSecureCredential.

created_at = None

The time the secure credential was created.

description = None

The secure credential’s description.

id = None

The provider-assigned unique ID for this managed resource.

last_updated = None

The time the secure credential was last updated.

class pulumi_newrelic.synthetics.Label(resource_name, opts=None, monitor_id=None, type=None, value=None, __props__=None, __name__=None, __opts__=None)

Use this resource to create, update, and delete a Synthetics label in New Relic.

import pulumi
import pulumi_newrelic as newrelic

foo = newrelic.synthetics.Label("foo",
    monitor_id=newrelic_synthetics_monitor["foo"]["id"],
    type="MyCategory",
    value="MyValue")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • monitor_id (pulumi.Input[str]) – The ID of the monitor that will be assigned the label.

  • type (pulumi.Input[str]) – A string representing the label key/category.

  • value (pulumi.Input[str]) – A string representing the label value.

href: pulumi.Output[str] = None

The URL of the Synthetics label.

monitor_id: pulumi.Output[str] = None

The ID of the monitor that will be assigned the label.

type: pulumi.Output[str] = None

A string representing the label key/category.

value: pulumi.Output[str] = None

A string representing the label value.

static get(resource_name, id, opts=None, href=None, monitor_id=None, type=None, value=None)

Get an existing Label resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • href (pulumi.Input[str]) – The URL of the Synthetics label.

  • monitor_id (pulumi.Input[str]) – The ID of the monitor that will be assigned the label.

  • type (pulumi.Input[str]) – A string representing the label key/category.

  • value (pulumi.Input[str]) – A string representing the label value.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_newrelic.synthetics.Monitor(resource_name, opts=None, bypass_head_request=None, frequency=None, locations=None, name=None, sla_threshold=None, status=None, treat_redirect_as_failure=None, type=None, uri=None, validation_string=None, verify_ssl=None, __props__=None, __name__=None, __opts__=None)

Use this resource to create, update, and delete a synthetics monitor in New Relic.

import pulumi
import pulumi_newrelic as newrelic

foo = newrelic.synthetics.Monitor("foo",
    frequency=5,
    locations=[
        "AWS_US_EAST_1",
        "AWS_US_EAST_2",
    ],
    status="ENABLED",
    type="SIMPLE",
    uri="https://example.com",
    validation_string="add example validation check here",
    verify_ssl=True)
# Optional for type "SIMPLE" and "BROWSER"

Type: BROWSER

import pulumi
import pulumi_newrelic as newrelic

foo = newrelic.synthetics.Monitor("foo",
    bypass_head_request=True,
    frequency=5,
    locations=["AWS_US_EAST_1"],
    status="ENABLED",
    treat_redirect_as_failure=True,
    type="BROWSER",
    uri="https://example.com",
    validation_string="add example validation check here",
    verify_ssl=True)
# optional for type "SIMPLE" and "BROWSER"

Type: SCRIPT_BROWSER

import pulumi
import pulumi_newrelic as newrelic

foo = newrelic.synthetics.Monitor("foo",
    frequency=5,
    locations=["AWS_US_EAST_1"],
    status="ENABLED",
    type="SCRIPT_BROWSER")

Type: SCRIPT_API

import pulumi
import pulumi_newrelic as newrelic

foo = newrelic.synthetics.Monitor("foo",
    frequency=5,
    locations=["AWS_US_EAST_1"],
    status="ENABLED",
    type="SCRIPT_API")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • bypass_head_request (pulumi.Input[bool]) – Bypass HEAD request.

  • frequency (pulumi.Input[float]) – The interval (in minutes) at which this monitor should run.

  • locations (pulumi.Input[list]) – The locations in which this monitor should be run.

  • name (pulumi.Input[str]) – The title of this monitor.

  • sla_threshold (pulumi.Input[float]) – The base threshold for the SLA report.

  • status (pulumi.Input[str]) – The monitor status (i.e. ENABLED, MUTED, DISABLED).

  • treat_redirect_as_failure (pulumi.Input[bool]) – Fail the monitor check if redirected.

  • type (pulumi.Input[str]) – The monitor type. Valid values are SIMPLE, BROWSER, SCRIPT_BROWSER, and SCRIPT_API.

  • uri (pulumi.Input[str]) – The URI for the monitor to hit.

  • validation_string (pulumi.Input[str]) – The string to validate against in the response.

  • verify_ssl (pulumi.Input[bool]) – Verify SSL.

bypass_head_request: pulumi.Output[bool] = None

Bypass HEAD request.

frequency: pulumi.Output[float] = None

The interval (in minutes) at which this monitor should run.

locations: pulumi.Output[list] = None

The locations in which this monitor should be run.

name: pulumi.Output[str] = None

The title of this monitor.

sla_threshold: pulumi.Output[float] = None

The base threshold for the SLA report.

status: pulumi.Output[str] = None

The monitor status (i.e. ENABLED, MUTED, DISABLED).

treat_redirect_as_failure: pulumi.Output[bool] = None

Fail the monitor check if redirected.

type: pulumi.Output[str] = None

The monitor type. Valid values are SIMPLE, BROWSER, SCRIPT_BROWSER, and SCRIPT_API.

uri: pulumi.Output[str] = None

The URI for the monitor to hit.

validation_string: pulumi.Output[str] = None

The string to validate against in the response.

verify_ssl: pulumi.Output[bool] = None

Verify SSL.

static get(resource_name, id, opts=None, bypass_head_request=None, frequency=None, locations=None, name=None, sla_threshold=None, status=None, treat_redirect_as_failure=None, type=None, uri=None, validation_string=None, verify_ssl=None)

Get an existing Monitor resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • bypass_head_request (pulumi.Input[bool]) – Bypass HEAD request.

  • frequency (pulumi.Input[float]) – The interval (in minutes) at which this monitor should run.

  • locations (pulumi.Input[list]) – The locations in which this monitor should be run.

  • name (pulumi.Input[str]) – The title of this monitor.

  • sla_threshold (pulumi.Input[float]) – The base threshold for the SLA report.

  • status (pulumi.Input[str]) – The monitor status (i.e. ENABLED, MUTED, DISABLED).

  • treat_redirect_as_failure (pulumi.Input[bool]) – Fail the monitor check if redirected.

  • type (pulumi.Input[str]) – The monitor type. Valid values are SIMPLE, BROWSER, SCRIPT_BROWSER, and SCRIPT_API.

  • uri (pulumi.Input[str]) – The URI for the monitor to hit.

  • validation_string (pulumi.Input[str]) – The string to validate against in the response.

  • verify_ssl (pulumi.Input[bool]) – Verify SSL.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_newrelic.synthetics.MonitorScript(resource_name, opts=None, monitor_id=None, text=None, __props__=None, __name__=None, __opts__=None)

Use this resource to update a synthetics monitor script in New Relic.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • monitor_id (pulumi.Input[str]) – The ID of the monitor to attach the script to.

  • text (pulumi.Input[str]) – The plaintext representing the monitor script.

monitor_id: pulumi.Output[str] = None

The ID of the monitor to attach the script to.

text: pulumi.Output[str] = None

The plaintext representing the monitor script.

static get(resource_name, id, opts=None, monitor_id=None, text=None)

Get an existing MonitorScript resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • monitor_id (pulumi.Input[str]) – The ID of the monitor to attach the script to.

  • text (pulumi.Input[str]) – The plaintext representing the monitor script.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_newrelic.synthetics.SecureCredential(resource_name, opts=None, created_at=None, description=None, key=None, last_updated=None, value=None, __props__=None, __name__=None, __opts__=None)

Use this resource to create and manage New Relic Synthetic secure credentials.

import pulumi
import pulumi_newrelic as newrelic

foo = newrelic.synthetics.SecureCredential("foo",
    description="My description",
    key="MY_KEY",
    value="My value")
Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • created_at (pulumi.Input[str]) – The time the secure credential was created.

  • description (pulumi.Input[str]) – The secure credential’s description.

  • key (pulumi.Input[str]) – The secure credential’s key name. Regardless of the case used in the configuration, the provider will provide an upcased key to the underlying API.

  • last_updated (pulumi.Input[str]) – The time the secure credential was last updated.

  • value (pulumi.Input[str]) – The secure credential’s value.

created_at: pulumi.Output[str] = None

The time the secure credential was created.

description: pulumi.Output[str] = None

The secure credential’s description.

key: pulumi.Output[str] = None

The secure credential’s key name. Regardless of the case used in the configuration, the provider will provide an upcased key to the underlying API.

last_updated: pulumi.Output[str] = None

The time the secure credential was last updated.

value: pulumi.Output[str] = None

The secure credential’s value.

static get(resource_name, id, opts=None, created_at=None, description=None, key=None, last_updated=None, value=None)

Get an existing SecureCredential resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • created_at (pulumi.Input[str]) – The time the secure credential was created.

  • description (pulumi.Input[str]) – The secure credential’s description.

  • key (pulumi.Input[str]) – The secure credential’s key name. Regardless of the case used in the configuration, the provider will provide an upcased key to the underlying API.

  • last_updated (pulumi.Input[str]) – The time the secure credential was last updated.

  • value (pulumi.Input[str]) – The secure credential’s value.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_newrelic.synthetics.get_monitor(name=None, opts=None)

Use this data source to get information about a specific synthetics monitor in New Relic that already exists. This can be used to set up a Synthetics alert condition.

import pulumi
import pulumi_newrelic as newrelic

bar = newrelic.synthetics.get_monitor(name="bar")
baz = newrelic.synthetics.AlertCondition("baz",
    policy_id=newrelic_alert_policy["foo"]["id"],
    monitor_id=bar.id,
    runbook_url="https://www.example.com")
Parameters

name (str) – The name of the synthetics monitor in New Relic.

pulumi_newrelic.synthetics.get_secure_credential(key=None, opts=None)

Use this data source to get information about a specific Synthetics secure credential in New Relic that already exists.

Note that the secure credential’s value is not returned as an attribute for security reasons.

import pulumi
import pulumi_newrelic as newrelic

foo = newrelic.synthetics.get_secure_credential(key="MY_KEY")
Parameters

key (str) – The secure credential’s key name. Regardless of the case used in the configuration, the provider will provide an upcased key to the underlying API.