Skip to content

Latest commit

 

History

History
1349 lines (840 loc) · 66.3 KB

teamNotificationConfiguration.java.md

File metadata and controls

1349 lines (840 loc) · 66.3 KB

teamNotificationConfiguration Submodule

Constructs

TeamNotificationConfiguration

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

Initializers 

import com.hashicorp.cdktf.providers.tfe.team_notification_configuration.TeamNotificationConfiguration;

TeamNotificationConfiguration.Builder.create(Construct scope, java.lang.String id)
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .destinationType(java.lang.String)
    .name(java.lang.String)
    .teamId(java.lang.String)
//  .emailAddresses(java.util.List<java.lang.String>)
//  .emailUserIds(java.util.List<java.lang.String>)
//  .enabled(java.lang.Boolean)
//  .enabled(IResolvable)
//  .token(java.lang.String)
//  .triggers(java.util.List<java.lang.String>)
//  .url(java.lang.String)
    .build();
Name Type Description
scope software.constructs.Construct The scope in which to define this construct.
id java.lang.String The scoped construct ID.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
destinationType java.lang.String The type of notification configuration payload to send.
name java.lang.String Name of the team notification configuration.
teamId java.lang.String The ID of the team that owns the notification configuration.
emailAddresses java.util.List<java.lang.String> A list of email addresses. This value must not be provided if destination_type is generic, microsoft-teams, or slack.
emailUserIds java.util.List<java.lang.String> A list of user IDs. This value must not be provided if destination_type is generic, microsoft-teams, or slack.
enabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether the team notification configuration should be enabled or not.
token java.lang.String A write-only secure token for the notification configuration, which can be used by the receiving server to verify request authenticity when configured for notification configurations with a destination type of generic.
triggers java.util.List<java.lang.String> The array of triggers for which this team notification configuration will send notifications.
url java.lang.String The HTTP or HTTPS URL where notification requests will be made.
scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
destinationTypeRequired
  • Type: java.lang.String

The type of notification configuration payload to send.

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

nameRequired
  • Type: java.lang.String

Name of the team notification configuration.

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

teamIdRequired
  • Type: java.lang.String

The ID of the team that owns the notification configuration.

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

emailAddressesOptional
  • Type: java.util.List<java.lang.String>

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

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

emailUserIdsOptional
  • Type: java.util.List<java.lang.String>

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

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

enabledOptional
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether the team notification configuration should be enabled or not.

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

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

tokenOptional
  • Type: java.lang.String

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

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

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

triggersOptional
  • Type: java.util.List<java.lang.String>

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

If omitted, no notification triggers are configured.

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

urlOptional
  • Type: java.lang.String

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

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

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

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
resetEmailAddresses No description.
resetEmailUserIds No description.
resetEnabled No description.
resetToken No description.
resetTriggers No description.
resetUrl No description.
toString 
public java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

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

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

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.

idRequired
  • Type: java.lang.String

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

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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

indexOptional
  • Type: java.lang.String OR java.lang.Number

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

moveToId 
public void moveToId(java.lang.String id)

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

idRequired
  • Type: java.lang.String

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

resetEmailAddresses 
public void resetEmailAddresses()
resetEmailUserIds 
public void resetEmailUserIds()
resetEnabled 
public void resetEnabled()
resetToken 
public void resetToken()
resetTriggers 
public void resetTriggers()
resetUrl 
public void resetUrl()

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
generateConfigForImport Generates CDKTF code for importing a TeamNotificationConfiguration resource upon running "cdktf plan ".
isConstruct 
import com.hashicorp.cdktf.providers.tfe.team_notification_configuration.TeamNotificationConfiguration;

TeamNotificationConfiguration.isConstruct(java.lang.Object x)

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.

xRequired
  • Type: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.tfe.team_notification_configuration.TeamNotificationConfiguration;

TeamNotificationConfiguration.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.tfe.team_notification_configuration.TeamNotificationConfiguration;

TeamNotificationConfiguration.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.tfe.team_notification_configuration.TeamNotificationConfiguration;

TeamNotificationConfiguration.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),TeamNotificationConfiguration.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • Type: java.lang.String

The id of the existing TeamNotificationConfiguration that should be imported.

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

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
id java.lang.String No description.
destinationTypeInput java.lang.String No description.
emailAddressesInput java.util.List<java.lang.String> No description.
emailUserIdsInput java.util.List<java.lang.String> No description.
enabledInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
nameInput java.lang.String No description.
teamIdInput java.lang.String No description.
tokenInput java.lang.String No description.
triggersInput java.util.List<java.lang.String> No description.
urlInput java.lang.String No description.
destinationType java.lang.String No description.
emailAddresses java.util.List<java.lang.String> No description.
emailUserIds java.util.List<java.lang.String> No description.
enabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
name java.lang.String No description.
teamId java.lang.String No description.
token java.lang.String No description.
triggers java.util.List<java.lang.String> No description.
url java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
destinationTypeInputOptional 
public java.lang.String getDestinationTypeInput();
  • Type: java.lang.String
