Represents a {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/notification_configuration tfe_notification_configuration}.
from cdktf_cdktf_provider_tfe import notification_configuration
notificationConfiguration.NotificationConfiguration(
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,
destination_type: str,
name: str,
workspace_id: str,
email_addresses: typing.List[str] = None,
email_user_ids: typing.List[str] = None,
enabled: bool | IResolvable = None,
token: str = None,
token_wo: str = None,
triggers: typing.List[str] = None,
url: 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. |
destination_type |
str |
The type of notification configuration payload to send. |
name |
str |
Name of the notification configuration. |
workspace_id |
str |
The ID of the workspace that owns the notification configuration. |
email_addresses |
typing.List[str] |
A list of email addresses. This value must not be provided if destination_type is generic, microsoft-teams, or slack. |
email_user_ids |
typing.List[str] |
A list of user IDs. This value must not be provided if destination_type is generic, microsoft-teams, or slack. |
enabled |
bool | cdktf.IResolvable |
Whether the notification configuration should be enabled or not. Disabled configurations will not send any notifications. Defaults to false. |
token |
str |
A write-only secure token for the notification configuration, which can be used by the receiving server to verify request authenticity when configured for notification configurations with a destination type of generic. |
token_wo |
str |
Value of the token in write-only mode. |
triggers |
typing.List[str] |
The array of triggers for which this notification configuration will send notifications. If omitted, no notification triggers are configured. |
url |
str |
The HTTP or HTTPS URL where notification requests will be made. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: str
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
- Type: typing.Union[int, float] | cdktf.TerraformCount
- Type: typing.List[cdktf.ITerraformDependable]
- Type: cdktf.ITerraformIterator
- Type: cdktf.TerraformResourceLifecycle
- Type: cdktf.TerraformProvider
- Type: typing.List[cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner]
- Type: str
The type of notification configuration payload to send.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/notification_configuration#destination_type NotificationConfiguration#destination_type}
- Type: str
Name of the notification configuration.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/notification_configuration#name NotificationConfiguration#name}
- Type: str
The ID of the workspace that owns the notification configuration.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/notification_configuration#workspace_id NotificationConfiguration#workspace_id}
- Type: typing.List[str]
A list of email addresses. This value must not be provided if destination_type is generic, microsoft-teams, or slack.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/notification_configuration#email_addresses NotificationConfiguration#email_addresses}
- Type: typing.List[str]
A list of user IDs. This value must not be provided if destination_type is generic, microsoft-teams, or slack.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/notification_configuration#email_user_ids NotificationConfiguration#email_user_ids}
- Type: bool | cdktf.IResolvable
Whether the notification configuration should be enabled or not. Disabled configurations will not send any notifications. Defaults to false.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/notification_configuration#enabled NotificationConfiguration#enabled}
- Type: str
A write-only secure token for the notification configuration, which can be used by the receiving server to verify request authenticity when configured for notification configurations with a destination type of generic.
Defaults to null. This value must not be provided if destination_type is email, microsoft-teams, or slack.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/notification_configuration#token NotificationConfiguration#token}
- Type: str
Value of the token in write-only mode.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/notification_configuration#token_wo NotificationConfiguration#token_wo}
- Type: typing.List[str]
The array of triggers for which this notification configuration will send notifications. If omitted, no notification triggers are configured.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/notification_configuration#triggers NotificationConfiguration#triggers}
- Type: str
The HTTP or HTTPS URL where notification requests will be made.
This value must not be provided if email_addresses or email_user_ids is present, or if destination_type is email.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/notification_configuration#url NotificationConfiguration#url}
| 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". |
reset_email_addresses |
No description. |
reset_email_user_ids |
No description. |
reset_enabled |
No description. |
reset_token |
No description. |
reset_token_wo |
No description. |
reset_triggers |
No description. |
reset_url |
No description. |
def to_string() -> strReturns a string representation of this construct.
def add_override(
path: str,
value: typing.Any
) -> None- Type: str
- Type: typing.Any
def override_logical_id(
new_logical_id: str
) -> NoneOverrides the auto-generated logical ID with a specific ID.
- Type: str
The new logical ID to use for this stack element.
def reset_override_logical_id() -> NoneResets a previously passed logical Id to use the auto-generated logical id again.
def to_hcl_terraform() -> typing.Anydef to_metadata() -> typing.Anydef to_terraform() -> typing.AnyAdds this resource to the terraform JSON output.
def add_move_target(
move_target: str
) -> NoneAdds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
- Type: str
The string move target that will correspond to this resource.
def get_any_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Any]- Type: str
def get_boolean_attribute(
terraform_attribute: str
) -> IResolvable- Type: str
def get_boolean_map_attribute(
terraform_attribute: str
) -> typing.Mapping[bool]- Type: str
def get_list_attribute(
terraform_attribute: str
) -> typing.List[str]- Type: str
def get_number_attribute(
terraform_attribute: str
) -> typing.Union[int, float]- Type: str
def get_number_list_attribute(
terraform_attribute: str
) -> typing.List[typing.Union[int, float]]- Type: str
def get_number_map_attribute(
terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]- Type: str
def get_string_attribute(
terraform_attribute: str
) -> str- Type: str
def get_string_map_attribute(
terraform_attribute: str
) -> typing.Mapping[str]- Type: str
def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveByIddef import_from(
id: str,
provider: TerraformProvider = None
) -> None- Type: str
- Type: cdktf.TerraformProvider
def interpolation_for_attribute(
terraform_attribute: str
) -> IResolvable- Type: str
def move_from_id(
id: str
) -> NoneMove 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.
- Type: str
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
def move_to(
move_target: str,
index: str | typing.Union[int, float] = None
) -> NoneMoves this resource to the target resource given by moveTarget.
- Type: str
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- 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.
def move_to_id(
id: str
) -> NoneMoves this resource to the resource corresponding to "id".
- Type: str
Full id of resource to move to, e.g. "aws_s3_bucket.example".
def reset_email_addresses() -> Nonedef reset_email_user_ids() -> Nonedef reset_enabled() -> Nonedef reset_token() -> Nonedef reset_token_wo() -> Nonedef reset_triggers() -> Nonedef reset_url() -> None| 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 NotificationConfiguration resource upon running "cdktf plan ". |
from cdktf_cdktf_provider_tfe import notification_configuration
notificationConfiguration.NotificationConfiguration.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.
- Type: typing.Any
Any object.
from cdktf_cdktf_provider_tfe import notification_configuration
notificationConfiguration.NotificationConfiguration.is_terraform_element(
x: typing.Any
)- Type: typing.Any
from cdktf_cdktf_provider_tfe import notification_configuration
notificationConfiguration.NotificationConfiguration.is_terraform_resource(
x: typing.Any
)- Type: typing.Any
from cdktf_cdktf_provider_tfe import notification_configuration
notificationConfiguration.NotificationConfiguration.generate_config_for_import(
scope: Construct,
import_to_id: str,
import_from_id: str,
provider: TerraformProvider = None
)Generates CDKTF code for importing a NotificationConfiguration resource upon running "cdktf plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: str
The construct id used in the generated config for the NotificationConfiguration to import.
- Type: str
The id of the existing NotificationConfiguration that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/notification_configuration#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the NotificationConfiguration to import is found.
| 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. |
id |
str |
No description. |
destination_type_input |
str |
No description. |
email_addresses_input |
typing.List[str] |
No description. |
email_user_ids_input |
typing.List[str] |
No description. |
enabled_input |
bool | cdktf.IResolvable |
No description. |
name_input |
str |
No description. |
token_input |
str |
No description. |
token_wo_input |
str |
No description. |
triggers_input |
typing.List[str] |
No description. |
url_input |
str |
No description. |
workspace_id_input |
str |
No description. |
destination_type |
str |
No description. |
email_addresses |
typing.List[str] |
No description. |
email_user_ids |
typing.List[str] |
No description. |
enabled |
bool | cdktf.IResolvable |
No description. |
name |
str |
No description. |
token |
str |
No description. |
token_wo |
str |
No description. |
triggers |
typing.List[str] |
No description. |
url |
str |
No description. |
workspace_id |
str |
No description. |
node: Node- Type: constructs.Node
The tree node.
cdktf_stack: TerraformStack- Type: cdktf.TerraformStack
fqn: str- Type: str
friendly_unique_id: str- Type: str
terraform_meta_arguments: typing.Mapping[typing.Any]- Type: typing.Mapping[typing.Any]
terraform_resource_type: str- Type: str
terraform_generator_metadata: TerraformProviderGeneratorMetadata- Type: cdktf.TerraformProviderGeneratorMetadata
connection: SSHProvisionerConnection | WinrmProvisionerConnection- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
count: typing.Union[int, float] | TerraformCount- Type: typing.Union[int, float] | cdktf.TerraformCount
depends_on: typing.List[str]- Type: typing.List[str]
for_each: ITerraformIterator- Type: cdktf.ITerraformIterator
lifecycle: TerraformResourceLifecycle- Type: cdktf.TerraformResourceLifecycle
provider: TerraformProvider- Type: cdktf.TerraformProvider
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]- Type: typing.List[cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner]
id: str- Type: str
destination_type_input: str- Type: str
email_addresses_input: typing.List[str]- Type: typing.List[str]
email_user_ids_input: typing.List[str]- Type: typing.List[str]
enabled_input: bool | IResolvable- Type: bool | cdktf.IResolvable
name_input: str- Type: str
token_input: str- Type: str
token_wo_input: str- Type: str
triggers_input: typing.List[str]- Type: typing.List[str]
url_input: str- Type: str
workspace_id_input: str- Type: str
destination_type: str- Type: str
email_addresses: typing.List[str]- Type: typing.List[str]
email_user_ids: typing.List[str]- Type: typing.List[str]
enabled: bool | IResolvable- Type: bool | cdktf.IResolvable
name: str- Type: str
token: str- Type: str
token_wo: str- Type: str
triggers: typing.List[str]- Type: typing.List[str]
url: str- Type: str
workspace_id: str- Type: str
| Name | Type | Description |
|---|---|---|
tfResourceType |
str |
No description. |
tfResourceType: str- Type: str
from cdktf_cdktf_provider_tfe import notification_configuration
notificationConfiguration.NotificationConfigurationConfig(
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,
destination_type: str,
name: str,
workspace_id: str,
email_addresses: typing.List[str] = None,
email_user_ids: typing.List[str] = None,
enabled: bool | IResolvable = None,
token: str = None,
token_wo: str = None,
triggers: typing.List[str] = None,
url: str = None
)| 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. |
destination_type |
str |
The type of notification configuration payload to send. |
name |
str |
Name of the notification configuration. |
workspace_id |
str |
The ID of the workspace that owns the notification configuration. |
email_addresses |
typing.List[str] |
A list of email addresses. This value must not be provided if destination_type is generic, microsoft-teams, or slack. |
email_user_ids |
typing.List[str] |
A list of user IDs. This value must not be provided if destination_type is generic, microsoft-teams, or slack. |
enabled |
bool | cdktf.IResolvable |
Whether the notification configuration should be enabled or not. Disabled configurations will not send any notifications. Defaults to false. |
token |
str |
A write-only secure token for the notification configuration, which can be used by the receiving server to verify request authenticity when configured for notification configurations with a destination type of generic. |
token_wo |
str |
Value of the token in write-only mode. |
triggers |
typing.List[str] |
The array of triggers for which this notification configuration will send notifications. If omitted, no notification triggers are configured. |
url |
str |
The HTTP or HTTPS URL where notification requests will be made. |
connection: SSHProvisionerConnection | WinrmProvisionerConnection- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
count: typing.Union[int, float] | TerraformCount- Type: typing.Union[int, float] | cdktf.TerraformCount
depends_on: typing.List[ITerraformDependable]- Type: typing.List[cdktf.ITerraformDependable]
for_each: ITerraformIterator- Type: cdktf.ITerraformIterator
lifecycle: TerraformResourceLifecycle- Type: cdktf.TerraformResourceLifecycle
provider: TerraformProvider- Type: cdktf.TerraformProvider
provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]- Type: typing.List[cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner]
destination_type: str- Type: str
The type of notification configuration payload to send.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/notification_configuration#destination_type NotificationConfiguration#destination_type}
name: str- Type: str
Name of the notification configuration.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/notification_configuration#name NotificationConfiguration#name}
workspace_id: str- Type: str
The ID of the workspace that owns the notification configuration.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/notification_configuration#workspace_id NotificationConfiguration#workspace_id}
email_addresses: typing.List[str]- Type: typing.List[str]
A list of email addresses. This value must not be provided if destination_type is generic, microsoft-teams, or slack.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/notification_configuration#email_addresses NotificationConfiguration#email_addresses}
email_user_ids: typing.List[str]- Type: typing.List[str]
A list of user IDs. This value must not be provided if destination_type is generic, microsoft-teams, or slack.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/notification_configuration#email_user_ids NotificationConfiguration#email_user_ids}
enabled: bool | IResolvable- Type: bool | cdktf.IResolvable
Whether the notification configuration should be enabled or not. Disabled configurations will not send any notifications. Defaults to false.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/notification_configuration#enabled NotificationConfiguration#enabled}
token: str- Type: str
A write-only secure token for the notification configuration, which can be used by the receiving server to verify request authenticity when configured for notification configurations with a destination type of generic.
Defaults to null. This value must not be provided if destination_type is email, microsoft-teams, or slack.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/notification_configuration#token NotificationConfiguration#token}
token_wo: str- Type: str
Value of the token in write-only mode.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/notification_configuration#token_wo NotificationConfiguration#token_wo}
triggers: typing.List[str]- Type: typing.List[str]
The array of triggers for which this notification configuration will send notifications. If omitted, no notification triggers are configured.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/notification_configuration#triggers NotificationConfiguration#triggers}
url: str- Type: str
The HTTP or HTTPS URL where notification requests will be made.
This value must not be provided if email_addresses or email_user_ids is present, or if destination_type is email.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.71.0/docs/resources/notification_configuration#url NotificationConfiguration#url}