alertChannel.typescript.md

alertChannel Submodule

Constructs

AlertChannel

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

Initializers

import { alertChannel } from '@cdktf/provider-newrelic'

new alertChannel.AlertChannel(scope: Construct, id: string, config: AlertChannelConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	AlertChannelConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: AlertChannelConfig

---

Methods

Name	Description
toString	Returns a string representation of this construct.
addOverride	No description.
overrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId	Resets a previously passed logical Id to use the auto-generated logical id again.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
putConfig	No description.
resetAccountId	No description.
resetConfig	No description.
resetId	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

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

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

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

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

putConfig

public putConfig(value: AlertChannelConfigA): void

value^Required

• Type: AlertChannelConfigA

---

resetAccountId

public resetAccountId(): void

resetConfig

public resetConfig(): void

resetId

public resetId(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.

---

isConstruct

import { alertChannel } from '@cdktf/provider-newrelic'

alertChannel.AlertChannel.isConstruct(x: 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.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { alertChannel } from '@cdktf/provider-newrelic'

alertChannel.AlertChannel.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { alertChannel } from '@cdktf/provider-newrelic'

alertChannel.AlertChannel.isTerraformResource(x: any)

x^Required

• Type: any

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
config	AlertChannelConfigAOutputReference	No description.
accountIdInput	number	No description.
configInput	AlertChannelConfigA	No description.
idInput	string	No description.
nameInput	string	No description.
typeInput	string	No description.
accountId	number	No description.
id	string	No description.
name	string	No description.
type	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number;

• Type: number

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

config^Required

public readonly config: AlertChannelConfigAOutputReference;

• Type: AlertChannelConfigAOutputReference

---

accountIdInput^Optional

public readonly accountIdInput: number;

• Type: number

---

configInput^Optional

public readonly configInput: AlertChannelConfigA;

• Type: AlertChannelConfigA

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

typeInput^Optional

public readonly typeInput: string;

• Type: string

---

accountId^Required

public readonly accountId: number;

• Type: number

---

id^Required

public readonly id: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

type^Required

public readonly type: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

AlertChannelConfig

Initializer

import { alertChannel } from '@cdktf/provider-newrelic'

const alertChannelConfig: alertChannel.AlertChannelConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
name	string	(Required) The name of the channel.
type	string	(Required) The type of channel. One of: (webhook, email, opsgenie, pagerduty, slack, user, victorops).
accountId	number	The New Relic account ID where you want to create alert channels.
config	AlertChannelConfigA	config block.
id	string	Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/newrelic/r/alert_channel#id AlertChannel#id}.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number;

• Type: number

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

name^Required

public readonly name: string;

• Type: string

(Required) The name of the channel.

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

---

type^Required

public readonly type: string;

• Type: string

(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}

---

accountId^Optional

public readonly accountId: number;

• Type: number

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}

---

config^Optional

public readonly config: AlertChannelConfigA;

• Type: AlertChannelConfigA

config block.

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

---

id^Optional

public readonly id: string;

• Type: string

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

import { alertChannel } from '@cdktf/provider-newrelic'

const alertChannelConfigA: alertChannel.AlertChannelConfigA = { ... }

Properties

Name	Type	Description
apiKey	string	The API key for integrating with OpsGenie.
authPassword	string	Specifies an authentication password for use with a channel. Supported by the webhook channel type.
authType	string	Specifies an authentication method for use with a channel.
authUsername	string	Specifies an authentication username for use with a channel. Supported by the webhook channel type.
baseUrl	string	The base URL of the webhook destination.
channel	string	The Slack channel to send notifications to.
headers	{[ key: string ]: string}	A map of key/value pairs that represents extra HTTP headers to be sent along with the webhook payload.
headersString	string	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.
includeJsonAttachment	string	true or false.
key	string	The key for integrating with VictorOps.
payload	{[ key: string ]: string}	A map of key/value pairs that represents the webhook payload. Must provide payload_type if setting this argument.
payloadString	string	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.
payloadType	string	Can either be application/json or application/x-www-form-urlencoded. The payload_type argument is required if payload is set.
recipients	string	A set of recipients for targeting notifications. Multiple values are comma separated.
region	string	The data center region to store your data. Valid values are US and EU. Default is US.
routeKey	string	The route key for integrating with VictorOps.
serviceKey	string	Specifies the service key for integrating with Pagerduty.
tags	string	A set of tags for targeting notifications. Multiple values are comma separated.
teams	string	A set of teams for targeting notifications. Multiple values are comma separated.
url	string	Your organization's Slack URL.
userId	string	The user ID for use with the user channel type.

---

apiKey^Optional

public readonly apiKey: string;

• Type: string

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}

---

authPassword^Optional

public readonly authPassword: string;

• Type: string

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}

