`googleMonitoringNotificationChannel` Submodule

Constructs

GoogleMonitoringNotificationChannel

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

Initializers

from cdktf_cdktf_provider_google_beta import google_monitoring_notification_channel

googleMonitoringNotificationChannel.GoogleMonitoringNotificationChannel(
  scope: Construct,
  id: str,
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  type: str,
  description: str = None,
  display_name: str = None,
  enabled: bool | IResolvable = None,
  force_delete: bool | IResolvable = None,
  id: str = None,
  labels: typing.Mapping[str] = None,
  project: str = None,
  sensitive_labels: GoogleMonitoringNotificationChannelSensitiveLabels = None,
  timeouts: GoogleMonitoringNotificationChannelTimeouts = None,
  user_labels: typing.Mapping[str] = None
)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`str`	The scoped construct ID.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktf.TerraformCount`	No description.
`depends_on`	`typing.List[cdktf.ITerraformDependable]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner]`	No description.
`type`	`str`	The type of the notification channel.
`description`	`str`	An optional human-readable description of this notification channel.
`display_name`	`str`	An optional human-readable name for this notification channel.
`enabled`	`bool \| cdktf.IResolvable`	Whether notifications are forwarded to the described channel.
`force_delete`	`bool \| 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`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_monitoring_notification_channel#id GoogleMonitoringNotificationChannel#id}.
`labels`	`typing.Mapping[str]`	Configuration fields that define the channel and its behavior.
`project`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_monitoring_notification_channel#project GoogleMonitoringNotificationChannel#project}.
`sensitive_labels`	`GoogleMonitoringNotificationChannelSensitiveLabels`	sensitive_labels block.
`timeouts`	`GoogleMonitoringNotificationChannelTimeouts`	timeouts block.
`user_labels`	`typing.Mapping[str]`	User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

`connection`^Optional

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

Type: typing.Union[int, float] | cdktf.TerraformCount

`depends_on`^Optional

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

Type: cdktf.TerraformProvider

`provisioners`^Optional

Type: typing.List[cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner]

`type`^Required

Type: str

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.50.0/docs/resources/google_monitoring_notification_channel#type GoogleMonitoringNotificationChannel#type}

`description`^Optional

Type: str

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.

`display_name`^Optional

Type: str

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.

`enabled`^Optional

Type: bool | 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.

`force_delete`^Optional

Type: bool | 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.

`id`^Optional

Type: str

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

Type: typing.Mapping[str]

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.

`project`^Optional

Type: str

`sensitive_labels`^Optional

Type: GoogleMonitoringNotificationChannelSensitiveLabels

sensitive_labels block.

`timeouts`^Optional

Type: GoogleMonitoringNotificationChannelTimeouts

timeouts block.

`user_labels`^Optional

Type: typing.Mapping[str]

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.

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`add_override`	No description.
`override_logical_id`	Overrides the auto-generated logical ID with a specific ID.
`reset_override_logical_id`	Resets a previously passed logical Id to use the auto-generated logical id again.
`to_hcl_terraform`	No description.
`to_metadata`	No description.
`to_terraform`	Adds this resource to the terraform JSON output.
`add_move_target`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`get_any_map_attribute`	No description.
`get_boolean_attribute`	No description.
`get_boolean_map_attribute`	No description.
`get_list_attribute`	No description.
`get_number_attribute`	No description.
`get_number_list_attribute`	No description.
`get_number_map_attribute`	No description.
`get_string_attribute`	No description.
`get_string_map_attribute`	No description.
`has_resource_move`	No description.
`import_from`	No description.
`interpolation_for_attribute`	No description.
`move_from_id`	Move the resource corresponding to "id" to this resource.
`move_to`	Moves this resource to the target resource given by moveTarget.
`move_to_id`	Moves this resource to the resource corresponding to "id".
`put_sensitive_labels`	No description.
`put_timeouts`	No description.
`reset_description`	No description.
`reset_display_name`	No description.
`reset_enabled`	No description.
`reset_force_delete`	No description.
`reset_id`	No description.
`reset_labels`	No description.
`reset_project`	No description.
`reset_sensitive_labels`	No description.
`reset_timeouts`	No description.
`reset_user_labels`	No description.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`add_override`

def add_override(
  path: str,
  value: typing.Any
) -> None

`path`^Required

Type: str

`value`^Required

Type: typing.Any

`override_logical_id`

def override_logical_id(
  new_logical_id: str
) -> None

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

`new_logical_id`^Required

Type: str

The new logical ID to use for this stack element.

`reset_override_logical_id`

def reset_override_logical_id() -> None

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

`to_hcl_terraform`

def to_hcl_terraform() -> typing.Any

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`add_move_target`

def add_move_target(
  move_target: str
) -> None

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

`move_target`^Required

Type: str

The string move target that will correspond to this resource.

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`has_resource_move`

def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveById

`import_from`

def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None

`id`^Required

Type: str

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolation_for_attribute`

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`move_from_id`

