Skip to content

Latest commit

 

History

History
2019 lines (1249 loc) · 94.1 KB

resourceMonitor.java.md

File metadata and controls

2019 lines (1249 loc) · 94.1 KB

resourceMonitor Submodule

Constructs

ResourceMonitor

Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/resource_monitor snowflake_resource_monitor}.

Initializers 

import com.hashicorp.cdktf.providers.snowflake.resource_monitor.ResourceMonitor;

ResourceMonitor.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>)
    .name(java.lang.String)
//  .creditQuota(java.lang.Number)
//  .endTimestamp(java.lang.String)
//  .frequency(java.lang.String)
//  .id(java.lang.String)
//  .notifyTriggers(java.util.List<java.lang.Number>)
//  .notifyUsers(java.util.List<java.lang.String>)
//  .startTimestamp(java.lang.String)
//  .suspendImmediateTrigger(java.lang.Number)
//  .suspendTrigger(java.lang.Number)
    .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.
name java.lang.String Identifier for the resource monitor;
creditQuota java.lang.Number The number of credits allocated to the resource monitor per frequency interval.
endTimestamp java.lang.String The date and time when the resource monitor suspends the assigned warehouses.
frequency java.lang.String The frequency interval at which the credit usage resets to 0.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/resource_monitor#id ResourceMonitor#id}.
notifyTriggers java.util.List<java.lang.Number> Specifies a list of percentages of the credit quota.
notifyUsers java.util.List<java.lang.String> Specifies the list of users (their identifiers) to receive email notifications on resource monitors.
startTimestamp java.lang.String The date and time when the resource monitor starts monitoring credit usage for the assigned warehouses.
suspendImmediateTrigger java.lang.Number Represents a numeric value specified as a percentage of the credit quota.
suspendTrigger java.lang.Number Represents a numeric value specified as a percentage of the credit quota.
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>
nameRequired
  • Type: java.lang.String

Identifier for the resource monitor;

must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/resource_monitor#name ResourceMonitor#name}

creditQuotaOptional
  • Type: java.lang.Number

The number of credits allocated to the resource monitor per frequency interval.

When total usage for all warehouses assigned to the monitor reaches this number for the current frequency interval, the resource monitor is considered to be at 100% of quota.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/resource_monitor#credit_quota ResourceMonitor#credit_quota}

endTimestampOptional
  • Type: java.lang.String

The date and time when the resource monitor suspends the assigned warehouses.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/resource_monitor#end_timestamp ResourceMonitor#end_timestamp}

frequencyOptional
  • Type: java.lang.String

The frequency interval at which the credit usage resets to 0.

Valid values are (case-insensitive): MONTHLY | DAILY | WEEKLY | YEARLY | NEVER. If you set a frequency for a resource monitor, you must also set start_timestamp. If you specify NEVER for the frequency, the credit usage for the warehouse does not reset. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/resource_monitor#frequency ResourceMonitor#frequency}

idOptional
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/resource_monitor#id ResourceMonitor#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.

notifyTriggersOptional
  • Type: java.util.List<java.lang.Number>

Specifies a list of percentages of the credit quota.

After reaching any of the values the users passed in the notify_users field will be notified (to receive the notification they should have notifications enabled). Values over 100 are supported.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/resource_monitor#notify_triggers ResourceMonitor#notify_triggers}

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

Specifies the list of users (their identifiers) to receive email notifications on resource monitors.

For more information about this resource, see docs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/resource_monitor#notify_users ResourceMonitor#notify_users}

startTimestampOptional
  • Type: java.lang.String

The date and time when the resource monitor starts monitoring credit usage for the assigned warehouses.

If you set a start_timestamp for a resource monitor, you must also set frequency. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/resource_monitor#start_timestamp ResourceMonitor#start_timestamp}

suspendImmediateTriggerOptional
  • Type: java.lang.Number

Represents a numeric value specified as a percentage of the credit quota.

Values over 100 are supported. After reaching this value, all assigned warehouses immediately cancel any currently running queries or statements. In addition, this action sends a notification to all users who have enabled notifications for themselves.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/resource_monitor#suspend_immediate_trigger ResourceMonitor#suspend_immediate_trigger}

suspendTriggerOptional
  • Type: java.lang.Number

Represents a numeric value specified as a percentage of the credit quota.

