Class MonitoringNotificationChannelConfig.Builder
- java.lang.Object
-
- com.hashicorp.cdktf.providers.google.monitoring_notification_channel.MonitoringNotificationChannelConfig.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<MonitoringNotificationChannelConfig>
- Enclosing interface:
- MonitoringNotificationChannelConfig
@Stability(Stable) public static final class MonitoringNotificationChannelConfig.Builder extends Object implements software.amazon.jsii.Builder<MonitoringNotificationChannelConfig>
A builder forMonitoringNotificationChannelConfig
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
-
-
-
Method Detail
-
type
@Stability(Stable) public MonitoringNotificationChannelConfig.Builder type(String type)
Sets the value ofMonitoringNotificationChannelConfig.getType()- Parameters:
type- The type of the notification channel. This parameter is required. 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/5.43.1/docs/resources/monitoring_notification_channel#type MonitoringNotificationChannel#type}- Returns:
this
-
description
@Stability(Stable) public MonitoringNotificationChannelConfig.Builder description(String description)
Sets the value ofMonitoringNotificationChannelConfig.getDescription()- Parameters:
description- 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/5.43.1/docs/resources/monitoring_notification_channel#description MonitoringNotificationChannel#description}- Returns:
this
-
displayName
@Stability(Stable) public MonitoringNotificationChannelConfig.Builder displayName(String displayName)
Sets the value ofMonitoringNotificationChannelConfig.getDisplayName()- Parameters:
displayName- 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/5.43.1/docs/resources/monitoring_notification_channel#display_name MonitoringNotificationChannel#display_name}- Returns:
this
-
enabled
@Stability(Stable) public MonitoringNotificationChannelConfig.Builder enabled(Boolean enabled)
Sets the value ofMonitoringNotificationChannelConfig.getEnabled()- Parameters:
enabled- 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/5.43.1/docs/resources/monitoring_notification_channel#enabled MonitoringNotificationChannel#enabled}- Returns:
this
-
enabled
@Stability(Stable) public MonitoringNotificationChannelConfig.Builder enabled(com.hashicorp.cdktf.IResolvable enabled)
Sets the value ofMonitoringNotificationChannelConfig.getEnabled()- Parameters:
enabled- 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/5.43.1/docs/resources/monitoring_notification_channel#enabled MonitoringNotificationChannel#enabled}- Returns:
this
-
forceDelete
@Stability(Stable) public MonitoringNotificationChannelConfig.Builder forceDelete(Boolean forceDelete)
Sets the value ofMonitoringNotificationChannelConfig.getForceDelete()- Parameters:
forceDelete- 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/5.43.1/docs/resources/monitoring_notification_channel#force_delete MonitoringNotificationChannel#force_delete}- Returns:
this
-
forceDelete
@Stability(Stable) public MonitoringNotificationChannelConfig.Builder forceDelete(com.hashicorp.cdktf.IResolvable forceDelete)
Sets the value ofMonitoringNotificationChannelConfig.getForceDelete()- Parameters:
forceDelete- 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/5.43.1/docs/resources/monitoring_notification_channel#force_delete MonitoringNotificationChannel#force_delete}- Returns:
this
-
id
@Stability(Stable) public MonitoringNotificationChannelConfig.Builder id(String id)
Sets the value ofMonitoringNotificationChannelConfig.getId()- Parameters:
id- Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_notification_channel#id MonitoringNotificationChannel#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.- Returns:
this
-
labels
@Stability(Stable) public MonitoringNotificationChannelConfig.Builder labels(Map<String,String> labels)
Sets the value ofMonitoringNotificationChannelConfig.getLabels()- Parameters:
labels- 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/5.43.1/docs/resources/monitoring_notification_channel#labels MonitoringNotificationChannel#labels}- Returns:
this
-
project
@Stability(Stable) public MonitoringNotificationChannelConfig.Builder project(String project)
Sets the value ofMonitoringNotificationChannelConfig.getProject()- Parameters:
project- Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_notification_channel#project MonitoringNotificationChannel#project}.- Returns:
this
-
sensitiveLabels
@Stability(Stable) public MonitoringNotificationChannelConfig.Builder sensitiveLabels(MonitoringNotificationChannelSensitiveLabels sensitiveLabels)
Sets the value ofMonitoringNotificationChannelConfig.getSensitiveLabels()- Parameters:
sensitiveLabels- sensitive_labels block. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_notification_channel#sensitive_labels MonitoringNotificationChannel#sensitive_labels}- Returns:
this
-
timeouts
@Stability(Stable) public MonitoringNotificationChannelConfig.Builder timeouts(MonitoringNotificationChannelTimeouts timeouts)
Sets the value ofMonitoringNotificationChannelConfig.getTimeouts()- Parameters:
timeouts- timeouts block. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/monitoring_notification_channel#timeouts MonitoringNotificationChannel#timeouts}- Returns:
this
-
userLabels
@Stability(Stable) public MonitoringNotificationChannelConfig.Builder userLabels(Map<String,String> userLabels)
Sets the value ofMonitoringNotificationChannelConfig.getUserLabels()- Parameters:
userLabels- 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/5.43.1/docs/resources/monitoring_notification_channel#user_labels MonitoringNotificationChannel#user_labels}- Returns:
this
-
connection
@Stability(Experimental) public MonitoringNotificationChannelConfig.Builder connection(com.hashicorp.cdktf.SSHProvisionerConnection connection)
Sets the value ofTerraformMetaArguments.getConnection()- Parameters:
connection- the value to be set.- Returns:
this
-
connection
@Stability(Experimental) public MonitoringNotificationChannelConfig.Builder connection(com.hashicorp.cdktf.WinrmProvisionerConnection connection)
Sets the value ofTerraformMetaArguments.getConnection()- Parameters:
connection- the value to be set.- Returns:
this
-
count
@Stability(Experimental) public MonitoringNotificationChannelConfig.Builder count(Number count)
Sets the value ofTerraformMetaArguments.getCount()- Parameters:
count- the value to be set.- Returns:
this
-
count
@Stability(Experimental) public MonitoringNotificationChannelConfig.Builder count(com.hashicorp.cdktf.TerraformCount count)
Sets the value ofTerraformMetaArguments.getCount()- Parameters:
count- the value to be set.- Returns:
this
-
dependsOn
@Stability(Experimental) public MonitoringNotificationChannelConfig.Builder dependsOn(List<? extends com.hashicorp.cdktf.ITerraformDependable> dependsOn)
Sets the value ofTerraformMetaArguments.getDependsOn()- Parameters:
dependsOn- the value to be set.- Returns:
this
-
forEach
@Stability(Experimental) public MonitoringNotificationChannelConfig.Builder forEach(com.hashicorp.cdktf.ITerraformIterator forEach)
Sets the value ofTerraformMetaArguments.getForEach()- Parameters:
forEach- the value to be set.- Returns:
this
-
lifecycle
@Stability(Experimental) public MonitoringNotificationChannelConfig.Builder lifecycle(com.hashicorp.cdktf.TerraformResourceLifecycle lifecycle)
Sets the value ofTerraformMetaArguments.getLifecycle()- Parameters:
lifecycle- the value to be set.- Returns:
this
-
provider
@Stability(Experimental) public MonitoringNotificationChannelConfig.Builder provider(com.hashicorp.cdktf.TerraformProvider provider)
Sets the value ofTerraformMetaArguments.getProvider()- Parameters:
provider- the value to be set.- Returns:
this
-
provisioners
@Stability(Experimental) public MonitoringNotificationChannelConfig.Builder provisioners(List<? extends Object> provisioners)
Sets the value ofTerraformMetaArguments.getProvisioners()- Parameters:
provisioners- the value to be set.- Returns:
this
-
build
@Stability(Stable) public MonitoringNotificationChannelConfig build()
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<MonitoringNotificationChannelConfig>- Returns:
- a new instance of
MonitoringNotificationChannelConfig - Throws:
NullPointerException- if any required attribute was not provided
-
-