`googleMonitoringNotificationChannel` Submodule

Constructs

GoogleMonitoringNotificationChannel

Represents a {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_monitoring_notification_channel google_monitoring_notification_channel}.

Initializers

import { googleMonitoringNotificationChannel } from '@cdktf/provider-google-beta'

new googleMonitoringNotificationChannel.GoogleMonitoringNotificationChannel(scope: Construct, id: string, config: GoogleMonitoringNotificationChannelConfig)

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

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".
`putSensitiveLabels`	No description.
`putTimeouts`	No description.
`resetDescription`	No description.
`resetDisplayName`	No description.
`resetEnabled`	No description.
`resetForceDelete`	No description.
`resetId`	No description.
`resetLabels`	No description.
`resetProject`	No description.
`resetSensitiveLabels`	No description.
`resetTimeouts`	No description.
`resetUserLabels`	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".

`putSensitiveLabels`

public putSensitiveLabels(value: GoogleMonitoringNotificationChannelSensitiveLabels): void

`value`^Required

Type: GoogleMonitoringNotificationChannelSensitiveLabels

`putTimeouts`

public putTimeouts(value: GoogleMonitoringNotificationChannelTimeouts): void

`value`^Required

Type: GoogleMonitoringNotificationChannelTimeouts

`resetDescription`

public resetDescription(): void

`resetDisplayName`

public resetDisplayName(): void

`resetEnabled`

public resetEnabled(): void

`resetForceDelete`

public resetForceDelete(): void

`resetId`

public resetId(): void

`resetLabels`

public resetLabels(): void

`resetProject`

public resetProject(): void

`resetSensitiveLabels`

public resetSensitiveLabels(): void

`resetTimeouts`

public resetTimeouts(): void

`resetUserLabels`

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

`isConstruct`

import { googleMonitoringNotificationChannel } from '@cdktf/provider-google-beta'

googleMonitoringNotificationChannel.GoogleMonitoringNotificationChannel.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 { googleMonitoringNotificationChannel } from '@cdktf/provider-google-beta'

googleMonitoringNotificationChannel.GoogleMonitoringNotificationChannel.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { googleMonitoringNotificationChannel } from '@cdktf/provider-google-beta'

googleMonitoringNotificationChannel.GoogleMonitoringNotificationChannel.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { googleMonitoringNotificationChannel } from '@cdktf/provider-google-beta'

googleMonitoringNotificationChannel.GoogleMonitoringNotificationChannel.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

`importFromId`^Required

Type: string