Values over 100 are supported. After reaching this value, all assigned warehouses while allowing currently running queries to complete will be suspended. No new queries can be executed by the warehouses until the credit quota for the resource monitor is increased. In addition, this action sends a notification to all users who have enabled notifications for themselves.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/resource_monitor#suspend_trigger ResourceMonitor#suspend_trigger}

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".
resetCreditQuota No description.
resetEndTimestamp No description.
resetFrequency No description.
resetId No description.
resetNotifyTriggers No description.
resetNotifyUsers No description.
resetStartTimestamp No description.
resetSuspendImmediateTrigger No description.
resetSuspendTrigger 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".

resetCreditQuota 
public void resetCreditQuota()
resetEndTimestamp 
public void resetEndTimestamp()
resetFrequency 
public void resetFrequency()
resetId 
public void resetId()
resetNotifyTriggers 
public void resetNotifyTriggers()
resetNotifyUsers 
public void resetNotifyUsers()
resetStartTimestamp 
public void resetStartTimestamp()
resetSuspendImmediateTrigger 
public void resetSuspendImmediateTrigger()
resetSuspendTrigger 
public void resetSuspendTrigger()

Static Functions

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

ResourceMonitor.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.snowflake.resource_monitor.ResourceMonitor;

ResourceMonitor.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.snowflake.resource_monitor.ResourceMonitor;

ResourceMonitor.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.snowflake.resource_monitor.ResourceMonitor;

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

Generates CDKTF code for importing a ResourceMonitor 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 ResourceMonitor to import.

importFromIdRequired
  • Type: java.lang.String

The id of the existing ResourceMonitor that should be imported.

Refer to the {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/resource_monitor#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 ResourceMonitor 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.
fullyQualifiedName java.lang.String No description.
showOutput ResourceMonitorShowOutputList No description.
creditQuotaInput java.lang.Number No description.
endTimestampInput java.lang.String No description.
frequencyInput java.lang.String No description.
idInput java.lang.String No description.
nameInput java.lang.String No description.
notifyTriggersInput java.util.List<java.lang.Number> No description.
notifyUsersInput java.util.List<java.lang.String> No description.
startTimestampInput java.lang.String No description.
suspendImmediateTriggerInput java.lang.Number No description.
suspendTriggerInput java.lang.Number No description.
creditQuota java.lang.Number No description.
endTimestamp java.lang.String No description.
frequency java.lang.String No description.
id java.lang.String No description.
name java.lang.String No description.
notifyTriggers java.util.List<java.lang.Number> No description.
notifyUsers java.util.List<java.lang.String> No description.
startTimestamp java.lang.String No description.
suspendImmediateTrigger java.lang.Number No description.
suspendTrigger java.lang.Number 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>
fullyQualifiedNameRequired 
public java.lang.String getFullyQualifiedName();
  • Type: java.lang.String
showOutputRequired 
public ResourceMonitorShowOutputList getShowOutput();
creditQuotaInputOptional 
public java.lang.Number getCreditQuotaInput();
  • Type: java.lang.Number
endTimestampInputOptional 
public java.lang.String getEndTimestampInput();
  • Type: java.lang.String
frequencyInputOptional 
public java.lang.String getFrequencyInput();
  • Type: java.lang.String
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
nameInputOptional 
public java.lang.String getNameInput();
  • Type: java.lang.String
notifyTriggersInputOptional 
public java.util.List<java.lang.Number> getNotifyTriggersInput();
  • Type: java.util.List<java.lang.Number>
notifyUsersInputOptional 
public java.util.List<java.lang.String> getNotifyUsersInput();
  • Type: java.util.List<java.lang.String>
startTimestampInputOptional 
public java.lang.String getStartTimestampInput();
  • Type: java.lang.String
suspendImmediateTriggerInputOptional 
public java.lang.Number getSuspendImmediateTriggerInput();
  • Type: java.lang.Number
suspendTriggerInputOptional 
public java.lang.Number getSuspendTriggerInput();
  • Type: java.lang.Number
creditQuotaRequired 
public java.lang.Number getCreditQuota();
  • Type: java.lang.Number
endTimestampRequired 
public java.lang.String getEndTimestamp();
  • Type: java.lang.String
frequencyRequired 
public java.lang.String getFrequency();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
notifyTriggersRequired 
public java.util.List<java.lang.Number> getNotifyTriggers();
  • Type: java.util.List<java.lang.Number>
notifyUsersRequired 
public java.util.List<java.lang.String> getNotifyUsers();
  • Type: java.util.List<java.lang.String>
startTimestampRequired 
public java.lang.String getStartTimestamp();
  • Type: java.lang.String
suspendImmediateTriggerRequired 
public java.lang.Number getSuspendImmediateTrigger();
  • Type: java.lang.Number
suspendTriggerRequired 
public java.lang.Number getSuspendTrigger();
  • Type: java.lang.Number

Constants

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

Structs

ResourceMonitorConfig

Initializer 

import com.hashicorp.cdktf.providers.snowflake.resource_monitor.ResourceMonitorConfig;

ResourceMonitorConfig.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>)
    .name(java.lang.String)
