thirdPartyIntegration.typescript.md

thirdPartyIntegration Submodule

Constructs

ThirdPartyIntegration

Represents a {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration mongodbatlas_third_party_integration}.

Initializers

import { thirdPartyIntegration } from '@cdktf/provider-mongodbatlas'

new thirdPartyIntegration.ThirdPartyIntegration(scope: Construct, id: string, config: ThirdPartyIntegrationConfig)

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

---

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".
resetApiKey	No description.
resetChannelName	No description.
resetEnabled	No description.
resetMicrosoftTeamsWebhookUrl	No description.
resetPassword	No description.
resetRegion	No description.
resetRoutingKey	No description.
resetSecret	No description.
resetServiceDiscovery	No description.
resetServiceKey	No description.
resetTeamName	No description.
resetUrl	No description.
resetUserName	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".

---

resetApiKey

public resetApiKey(): void

resetChannelName

public resetChannelName(): void

resetEnabled

public resetEnabled(): void

resetMicrosoftTeamsWebhookUrl

public resetMicrosoftTeamsWebhookUrl(): void

resetPassword

public resetPassword(): void

resetRegion

public resetRegion(): void

resetRoutingKey

public resetRoutingKey(): void

resetSecret

public resetSecret(): void

resetServiceDiscovery

public resetServiceDiscovery(): void

resetServiceKey

public resetServiceKey(): void

resetTeamName

public resetTeamName(): void

resetUrl

public resetUrl(): void

resetUserName

public resetUserName(): 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 ThirdPartyIntegration resource upon running "cdktf plan ".

---

isConstruct

import { thirdPartyIntegration } from '@cdktf/provider-mongodbatlas'

thirdPartyIntegration.ThirdPartyIntegration.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 { thirdPartyIntegration } from '@cdktf/provider-mongodbatlas'

thirdPartyIntegration.ThirdPartyIntegration.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { thirdPartyIntegration } from '@cdktf/provider-mongodbatlas'

thirdPartyIntegration.ThirdPartyIntegration.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { thirdPartyIntegration } from '@cdktf/provider-mongodbatlas'

thirdPartyIntegration.ThirdPartyIntegration.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a ThirdPartyIntegration 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 ThirdPartyIntegration to import.

---

importFromId^Required

• Type: string

The id of the existing ThirdPartyIntegration that should be imported.

