Skip to content

Latest commit

 

History

History
2453 lines (1552 loc) · 96.8 KB

alertChannel.python.md

File metadata and controls

2453 lines (1552 loc) · 96.8 KB
Raw

alertChannel Submodule

Constructs

AlertChannel

Represents a {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel newrelic_alert_channel}.

Initializers 

from cdktf_cdktf_provider_newrelic import alert_channel

alertChannel.AlertChannel(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[int, float] = 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,
  name: str,
  type: str,
  account_id: typing.Union[int, float] = None,
  config: AlertChannelConfigA = None,
  id: str = 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[int, float] 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.
name str (Required) The name of the channel.
type str (Required) The type of channel. One of: (webhook, email, opsgenie, pagerduty, slack, user, victorops).
account_id typing.Union[int, float] The New Relic account ID where you want to create alert channels.
config AlertChannelConfigA config block.
id str Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#id AlertChannel#id}.
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[int, float]
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]]
nameRequired
  • Type: str

(Required) The name of the channel.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#name AlertChannel#name}

typeRequired
  • Type: str

(Required) The type of channel. One of: (webhook, email, opsgenie, pagerduty, slack, user, victorops).

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#type AlertChannel#type}

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

The New Relic account ID where you want to create alert channels.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#account_id AlertChannel#account_id}

configOptional

config block.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#config AlertChannel#config}

idOptional
  • Type: str

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#id AlertChannel#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.

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_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
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.
put_config No description.
reset_account_id No description.
reset_config No description.
reset_id 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_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

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(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
put_config 
def put_config(
  api_key: str = None,
  auth_password: str = None,
  auth_type: str = None,
  auth_username: str = None,
  base_url: str = None,
  channel: str = None,
  headers: typing.Mapping[str] = None,
  headers_string: str = None,
  include_json_attachment: str = None,
  key: str = None,
  payload: typing.Mapping[str] = None,
  payload_string: str = None,
  payload_type: str = None,
  recipients: str = None,
  region: str = None,
  route_key: str = None,
  service_key: str = None,
  tags: str = None,
  teams: str = None,
  url: str = None,
  user_id: str = None
) -> None
api_keyOptional
  • Type: str

The API key for integrating with OpsGenie.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#api_key AlertChannel#api_key}

auth_passwordOptional
  • Type: str

Specifies an authentication password for use with a channel. Supported by the webhook channel type.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#auth_password AlertChannel#auth_password}

auth_typeOptional
  • Type: str

Specifies an authentication method for use with a channel.

Supported by the webhook channel type. Only HTTP basic authentication is currently supported via the value BASIC.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#auth_type AlertChannel#auth_type}

auth_usernameOptional
  • Type: str

Specifies an authentication username for use with a channel. Supported by the webhook channel type.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#auth_username AlertChannel#auth_username}

base_urlOptional
  • Type: str

The base URL of the webhook destination.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#base_url AlertChannel#base_url}

channelOptional
  • Type: str

The Slack channel to send notifications to.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#channel AlertChannel#channel}

headersOptional
  • Type: typing.Mapping[str]

A map of key/value pairs that represents extra HTTP headers to be sent along with the webhook payload.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#headers AlertChannel#headers}

headers_stringOptional
  • Type: str

Use instead of headers if the desired payload is more complex than a list of key/value pairs (e.g. a set of headers that makes use of nested objects). The value provided should be a valid JSON string with escaped double quotes. Conflicts with headers.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#headers_string AlertChannel#headers_string}

include_json_attachmentOptional
  • Type: str

true or false.

Flag for whether or not to attach a JSON document containing information about the associated alert to the email that is sent to recipients.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#include_json_attachment AlertChannel#include_json_attachment}

keyOptional
  • Type: str

The key for integrating with VictorOps.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#key AlertChannel#key}

payloadOptional
  • Type: typing.Mapping[str]

A map of key/value pairs that represents the webhook payload. Must provide payload_type if setting this argument.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#payload AlertChannel#payload}

payload_stringOptional
  • Type: str

Use instead of payload if the desired payload is more complex than a list of key/value pairs (e.g. a payload that makes use of nested objects). The value provided should be a valid JSON string with escaped double quotes. Conflicts with payload.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#payload_string AlertChannel#payload_string}

payload_typeOptional
  • Type: str

Can either be application/json or application/x-www-form-urlencoded. The payload_type argument is required if payload is set.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#payload_type AlertChannel#payload_type}

recipientsOptional
  • Type: str

A set of recipients for targeting notifications. Multiple values are comma separated.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#recipients AlertChannel#recipients}

regionOptional
  • Type: str

The data center region to store your data. Valid values are US and EU. Default is US.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#region AlertChannel#region}

route_keyOptional
  • Type: str

The route key for integrating with VictorOps.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#route_key AlertChannel#route_key}

service_keyOptional
  • Type: str

Specifies the service key for integrating with Pagerduty.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#service_key AlertChannel#service_key}

tagsOptional
  • Type: str

A set of tags for targeting notifications. Multiple values are comma separated.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#tags AlertChannel#tags}

teamsOptional
  • Type: str

A set of teams for targeting notifications. Multiple values are comma separated.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#teams AlertChannel#teams}

urlOptional
  • Type: str

Your organization's Slack URL.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#url AlertChannel#url}

user_idOptional
  • Type: str

The user ID for use with the user channel type.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#user_id AlertChannel#user_id}

reset_account_id 
def reset_account_id() -> None
reset_config 
def reset_config() -> None
reset_id 
def reset_id() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
is_construct 
from cdktf_cdktf_provider_newrelic import alert_channel

alertChannel.AlertChannel.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_channel

alertChannel.AlertChannel.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_newrelic import alert_channel

alertChannel.AlertChannel.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any

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[int, float] 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.
config AlertChannelConfigAOutputReference No description.
account_id_input typing.Union[int, float] No description.
config_input AlertChannelConfigA No description.
id_input str No description.
name_input str No description.
type_input str No description.
account_id typing.Union[int, float] No description.
id str No description.
name str No description.
type str 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[int, float]
  • Type: typing.Union[int, float]
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]]
configRequired 
config: AlertChannelConfigAOutputReference
account_id_inputOptional 
account_id_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
config_inputOptional 
config_input: AlertChannelConfigA
id_inputOptional 
id_input: str
  • Type: str