//  .creditQuota(java.lang.Number)
//  .endTimestamp(java.lang.String)
//  .frequency(java.lang.String)
//  .id(java.lang.String)
//  .notifyTriggers(java.util.List<java.lang.Number>)
//  .notifyUsers(java.util.List<java.lang.String>)
//  .startTimestamp(java.lang.String)
//  .suspendImmediateTrigger(java.lang.Number)
//  .suspendTrigger(java.lang.Number)
    .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.
name java.lang.String Identifier for the resource monitor;
creditQuota java.lang.Number The number of credits allocated to the resource monitor per frequency interval.
endTimestamp java.lang.String The date and time when the resource monitor suspends the assigned warehouses.
frequency java.lang.String The frequency interval at which the credit usage resets to 0.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/resource_monitor#id ResourceMonitor#id}.
notifyTriggers java.util.List<java.lang.Number> Specifies a list of percentages of the credit quota.
notifyUsers java.util.List<java.lang.String> Specifies the list of users (their identifiers) to receive email notifications on resource monitors.
startTimestamp java.lang.String The date and time when the resource monitor starts monitoring credit usage for the assigned warehouses.
suspendImmediateTrigger java.lang.Number Represents a numeric value specified as a percentage of the credit quota.
suspendTrigger java.lang.Number Represents a numeric value specified as a percentage of the credit quota.
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>
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String

Identifier for the resource monitor;

must be unique for your account. Due to technical limitations (read more here), avoid using the following characters: |, ., ".

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/resource_monitor#name ResourceMonitor#name}

creditQuotaOptional 
public java.lang.Number getCreditQuota();
  • Type: java.lang.Number

The number of credits allocated to the resource monitor per frequency interval.

When total usage for all warehouses assigned to the monitor reaches this number for the current frequency interval, the resource monitor is considered to be at 100% of quota.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/resource_monitor#credit_quota ResourceMonitor#credit_quota}

endTimestampOptional 
public java.lang.String getEndTimestamp();
  • Type: java.lang.String

The date and time when the resource monitor suspends the assigned warehouses.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/resource_monitor#end_timestamp ResourceMonitor#end_timestamp}

frequencyOptional 
public java.lang.String getFrequency();
  • Type: java.lang.String

The frequency interval at which the credit usage resets to 0.

Valid values are (case-insensitive): MONTHLY | DAILY | WEEKLY | YEARLY | NEVER. If you set a frequency for a resource monitor, you must also set start_timestamp. If you specify NEVER for the frequency, the credit usage for the warehouse does not reset. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/resource_monitor#frequency ResourceMonitor#frequency}

idOptional 
public java.lang.String getId();
  • Type: java.lang.String

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/resource_monitor#id ResourceMonitor#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.

notifyTriggersOptional 
public java.util.List<java.lang.Number> getNotifyTriggers();
  • Type: java.util.List<java.lang.Number>

Specifies a list of percentages of the credit quota.

After reaching any of the values the users passed in the notify_users field will be notified (to receive the notification they should have notifications enabled). Values over 100 are supported.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/resource_monitor#notify_triggers ResourceMonitor#notify_triggers}

notifyUsersOptional 
public java.util.List<java.lang.String> getNotifyUsers();
  • Type: java.util.List<java.lang.String>

Specifies the list of users (their identifiers) to receive email notifications on resource monitors.

For more information about this resource, see docs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/resource_monitor#notify_users ResourceMonitor#notify_users}

startTimestampOptional 
public java.lang.String getStartTimestamp();
  • Type: java.lang.String

The date and time when the resource monitor starts monitoring credit usage for the assigned warehouses.

If you set a start_timestamp for a resource monitor, you must also set frequency. After removing this field from the config, the previously set value will be preserved on the Snowflake side, not the default value. That's due to Snowflake limitation and the lack of unset functionality for this parameter.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/resource_monitor#start_timestamp ResourceMonitor#start_timestamp}

suspendImmediateTriggerOptional 
public java.lang.Number getSuspendImmediateTrigger();
  • Type: java.lang.Number

