teamNotificationConfiguration.typescript.md

teamNotificationConfiguration Submodule

Constructs

TeamNotificationConfiguration

Represents a {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team_notification_configuration tfe_team_notification_configuration}.

Initializers

import { teamNotificationConfiguration } from '@cdktf/provider-tfe'

new teamNotificationConfiguration.TeamNotificationConfiguration(scope: Construct, id: string, config: TeamNotificationConfigurationConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	TeamNotificationConfigurationConfig	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: TeamNotificationConfigurationConfig

---

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.
toHclTerraform	No description.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
addMoveTarget	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
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.
hasResourceMove	No description.
importFrom	No description.
interpolationForAttribute	No description.
moveFromId	Move the resource corresponding to "id" to this resource.
moveTo	Moves this resource to the target resource given by moveTarget.
moveToId	Moves this resource to the resource corresponding to "id".
resetEmailAddresses	No description.
resetEmailUserIds	No description.
resetEnabled	No description.
resetToken	No description.
resetTriggers	No description.
resetUrl	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.

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

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

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

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

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

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.

id^Required

• Type: string

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

---

moveTo

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

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

---

index^Optional

• Type: string | number

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

---

moveToId

public moveToId(id: string): void

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

id^Required

• Type: string

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

---

resetEmailAddresses

public resetEmailAddresses(): void

resetEmailUserIds

public resetEmailUserIds(): void

resetEnabled

public resetEnabled(): void

resetToken

public resetToken(): void

resetTriggers

public resetTriggers(): void

resetUrl

public resetUrl(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.
generateConfigForImport	Generates CDKTF code for importing a TeamNotificationConfiguration resource upon running "cdktf plan ".

---

isConstruct

import { teamNotificationConfiguration } from '@cdktf/provider-tfe'

teamNotificationConfiguration.TeamNotificationConfiguration.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 { teamNotificationConfiguration } from '@cdktf/provider-tfe'

teamNotificationConfiguration.TeamNotificationConfiguration.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { teamNotificationConfiguration } from '@cdktf/provider-tfe'

teamNotificationConfiguration.TeamNotificationConfiguration.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { teamNotificationConfiguration } from '@cdktf/provider-tfe'

teamNotificationConfiguration.TeamNotificationConfiguration.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

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

---

importFromId^Required

• Type: string

The id of the existing TeamNotificationConfiguration that should be imported.

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

---

provider^Optional

• Type: cdktf.TerraformProvider

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

---

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 | cdktf.TerraformCount	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.
id	string	No description.
destinationTypeInput	string	No description.
emailAddressesInput	string[]	No description.
emailUserIdsInput	string[]	No description.
enabledInput	boolean | cdktf.IResolvable	No description.
nameInput	string	No description.
teamIdInput	string	No description.
tokenInput	string	No description.
triggersInput	string[]	No description.
urlInput	string	No description.
destinationType	string	No description.
emailAddresses	string[]	No description.
emailUserIds	string[]	No description.
enabled	boolean | cdktf.IResolvable	No description.
name	string	No description.
teamId	string	No description.
token	string	No description.
triggers	string[]	No description.
url	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 | TerraformCount;

• Type: number | cdktf.TerraformCount

---

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[]

---

id^Required

public readonly id: string;

• Type: string

---

destinationTypeInput^Optional

public readonly destinationTypeInput: string;

• Type: string

---

emailAddressesInput^Optional

public readonly emailAddressesInput: string[];

• Type: string[]

---

emailUserIdsInput^Optional

public readonly emailUserIdsInput: string[];

• Type: string[]

---

enabledInput^Optional

public readonly enabledInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

teamIdInput^Optional

public readonly teamIdInput: string;

• Type: string

---

tokenInput^Optional

public readonly tokenInput: string;

• Type: string

---

triggersInput^Optional

public readonly triggersInput: string[];

• Type: string[]

---

urlInput^Optional

public readonly urlInput: string;

• Type: string

---

destinationType^Required

public readonly destinationType: string;

• Type: string

---

emailAddresses^Required

public readonly emailAddresses: string[];

• Type: string[]

---

emailUserIds^Required

public readonly emailUserIds: string[];

• Type: string[]

---

enabled^Required

public readonly enabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

name^Required

public readonly name: string;

• Type: string

---

teamId^Required

public readonly teamId: string;

• Type: string

---

token^Required

public readonly token: string;

• Type: string

---

triggers^Required

public readonly triggers: string[];

• Type: string[]

---

url^Required

public readonly url: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

TeamNotificationConfigurationConfig

Initializer

import { teamNotificationConfiguration } from '@cdktf/provider-tfe'

const teamNotificationConfigurationConfig: teamNotificationConfiguration.TeamNotificationConfigurationConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	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.
destinationType	string	The type of notification configuration payload to send.
name	string	Name of the team notification configuration.
teamId	string	The ID of the team that owns the notification configuration.
emailAddresses	string[]	A list of email addresses. This value must not be provided if destination_type is generic, microsoft-teams, or slack.
emailUserIds	string[]	A list of user IDs. This value must not be provided if destination_type is generic, microsoft-teams, or slack.
enabled	boolean | cdktf.IResolvable	Whether the team notification configuration should be enabled or not.
token	string	A write-only secure token for the notification configuration, which can be used by the receiving server to verify request authenticity when configured for notification configurations with a destination type of generic.
triggers	string[]	The array of triggers for which this team notification configuration will send notifications.
url	string	The HTTP or HTTPS URL where notification requests will be made.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

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[]

---

destinationType^Required

public readonly destinationType: string;

• Type: string

The type of notification configuration payload to send.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team_notification_configuration#destination_type TeamNotificationConfiguration#destination_type}

---

name^Required

public readonly name: string;

• Type: string

Name of the team notification configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team_notification_configuration#name TeamNotificationConfiguration#name}

---

teamId^Required

public readonly teamId: string;

• Type: string

The ID of the team that owns the notification configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team_notification_configuration#team_id TeamNotificationConfiguration#team_id}

---

emailAddresses^Optional

public readonly emailAddresses: string[];

• Type: string[]

A list of email addresses. This value must not be provided if destination_type is generic, microsoft-teams, or slack.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team_notification_configuration#email_addresses TeamNotificationConfiguration#email_addresses}

---

emailUserIds^Optional

public readonly emailUserIds: string[];

• Type: string[]

A list of user IDs. This value must not be provided if destination_type is generic, microsoft-teams, or slack.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team_notification_configuration#email_user_ids TeamNotificationConfiguration#email_user_ids}

---

enabled^Optional

public readonly enabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Whether the team notification configuration should be enabled or not.

Disabled configurations will not send any notifications. Defaults to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team_notification_configuration#enabled TeamNotificationConfiguration#enabled}

---

token^Optional

public readonly token: string;

• Type: string

A write-only secure token for the notification configuration, which can be used by the receiving server to verify request authenticity when configured for notification configurations with a destination type of generic.

Defaults to null. This value must not be provided if destination_type is email, microsoft-teams, or slack.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team_notification_configuration#token TeamNotificationConfiguration#token}

---

triggers^Optional

public readonly triggers: string[];

• Type: string[]

The array of triggers for which this team notification configuration will send notifications.

If omitted, no notification triggers are configured.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team_notification_configuration#triggers TeamNotificationConfiguration#triggers}

---

url^Optional

public readonly url: string;

• Type: string

The HTTP or HTTPS URL where notification requests will be made.

This value must not be provided if email_addresses or email_user_ids is present, or if destination_type is email.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/team_notification_configuration#url TeamNotificationConfiguration#url}

---