name_inputOptional 
name_input: str
  • Type: str
type_inputOptional 
type_input: str
  • Type: str
account_idRequired 
account_id: typing.Union[int, float]
  • Type: typing.Union[int, float]
idRequired 
id: str
  • Type: str
nameRequired 
name: str
  • Type: str
typeRequired 
type: str
  • Type: str

Constants

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

Structs

AlertChannelConfig

Initializer 

from cdktf_cdktf_provider_newrelic import alert_channel

alertChannel.AlertChannelConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[int, float] = 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,
  name: str,
  type: str,
  account_id: typing.Union[int, float] = None,
  config: AlertChannelConfigA = None,
  id: str = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[int, float] 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.
name str (Required) The name of the channel.
type str (Required) The type of channel. One of: (webhook, email, opsgenie, pagerduty, slack, user, victorops).
account_id typing.Union[int, float] The New Relic account ID where you want to create alert channels.
config AlertChannelConfigA config block.
id str Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#id AlertChannel#id}.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[int, float]
  • Type: typing.Union[int, float]
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]]
nameRequired 
name: str
  • Type: str

(Required) The name of the channel.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#name AlertChannel#name}

typeRequired 
type: str
  • Type: str

(Required) The type of channel. One of: (webhook, email, opsgenie, pagerduty, slack, user, victorops).

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#type AlertChannel#type}

account_idOptional 
account_id: typing.Union[int, float]
  • Type: typing.Union[int, float]

The New Relic account ID where you want to create alert channels.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#account_id AlertChannel#account_id}

configOptional 
config: AlertChannelConfigA

config block.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#config AlertChannel#config}