Represents a numeric value specified as a percentage of the credit quota.

Values over 100 are supported. After reaching this value, all assigned warehouses immediately cancel any currently running queries or statements. In addition, this action sends a notification to all users who have enabled notifications for themselves.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/resource_monitor#suspend_immediate_trigger ResourceMonitor#suspend_immediate_trigger}

suspendTriggerOptional 
public java.lang.Number getSuspendTrigger();
  • Type: java.lang.Number

Represents a numeric value specified as a percentage of the credit quota.

Values over 100 are supported. After reaching this value, all assigned warehouses while allowing currently running queries to complete will be suspended. No new queries can be executed by the warehouses until the credit quota for the resource monitor is increased. In addition, this action sends a notification to all users who have enabled notifications for themselves.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.3/docs/resources/resource_monitor#suspend_trigger ResourceMonitor#suspend_trigger}

ResourceMonitorShowOutput

Initializer 

import com.hashicorp.cdktf.providers.snowflake.resource_monitor.ResourceMonitorShowOutput;

ResourceMonitorShowOutput.builder()
    .build();

Classes

ResourceMonitorShowOutputList

Initializers 

import com.hashicorp.cdktf.providers.snowflake.resource_monitor.ResourceMonitorShowOutputList;

new ResourceMonitorShowOutputList(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Boolean wrapsSet);
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.
wrapsSet java.lang.Boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • Type: java.lang.Boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

Name Description
allWithMapKey Creating an iterator for this complex list.
computeFqn No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.
allWithMapKey 
public DynamicListTerraformIterator allWithMapKey(java.lang.String mapKeyAttributeName)

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeNameRequired
  • Type: java.lang.String
computeFqn 
public java.lang.String computeFqn()
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

get 
public ResourceMonitorShowOutputOutputReference get(java.lang.Number index)
indexRequired
  • Type: java.lang.Number

the index of the item to return.

Properties

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.
creationStackRequired 
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.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String

ResourceMonitorShowOutputOutputReference

Initializers 

import com.hashicorp.cdktf.providers.snowflake.resource_monitor.ResourceMonitorShowOutputOutputReference;

new ResourceMonitorShowOutputOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute, java.lang.Number complexObjectIndex, java.lang.Boolean complexObjectIsFromSet);
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.
complexObjectIndex java.lang.Number the index of this item in the list.
complexObjectIsFromSet java.lang.Boolean whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.String

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: java.lang.Number

the index of this item in the list.

complexObjectIsFromSetRequired
  • Type: java.lang.Boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

Methods

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.
computeFqn 
public java.lang.String computeFqn()
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
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

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.
comment java.lang.String No description.
createdOn java.lang.String No description.
creditQuota java.lang.Number No description.
endTime java.lang.String No description.
frequency java.lang.String No description.
level java.lang.String No description.
name java.lang.String No description.
owner java.lang.String No description.
remainingCredits java.lang.Number No description.
startTime java.lang.String No description.
suspendAt java.lang.Number No description.
suspendImmediateAt java.lang.Number No description.
usedCredits java.lang.Number No description.
internalValue ResourceMonitorShowOutput No description.
creationStackRequired 
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.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
commentRequired 
public java.lang.String getComment();
  • Type: java.lang.String
createdOnRequired 
public java.lang.String getCreatedOn();
  • Type: java.lang.String
creditQuotaRequired 
public java.lang.Number getCreditQuota();
  • Type: java.lang.Number
endTimeRequired 
public java.lang.String getEndTime();
  • Type: java.lang.String
frequencyRequired 
public java.lang.String getFrequency();
  • Type: java.lang.String
levelRequired 
public java.lang.String getLevel();
  • Type: java.lang.String
nameRequired 
public java.lang.String getName();
  • Type: java.lang.String
ownerRequired 
public java.lang.String getOwner();
  • Type: java.lang.String
remainingCreditsRequired 
public java.lang.Number getRemainingCredits();
  • Type: java.lang.Number
startTimeRequired 
public java.lang.String getStartTime();
  • Type: java.lang.String
suspendAtRequired 
public java.lang.Number getSuspendAt();
  • Type: java.lang.Number
suspendImmediateAtRequired 
public java.lang.Number getSuspendImmediateAt();
  • Type: java.lang.Number
usedCreditsRequired 
public java.lang.Number getUsedCredits();
  • Type: java.lang.Number
internalValueOptional 
public ResourceMonitorShowOutput getInternalValue();