Represents a {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel google_monitoring_notification_channel}.
import com.hashicorp.cdktf.providers.google_beta.google_monitoring_notification_channel.GoogleMonitoringNotificationChannel;
GoogleMonitoringNotificationChannel.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>)
.type(java.lang.String)
// .description(java.lang.String)
// .displayName(java.lang.String)
// .enabled(java.lang.Boolean)
// .enabled(IResolvable)
// .forceDelete(java.lang.Boolean)
// .forceDelete(IResolvable)
// .id(java.lang.String)
// .labels(java.util.Map<java.lang.String, java.lang.String>)
// .project(java.lang.String)
// .sensitiveLabels(GoogleMonitoringNotificationChannelSensitiveLabels)
// .timeouts(GoogleMonitoringNotificationChannelTimeouts)
// .userLabels(java.util.Map<java.lang.String, 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. |
type |
java.lang.String |
The type of the notification channel. |
description |
java.lang.String |
An optional human-readable description of this notification channel. |
displayName |
java.lang.String |
An optional human-readable name for this notification channel. |
enabled |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
Whether notifications are forwarded to the described channel. |
forceDelete |
java.lang.Boolean OR com.hashicorp.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 |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#id GoogleMonitoringNotificationChannel#id}. |
labels |
java.util.Map<java.lang.String, java.lang.String> |
Configuration fields that define the channel and its behavior. |
project |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#project GoogleMonitoringNotificationChannel#project}. |
sensitiveLabels |
GoogleMonitoringNotificationChannelSensitiveLabels |
sensitive_labels block. |
timeouts |
GoogleMonitoringNotificationChannelTimeouts |
timeouts block. |
userLabels |
java.util.Map<java.lang.String, java.lang.String> |
User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. |
- Type: software.constructs.Construct
The scope in which to define this construct.
- Type: java.lang.String
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
- Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
- Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
- Type: com.hashicorp.cdktf.ITerraformIterator
- Type: com.hashicorp.cdktf.TerraformResourceLifecycle
- Type: com.hashicorp.cdktf.TerraformProvider
- Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
- Type: java.lang.String
The type of the notification channel.
This field matches the value of the NotificationChannelDescriptor.type field. See https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.notificationChannelDescriptors/list to get the list of valid values such as "email", "slack", etc...
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#type GoogleMonitoringNotificationChannel#type}
- Type: java.lang.String
An optional human-readable description of this notification channel.
This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#description GoogleMonitoringNotificationChannel#description}
- Type: java.lang.String
An optional human-readable name for this notification channel.
It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#display_name GoogleMonitoringNotificationChannel#display_name}
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
Whether notifications are forwarded to the described channel.
This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#enabled GoogleMonitoringNotificationChannel#enabled}
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel).
If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#force_delete GoogleMonitoringNotificationChannel#force_delete}
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#id GoogleMonitoringNotificationChannel#id}.
Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
- Type: java.util.Map<java.lang.String, java.lang.String>
Configuration fields that define the channel and its behavior.
The permissible and required labels are specified in the NotificationChannelDescriptor corresponding to the type field.
Labels with sensitive data are obfuscated by the API and therefore Terraform cannot determine if there are upstream changes to these fields. They can also be configured via the sensitive_labels block, but cannot be configured in both places.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#labels GoogleMonitoringNotificationChannel#labels}
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#project GoogleMonitoringNotificationChannel#project}.
sensitive_labels block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#sensitive_labels GoogleMonitoringNotificationChannel#sensitive_labels}
timeouts block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#timeouts GoogleMonitoringNotificationChannel#timeouts}
- Type: java.util.Map<java.lang.String, java.lang.String>
User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field.
This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#user_labels GoogleMonitoringNotificationChannel#user_labels}
Name | Description |
---|---|
toString |
Returns a string representation of this construct. |
addOverride |
No description. |
overrideLogicalId |
Overrides the auto-generated logical ID with a specific ID. |
resetOverrideLogicalId |
Resets a previously passed logical Id to use the auto-generated logical id again. |
toHclTerraform |
No description. |
toMetadata |
No description. |
toTerraform |
Adds this resource to the terraform JSON output. |
addMoveTarget |
Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. |
getAnyMapAttribute |
No description. |
getBooleanAttribute |
No description. |
getBooleanMapAttribute |
No description. |
getListAttribute |
No description. |
getNumberAttribute |
No description. |
getNumberListAttribute |
No description. |
getNumberMapAttribute |
No description. |
getStringAttribute |
No description. |
getStringMapAttribute |
No description. |
hasResourceMove |
No description. |
importFrom |
No description. |
interpolationForAttribute |
No description. |
moveFromId |
Move the resource corresponding to "id" to this resource. |
moveTo |
Moves this resource to the target resource given by moveTarget. |
moveToId |
Moves this resource to the resource corresponding to "id". |
putSensitiveLabels |
No description. |
putTimeouts |
No description. |
resetDescription |
No description. |
resetDisplayName |
No description. |
resetEnabled |
No description. |
resetForceDelete |
No description. |
resetId |
No description. |
resetLabels |
No description. |
resetProject |
No description. |
resetSensitiveLabels |
No description. |
resetTimeouts |
No description. |
resetUserLabels |
No description. |
public java.lang.String toString()
Returns a string representation of this construct.
public void addOverride(java.lang.String path, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
public void overrideLogicalId(java.lang.String newLogicalId)
Overrides the auto-generated logical ID with a specific ID.
- Type: java.lang.String
The new logical ID to use for this stack element.
public void resetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
public java.lang.Object toHclTerraform()
public java.lang.Object toMetadata()
public java.lang.Object toTerraform()
Adds this resource to the terraform JSON output.
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.
- Type: java.lang.String
The string move target that will correspond to this resource.
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
- Type: java.lang.String
- Type: com.hashicorp.cdktf.TerraformProvider
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
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.
- Type: java.lang.String
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
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.
- Type: java.lang.String
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- 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.
public void moveToId(java.lang.String id)
Moves this resource to the resource corresponding to "id".
- Type: java.lang.String
Full id of resource to move to, e.g. "aws_s3_bucket.example".
public void putSensitiveLabels(GoogleMonitoringNotificationChannelSensitiveLabels value)
public void putTimeouts(GoogleMonitoringNotificationChannelTimeouts value)
public void resetDescription()
public void resetDisplayName()
public void resetEnabled()
public void resetForceDelete()
public void resetId()
public void resetLabels()
public void resetProject()
public void resetSensitiveLabels()
public void resetTimeouts()
public void resetUserLabels()
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a GoogleMonitoringNotificationChannel resource upon running "cdktf plan ". |
import com.hashicorp.cdktf.providers.google_beta.google_monitoring_notification_channel.GoogleMonitoringNotificationChannel;
GoogleMonitoringNotificationChannel.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.
- Type: java.lang.Object
Any object.
import com.hashicorp.cdktf.providers.google_beta.google_monitoring_notification_channel.GoogleMonitoringNotificationChannel;
GoogleMonitoringNotificationChannel.isTerraformElement(java.lang.Object x)
- Type: java.lang.Object
import com.hashicorp.cdktf.providers.google_beta.google_monitoring_notification_channel.GoogleMonitoringNotificationChannel;
GoogleMonitoringNotificationChannel.isTerraformResource(java.lang.Object x)
- Type: java.lang.Object
import com.hashicorp.cdktf.providers.google_beta.google_monitoring_notification_channel.GoogleMonitoringNotificationChannel;
GoogleMonitoringNotificationChannel.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),GoogleMonitoringNotificationChannel.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)
Generates CDKTF code for importing a GoogleMonitoringNotificationChannel resource upon running "cdktf plan ".
- Type: software.constructs.Construct
The scope in which to define this construct.
- Type: java.lang.String
The construct id used in the generated config for the GoogleMonitoringNotificationChannel to import.
- Type: java.lang.String
The id of the existing GoogleMonitoringNotificationChannel that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#import import section} in the documentation of this resource for the id to use
- Type: com.hashicorp.cdktf.TerraformProvider
? Optional instance of the provider where the GoogleMonitoringNotificationChannel to import is found.
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. |
name |
java.lang.String |
No description. |
sensitiveLabels |
GoogleMonitoringNotificationChannelSensitiveLabelsOutputReference |
No description. |
timeouts |
GoogleMonitoringNotificationChannelTimeoutsOutputReference |
No description. |
verificationStatus |
java.lang.String |
No description. |
descriptionInput |
java.lang.String |
No description. |
displayNameInput |
java.lang.String |
No description. |
enabledInput |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
No description. |
forceDeleteInput |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
No description. |
idInput |
java.lang.String |
No description. |
labelsInput |
java.util.Map<java.lang.String, java.lang.String> |
No description. |
projectInput |
java.lang.String |
No description. |
sensitiveLabelsInput |
GoogleMonitoringNotificationChannelSensitiveLabels |
No description. |
timeoutsInput |
com.hashicorp.cdktf.IResolvable OR GoogleMonitoringNotificationChannelTimeouts |
No description. |
typeInput |
java.lang.String |
No description. |
userLabelsInput |
java.util.Map<java.lang.String, java.lang.String> |
No description. |
description |
java.lang.String |
No description. |
displayName |
java.lang.String |
No description. |
enabled |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
No description. |
forceDelete |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
No description. |
id |
java.lang.String |
No description. |
labels |
java.util.Map<java.lang.String, java.lang.String> |
No description. |
project |
java.lang.String |
No description. |
type |
java.lang.String |
No description. |
userLabels |
java.util.Map<java.lang.String, java.lang.String> |
No description. |
public Node getNode();
- Type: software.constructs.Node
The tree node.
public TerraformStack getCdktfStack();
- Type: com.hashicorp.cdktf.TerraformStack
public java.lang.String getFqn();
- Type: java.lang.String
public java.lang.String getFriendlyUniqueId();
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
- Type: java.util.Map<java.lang.String, java.lang.Object>
public java.lang.String getTerraformResourceType();
- Type: java.lang.String
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
- Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
public java.lang.Object getConnection();
- Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
public java.lang.Object getCount();
- Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
public java.util.List<java.lang.String> getDependsOn();
- Type: java.util.List<java.lang.String>
public ITerraformIterator getForEach();
- Type: com.hashicorp.cdktf.ITerraformIterator
public TerraformResourceLifecycle getLifecycle();
- Type: com.hashicorp.cdktf.TerraformResourceLifecycle
public TerraformProvider getProvider();
- Type: com.hashicorp.cdktf.TerraformProvider
public java.lang.Object getProvisioners();
- Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
public java.lang.String getName();
- Type: java.lang.String
public GoogleMonitoringNotificationChannelSensitiveLabelsOutputReference getSensitiveLabels();
public GoogleMonitoringNotificationChannelTimeoutsOutputReference getTimeouts();
public java.lang.String getVerificationStatus();
- Type: java.lang.String
public java.lang.String getDescriptionInput();
- Type: java.lang.String
public java.lang.String getDisplayNameInput();
- Type: java.lang.String
public java.lang.Object getEnabledInput();
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
public java.lang.Object getForceDeleteInput();
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
public java.lang.String getIdInput();
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getLabelsInput();
- Type: java.util.Map<java.lang.String, java.lang.String>
public java.lang.String getProjectInput();
- Type: java.lang.String
public GoogleMonitoringNotificationChannelSensitiveLabels getSensitiveLabelsInput();
public java.lang.Object getTimeoutsInput();
- Type: com.hashicorp.cdktf.IResolvable OR GoogleMonitoringNotificationChannelTimeouts
public java.lang.String getTypeInput();
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getUserLabelsInput();
- Type: java.util.Map<java.lang.String, java.lang.String>
public java.lang.String getDescription();
- Type: java.lang.String
public java.lang.String getDisplayName();
- Type: java.lang.String
public java.lang.Object getEnabled();
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
public java.lang.Object getForceDelete();
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
public java.lang.String getId();
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getLabels();
- Type: java.util.Map<java.lang.String, java.lang.String>
public java.lang.String getProject();
- Type: java.lang.String
public java.lang.String getType();
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getUserLabels();
- Type: java.util.Map<java.lang.String, java.lang.String>
Name | Type | Description |
---|---|---|
tfResourceType |
java.lang.String |
No description. |
public java.lang.String getTfResourceType();
- Type: java.lang.String
import com.hashicorp.cdktf.providers.google_beta.google_monitoring_notification_channel.GoogleMonitoringNotificationChannelConfig;
GoogleMonitoringNotificationChannelConfig.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>)
.type(java.lang.String)
// .description(java.lang.String)
// .displayName(java.lang.String)
// .enabled(java.lang.Boolean)
// .enabled(IResolvable)
// .forceDelete(java.lang.Boolean)
// .forceDelete(IResolvable)
// .id(java.lang.String)
// .labels(java.util.Map<java.lang.String, java.lang.String>)
// .project(java.lang.String)
// .sensitiveLabels(GoogleMonitoringNotificationChannelSensitiveLabels)
// .timeouts(GoogleMonitoringNotificationChannelTimeouts)
// .userLabels(java.util.Map<java.lang.String, java.lang.String>)
.build();
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. |
type |
java.lang.String |
The type of the notification channel. |
description |
java.lang.String |
An optional human-readable description of this notification channel. |
displayName |
java.lang.String |
An optional human-readable name for this notification channel. |
enabled |
java.lang.Boolean OR com.hashicorp.cdktf.IResolvable |
Whether notifications are forwarded to the described channel. |
forceDelete |
java.lang.Boolean OR com.hashicorp.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 |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#id GoogleMonitoringNotificationChannel#id}. |
labels |
java.util.Map<java.lang.String, java.lang.String> |
Configuration fields that define the channel and its behavior. |
project |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#project GoogleMonitoringNotificationChannel#project}. |
sensitiveLabels |
GoogleMonitoringNotificationChannelSensitiveLabels |
sensitive_labels block. |
timeouts |
GoogleMonitoringNotificationChannelTimeouts |
timeouts block. |
userLabels |
java.util.Map<java.lang.String, java.lang.String> |
User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. |
public java.lang.Object getConnection();
- Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
public java.lang.Object getCount();
- Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
public java.util.List<ITerraformDependable> getDependsOn();
- Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
public ITerraformIterator getForEach();
- Type: com.hashicorp.cdktf.ITerraformIterator
public TerraformResourceLifecycle getLifecycle();
- Type: com.hashicorp.cdktf.TerraformResourceLifecycle
public TerraformProvider getProvider();
- Type: com.hashicorp.cdktf.TerraformProvider
public java.lang.Object getProvisioners();
- Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
public java.lang.String getType();
- Type: java.lang.String
The type of the notification channel.
This field matches the value of the NotificationChannelDescriptor.type field. See https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.notificationChannelDescriptors/list to get the list of valid values such as "email", "slack", etc...
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#type GoogleMonitoringNotificationChannel#type}
public java.lang.String getDescription();
- Type: java.lang.String
An optional human-readable description of this notification channel.
This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#description GoogleMonitoringNotificationChannel#description}
public java.lang.String getDisplayName();
- Type: java.lang.String
An optional human-readable name for this notification channel.
It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#display_name GoogleMonitoringNotificationChannel#display_name}
public java.lang.Object getEnabled();
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
Whether notifications are forwarded to the described channel.
This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#enabled GoogleMonitoringNotificationChannel#enabled}
public java.lang.Object getForceDelete();
- Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel).
If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#force_delete GoogleMonitoringNotificationChannel#force_delete}
public java.lang.String getId();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#id GoogleMonitoringNotificationChannel#id}.
Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
public java.util.Map<java.lang.String, java.lang.String> getLabels();
- Type: java.util.Map<java.lang.String, java.lang.String>
Configuration fields that define the channel and its behavior.
The permissible and required labels are specified in the NotificationChannelDescriptor corresponding to the type field.
Labels with sensitive data are obfuscated by the API and therefore Terraform cannot determine if there are upstream changes to these fields. They can also be configured via the sensitive_labels block, but cannot be configured in both places.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#labels GoogleMonitoringNotificationChannel#labels}
public java.lang.String getProject();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#project GoogleMonitoringNotificationChannel#project}.
public GoogleMonitoringNotificationChannelSensitiveLabels getSensitiveLabels();
sensitive_labels block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#sensitive_labels GoogleMonitoringNotificationChannel#sensitive_labels}
public GoogleMonitoringNotificationChannelTimeouts getTimeouts();
timeouts block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#timeouts GoogleMonitoringNotificationChannel#timeouts}
public java.util.Map<java.lang.String, java.lang.String> getUserLabels();
- Type: java.util.Map<java.lang.String, java.lang.String>
User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field.
This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#user_labels GoogleMonitoringNotificationChannel#user_labels}
import com.hashicorp.cdktf.providers.google_beta.google_monitoring_notification_channel.GoogleMonitoringNotificationChannelSensitiveLabels;
GoogleMonitoringNotificationChannelSensitiveLabels.builder()
// .authToken(java.lang.String)
// .password(java.lang.String)
// .serviceKey(java.lang.String)
.build();
Name | Type | Description |
---|---|---|
authToken |
java.lang.String |
An authorization token for a notification channel. Channel types that support this field include: slack. |
password |
java.lang.String |
An password for a notification channel. Channel types that support this field include: webhook_basicauth. |
serviceKey |
java.lang.String |
An servicekey token for a notification channel. Channel types that support this field include: pagerduty. |
public java.lang.String getAuthToken();
- Type: java.lang.String
An authorization token for a notification channel. Channel types that support this field include: slack.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#auth_token GoogleMonitoringNotificationChannel#auth_token}
public java.lang.String getPassword();
- Type: java.lang.String
An password for a notification channel. Channel types that support this field include: webhook_basicauth.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#password GoogleMonitoringNotificationChannel#password}
public java.lang.String getServiceKey();
- Type: java.lang.String
An servicekey token for a notification channel. Channel types that support this field include: pagerduty.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#service_key GoogleMonitoringNotificationChannel#service_key}
import com.hashicorp.cdktf.providers.google_beta.google_monitoring_notification_channel.GoogleMonitoringNotificationChannelTimeouts;
GoogleMonitoringNotificationChannelTimeouts.builder()
// .create(java.lang.String)
// .delete(java.lang.String)
// .update(java.lang.String)
.build();
Name | Type | Description |
---|---|---|
create |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#create GoogleMonitoringNotificationChannel#create}. |
delete |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#delete GoogleMonitoringNotificationChannel#delete}. |
update |
java.lang.String |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#update GoogleMonitoringNotificationChannel#update}. |
public java.lang.String getCreate();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#create GoogleMonitoringNotificationChannel#create}.
public java.lang.String getDelete();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#delete GoogleMonitoringNotificationChannel#delete}.
public java.lang.String getUpdate();
- Type: java.lang.String
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google-beta/6.14.1/docs/resources/google_monitoring_notification_channel#update GoogleMonitoringNotificationChannel#update}.
import com.hashicorp.cdktf.providers.google_beta.google_monitoring_notification_channel.GoogleMonitoringNotificationChannelSensitiveLabelsOutputReference;
new GoogleMonitoringNotificationChannelSensitiveLabelsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name | Type | Description |
---|---|---|
terraformResource |
com.hashicorp.cdktf.IInterpolatingParent |
The parent resource. |
terraformAttribute |
java.lang.String |
The attribute on the parent resource this class is referencing. |
- Type: com.hashicorp.cdktf.IInterpolatingParent
The parent resource.
- Type: java.lang.String
The attribute on the parent resource this class is referencing.
Name | Description |
---|---|
computeFqn |
No description. |
getAnyMapAttribute |
No description. |
getBooleanAttribute |
No description. |
getBooleanMapAttribute |
No description. |
getListAttribute |
No description. |
getNumberAttribute |
No description. |
getNumberListAttribute |
No description. |
getNumberMapAttribute |
No description. |
getStringAttribute |
No description. |
getStringMapAttribute |
No description. |
interpolationForAttribute |
No description. |
resolve |
Produce the Token's value at resolution time. |
toString |
Return a string representation of this resolvable object. |
resetAuthToken |
No description. |
resetPassword |
No description. |
resetServiceKey |
No description. |
public java.lang.String computeFqn()
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable interpolationForAttribute(java.lang.String property)
- Type: java.lang.String
public java.lang.Object resolve(IResolveContext _context)
Produce the Token's value at resolution time.
- Type: com.hashicorp.cdktf.IResolveContext
public java.lang.String toString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
public void resetAuthToken()
public void resetPassword()
public void resetServiceKey()
Name | Type | Description |
---|---|---|
creationStack |
java.util.List<java.lang.String> |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
java.lang.String |
No description. |
authTokenInput |
java.lang.String |
No description. |
passwordInput |
java.lang.String |
No description. |
serviceKeyInput |
java.lang.String |
No description. |
authToken |
java.lang.String |
No description. |
password |
java.lang.String |
No description. |
serviceKey |
java.lang.String |
No description. |
internalValue |
GoogleMonitoringNotificationChannelSensitiveLabels |
No description. |
public java.util.List<java.lang.String> getCreationStack();
- Type: java.util.List<java.lang.String>
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
public java.lang.String getFqn();
- Type: java.lang.String
public java.lang.String getAuthTokenInput();
- Type: java.lang.String
public java.lang.String getPasswordInput();
- Type: java.lang.String
public java.lang.String getServiceKeyInput();
- Type: java.lang.String
public java.lang.String getAuthToken();
- Type: java.lang.String
public java.lang.String getPassword();
- Type: java.lang.String
public java.lang.String getServiceKey();
- Type: java.lang.String
public GoogleMonitoringNotificationChannelSensitiveLabels getInternalValue();
import com.hashicorp.cdktf.providers.google_beta.google_monitoring_notification_channel.GoogleMonitoringNotificationChannelTimeoutsOutputReference;
new GoogleMonitoringNotificationChannelTimeoutsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name | Type | Description |
---|---|---|
terraformResource |
com.hashicorp.cdktf.IInterpolatingParent |
The parent resource. |
terraformAttribute |
java.lang.String |
The attribute on the parent resource this class is referencing. |
- Type: com.hashicorp.cdktf.IInterpolatingParent
The parent resource.
- Type: java.lang.String
The attribute on the parent resource this class is referencing.
Name | Description |
---|---|
computeFqn |
No description. |
getAnyMapAttribute |
No description. |
getBooleanAttribute |
No description. |
getBooleanMapAttribute |
No description. |
getListAttribute |
No description. |
getNumberAttribute |
No description. |
getNumberListAttribute |
No description. |
getNumberMapAttribute |
No description. |
getStringAttribute |
No description. |
getStringMapAttribute |
No description. |
interpolationForAttribute |
No description. |
resolve |
Produce the Token's value at resolution time. |
toString |
Return a string representation of this resolvable object. |
resetCreate |
No description. |
resetDelete |
No description. |
resetUpdate |
No description. |
public java.lang.String computeFqn()
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
- Type: java.lang.String
public IResolvable interpolationForAttribute(java.lang.String property)
- Type: java.lang.String
public java.lang.Object resolve(IResolveContext _context)
Produce the Token's value at resolution time.
- Type: com.hashicorp.cdktf.IResolveContext
public java.lang.String toString()
Return a string representation of this resolvable object.
Returns a reversible string representation.
public void resetCreate()
public void resetDelete()
public void resetUpdate()
Name | Type | Description |
---|---|---|
creationStack |
java.util.List<java.lang.String> |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
java.lang.String |
No description. |
createInput |
java.lang.String |
No description. |
deleteInput |
java.lang.String |
No description. |
updateInput |
java.lang.String |
No description. |
create |
java.lang.String |
No description. |
delete |
java.lang.String |
No description. |
update |
java.lang.String |
No description. |
internalValue |
com.hashicorp.cdktf.IResolvable OR GoogleMonitoringNotificationChannelTimeouts |
No description. |
public java.util.List<java.lang.String> getCreationStack();
- Type: java.util.List<java.lang.String>
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
public java.lang.String getFqn();
- Type: java.lang.String
public java.lang.String getCreateInput();
- Type: java.lang.String
public java.lang.String getDeleteInput();
- Type: java.lang.String
public java.lang.String getUpdateInput();
- Type: java.lang.String
public java.lang.String getCreate();
- Type: java.lang.String
public java.lang.String getDelete();
- Type: java.lang.String
public java.lang.String getUpdate();
- Type: java.lang.String
public java.lang.Object getInternalValue();
- Type: com.hashicorp.cdktf.IResolvable OR GoogleMonitoringNotificationChannelTimeouts