idOptional 
id: str
  • Type: str

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#id AlertChannel#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.

AlertChannelConfigA

Initializer 

from cdktf_cdktf_provider_newrelic import alert_channel

alertChannel.AlertChannelConfigA(
  api_key: str = None,
  auth_password: str = None,
  auth_type: str = None,
  auth_username: str = None,
  base_url: str = None,
  channel: str = None,
  headers: typing.Mapping[str] = None,
  headers_string: str = None,
  include_json_attachment: str = None,
  key: str = None,
  payload: typing.Mapping[str] = None,
  payload_string: str = None,
  payload_type: str = None,
  recipients: str = None,
  region: str = None,
  route_key: str = None,
  service_key: str = None,
  tags: str = None,
  teams: str = None,
  url: str = None,
  user_id: str = None
)

Properties

Name Type Description
api_key str The API key for integrating with OpsGenie.
auth_password str Specifies an authentication password for use with a channel. Supported by the webhook channel type.
auth_type str Specifies an authentication method for use with a channel.
auth_username str Specifies an authentication username for use with a channel. Supported by the webhook channel type.
base_url str The base URL of the webhook destination.
channel str The Slack channel to send notifications to.
headers typing.Mapping[str] A map of key/value pairs that represents extra HTTP headers to be sent along with the webhook payload.
headers_string str Use instead of headers if the desired payload is more complex than a list of key/value pairs (e.g. a set of headers that makes use of nested objects). The value provided should be a valid JSON string with escaped double quotes. Conflicts with headers.
include_json_attachment str true or false.
key str The key for integrating with VictorOps.
payload typing.Mapping[str] A map of key/value pairs that represents the webhook payload. Must provide payload_type if setting this argument.
payload_string str Use instead of payload if the desired payload is more complex than a list of key/value pairs (e.g. a payload that makes use of nested objects). The value provided should be a valid JSON string with escaped double quotes. Conflicts with payload.
payload_type str Can either be application/json or application/x-www-form-urlencoded. The payload_type argument is required if payload is set.
recipients str A set of recipients for targeting notifications. Multiple values are comma separated.
region str The data center region to store your data. Valid values are US and EU. Default is US.
route_key str The route key for integrating with VictorOps.
service_key str Specifies the service key for integrating with Pagerduty.
tags str A set of tags for targeting notifications. Multiple values are comma separated.
teams str A set of teams for targeting notifications. Multiple values are comma separated.
url str Your organization's Slack URL.
user_id str The user ID for use with the user channel type.
api_keyOptional 
api_key: str
  • Type: str

The API key for integrating with OpsGenie.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#api_key AlertChannel#api_key}

auth_passwordOptional 
auth_password: str
  • Type: str

Specifies an authentication password for use with a channel. Supported by the webhook channel type.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#auth_password AlertChannel#auth_password}

auth_typeOptional 
auth_type: str
  • Type: str

Specifies an authentication method for use with a channel.

Supported by the webhook channel type. Only HTTP basic authentication is currently supported via the value BASIC.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#auth_type AlertChannel#auth_type}

auth_usernameOptional 
auth_username: str
  • Type: str

Specifies an authentication username for use with a channel. Supported by the webhook channel type.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#auth_username AlertChannel#auth_username}

base_urlOptional 
base_url: str
  • Type: str

The base URL of the webhook destination.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#base_url AlertChannel#base_url}

channelOptional 
channel: str
  • Type: str

The Slack channel to send notifications to.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#channel AlertChannel#channel}

headersOptional 
headers: typing.Mapping[str]
  • Type: typing.Mapping[str]

A map of key/value pairs that represents extra HTTP headers to be sent along with the webhook payload.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#headers AlertChannel#headers}

headers_stringOptional 
headers_string: str
  • Type: str

Use instead of headers if the desired payload is more complex than a list of key/value pairs (e.g. a set of headers that makes use of nested objects). The value provided should be a valid JSON string with escaped double quotes. Conflicts with headers.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#headers_string AlertChannel#headers_string}