The id of the existing GoogleMonitoringNotificationChannel that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_monitoring_notification_channel#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 GoogleMonitoringNotificationChannel 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.
`name`	`string`	No description.
`sensitiveLabels`	`GoogleMonitoringNotificationChannelSensitiveLabelsOutputReference`	No description.
`timeouts`	`GoogleMonitoringNotificationChannelTimeoutsOutputReference`	No description.
`verificationStatus`	`string`	No description.
`descriptionInput`	`string`	No description.
`displayNameInput`	`string`	No description.
`enabledInput`	`boolean \| cdktf.IResolvable`	No description.
`forceDeleteInput`	`boolean \| cdktf.IResolvable`	No description.
`idInput`	`string`	No description.
`labelsInput`	`{[ key: string ]: string}`	No description.
`projectInput`	`string`	No description.
`sensitiveLabelsInput`	`GoogleMonitoringNotificationChannelSensitiveLabels`	No description.
`timeoutsInput`	`cdktf.IResolvable \| GoogleMonitoringNotificationChannelTimeouts`	No description.
`typeInput`	`string`	No description.
`userLabelsInput`	`{[ key: string ]: string}`	No description.
`description`	`string`	No description.
`displayName`	`string`	No description.
`enabled`	`boolean \| cdktf.IResolvable`	No description.
`forceDelete`	`boolean \| cdktf.IResolvable`	No description.
`id`	`string`	No description.
`labels`	`{[ key: string ]: string}`	No description.
`project`	`string`	No description.
`type`	`string`	No description.
`userLabels`	`{[ key: string ]: 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[]

`name`^Required

public readonly name: string;

Type: string

`sensitiveLabels`^Required

public readonly sensitiveLabels: GoogleMonitoringNotificationChannelSensitiveLabelsOutputReference;

Type: GoogleMonitoringNotificationChannelSensitiveLabelsOutputReference

`timeouts`^Required

public readonly timeouts: GoogleMonitoringNotificationChannelTimeoutsOutputReference;

Type: GoogleMonitoringNotificationChannelTimeoutsOutputReference

`verificationStatus`^Required

public readonly verificationStatus: string;

Type: string

`descriptionInput`^Optional

public readonly descriptionInput: string;

Type: string

`displayNameInput`^Optional

public readonly displayNameInput: string;

Type: string

`enabledInput`^Optional

public readonly enabledInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`forceDeleteInput`^Optional

public readonly forceDeleteInput: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`idInput`^Optional

public readonly idInput: string;

Type: string

`labelsInput`^Optional

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

Type: {[ key: string ]: string}

`projectInput`^Optional

public readonly projectInput: string;

Type: string

`sensitiveLabelsInput`^Optional

public readonly sensitiveLabelsInput: GoogleMonitoringNotificationChannelSensitiveLabels;

Type: GoogleMonitoringNotificationChannelSensitiveLabels

`timeoutsInput`^Optional

public readonly timeoutsInput: IResolvable | GoogleMonitoringNotificationChannelTimeouts;

Type: cdktf.IResolvable | GoogleMonitoringNotificationChannelTimeouts

`typeInput`^Optional

public readonly typeInput: string;

Type: string

`userLabelsInput`^Optional

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

Type: {[ key: string ]: string}

`description`^Required

public readonly description: string;

Type: string

`displayName`^Required

public readonly displayName: string;

Type: string

`enabled`^Required

public readonly enabled: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`forceDelete`^Required

public readonly forceDelete: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

`id`^Required

public readonly id: string;

Type: string

`labels`^Required

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

Type: {[ key: string ]: string}

`project`^Required

public readonly project: string;

Type: string

`type`^Required

public readonly type: string;

Type: string

`userLabels`^Required

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

Type: {[ key: string ]: string}

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

GoogleMonitoringNotificationChannelConfig

Initializer

import { googleMonitoringNotificationChannel } from '@cdktf/provider-google-beta'

const googleMonitoringNotificationChannelConfig: googleMonitoringNotificationChannel.GoogleMonitoringNotificationChannelConfig = { ... }

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.
`type`	`string`	The type of the notification channel.
`description`	`string`	An optional human-readable description of this notification channel.
`displayName`	`string`	An optional human-readable name for this notification channel.
`enabled`	`boolean \| cdktf.IResolvable`	Whether notifications are forwarded to the described channel.
`forceDelete`	`boolean \| cdktf.IResolvable`	If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel).
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_monitoring_notification_channel#id GoogleMonitoringNotificationChannel#id}.
`labels`	`{[ key: string ]: string}`	Configuration fields that define the channel and its behavior.
`project`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_monitoring_notification_channel#project GoogleMonitoringNotificationChannel#project}.
`sensitiveLabels`	`GoogleMonitoringNotificationChannelSensitiveLabels`	sensitive_labels block.
`timeouts`	`GoogleMonitoringNotificationChannelTimeouts`	timeouts block.
`userLabels`	`{[ key: string ]: string}`	User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field.

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

`type`^Required

public readonly type: string;

Type: string

The type of the notification channel.

This field matches the value of the NotificationChannelDescriptor.type field. See https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.notificationChannelDescriptors/list to get the list of valid values such as "email", "slack", etc...

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_monitoring_notification_channel#type GoogleMonitoringNotificationChannel#type}

`description`^Optional

public readonly description: string;

Type: string

An optional human-readable description of this notification channel.

This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_monitoring_notification_channel#description GoogleMonitoringNotificationChannel#description}

`displayName`^Optional

public readonly displayName: string;

Type: string

An optional human-readable name for this notification channel.

It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_monitoring_notification_channel#display_name GoogleMonitoringNotificationChannel#display_name}

`enabled`^Optional

public readonly enabled: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

Whether notifications are forwarded to the described channel.

This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_monitoring_notification_channel#enabled GoogleMonitoringNotificationChannel#enabled}

`forceDelete`^Optional

public readonly forceDelete: boolean | IResolvable;

Type: boolean | cdktf.IResolvable

If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel).

If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_monitoring_notification_channel#force_delete GoogleMonitoringNotificationChannel#force_delete}

`id`^Optional

public readonly id: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_monitoring_notification_channel#id GoogleMonitoringNotificationChannel#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.

`labels`^Optional

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

Type: {[ key: string ]: string}

Configuration fields that define the channel and its behavior.

The permissible and required labels are specified in the NotificationChannelDescriptor corresponding to the type field.

Labels with sensitive data are obfuscated by the API and therefore Terraform cannot determine if there are upstream changes to these fields. They can also be configured via the sensitive_labels block, but cannot be configured in both places.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_monitoring_notification_channel#labels GoogleMonitoringNotificationChannel#labels}

`project`^Optional

public readonly project: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_monitoring_notification_channel#project GoogleMonitoringNotificationChannel#project}.

`sensitiveLabels`^Optional

public readonly sensitiveLabels: GoogleMonitoringNotificationChannelSensitiveLabels;

Type: GoogleMonitoringNotificationChannelSensitiveLabels

sensitive_labels block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_monitoring_notification_channel#sensitive_labels GoogleMonitoringNotificationChannel#sensitive_labels}

`timeouts`^Optional

public readonly timeouts: GoogleMonitoringNotificationChannelTimeouts;

Type: GoogleMonitoringNotificationChannelTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_monitoring_notification_channel#timeouts GoogleMonitoringNotificationChannel#timeouts}

`userLabels`^Optional

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

Type: {[ key: string ]: string}

User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field.

This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_monitoring_notification_channel#user_labels GoogleMonitoringNotificationChannel#user_labels}

GoogleMonitoringNotificationChannelSensitiveLabels

Initializer

import { googleMonitoringNotificationChannel } from '@cdktf/provider-google-beta'

const googleMonitoringNotificationChannelSensitiveLabels: googleMonitoringNotificationChannel.GoogleMonitoringNotificationChannelSensitiveLabels = { ... }

Properties

Name	Type	Description
`authToken`	`string`	An authorization token for a notification channel. Channel types that support this field include: slack.
`password`	`string`	An password for a notification channel. Channel types that support this field include: webhook_basicauth.
`serviceKey`	`string`	An servicekey token for a notification channel. Channel types that support this field include: pagerduty.

`authToken`^Optional

public readonly authToken: string;

Type: string

An authorization token for a notification channel. Channel types that support this field include: slack.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_monitoring_notification_channel#auth_token GoogleMonitoringNotificationChannel#auth_token}

`password`^Optional

public readonly password: string;

Type: string

An password for a notification channel. Channel types that support this field include: webhook_basicauth.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_monitoring_notification_channel#password GoogleMonitoringNotificationChannel#password}

`serviceKey`^Optional

public readonly serviceKey: string;

Type: string

An servicekey token for a notification channel. Channel types that support this field include: pagerduty.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_monitoring_notification_channel#service_key GoogleMonitoringNotificationChannel#service_key}

GoogleMonitoringNotificationChannelTimeouts

Initializer

import { googleMonitoringNotificationChannel } from '@cdktf/provider-google-beta'

const googleMonitoringNotificationChannelTimeouts: googleMonitoringNotificationChannel.GoogleMonitoringNotificationChannelTimeouts = { ... }

Properties

Name	Type	Description
`create`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_monitoring_notification_channel#create GoogleMonitoringNotificationChannel#create}.
`delete`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_monitoring_notification_channel#delete GoogleMonitoringNotificationChannel#delete}.
`update`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_monitoring_notification_channel#update GoogleMonitoringNotificationChannel#update}.

`create`^Optional

public readonly create: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_monitoring_notification_channel#create GoogleMonitoringNotificationChannel#create}.

`delete`^Optional

public readonly delete: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_monitoring_notification_channel#delete GoogleMonitoringNotificationChannel#delete}.

`update`^Optional

public readonly update: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.13.0/docs/resources/google_monitoring_notification_channel#update GoogleMonitoringNotificationChannel#update}.

Classes

GoogleMonitoringNotificationChannelSensitiveLabelsOutputReference

Initializers

import { googleMonitoringNotificationChannel } from '@cdktf/provider-google-beta'

new googleMonitoringNotificationChannel.GoogleMonitoringNotificationChannelSensitiveLabelsOutputReference(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.
`resetAuthToken`	No description.
`resetPassword`	No description.
`resetServiceKey`	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.

`resetAuthToken`

public resetAuthToken(): void

`resetPassword`

public resetPassword(): void

`resetServiceKey`

public resetServiceKey(): 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.
`authTokenInput`	`string`	No description.
`passwordInput`	`string`	No description.
`serviceKeyInput`	`string`	No description.
`authToken`	`string`	No description.
`password`	`string`	No description.
`serviceKey`	`string`	No description.
`internalValue`	`GoogleMonitoringNotificationChannelSensitiveLabels`	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

`authTokenInput`^Optional

public readonly authTokenInput: string;

Type: string

`passwordInput`^Optional

public readonly passwordInput: string;

Type: string

`serviceKeyInput`^Optional

public readonly serviceKeyInput: string;

Type: string

`authToken`^Required

public readonly authToken: string;

Type: string

`password`^Required

public readonly password: string;

Type: string

`serviceKey`^Required

public readonly serviceKey: string;

Type: string

`internalValue`^Optional

public readonly internalValue: GoogleMonitoringNotificationChannelSensitiveLabels;

Type: GoogleMonitoringNotificationChannelSensitiveLabels

GoogleMonitoringNotificationChannelTimeoutsOutputReference

Initializers

import { googleMonitoringNotificationChannel } from '@cdktf/provider-google-beta'

new googleMonitoringNotificationChannel.GoogleMonitoringNotificationChannelTimeoutsOutputReference(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.
`resetCreate`	No description.
`resetDelete`	No description.
`resetUpdate`	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.

`resetCreate`

public resetCreate(): void

`resetDelete`

public resetDelete(): void

`resetUpdate`

public resetUpdate(): 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.
`createInput`	`string`	No description.
`deleteInput`	`string`	No description.
`updateInput`	`string`	No description.
`create`	`string`	No description.
`delete`	`string`	No description.
`update`	`string`	No description.
`internalValue`	`cdktf.IResolvable \| GoogleMonitoringNotificationChannelTimeouts`	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

`createInput`^Optional

public readonly createInput: string;

Type: string

`deleteInput`^Optional

public readonly deleteInput: string;

Type: string

`updateInput`^Optional

public readonly updateInput: string;

Type: string

`create`^Required

public readonly create: string;

Type: string

`delete`^Required

public readonly delete: string;

Type: string

`update`^Required

public readonly update: string;

Type: string

`internalValue`^Optional

public readonly internalValue: IResolvable | GoogleMonitoringNotificationChannelTimeouts;

Type: cdktf.IResolvable | GoogleMonitoringNotificationChannelTimeouts

Files

googleMonitoringNotificationChannel.typescript.md

Latest commit

History

googleMonitoringNotificationChannel.typescript.md

File metadata and controls

googleMonitoringNotificationChannel Submodule

Constructs