---

authType^Optional

public readonly authType: string;

• Type: string

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}

---

authUsername^Optional

public readonly authUsername: string;

• Type: string

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}

---

baseUrl^Optional

public readonly baseUrl: string;

• Type: string

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}

---

channel^Optional

public readonly channel: string;

• Type: string

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}

---

headers^Optional

public readonly headers: {[ key: string ]: string};

• Type: {[ key: string ]: string}

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}

---

headersString^Optional

public readonly headersString: string;

• Type: string

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}

---

includeJsonAttachment^Optional

public readonly includeJsonAttachment: string;

• Type: string

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}

---

key^Optional

public readonly key: string;

• Type: string

The key for integrating with VictorOps.

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

---

payload^Optional

public readonly payload: {[ key: string ]: string};

• Type: {[ key: string ]: string}

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}

---

payloadString^Optional

public readonly payloadString: string;

• Type: string

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}

---

payloadType^Optional

public readonly payloadType: string;

• Type: string

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}

---

recipients^Optional

public readonly recipients: string;

• Type: string

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}

---

region^Optional

public readonly region: string;

• Type: string

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}

---

routeKey^Optional

public readonly routeKey: string;

• Type: string

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}

---

serviceKey^Optional

public readonly serviceKey: string;

• Type: string

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}

---

tags^Optional

public readonly tags: string;

• Type: string

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}

---

teams^Optional

public readonly teams: string;

• Type: string

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}

---

url^Optional

public readonly url: string;

• Type: string

Your organization's Slack URL.

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

---

userId^Optional

public readonly userId: string;

• Type: string

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

import { alertChannel } from '@cdktf/provider-newrelic'

new alertChannel.AlertChannelConfigAOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetApiKey	No description.
resetAuthPassword	No description.
resetAuthType	No description.
resetAuthUsername	No description.
resetBaseUrl	No description.
resetChannel	No description.
resetHeaders	No description.
resetHeadersString	No description.
resetIncludeJsonAttachment	No description.
resetKey	No description.
resetPayload	No description.
resetPayloadString	No description.
resetPayloadType	No description.
resetRecipients	No description.
resetRegion	No description.
resetRouteKey	No description.
resetServiceKey	No description.
resetTags	No description.
resetTeams	No description.
resetUrl	No description.
resetUserId	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetApiKey

public resetApiKey(): void

resetAuthPassword

public resetAuthPassword(): void

resetAuthType

public resetAuthType(): void

resetAuthUsername

public resetAuthUsername(): void

resetBaseUrl

public resetBaseUrl(): void

resetChannel

public resetChannel(): void

resetHeaders

public resetHeaders(): void

resetHeadersString

public resetHeadersString(): void

resetIncludeJsonAttachment

public resetIncludeJsonAttachment(): void

resetKey

public resetKey(): void

resetPayload

public resetPayload(): void

resetPayloadString

public resetPayloadString(): void

resetPayloadType

public resetPayloadType(): void

resetRecipients

public resetRecipients(): void

resetRegion

public resetRegion(): void

resetRouteKey

public resetRouteKey(): void

resetServiceKey

public resetServiceKey(): void

resetTags

public resetTags(): void

resetTeams

public resetTeams(): void

resetUrl

public resetUrl(): void

resetUserId