include_json_attachmentOptional 
include_json_attachment: str
  • Type: str

true or false.

Flag for whether or not to attach a JSON document containing information about the associated alert to the email that is sent to recipients.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#include_json_attachment AlertChannel#include_json_attachment}

keyOptional 
key: str
  • Type: str

The key for integrating with VictorOps.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#key AlertChannel#key}

payloadOptional 
payload: typing.Mapping[str]
  • Type: typing.Mapping[str]

A map of key/value pairs that represents the webhook payload. Must provide payload_type if setting this argument.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#payload AlertChannel#payload}

payload_stringOptional 
payload_string: str
  • Type: str

Use instead of payload if the desired payload is more complex than a list of key/value pairs (e.g. a payload that makes use of nested objects). The value provided should be a valid JSON string with escaped double quotes. Conflicts with payload.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#payload_string AlertChannel#payload_string}

payload_typeOptional 
payload_type: str
  • Type: str

Can either be application/json or application/x-www-form-urlencoded. The payload_type argument is required if payload is set.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#payload_type AlertChannel#payload_type}

recipientsOptional 
recipients: str
  • Type: str

A set of recipients for targeting notifications. Multiple values are comma separated.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#recipients AlertChannel#recipients}

regionOptional 
region: str
  • Type: str

The data center region to store your data. Valid values are US and EU. Default is US.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#region AlertChannel#region}

route_keyOptional 
route_key: str
  • Type: str

The route key for integrating with VictorOps.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#route_key AlertChannel#route_key}

service_keyOptional 
service_key: str
  • Type: str

Specifies the service key for integrating with Pagerduty.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#service_key AlertChannel#service_key}

tagsOptional 
tags: str
  • Type: str

A set of tags for targeting notifications. Multiple values are comma separated.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#tags AlertChannel#tags}

teamsOptional 
teams: str
  • Type: str

A set of teams for targeting notifications. Multiple values are comma separated.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#teams AlertChannel#teams}

urlOptional 
url: str
  • Type: str

Your organization's Slack URL.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#url AlertChannel#url}

user_idOptional 
user_id: str
  • Type: str

The user ID for use with the user channel type.

Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#user_id AlertChannel#user_id}

Classes

AlertChannelConfigAOutputReference

Initializers 

from cdktf_cdktf_provider_newrelic import alert_channel

alertChannel.AlertChannelConfigAOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)
Name Type Description
terraform_resource cdktf.IInterpolatingParent The parent resource.
terraform_attribute str The attribute on the parent resource this class is referencing.
terraform_resourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraform_attributeRequired
  • Type: str

The attribute on the parent resource this class is referencing.

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_api_key No description.
reset_auth_password No description.
reset_auth_type No description.
reset_auth_username No description.
reset_base_url No description.
reset_channel No description.
reset_headers No description.
reset_headers_string No description.
reset_include_json_attachment No description.
reset_key No description.
reset_payload No description.
reset_payload_string No description.
reset_payload_type No description.
reset_recipients No description.
reset_region No description.
reset_route_key No description.
reset_service_key No description.
reset_tags No description.
reset_teams No description.
reset_url No description.
reset_user_id 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_api_key 
def reset_api_key() -> None
reset_auth_password 
def reset_auth_password() -> None
reset_auth_type 
def reset_auth_type() -> None
reset_auth_username 
def reset_auth_username() -> None
reset_base_url 
def reset_base_url() -> None
reset_channel 
def reset_channel() -> None
reset_headers 
def reset_headers() -> None
reset_headers_string 
def reset_headers_string() -> None
reset_include_json_attachment 
def reset_include_json_attachment() -> None
reset_key 
def reset_key() -> None
reset_payload 
def reset_payload() -> None
reset_payload_string 
def reset_payload_string() -> None
reset_payload_type 
def reset_payload_type() -> None
reset_recipients 
def reset_recipients() -> None
reset_region 
def reset_region() -> None
reset_route_key 
def reset_route_key() -> None
reset_service_key 
def reset_service_key() -> None
reset_tags 
def reset_tags() -> None
reset_teams 
def reset_teams() -> None
reset_url 
def reset_url() -> None
reset_user_id 
def reset_user_id() -> 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.
api_key_input str No description.
auth_password_input str No description.
auth_type_input str No description.
auth_username_input str No description.
base_url_input str No description.
channel_input str No description.
headers_input typing.Mapping[str] No description.
headers_string_input str No description.
include_json_attachment_input str No description.
key_input str No description.
payload_input typing.Mapping[str] No description.
payload_string_input str No description.
payload_type_input str No description.
recipients_input str No description.
region_input str No description.
route_key_input str No description.
service_key_input str No description.
tags_input str No description.
teams_input str No description.
url_input str No description.
user_id_input str No description.
api_key str No description.
auth_password str No description.
auth_type str No description.
auth_username str No description.
base_url str No description.
channel str No description.
headers typing.Mapping[str] No description.
headers_string str No description.
include_json_attachment str No description.
key str No description.
payload typing.Mapping[str] No description.
payload_string str No description.
payload_type str No description.
recipients str No description.
region str No description.
route_key str No description.
service_key str No description.
tags str No description.
teams str No description.
url str No description.
user_id str No description.
internal_value AlertChannelConfigA 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
api_key_inputOptional 
api_key_input: str
  • Type: str