Refer to the {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#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 ThirdPartyIntegration 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.
apiKeyInput	string	No description.
channelNameInput	string	No description.
enabledInput	boolean | cdktf.IResolvable	No description.
microsoftTeamsWebhookUrlInput	string	No description.
passwordInput	string	No description.
projectIdInput	string	No description.
regionInput	string	No description.
routingKeyInput	string	No description.
secretInput	string	No description.
serviceDiscoveryInput	string	No description.
serviceKeyInput	string	No description.
teamNameInput	string	No description.
typeInput	string	No description.
urlInput	string	No description.
userNameInput	string	No description.
apiKey	string	No description.
channelName	string	No description.
enabled	boolean | cdktf.IResolvable	No description.
microsoftTeamsWebhookUrl	string	No description.
password	string	No description.
projectId	string	No description.
region	string	No description.
routingKey	string	No description.
secret	string	No description.
serviceDiscovery	string	No description.
serviceKey	string	No description.
teamName	string	No description.
type	string	No description.
url	string	No description.
userName	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

---

apiKeyInput^Optional

public readonly apiKeyInput: string;

• Type: string

---

channelNameInput^Optional

public readonly channelNameInput: string;

• Type: string

---

enabledInput^Optional

public readonly enabledInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

microsoftTeamsWebhookUrlInput^Optional

public readonly microsoftTeamsWebhookUrlInput: string;

• Type: string

---

passwordInput^Optional

public readonly passwordInput: string;

• Type: string

---

projectIdInput^Optional

public readonly projectIdInput: string;

• Type: string

---

regionInput^Optional

public readonly regionInput: string;

• Type: string

---

routingKeyInput^Optional

public readonly routingKeyInput: string;

• Type: string

---

secretInput^Optional

public readonly secretInput: string;

• Type: string

---

serviceDiscoveryInput^Optional

public readonly serviceDiscoveryInput: string;

• Type: string

---

serviceKeyInput^Optional

public readonly serviceKeyInput: string;

• Type: string

---

teamNameInput^Optional

public readonly teamNameInput: string;

• Type: string

---

typeInput^Optional

public readonly typeInput: string;

• Type: string

---

urlInput^Optional

public readonly urlInput: string;

• Type: string

---

userNameInput^Optional

public readonly userNameInput: string;

• Type: string

---

apiKey^Required

public readonly apiKey: string;

• Type: string

---

channelName^Required

public readonly channelName: string;

• Type: string

---

enabled^Required

public readonly enabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

microsoftTeamsWebhookUrl^Required

public readonly microsoftTeamsWebhookUrl: string;

• Type: string

---

password^Required

public readonly password: string;

• Type: string

---

projectId^Required

public readonly projectId: string;

• Type: string

---

region^Required

public readonly region: string;

• Type: string

---

routingKey^Required

public readonly routingKey: string;

• Type: string

---

secret^Required

public readonly secret: string;

• Type: string

---

serviceDiscovery^Required

public readonly serviceDiscovery: string;

• Type: string

---

serviceKey^Required

public readonly serviceKey: string;

• Type: string

---

teamName^Required

public readonly teamName: string;

• Type: string

---

type^Required

public readonly type: string;

• Type: string

---

url^Required

public readonly url: string;

• Type: string

---

userName^Required

public readonly userName: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

ThirdPartyIntegrationConfig

Initializer

import { thirdPartyIntegration } from '@cdktf/provider-mongodbatlas'

const thirdPartyIntegrationConfig: thirdPartyIntegration.ThirdPartyIntegrationConfig = { ... }

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.
projectId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#project_id ThirdPartyIntegration#project_id}.
type	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#type ThirdPartyIntegration#type}.
apiKey	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#api_key ThirdPartyIntegration#api_key}.
channelName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#channel_name ThirdPartyIntegration#channel_name}.
enabled	boolean | cdktf.IResolvable	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#enabled ThirdPartyIntegration#enabled}.
microsoftTeamsWebhookUrl	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#microsoft_teams_webhook_url ThirdPartyIntegration#microsoft_teams_webhook_url}.
password	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#password ThirdPartyIntegration#password}.
region	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#region ThirdPartyIntegration#region}.
routingKey	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#routing_key ThirdPartyIntegration#routing_key}.
secret	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#secret ThirdPartyIntegration#secret}.
serviceDiscovery	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#service_discovery ThirdPartyIntegration#service_discovery}.
serviceKey	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#service_key ThirdPartyIntegration#service_key}.
teamName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#team_name ThirdPartyIntegration#team_name}.
url	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#url ThirdPartyIntegration#url}.
userName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#user_name ThirdPartyIntegration#user_name}.

---

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

---

projectId^Required

public readonly projectId: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#project_id ThirdPartyIntegration#project_id}.

---

type^Required

public readonly type: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#type ThirdPartyIntegration#type}.

---

apiKey^Optional

public readonly apiKey: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#api_key ThirdPartyIntegration#api_key}.

---

channelName^Optional

public readonly channelName: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#channel_name ThirdPartyIntegration#channel_name}.

---

enabled^Optional

public readonly enabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#enabled ThirdPartyIntegration#enabled}.

---

microsoftTeamsWebhookUrl^Optional

public readonly microsoftTeamsWebhookUrl: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#microsoft_teams_webhook_url ThirdPartyIntegration#microsoft_teams_webhook_url}.

---

password^Optional

public readonly password: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#password ThirdPartyIntegration#password}.

---

region^Optional

public readonly region: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#region ThirdPartyIntegration#region}.

---

routingKey^Optional

public readonly routingKey: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#routing_key ThirdPartyIntegration#routing_key}.

---

secret^Optional

public readonly secret: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#secret ThirdPartyIntegration#secret}.

---

serviceDiscovery^Optional

public readonly serviceDiscovery: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#service_discovery ThirdPartyIntegration#service_discovery}.

---

serviceKey^Optional

public readonly serviceKey: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#service_key ThirdPartyIntegration#service_key}.

---

teamName^Optional

public readonly teamName: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#team_name ThirdPartyIntegration#team_name}.

---

url^Optional

public readonly url: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#url ThirdPartyIntegration#url}.

---

userName^Optional

public readonly userName: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/mongodb/mongodbatlas/1.27.0/docs/resources/third_party_integration#user_name ThirdPartyIntegration#user_name}.

---