def move_from_id(
  id: str
) -> None

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: str

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

`move_to`

def move_to(
  move_target: str,
  index: str | typing.Union[int, float] = None
) -> None

Moves this resource to the target resource given by moveTarget.

`move_target`^Required

Type: str

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

`index`^Optional

Type: str | typing.Union[int, float]

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

`move_to_id`

def move_to_id(
  id: str
) -> None

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

`id`^Required

Type: str

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

`put_sensitive_labels`

def put_sensitive_labels(
  auth_token: str = None,
  password: str = None,
  service_key: str = None
) -> None

`auth_token`^Optional

Type: str

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

`password`^Optional

Type: str

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

`service_key`^Optional

Type: str

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

`put_timeouts`

def put_timeouts(
  create: str = None,
  delete: str = None,
  update: str = None
) -> None

`create`^Optional

Type: str

`delete`^Optional

Type: str

`update`^Optional

Type: str

`reset_description`

def reset_description() -> None

`reset_display_name`

def reset_display_name() -> None

`reset_enabled`

def reset_enabled() -> None

`reset_force_delete`

def reset_force_delete() -> None

`reset_id`

def reset_id() -> None

`reset_labels`

def reset_labels() -> None

`reset_project`

def reset_project() -> None

`reset_sensitive_labels`

def reset_sensitive_labels() -> None

`reset_timeouts`

def reset_timeouts() -> None

`reset_user_labels`

def reset_user_labels() -> None

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.
`is_terraform_element`	No description.
`is_terraform_resource`	No description.
`generate_config_for_import`	Generates CDKTF code for importing a GoogleMonitoringNotificationChannel resource upon running "cdktf plan ".

`is_construct`

from cdktf_cdktf_provider_google_beta import google_monitoring_notification_channel

googleMonitoringNotificationChannel.GoogleMonitoringNotificationChannel.is_construct(
  x: typing.Any
)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`x`^Required

Type: typing.Any

Any object.

`is_terraform_element`

from cdktf_cdktf_provider_google_beta import google_monitoring_notification_channel

