Skip to content

Latest commit

 

History

History
2347 lines (1486 loc) · 97.4 KB

alertCondition.python.md

File metadata and controls

2347 lines (1486 loc) · 97.4 KB
Raw

alertCondition Submodule

Constructs

AlertCondition

Represents a {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition newrelic_alert_condition}.

Initializers 

from cdktf_cdktf_provider_newrelic import alert_condition

alertCondition.AlertCondition(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  entities: typing.List[typing.Union[int, float]],
  metric: str,
  name: str,
  policy_id: typing.Union[int, float],
  term: typing.Union[IResolvable, typing.List[AlertConditionTerm]],
  type: str,
  condition_scope: str = None,
  enabled: typing.Union[bool, IResolvable] = None,
  gc_metric: str = None,
  id: str = None,
  runbook_url: str = None,
  user_defined_metric: str = None,
  user_defined_value_function: str = None,
  violation_close_timer: typing.Union[int, float] = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
entities typing.List[typing.Union[int, float]] The instance IDs associated with this condition.
metric str The metric field accepts parameters based on the type set.
name str The title of the condition. Must be between 1 and 128 characters, inclusive.
policy_id typing.Union[int, float] The ID of the policy where this condition should be used.
term typing.Union[cdktf.IResolvable, typing.List[AlertConditionTerm]] term block.
type str The type of condition. One of: (apm_app_metric, apm_jvm_metric, apm_kt_metric, browser_metric, mobile_metric, servers_metric).
condition_scope str One of (application, instance).
enabled typing.Union[bool, cdktf.IResolvable] Whether the condition is enabled.
gc_metric str A valid Garbage Collection metric e.g. GC/G1 Young Generation. This is required if you are using apm_jvm_metric with gc_cpu_time condition type.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#id AlertCondition#id}.
runbook_url str Runbook URL to display in notifications.
user_defined_metric str A custom metric to be evaluated.
user_defined_value_function str One of: (average, min, max, total, sample_size, percent, rate).
violation_close_timer typing.Union[int, float] Automatically close instance-based incidents, including JVM health metric incidents, after the number of hours specified.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
entitiesRequired
  • Type: typing.List[typing.Union[int, float]]

The instance IDs associated with this condition.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#entities AlertCondition#entities}

metricRequired
  • Type: str

The metric field accepts parameters based on the type set.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#metric AlertCondition#metric}

nameRequired
  • Type: str

The title of the condition. Must be between 1 and 128 characters, inclusive.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#name AlertCondition#name}

policy_idRequired
  • Type: typing.Union[int, float]

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#policy_id AlertCondition#policy_id}

termRequired

term block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#term AlertCondition#term}

typeRequired
  • Type: str

The type of condition. One of: (apm_app_metric, apm_jvm_metric, apm_kt_metric, browser_metric, mobile_metric, servers_metric).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#type AlertCondition#type}

condition_scopeOptional
  • Type: str

One of (application, instance).

Choose application for most scenarios. If you are using the JVM plugin in New Relic, the instance setting allows your condition to trigger for specific app instances.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#condition_scope AlertCondition#condition_scope}

enabledOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether the condition is enabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#enabled AlertCondition#enabled}

gc_metricOptional
  • Type: str

A valid Garbage Collection metric e.g. GC/G1 Young Generation. This is required if you are using apm_jvm_metric with gc_cpu_time condition type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#gc_metric AlertCondition#gc_metric}

idOptional
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#id AlertCondition#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

runbook_urlOptional
  • Type: str

Runbook URL to display in notifications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#runbook_url AlertCondition#runbook_url}

user_defined_metricOptional
  • Type: str

A custom metric to be evaluated.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#user_defined_metric AlertCondition#user_defined_metric}

user_defined_value_functionOptional
  • Type: str

One of: (average, min, max, total, sample_size, percent, rate).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#user_defined_value_function AlertCondition#user_defined_value_function}

violation_close_timerOptional
  • Type: typing.Union[int, float]

Automatically close instance-based incidents, including JVM health metric incidents, after the number of hours specified.

Must be between 1 and 720 hours.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#violation_close_timer AlertCondition#violation_close_timer}

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
put_term No description.
reset_condition_scope No description.
reset_enabled No description.
reset_gc_metric No description.
reset_id No description.
reset_runbook_url No description.
reset_user_defined_metric No description.
reset_user_defined_value_function No description.
reset_violation_close_timer No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: str

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

move_to 
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

move_to_id 
def move_to_id(
  id: str
) -> None

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: str

Full id of resource to move to, e.g. "aws_s3_bucket.example".

put_term 
def put_term(
  value: typing.Union[IResolvable, typing.List[AlertConditionTerm]]
) -> None
valueRequired
reset_condition_scope 
def reset_condition_scope() -> None
reset_enabled 
def reset_enabled() -> None
reset_gc_metric 
def reset_gc_metric() -> None
reset_id 
def reset_id() -> None
reset_runbook_url 
def reset_runbook_url() -> None
reset_user_defined_metric 
def reset_user_defined_metric() -> None
reset_user_defined_value_function 
def reset_user_defined_value_function() -> None
reset_violation_close_timer 
def reset_violation_close_timer() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a AlertCondition resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_newrelic import alert_condition

alertCondition.AlertCondition.is_construct(
  x: typing.Any
)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_newrelic import alert_condition

alertCondition.AlertCondition.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_newrelic import alert_condition

alertCondition.AlertCondition.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_newrelic import alert_condition

alertCondition.AlertCondition.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTF code for importing a AlertCondition resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

The construct id used in the generated config for the AlertCondition to import.

import_from_idRequired
  • Type: str

The id of the existing AlertCondition that should be imported.

Refer to the {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the AlertCondition to import is found.

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
entity_guid str No description.
term AlertConditionTermList No description.
condition_scope_input str No description.
enabled_input typing.Union[bool, cdktf.IResolvable] No description.
entities_input typing.List[typing.Union[int, float]] No description.
gc_metric_input str No description.
id_input str No description.
metric_input str No description.
name_input str No description.
policy_id_input typing.Union[int, float] No description.
runbook_url_input str No description.
term_input typing.Union[cdktf.IResolvable, typing.List[AlertConditionTerm]] No description.
type_input str No description.
user_defined_metric_input str No description.
user_defined_value_function_input str No description.
violation_close_timer_input typing.Union[int, float] No description.
condition_scope str No description.
enabled typing.Union[bool, cdktf.IResolvable] No description.
entities typing.List[typing.Union[int, float]] No description.
gc_metric str No description.
id str No description.
metric str No description.
name str No description.
policy_id typing.Union[int, float] No description.
runbook_url str No description.
type str No description.
user_defined_metric str No description.
user_defined_value_function str No description.
violation_close_timer typing.Union[int, float] No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
entity_guidRequired 
entity_guid: str
  • Type: str
termRequired 
term: AlertConditionTermList
condition_scope_inputOptional 
condition_scope_input: str
  • Type: str
enabled_inputOptional 
enabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
entities_inputOptional 
entities_input: typing.List[typing.Union[int, float]]
  • Type: typing.List[typing.Union[int, float]]
gc_metric_inputOptional 
gc_metric_input: str
  • Type: str
id_inputOptional 
id_input: str
  • Type: str
metric_inputOptional 
metric_input: str
  • Type: str
name_inputOptional 
name_input: str
  • Type: str
policy_id_inputOptional 
policy_id_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
runbook_url_inputOptional 
runbook_url_input: str
  • Type: str
term_inputOptional 
term_input: typing.Union[IResolvable, typing.List[AlertConditionTerm]]
type_inputOptional 
type_input: str
  • Type: str
user_defined_metric_inputOptional 
user_defined_metric_input: str
  • Type: str
user_defined_value_function_inputOptional 
user_defined_value_function_input: str
  • Type: str
violation_close_timer_inputOptional 
violation_close_timer_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
condition_scopeRequired 
condition_scope: str
  • Type: str
enabledRequired 
enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
entitiesRequired 
entities: typing.List[typing.Union[int, float]]
  • Type: typing.List[typing.Union[int, float]]
gc_metricRequired 
gc_metric: str
  • Type: str
idRequired 
id: str
  • Type: str
metricRequired 
metric: str
  • Type: str
nameRequired 
name: str
  • Type: str
policy_idRequired 
policy_id: typing.Union[int, float]
  • Type: typing.Union[int, float]
runbook_urlRequired 
runbook_url: str
  • Type: str
typeRequired 
type: str
  • Type: str
user_defined_metricRequired 
user_defined_metric: str
  • Type: str
user_defined_value_functionRequired 
user_defined_value_function: str
  • Type: str
violation_close_timerRequired 
violation_close_timer: typing.Union[int, float]
  • Type: typing.Union[int, float]

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

AlertConditionConfig

Initializer 

from cdktf_cdktf_provider_newrelic import alert_condition

alertCondition.AlertConditionConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  entities: typing.List[typing.Union[int, float]],
  metric: str,
  name: str,
  policy_id: typing.Union[int, float],
  term: typing.Union[IResolvable, typing.List[AlertConditionTerm]],
  type: str,
  condition_scope: str = None,
  enabled: typing.Union[bool, IResolvable] = None,
  gc_metric: str = None,
  id: str = None,
  runbook_url: str = None,
  user_defined_metric: str = None,
  user_defined_value_function: str = None,
  violation_close_timer: typing.Union[int, float] = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
entities typing.List[typing.Union[int, float]] The instance IDs associated with this condition.
metric str The metric field accepts parameters based on the type set.
name str The title of the condition. Must be between 1 and 128 characters, inclusive.
policy_id typing.Union[int, float] The ID of the policy where this condition should be used.
term typing.Union[cdktf.IResolvable, typing.List[AlertConditionTerm]] term block.
type str The type of condition. One of: (apm_app_metric, apm_jvm_metric, apm_kt_metric, browser_metric, mobile_metric, servers_metric).
condition_scope str One of (application, instance).
enabled typing.Union[bool, cdktf.IResolvable] Whether the condition is enabled.
gc_metric str A valid Garbage Collection metric e.g. GC/G1 Young Generation. This is required if you are using apm_jvm_metric with gc_cpu_time condition type.
id str Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#id AlertCondition#id}.
runbook_url str Runbook URL to display in notifications.
user_defined_metric str A custom metric to be evaluated.
user_defined_value_function str One of: (average, min, max, total, sample_size, percent, rate).
violation_close_timer typing.Union[int, float] Automatically close instance-based incidents, including JVM health metric incidents, after the number of hours specified.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
entitiesRequired 
entities: typing.List[typing.Union[int, float]]
  • Type: typing.List[typing.Union[int, float]]

The instance IDs associated with this condition.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#entities AlertCondition#entities}

metricRequired 
metric: str
  • Type: str

The metric field accepts parameters based on the type set.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#metric AlertCondition#metric}

nameRequired 
name: str
  • Type: str

The title of the condition. Must be between 1 and 128 characters, inclusive.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#name AlertCondition#name}

policy_idRequired 
policy_id: typing.Union[int, float]
  • Type: typing.Union[int, float]

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

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#policy_id AlertCondition#policy_id}

termRequired 
term: typing.Union[IResolvable, typing.List[AlertConditionTerm]]

term block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#term AlertCondition#term}

typeRequired 
type: str
  • Type: str

The type of condition. One of: (apm_app_metric, apm_jvm_metric, apm_kt_metric, browser_metric, mobile_metric, servers_metric).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#type AlertCondition#type}

condition_scopeOptional 
condition_scope: str
  • Type: str

One of (application, instance).

Choose application for most scenarios. If you are using the JVM plugin in New Relic, the instance setting allows your condition to trigger for specific app instances.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#condition_scope AlertCondition#condition_scope}

enabledOptional 
enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Whether the condition is enabled.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#enabled AlertCondition#enabled}

gc_metricOptional 
gc_metric: str
  • Type: str

A valid Garbage Collection metric e.g. GC/G1 Young Generation. This is required if you are using apm_jvm_metric with gc_cpu_time condition type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#gc_metric AlertCondition#gc_metric}

idOptional 
id: str
  • Type: str

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#id AlertCondition#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

runbook_urlOptional 
runbook_url: str
  • Type: str

Runbook URL to display in notifications.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#runbook_url AlertCondition#runbook_url}

user_defined_metricOptional 
user_defined_metric: str
  • Type: str

A custom metric to be evaluated.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#user_defined_metric AlertCondition#user_defined_metric}

user_defined_value_functionOptional 
user_defined_value_function: str
  • Type: str

One of: (average, min, max, total, sample_size, percent, rate).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#user_defined_value_function AlertCondition#user_defined_value_function}

violation_close_timerOptional 
violation_close_timer: typing.Union[int, float]
  • Type: typing.Union[int, float]

Automatically close instance-based incidents, including JVM health metric incidents, after the number of hours specified.

Must be between 1 and 720 hours.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#violation_close_timer AlertCondition#violation_close_timer}

AlertConditionTerm

Initializer 

from cdktf_cdktf_provider_newrelic import alert_condition

alertCondition.AlertConditionTerm(
  duration: typing.Union[int, float],
  threshold: typing.Union[int, float],
  time_function: str,
  operator: str = None,
  priority: str = None
)

Properties

Name Type Description
duration typing.Union[int, float] In minutes, must be in the range of 5 to 120, inclusive.
threshold typing.Union[int, float] Must be 0 or greater.
time_function str One of (all, any).
operator str One of (above, below, equal). Defaults to equal.
priority str One of (critical, warning). Defaults to critical.
durationRequired 
duration: typing.Union[int, float]
  • Type: typing.Union[int, float]

In minutes, must be in the range of 5 to 120, inclusive.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#duration AlertCondition#duration}

thresholdRequired 
threshold: typing.Union[int, float]
  • Type: typing.Union[int, float]

Must be 0 or greater.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#threshold AlertCondition#threshold}

time_functionRequired 
time_function: str
  • Type: str

One of (all, any).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#time_function AlertCondition#time_function}

operatorOptional 
operator: str
  • Type: str

One of (above, below, equal). Defaults to equal.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#operator AlertCondition#operator}

priorityOptional 
priority: str
  • Type: str

One of (critical, warning). Defaults to critical.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/newrelic/newrelic/3.36.0/docs/resources/alert_condition#priority AlertCondition#priority}

Classes

AlertConditionTermList

Initializers 

from cdktf_cdktf_provider_newrelic import alert_condition

alertCondition.AlertConditionTermList(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  wraps_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
wraps_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

wraps_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
all_with_map_key Creating an iterator for this complex list.
compute_fqn No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
get No description.
all_with_map_key 
def all_with_map_key(
  map_key_attribute_name: str
) -> DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

map_key_attribute_nameRequired
  • Type: str
compute_fqn 
def compute_fqn() -> str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
def get(
  index: typing.Union[int, float]
) -> AlertConditionTermOutputReference
indexRequired
  • Type: typing.Union[int, float]

the index of the item to return.

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
internal_value typing.Union[cdktf.IResolvable, typing.List[AlertConditionTerm]] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, typing.List[AlertConditionTerm]]

AlertConditionTermOutputReference

Initializers 

from cdktf_cdktf_provider_newrelic import alert_condition

alertCondition.AlertConditionTermOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str,
  complex_object_index: typing.Union[int, float],
  complex_object_is_from_set: bool
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
complex_object_index typing.Union[int, float] the index of this item in the list.
complex_object_is_from_set bool whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

complex_object_indexRequired
  • Type: typing.Union[int, float]

the index of this item in the list.

complex_object_is_from_setRequired
  • Type: bool

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
compute_fqn No description.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
interpolation_for_attribute No description.
resolve Produce the Token's value at resolution time.
to_string Return a string representation of this resolvable object.
reset_operator No description.
reset_priority No description.
compute_fqn 
def compute_fqn() -> str
get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
interpolation_for_attribute 
def interpolation_for_attribute(
  property: str
) -> IResolvable
propertyRequired
  • Type: str
resolve 
def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
to_string 
def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

reset_operator 
def reset_operator() -> None
reset_priority 
def reset_priority() -> None

Properties

Name Type Description
creation_stack typing.List[str] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn str No description.
duration_input typing.Union[int, float] No description.
operator_input str No description.
priority_input str No description.
threshold_input typing.Union[int, float] No description.
time_function_input str No description.
duration typing.Union[int, float] No description.
operator str No description.
priority str No description.
threshold typing.Union[int, float] No description.
time_function str No description.
internal_value typing.Union[cdktf.IResolvable, AlertConditionTerm] No description.
creation_stackRequired 
creation_stack: typing.List[str]
  • Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
fqn: str
  • Type: str
duration_inputOptional 
duration_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
operator_inputOptional 
operator_input: str
  • Type: str
priority_inputOptional 
priority_input: str
  • Type: str
threshold_inputOptional 
threshold_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
time_function_inputOptional 
time_function_input: str
  • Type: str
durationRequired 
duration: typing.Union[int, float]
  • Type: typing.Union[int, float]
operatorRequired 
operator: str
  • Type: str
priorityRequired 
priority: str
  • Type: str
thresholdRequired 
threshold: typing.Union[int, float]
  • Type: typing.Union[int, float]
time_functionRequired 
time_function: str
  • Type: str
internal_valueOptional 
internal_value: typing.Union[IResolvable, AlertConditionTerm]