emailAddressesInputOptional 
public java.util.List<java.lang.String> getEmailAddressesInput();
  • Type: java.util.List<java.lang.String>
emailUserIdsInputOptional 
public java.util.List<java.lang.String> getEmailUserIdsInput();
  • Type: java.util.List<java.lang.String>
enabledInputOptional 
public java.lang.Object getEnabledInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
teamIdInputOptional 
public java.lang.String getTeamIdInput();
  • Type: java.lang.String
tokenInputOptional 
public java.lang.String getTokenInput();
  • Type: java.lang.String
triggersInputOptional 
public java.util.List<java.lang.String> getTriggersInput();
  • Type: java.util.List<java.lang.String>
urlInputOptional 
public java.lang.String getUrlInput();
  • Type: java.lang.String
destinationTypeRequired 
public java.lang.String getDestinationType();
  • Type: java.lang.String
emailAddressesRequired 
public java.util.List<java.lang.String> getEmailAddresses();
  • Type: java.util.List<java.lang.String>
emailUserIdsRequired 
public java.util.List<java.lang.String> getEmailUserIds();
  • Type: java.util.List<java.lang.String>
enabledRequired 
public java.lang.Object getEnabled();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
teamIdRequired 
public java.lang.String getTeamId();
  • Type: java.lang.String
tokenRequired 
public java.lang.String getToken();
  • Type: java.lang.String
triggersRequired 
public java.util.List<java.lang.String> getTriggers();
  • Type: java.util.List<java.lang.String>
urlRequired 
public java.lang.String getUrl();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

TeamNotificationConfigurationConfig

Initializer 

import com.hashicorp.cdktf.providers.tfe.team_notification_configuration.TeamNotificationConfigurationConfig;

TeamNotificationConfigurationConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .destinationType(java.lang.String)
    .name(java.lang.String)
    .teamId(java.lang.String)
//  .emailAddresses(java.util.List<java.lang.String>)
//  .emailUserIds(java.util.List<java.lang.String>)
//  .enabled(java.lang.Boolean)
//  .enabled(IResolvable)
//  .token(java.lang.String)
//  .triggers(java.util.List<java.lang.String>)
//  .url(java.lang.String)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
destinationType java.lang.String The type of notification configuration payload to send.
name java.lang.String Name of the team notification configuration.
teamId java.lang.String The ID of the team that owns the notification configuration.
emailAddresses java.util.List<java.lang.String> A list of email addresses. This value must not be provided if destination_type is generic, microsoft-teams, or slack.
emailUserIds java.util.List<java.lang.String> A list of user IDs. This value must not be provided if destination_type is generic, microsoft-teams, or slack.
enabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Whether the team notification configuration should be enabled or not.
token java.lang.String A write-only secure token for the notification configuration, which can be used by the receiving server to verify request authenticity when configured for notification configurations with a destination type of generic.
triggers java.util.List<java.lang.String> The array of triggers for which this team notification configuration will send notifications.
url java.lang.String The HTTP or HTTPS URL where notification requests will be made.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
destinationTypeRequired 
public java.lang.String getDestinationType();
  • Type: java.lang.String

The type of notification configuration payload to send.

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

nameRequired 
public java.lang.String getName();
  • Type: java.lang.String

Name of the team notification configuration.

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

teamIdRequired 
public java.lang.String getTeamId();
  • Type: java.lang.String

The ID of the team that owns the notification configuration.

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

emailAddressesOptional 
public java.util.List<java.lang.String> getEmailAddresses();
  • Type: java.util.List<java.lang.String>

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

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

emailUserIdsOptional 
public java.util.List<java.lang.String> getEmailUserIds();
  • Type: java.util.List<java.lang.String>

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

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

enabledOptional 
public java.lang.Object getEnabled();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable

Whether the team notification configuration should be enabled or not.

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

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

tokenOptional 
public java.lang.String getToken();
  • Type: java.lang.String

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

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

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

triggersOptional 
public java.util.List<java.lang.String> getTriggers();
  • Type: java.util.List<java.lang.String>

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

If omitted, no notification triggers are configured.

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

urlOptional 
public java.lang.String getUrl();
  • Type: java.lang.String

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

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

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