googleMonitoringNotificationChannel.GoogleMonitoringNotificationChannel.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_resource`

from cdktf_cdktf_provider_google_beta import google_monitoring_notification_channel

googleMonitoringNotificationChannel.GoogleMonitoringNotificationChannel.is_terraform_resource(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

from cdktf_cdktf_provider_google_beta import google_monitoring_notification_channel

googleMonitoringNotificationChannel.GoogleMonitoringNotificationChannel.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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.

`import_to_id`^Required

Type: str

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

`import_from_id`^Required

Type: str

The id of the existing GoogleMonitoringNotificationChannel that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.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.
`cdktf_stack`	`cdktf.TerraformStack`	No description.
`fqn`	`str`	No description.
`friendly_unique_id`	`str`	No description.
`terraform_meta_arguments`	`typing.Mapping[typing.Any]`	No description.
`terraform_resource_type`	`str`	No description.
`terraform_generator_metadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktf.TerraformCount`	No description.
`depends_on`	`typing.List[str]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner]`	No description.
`name`	`str`	No description.
`sensitive_labels`	`GoogleMonitoringNotificationChannelSensitiveLabelsOutputReference`	No description.
`timeouts`	`GoogleMonitoringNotificationChannelTimeoutsOutputReference`	No description.
`verification_status`	`str`	No description.
`description_input`	`str`	No description.
`display_name_input`	`str`	No description.
`enabled_input`	`bool \| cdktf.IResolvable`	No description.
`force_delete_input`	`bool \| cdktf.IResolvable`	No description.
`id_input`	`str`	No description.
`labels_input`	`typing.Mapping[str]`	No description.
`project_input`	`str`	No description.
`sensitive_labels_input`	`GoogleMonitoringNotificationChannelSensitiveLabels`	No description.
`timeouts_input`	`cdktf.IResolvable \| GoogleMonitoringNotificationChannelTimeouts`	No description.
`type_input`	`str`	No description.
`user_labels_input`	`typing.Mapping[str]`	No description.
`description`	`str`	No description.
`display_name`	`str`	No description.
`enabled`	`bool \| cdktf.IResolvable`	No description.
`force_delete`	`bool \| cdktf.IResolvable`	No description.
`id`	`str`	No description.
`labels`	`typing.Mapping[str]`	No description.
`project`	`str`	No description.
`type`	`str`	No description.
`user_labels`	`typing.Mapping[str]`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: cdktf.TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`terraform_meta_arguments`^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | cdktf.TerraformCount

`depends_on`^Optional

depends_on: typing.List[str]

Type: typing.List[str]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

Type: typing.List[cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner]

`name`^Required

name: str

Type: str

`sensitive_labels`^Required

sensitive_labels: GoogleMonitoringNotificationChannelSensitiveLabelsOutputReference

Type: GoogleMonitoringNotificationChannelSensitiveLabelsOutputReference

`timeouts`^Required

timeouts: GoogleMonitoringNotificationChannelTimeoutsOutputReference

Type: GoogleMonitoringNotificationChannelTimeoutsOutputReference

`verification_status`^Required

verification_status: str

Type: str

`description_input`^Optional

description_input: str

Type: str

`display_name_input`^Optional

display_name_input: str

Type: str

`enabled_input`^Optional

enabled_input: bool | IResolvable

Type: bool | cdktf.IResolvable

`force_delete_input`^Optional

force_delete_input: bool | IResolvable

Type: bool | cdktf.IResolvable

`id_input`^Optional

id_input: str

Type: str

`labels_input`^Optional

labels_input: typing.Mapping[str]

Type: typing.Mapping[str]

`project_input`^Optional

project_input: str

Type: str

`sensitive_labels_input`^Optional

sensitive_labels_input: GoogleMonitoringNotificationChannelSensitiveLabels

Type: GoogleMonitoringNotificationChannelSensitiveLabels

`timeouts_input`^Optional

timeouts_input: IResolvable | GoogleMonitoringNotificationChannelTimeouts

Type: cdktf.IResolvable | GoogleMonitoringNotificationChannelTimeouts

`type_input`^Optional

type_input: str

Type: str

`user_labels_input`^Optional

user_labels_input: typing.Mapping[str]

Type: typing.Mapping[str]

`description`^Required

description: str

Type: str

`display_name`^Required

display_name: str

Type: str

`enabled`^Required

enabled: bool | IResolvable

Type: bool | cdktf.IResolvable

`force_delete`^Required

force_delete: bool | IResolvable

Type: bool | cdktf.IResolvable

`id`^Required

id: str

Type: str

`labels`^Required

labels: typing.Mapping[str]

Type: typing.Mapping[str]

`project`^Required

project: str

Type: str

`type`^Required

type: str

Type: str

`user_labels`^Required

user_labels: typing.Mapping[str]

Type: typing.Mapping[str]

Constants

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

`tfResourceType`^Required

tfResourceType: str

Type: str

Structs

GoogleMonitoringNotificationChannelConfig

Initializer

from cdktf_cdktf_provider_google_beta import google_monitoring_notification_channel

googleMonitoringNotificationChannel.GoogleMonitoringNotificationChannelConfig(
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  type: str,
  description: str = None,
  display_name: str = None,
  enabled: bool | IResolvable = None,
  force_delete: bool | IResolvable = None,
  id: str = None,
  labels: typing.Mapping[str] = None,
  project: str = None,
  sensitive_labels: GoogleMonitoringNotificationChannelSensitiveLabels = None,
  timeouts: GoogleMonitoringNotificationChannelTimeouts = None,
  user_labels: typing.Mapping[str] = None
)

Properties

Name	Type	Description
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| cdktf.TerraformCount`	No description.
`depends_on`	`typing.List[cdktf.ITerraformDependable]`	No description.
`for_each`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`typing.List[cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner]`	No description.
`type`	`str`	The type of the notification channel.
`description`	`str`	An optional human-readable description of this notification channel.
`display_name`	`str`	An optional human-readable name for this notification channel.
`enabled`	`bool \| cdktf.IResolvable`	Whether notifications are forwarded to the described channel.
`force_delete`	`bool \| 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`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_monitoring_notification_channel#id GoogleMonitoringNotificationChannel#id}.
`labels`	`typing.Mapping[str]`	Configuration fields that define the channel and its behavior.
`project`	`str`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.50.0/docs/resources/google_monitoring_notification_channel#project GoogleMonitoringNotificationChannel#project}.
`sensitive_labels`	`GoogleMonitoringNotificationChannelSensitiveLabels`	sensitive_labels block.
`timeouts`	`GoogleMonitoringNotificationChannelTimeouts`	timeouts block.
`user_labels`	`typing.Mapping[str]`	User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field.

