`resourceMonitor` Submodule

Constructs

ResourceMonitor

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

Initializers

import { resourceMonitor } from '@cdktf/provider-snowflake'

new resourceMonitor.ResourceMonitor(scope: Construct, id: string, config: ResourceMonitorConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`ResourceMonitorConfig`	No description.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`config`^Required

Type: ResourceMonitorConfig

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 toString(): string

Returns a string representation of this construct.

`addOverride`

public addOverride(path: string, value: any): void

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

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

`newLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`resetOverrideLogicalId`

public resetOverrideLogicalId(): void

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

`toHclTerraform`

public toHclTerraform(): any

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

public addMoveTarget(moveTarget: string): void

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

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

public importFrom(id: string, provider?: TerraformProvider): void

`id`^Required

Type: string

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

public moveFromId(id: string): void

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.

`id`^Required

Type: string

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

`moveTo`

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: string

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

`index`^Optional

Type: string | number

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

`moveToId`

public moveToId(id: string): void

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

`id`^Required

Type: string

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

`resetCreditQuota`

public resetCreditQuota(): void

`resetEndTimestamp`

public resetEndTimestamp(): void

`resetFrequency`

public resetFrequency(): void

`resetId`

public resetId(): void

`resetNotifyTriggers`

public resetNotifyTriggers(): void

`resetNotifyUsers`

public resetNotifyUsers(): void

`resetStartTimestamp`

public resetStartTimestamp(): void

`resetSuspendImmediateTrigger`

public resetSuspendImmediateTrigger(): void

`resetSuspendTrigger`

public resetSuspendTrigger(): void

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 { resourceMonitor } from '@cdktf/provider-snowflake'

resourceMonitor.ResourceMonitor.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`x`^Required

Type: any

Any object.

`isTerraformElement`

import { resourceMonitor } from '@cdktf/provider-snowflake'

resourceMonitor.ResourceMonitor.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { resourceMonitor } from '@cdktf/provider-snowflake'

resourceMonitor.ResourceMonitor.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { resourceMonitor } from '@cdktf/provider-snowflake'

resourceMonitor.ResourceMonitor.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: string

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

`importFromId`^Required

Type: 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.1/docs/resources/resource_monitor#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: cdktf.TerraformProvider

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

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktfStack`	`cdktf.TerraformStack`	No description.
`fqn`	`string`	No description.
`friendlyUniqueId`	`string`	No description.
`terraformMetaArguments`	`{[ key: string ]: any}`	No description.
`terraformResourceType`	`string`	No description.
`terraformGeneratorMetadata`	`cdktf.TerraformProviderGeneratorMetadata`	No description.
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`string[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`fullyQualifiedName`	`string`	No description.
`showOutput`	`ResourceMonitorShowOutputList`	No description.
`creditQuotaInput`	`number`	No description.
`endTimestampInput`	`string`	No description.
`frequencyInput`	`string`	No description.
`idInput`	`string`	No description.
`nameInput`	`string`	No description.
`notifyTriggersInput`	`number[]`	No description.
`notifyUsersInput`	`string[]`	No description.
`startTimestampInput`	`string`	No description.
`suspendImmediateTriggerInput`	`number`	No description.
`suspendTriggerInput`	`number`	No description.
`creditQuota`	`number`	No description.
`endTimestamp`	`string`	No description.
`frequency`	`string`	No description.
`id`	`string`	No description.
`name`	`string`	No description.
`notifyTriggers`	`number[]`	No description.
`notifyUsers`	`string[]`	No description.
`startTimestamp`	`string`	No description.
`suspendImmediateTrigger`	`number`	No description.
`suspendTrigger`	`number`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktf.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`fullyQualifiedName`^Required

public readonly fullyQualifiedName: string;

Type: string

`showOutput`^Required

public readonly showOutput: ResourceMonitorShowOutputList;

Type: ResourceMonitorShowOutputList

`creditQuotaInput`^Optional

public readonly creditQuotaInput: number;

Type: number

`endTimestampInput`^Optional

public readonly endTimestampInput: string;

Type: string

`frequencyInput`^Optional

public readonly frequencyInput: string;

Type: string

`idInput`^Optional

public readonly idInput: string;

Type: string

`nameInput`^Optional

public readonly nameInput: string;

Type: string

`notifyTriggersInput`^Optional

public readonly notifyTriggersInput: number[];

Type: number[]

`notifyUsersInput`^Optional

public readonly notifyUsersInput: string[];

Type: string[]

`startTimestampInput`^Optional

public readonly startTimestampInput: string;

Type: string

`suspendImmediateTriggerInput`^Optional

public readonly suspendImmediateTriggerInput: number;

Type: number

`suspendTriggerInput`^Optional

public readonly suspendTriggerInput: number;

Type: number

`creditQuota`^Required

public readonly creditQuota: number;

Type: number

`endTimestamp`^Required

public readonly endTimestamp: string;

Type: string

`frequency`^Required

public readonly frequency: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`name`^Required

public readonly name: string;

Type: string

`notifyTriggers`^Required

public readonly notifyTriggers: number[];

Type: number[]

`notifyUsers`^Required

public readonly notifyUsers: string[];

Type: string[]

`startTimestamp`^Required

public readonly startTimestamp: string;

Type: string

`suspendImmediateTrigger`^Required

public readonly suspendImmediateTrigger: number;

Type: number

`suspendTrigger`^Required

public readonly suspendTrigger: number;

Type: number

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

ResourceMonitorConfig

Initializer

import { resourceMonitor } from '@cdktf/provider-snowflake'

const resourceMonitorConfig: resourceMonitor.ResourceMonitorConfig = { ... }

Properties

Name	Type	Description
`connection`	`cdktf.SSHProvisionerConnection \| cdktf.WinrmProvisionerConnection`	No description.
`count`	`number \| cdktf.TerraformCount`	No description.
`dependsOn`	`cdktf.ITerraformDependable[]`	No description.
`forEach`	`cdktf.ITerraformIterator`	No description.
`lifecycle`	`cdktf.TerraformResourceLifecycle`	No description.
`provider`	`cdktf.TerraformProvider`	No description.
`provisioners`	`cdktf.FileProvisioner \| cdktf.LocalExecProvisioner \| cdktf.RemoteExecProvisioner[]`	No description.
`name`	`string`	Identifier for the resource monitor;
`creditQuota`	`number`	The number of credits allocated to the resource monitor per frequency interval.
`endTimestamp`	`string`	The date and time when the resource monitor suspends the assigned warehouses.
`frequency`	`string`	The frequency interval at which the credit usage resets to 0.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/resource_monitor#id ResourceMonitor#id}.
`notifyTriggers`	`number[]`	Specifies a list of percentages of the credit quota.
`notifyUsers`	`string[]`	Specifies the list of users (their identifiers) to receive email notifications on resource monitors.
`startTimestamp`	`string`	The date and time when the resource monitor starts monitoring credit usage for the assigned warehouses.
`suspendImmediateTrigger`	`number`	Represents a numeric value specified as a percentage of the credit quota.
`suspendTrigger`	`number`	Represents a numeric value specified as a percentage of the credit quota.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktf.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`name`^Required

public readonly name: string;

Type: 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.1/docs/resources/resource_monitor#name ResourceMonitor#name}

`creditQuota`^Optional

public readonly creditQuota: number;

Type: 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.1/docs/resources/resource_monitor#credit_quota ResourceMonitor#credit_quota}

`endTimestamp`^Optional

public readonly endTimestamp: string;

Type: 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.1/docs/resources/resource_monitor#end_timestamp ResourceMonitor#end_timestamp}

`frequency`^Optional

public readonly frequency: string;

Type: 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.1/docs/resources/resource_monitor#frequency ResourceMonitor#frequency}

`id`^Optional

public readonly id: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/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.

`notifyTriggers`^Optional

public readonly notifyTriggers: number[];

Type: 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.1/docs/resources/resource_monitor#notify_triggers ResourceMonitor#notify_triggers}

`notifyUsers`^Optional

public readonly notifyUsers: string[];

Type: 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.1/docs/resources/resource_monitor#notify_users ResourceMonitor#notify_users}

`startTimestamp`^Optional

public readonly startTimestamp: string;

Type: 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.1/docs/resources/resource_monitor#start_timestamp ResourceMonitor#start_timestamp}

`suspendImmediateTrigger`^Optional

public readonly suspendImmediateTrigger: number;

Type: 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.1/docs/resources/resource_monitor#suspend_immediate_trigger ResourceMonitor#suspend_immediate_trigger}

`suspendTrigger`^Optional

public readonly suspendTrigger: number;

Type: 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.1/docs/resources/resource_monitor#suspend_trigger ResourceMonitor#suspend_trigger}

ResourceMonitorShowOutput

Initializer

import { resourceMonitor } from '@cdktf/provider-snowflake'

const resourceMonitorShowOutput: resourceMonitor.ResourceMonitorShowOutput = { ... }

Classes

ResourceMonitorShowOutputList

Initializers

import { resourceMonitor } from '@cdktf/provider-snowflake'

new resourceMonitor.ResourceMonitorShowOutputList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`wrapsSet`	`boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`wrapsSet`^Required

Type: 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 allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

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

`mapKeyAttributeName`^Required

Type: string

`computeFqn`

public computeFqn(): string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`get`

public get(index: number): ResourceMonitorShowOutputOutputReference

`index`^Required

Type: number

the index of the item to return.

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: 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.

`fqn`^Required

public readonly fqn: string;

Type: string

ResourceMonitorShowOutputOutputReference

Initializers

import { resourceMonitor } from '@cdktf/provider-snowflake'

new resourceMonitor.ResourceMonitorShowOutputOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
`terraformResource`	`cdktf.IInterpolatingParent`	The parent resource.
`terraformAttribute`	`string`	The attribute on the parent resource this class is referencing.
`complexObjectIndex`	`number`	the index of this item in the list.
`complexObjectIsFromSet`	`boolean`	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

Type: string

The attribute on the parent resource this class is referencing.

`complexObjectIndex`^Required

Type: number

the index of this item in the list.

`complexObjectIsFromSet`^Required

Type: 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 computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
`creationStack`	`string[]`	The creation stack of this resolvable which will be appended to errors thrown during resolution.
`fqn`	`string`	No description.
`comment`	`string`	No description.
`createdOn`	`string`	No description.
`creditQuota`	`number`	No description.
`endTime`	`string`	No description.
`frequency`	`string`	No description.
`level`	`string`	No description.
`name`	`string`	No description.
`owner`	`string`	No description.
`remainingCredits`	`number`	No description.
`startTime`	`string`	No description.
`suspendAt`	`number`	No description.
`suspendImmediateAt`	`number`	No description.
`usedCredits`	`number`	No description.
`internalValue`	`ResourceMonitorShowOutput`	No description.

`creationStack`^Required

public readonly creationStack: string[];

Type: 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.

`fqn`^Required

public readonly fqn: string;

Type: string

`comment`^Required

public readonly comment: string;

Type: string

`createdOn`^Required

public readonly createdOn: string;

Type: string

`creditQuota`^Required

public readonly creditQuota: number;

Type: number

`endTime`^Required

public readonly endTime: string;

Type: string

`frequency`^Required

public readonly frequency: string;

Type: string

`level`^Required

public readonly level: string;

Type: string

`name`^Required

public readonly name: string;

Type: string

`owner`^Required

public readonly owner: string;

Type: string

`remainingCredits`^Required

public readonly remainingCredits: number;

Type: number

`startTime`^Required

public readonly startTime: string;

Type: string

`suspendAt`^Required

public readonly suspendAt: number;

Type: number

`suspendImmediateAt`^Required

public readonly suspendImmediateAt: number;

Type: number

`usedCredits`^Required

public readonly usedCredits: number;

Type: number

`internalValue`^Optional

public readonly internalValue: ResourceMonitorShowOutput;

Type: ResourceMonitorShowOutput

Files

resourceMonitor.typescript.md

Latest commit

History

resourceMonitor.typescript.md

File metadata and controls

resourceMonitor Submodule

Constructs