auth_password_inputOptional 
auth_password_input: str
  • Type: str
auth_type_inputOptional 
auth_type_input: str
  • Type: str
auth_username_inputOptional 
auth_username_input: str
  • Type: str
base_url_inputOptional 
base_url_input: str
  • Type: str
channel_inputOptional 
channel_input: str
  • Type: str
headers_inputOptional 
headers_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
headers_string_inputOptional 
headers_string_input: str
  • Type: str
include_json_attachment_inputOptional 
include_json_attachment_input: str
  • Type: str
key_inputOptional 
key_input: str
  • Type: str
payload_inputOptional 
payload_input: typing.Mapping[str]
  • Type: typing.Mapping[str]
payload_string_inputOptional 
payload_string_input: str
  • Type: str
payload_type_inputOptional 
payload_type_input: str
  • Type: str
recipients_inputOptional 
recipients_input: str
  • Type: str
region_inputOptional 
region_input: str
  • Type: str
route_key_inputOptional 
route_key_input: str
  • Type: str
service_key_inputOptional 
service_key_input: str
  • Type: str
tags_inputOptional 
tags_input: str
  • Type: str
teams_inputOptional 
teams_input: str
  • Type: str
url_inputOptional 
url_input: str
  • Type: str
user_id_inputOptional 
user_id_input: str
  • Type: str
api_keyRequired 
api_key: str
  • Type: str
auth_passwordRequired 
auth_password: str
  • Type: str
auth_typeRequired 
auth_type: str
  • Type: str
auth_usernameRequired 
auth_username: str
  • Type: str
base_urlRequired 
base_url: str
  • Type: str
channelRequired 
channel: str
  • Type: str
headersRequired 
headers: typing.Mapping[str]
  • Type: typing.Mapping[str]
headers_stringRequired 
headers_string: str
  • Type: str
include_json_attachmentRequired 
include_json_attachment: str
  • Type: str
keyRequired 
key: str
  • Type: str
payloadRequired 
payload: typing.Mapping[str]
  • Type: typing.Mapping[str]
payload_stringRequired 
payload_string: str
  • Type: str
payload_typeRequired 
payload_type: str
  • Type: str
recipientsRequired 
recipients: str
  • Type: str
regionRequired 
region: str
  • Type: str
route_keyRequired 
route_key: str
  • Type: str
service_keyRequired 
service_key: str
  • Type: str
tagsRequired 
tags: str
  • Type: str
teamsRequired 
teams: str
  • Type: str
urlRequired 
url: str
  • Type: str
user_idRequired 
user_id: str
  • Type: str
internal_valueOptional 
internal_value: AlertChannelConfigA