`connection`^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | cdktf.TerraformCount

`depends_on`^Optional

depends_on: typing.List[ITerraformDependable]

Type: typing.List[cdktf.ITerraformDependable]

`for_each`^Optional

for_each: ITerraformIterator

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: cdktf.TerraformProvider

`provisioners`^Optional

provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

Type: typing.List[cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner]

`type`^Required

type: str

Type: str

The type of the notification channel.

`description`^Optional

description: str

Type: str

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.

`display_name`^Optional

display_name: str

Type: str

An optional human-readable name for this notification channel.

`enabled`^Optional

enabled: bool | IResolvable

Type: bool | cdktf.IResolvable

Whether notifications are forwarded to the described channel.

`force_delete`^Optional

force_delete: bool | IResolvable

Type: bool | 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.

`id`^Optional

id: str

Type: str

`labels`^Optional

labels: typing.Mapping[str]

Type: typing.Mapping[str]

Configuration fields that define the channel and its behavior.

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

`project`^Optional

project: str

Type: str

`sensitive_labels`^Optional

sensitive_labels: GoogleMonitoringNotificationChannelSensitiveLabels

Type: GoogleMonitoringNotificationChannelSensitiveLabels

sensitive_labels block.

`timeouts`^Optional

timeouts: GoogleMonitoringNotificationChannelTimeouts

Type: GoogleMonitoringNotificationChannelTimeouts

timeouts block.

`user_labels`^Optional

user_labels: typing.Mapping[str]

Type: typing.Mapping[str]

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

GoogleMonitoringNotificationChannelSensitiveLabels

Initializer

from cdktf_cdktf_provider_google_beta import google_monitoring_notification_channel

googleMonitoringNotificationChannel.GoogleMonitoringNotificationChannelSensitiveLabels(
  auth_token: str = None,
  password: str = None,
  service_key: str = None
)

Properties

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

`auth_token`^Optional

auth_token: str

Type: str

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

`password`^Optional

password: str

Type: str

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

`service_key`^Optional

service_key: str

Type: str

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

GoogleMonitoringNotificationChannelTimeouts

Initializer

from cdktf_cdktf_provider_google_beta import google_monitoring_notification_channel

googleMonitoringNotificationChannel.GoogleMonitoringNotificationChannelTimeouts(
  create: str = None,
  delete: str = None,
  update: str = None
)

Properties

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

`create`^Optional

create: str

Type: str

`delete`^Optional

delete: str

Type: str

`update`^Optional

update: str

Type: str

Classes

GoogleMonitoringNotificationChannelSensitiveLabelsOutputReference

Initializers

from cdktf_cdktf_provider_google_beta import google_monitoring_notification_channel

googleMonitoringNotificationChannel.GoogleMonitoringNotificationChannelSensitiveLabelsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

Name	Type	Description
`terraform_resource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraform_attribute`	`str`	The attribute on the parent resource this class is referencing.

`terraform_resource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

Type: str

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`compute_fqn`	No description.
`get_any_map_attribute`	No description.
`get_boolean_attribute`	No description.
`get_boolean_map_attribute`	No description.
`get_list_attribute`	No description.
`get_number_attribute`	No description.
`get_number_list_attribute`	No description.
`get_number_map_attribute`	No description.
`get_string_attribute`	No description.
`get_string_map_attribute`	No description.
`interpolation_for_attribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`to_string`	Return a string representation of this resolvable object.
`reset_auth_token`	No description.
`reset_password`	No description.
`reset_service_key`	No description.