public resetUserId(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
apiKeyInput	string	No description.
authPasswordInput	string	No description.
authTypeInput	string	No description.
authUsernameInput	string	No description.
baseUrlInput	string	No description.
channelInput	string	No description.
headersInput	{[ key: string ]: string}	No description.
headersStringInput	string	No description.
includeJsonAttachmentInput	string	No description.
keyInput	string	No description.
payloadInput	{[ key: string ]: string}	No description.
payloadStringInput	string	No description.
payloadTypeInput	string	No description.
recipientsInput	string	No description.
regionInput	string	No description.
routeKeyInput	string	No description.
serviceKeyInput	string	No description.
tagsInput	string	No description.
teamsInput	string	No description.
urlInput	string	No description.
userIdInput	string	No description.
apiKey	string	No description.
authPassword	string	No description.
authType	string	No description.
authUsername	string	No description.
baseUrl	string	No description.
channel	string	No description.
headers	{[ key: string ]: string}	No description.
headersString	string	No description.
includeJsonAttachment	string	No description.
key	string	No description.
payload	{[ key: string ]: string}	No description.
payloadString	string	No description.
payloadType	string	No description.
recipients	string	No description.
region	string	No description.
routeKey	string	No description.
serviceKey	string	No description.
tags	string	No description.
teams	string	No description.
url	string	No description.
userId	string	No description.
internalValue	AlertChannelConfigA	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

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.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

apiKeyInput^Optional

public readonly apiKeyInput: string;

• Type: string

---

authPasswordInput^Optional

public readonly authPasswordInput: string;

• Type: string

---

authTypeInput^Optional

public readonly authTypeInput: string;

• Type: string

---

authUsernameInput^Optional

public readonly authUsernameInput: string;

• Type: string

---

baseUrlInput^Optional

public readonly baseUrlInput: string;

• Type: string

---

channelInput^Optional

public readonly channelInput: string;

• Type: string

---

headersInput^Optional

public readonly headersInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

headersStringInput^Optional

public readonly headersStringInput: string;

• Type: string

---

includeJsonAttachmentInput^Optional

public readonly includeJsonAttachmentInput: string;

• Type: string

---

keyInput^Optional

public readonly keyInput: string;

• Type: string

---

payloadInput^Optional

public readonly payloadInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

payloadStringInput^Optional

public readonly payloadStringInput: string;

• Type: string

---

payloadTypeInput^Optional

public readonly payloadTypeInput: string;

• Type: string

---

recipientsInput^Optional

public readonly recipientsInput: string;

• Type: string

---

regionInput^Optional

public readonly regionInput: string;

• Type: string

---

routeKeyInput^Optional

public readonly routeKeyInput: string;

• Type: string

---

serviceKeyInput^Optional

public readonly serviceKeyInput: string;

• Type: string

---

tagsInput^Optional

public readonly tagsInput: string;

• Type: string

---

teamsInput^Optional

public readonly teamsInput: string;

• Type: string

---

urlInput^Optional

public readonly urlInput: string;

• Type: string

---

userIdInput^Optional

public readonly userIdInput: string;

• Type: string

---

apiKey^Required

public readonly apiKey: string;

• Type: string

---

authPassword^Required

public readonly authPassword: string;

• Type: string

---

authType^Required

public readonly authType: string;

• Type: string

---

authUsername^Required

public readonly authUsername: string;

• Type: string

---

baseUrl^Required

public readonly baseUrl: string;

• Type: string

---

channel^Required

public readonly channel: string;

• Type: string

---

headers^Required

public readonly headers: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

headersString^Required

public readonly headersString: string;

• Type: string

---

includeJsonAttachment^Required

public readonly includeJsonAttachment: string;

• Type: string

---

key^Required

public readonly key: string;

• Type: string

---

payload^Required

public readonly payload: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

payloadString^Required

public readonly payloadString: string;

• Type: string

---

payloadType^Required

public readonly payloadType: string;

• Type: string

---

recipients^Required

public readonly recipients: string;

• Type: string

---

region^Required

public readonly region: string;

• Type: string

---

routeKey^Required

public readonly routeKey: string;

• Type: string

---

serviceKey^Required

public readonly serviceKey: string;

• Type: string

---

tags^Required

public readonly tags: string;

• Type: string

---

teams^Required

public readonly teams: string;

• Type: string

---

url^Required

public readonly url: string;

• Type: string

---

userId^Required

public readonly userId: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: AlertChannelConfigA;

• Type: AlertChannelConfigA

---