`compute_fqn`

def compute_fqn() -> str

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  property: str
) -> IResolvable

`property`^Required

Type: str

`resolve`

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`to_string`

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

`reset_auth_token`

def reset_auth_token() -> None

`reset_password`

def reset_password() -> None

`reset_service_key`

def reset_service_key() -> None

Properties

Name	Type	Description
`creation_stack`	`typing.List[str]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`str`	No description.
`auth_token_input`	`str`	No description.
`password_input`	`str`	No description.
`service_key_input`	`str`	No description.
`auth_token`	`str`	No description.
`password`	`str`	No description.
`service_key`	`str`	No description.
`internal_value`	`GoogleMonitoringNotificationChannelSensitiveLabels`	No description.

`creation_stack`^Required

creation_stack: typing.List[str]

Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

fqn: str

Type: str

`auth_token_input`^Optional

auth_token_input: str

Type: str

`password_input`^Optional

password_input: str

Type: str

`service_key_input`^Optional

service_key_input: str

Type: str

`auth_token`^Required

auth_token: str

Type: str

`password`^Required

password: str

Type: str

`service_key`^Required

service_key: str

Type: str

`internal_value`^Optional

internal_value: GoogleMonitoringNotificationChannelSensitiveLabels

Type: GoogleMonitoringNotificationChannelSensitiveLabels

GoogleMonitoringNotificationChannelTimeoutsOutputReference

Initializers

from cdktf_cdktf_provider_google_beta import google_monitoring_notification_channel

googleMonitoringNotificationChannel.GoogleMonitoringNotificationChannelTimeoutsOutputReference(
  terraform_resource: IInterpolatingParent,
  terraform_attribute: str
)

Name	Type	Description
`terraform_resource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraform_attribute`	`str`	The attribute on the parent resource this class is referencing.

`terraform_resource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraform_attribute`^Required

Type: str

The attribute on the parent resource this class is referencing.

Methods

Name	Description
`compute_fqn`	No description.
`get_any_map_attribute`	No description.
`get_boolean_attribute`	No description.
`get_boolean_map_attribute`	No description.
`get_list_attribute`	No description.
`get_number_attribute`	No description.
`get_number_list_attribute`	No description.
`get_number_map_attribute`	No description.
`get_string_attribute`	No description.
`get_string_map_attribute`	No description.
`interpolation_for_attribute`	No description.
`resolve`	Produce the Token's value at resolution time.
`to_string`	Return a string representation of this resolvable object.
`reset_create`	No description.
`reset_delete`	No description.
`reset_update`	No description.

`compute_fqn`

def compute_fqn() -> str

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`interpolation_for_attribute`

def interpolation_for_attribute(
  property: str
) -> IResolvable

`property`^Required

Type: str

`resolve`

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`to_string`

def to_string() -> str

Return a string representation of this resolvable object.

Returns a reversible string representation.

`reset_create`

def reset_create() -> None

`reset_delete`

def reset_delete() -> None

`reset_update`

def reset_update() -> None

Properties

Name	Type	Description
`creation_stack`	`typing.List[str]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`str`	No description.
`create_input`	`str`	No description.
`delete_input`	`str`	No description.
`update_input`	`str`	No description.
`create`	`str`	No description.
`delete`	`str`	No description.
`update`	`str`	No description.
`internal_value`	`cdktf.IResolvable \| GoogleMonitoringNotificationChannelTimeouts`	No description.

`creation_stack`^Required

creation_stack: typing.List[str]

Type: typing.List[str]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

`fqn`^Required

fqn: str

Type: str

`create_input`^Optional

create_input: str

Type: str

`delete_input`^Optional

delete_input: str

Type: str

`update_input`^Optional

update_input: str

Type: str

`create`^Required

create: str

Type: str

`delete`^Required

delete: str

Type: str

`update`^Required

update: str

Type: str

`internal_value`^Optional

internal_value: IResolvable | GoogleMonitoringNotificationChannelTimeouts

Type: cdktf.IResolvable | GoogleMonitoringNotificationChannelTimeouts

FilesExpand file tree

googleMonitoringNotificationChannel.python.md

Latest commit

History

googleMonitoringNotificationChannel.python.md

File metadata and controls

googleMonitoringNotificationChannel Submodule

Constructs