Skip to content

Latest commit

 

History

History
2812 lines (1760 loc) · 129 KB

cloudwatchMetricAlarm.md

File metadata and controls

2812 lines (1760 loc) · 129 KB

aws_cloudwatch_metric_alarm

Refer to the Terraform Registory for docs: aws_cloudwatch_metric_alarm.

cloudwatchMetricAlarm Submodule

Constructs

CloudwatchMetricAlarm

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm aws_cloudwatch_metric_alarm}.

Initializers

import { cloudwatchMetricAlarm } from '@cdktf/aws-cdk'

new cloudwatchMetricAlarm.CloudwatchMetricAlarm(scope: Construct, id: string, config: CloudwatchMetricAlarmConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config CloudwatchMetricAlarmConfig No description.

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.


idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope


configRequired

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.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
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.
putMetricQuery No description.
resetActionsEnabled No description.
resetAlarmActions No description.
resetAlarmDescription No description.
resetDatapointsToAlarm No description.
resetDimensions No description.
resetEvaluateLowSampleCountPercentiles No description.
resetExtendedStatistic No description.
resetId No description.
resetInsufficientDataActions No description.
resetMetricName No description.
resetMetricQuery No description.
resetNamespace No description.
resetOkActions No description.
resetPeriod No description.
resetStatistic No description.
resetTags No description.
resetTagsAll No description.
resetThreshold No description.
resetThresholdMetricId No description.
resetTreatMissingData No description.
resetUnit No description.

toString
public toString(): string

Returns a string representation of this construct.

addOverride
public addOverride(path: string, value: any): void
pathRequired
  • Type: string

valueRequired
  • Type: any

overrideLogicalId
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • 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.

toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any

Adds this resource to the terraform JSON output.

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

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

putMetricQuery
public putMetricQuery(value: IResolvable | CloudwatchMetricAlarmMetricQuery[]): void
valueRequired

resetActionsEnabled
public resetActionsEnabled(): void
resetAlarmActions
public resetAlarmActions(): void
resetAlarmDescription
public resetAlarmDescription(): void
resetDatapointsToAlarm
public resetDatapointsToAlarm(): void
resetDimensions
public resetDimensions(): void
resetEvaluateLowSampleCountPercentiles
public resetEvaluateLowSampleCountPercentiles(): void
resetExtendedStatistic
public resetExtendedStatistic(): void
resetId
public resetId(): void
resetInsufficientDataActions
public resetInsufficientDataActions(): void
resetMetricName
public resetMetricName(): void
resetMetricQuery
public resetMetricQuery(): void
resetNamespace
public resetNamespace(): void
resetOkActions
public resetOkActions(): void
resetPeriod
public resetPeriod(): void
resetStatistic
public resetStatistic(): void
resetTags
public resetTags(): void
resetTagsAll
public resetTagsAll(): void
resetThreshold
public resetThreshold(): void
resetThresholdMetricId
public resetThresholdMetricId(): void
resetTreatMissingData
public resetTreatMissingData(): void
resetUnit
public resetUnit(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.

isConstruct
import { cloudwatchMetricAlarm } from '@cdktf/aws-cdk'

cloudwatchMetricAlarm.CloudwatchMetricAlarm.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.

xRequired
  • Type: any

Any object.


isTerraformElement
import { cloudwatchMetricAlarm } from '@cdktf/aws-cdk'

cloudwatchMetricAlarm.CloudwatchMetricAlarm.isTerraformElement(x: any)
xRequired
  • Type: any

isTerraformResource
import { cloudwatchMetricAlarm } from '@cdktf/aws-cdk'

cloudwatchMetricAlarm.CloudwatchMetricAlarm.isTerraformResource(x: any)
xRequired
  • Type: any

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.
arn string No description.
metricQuery CloudwatchMetricAlarmMetricQueryList No description.
actionsEnabledInput boolean | cdktf.IResolvable No description.
alarmActionsInput string[] No description.
alarmDescriptionInput string No description.
alarmNameInput string No description.
comparisonOperatorInput string No description.
datapointsToAlarmInput number No description.
dimensionsInput {[ key: string ]: string} No description.
evaluateLowSampleCountPercentilesInput string No description.
evaluationPeriodsInput number No description.
extendedStatisticInput string No description.
idInput string No description.
insufficientDataActionsInput string[] No description.
metricNameInput string No description.
metricQueryInput cdktf.IResolvable | CloudwatchMetricAlarmMetricQuery[] No description.
namespaceInput string No description.
okActionsInput string[] No description.
periodInput number No description.
statisticInput string No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
thresholdInput number No description.
thresholdMetricIdInput string No description.
treatMissingDataInput string No description.
unitInput string No description.
actionsEnabled boolean | cdktf.IResolvable No description.
alarmActions string[] No description.
alarmDescription string No description.
alarmName string No description.
comparisonOperator string No description.
datapointsToAlarm number No description.
dimensions {[ key: string ]: string} No description.
evaluateLowSampleCountPercentiles string No description.
evaluationPeriods number No description.
extendedStatistic string No description.
id string No description.
insufficientDataActions string[] No description.
metricName string No description.
namespace string No description.
okActions string[] No description.
period number No description.
statistic string No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: string} No description.
threshold number No description.
thresholdMetricId string No description.
treatMissingData string No description.
unit string No description.

nodeRequired
public readonly node: Node;
  • Type: constructs.Node

The tree node.


cdktfStackRequired
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack

fqnRequired
public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
  • Type: string

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

terraformResourceTypeRequired
public readonly terraformResourceType: string;
  • Type: string

terraformGeneratorMetadataOptional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: string[];
  • Type: string[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

arnRequired
public readonly arn: string;
  • Type: string

metricQueryRequired
public readonly metricQuery: CloudwatchMetricAlarmMetricQueryList;

actionsEnabledInputOptional
public readonly actionsEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

alarmActionsInputOptional
public readonly alarmActionsInput: string[];
  • Type: string[]

alarmDescriptionInputOptional
public readonly alarmDescriptionInput: string;
  • Type: string

alarmNameInputOptional
public readonly alarmNameInput: string;
  • Type: string

comparisonOperatorInputOptional
public readonly comparisonOperatorInput: string;
  • Type: string

datapointsToAlarmInputOptional
public readonly datapointsToAlarmInput: number;
  • Type: number

dimensionsInputOptional
public readonly dimensionsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

evaluateLowSampleCountPercentilesInputOptional
public readonly evaluateLowSampleCountPercentilesInput: string;
  • Type: string

evaluationPeriodsInputOptional
public readonly evaluationPeriodsInput: number;
  • Type: number

extendedStatisticInputOptional
public readonly extendedStatisticInput: string;
  • Type: string

idInputOptional
public readonly idInput: string;
  • Type: string

insufficientDataActionsInputOptional
public readonly insufficientDataActionsInput: string[];
  • Type: string[]

metricNameInputOptional
public readonly metricNameInput: string;
  • Type: string

metricQueryInputOptional
public readonly metricQueryInput: IResolvable | CloudwatchMetricAlarmMetricQuery[];

namespaceInputOptional
public readonly namespaceInput: string;
  • Type: string

okActionsInputOptional
public readonly okActionsInput: string[];
  • Type: string[]

periodInputOptional
public readonly periodInput: number;
  • Type: number

statisticInputOptional
public readonly statisticInput: string;
  • Type: string

tagsAllInputOptional
public readonly tagsAllInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

tagsInputOptional
public readonly tagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

thresholdInputOptional
public readonly thresholdInput: number;
  • Type: number

thresholdMetricIdInputOptional
public readonly thresholdMetricIdInput: string;
  • Type: string

treatMissingDataInputOptional
public readonly treatMissingDataInput: string;
  • Type: string

unitInputOptional
public readonly unitInput: string;
  • Type: string

actionsEnabledRequired
public readonly actionsEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

alarmActionsRequired
public readonly alarmActions: string[];
  • Type: string[]

alarmDescriptionRequired
public readonly alarmDescription: string;
  • Type: string

alarmNameRequired
public readonly alarmName: string;
  • Type: string

comparisonOperatorRequired
public readonly comparisonOperator: string;
  • Type: string

datapointsToAlarmRequired
public readonly datapointsToAlarm: number;
  • Type: number

dimensionsRequired
public readonly dimensions: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

evaluateLowSampleCountPercentilesRequired
public readonly evaluateLowSampleCountPercentiles: string;
  • Type: string

evaluationPeriodsRequired
public readonly evaluationPeriods: number;
  • Type: number

extendedStatisticRequired
public readonly extendedStatistic: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

insufficientDataActionsRequired
public readonly insufficientDataActions: string[];
  • Type: string[]

metricNameRequired
public readonly metricName: string;
  • Type: string

namespaceRequired
public readonly namespace: string;
  • Type: string

okActionsRequired
public readonly okActions: string[];
  • Type: string[]

periodRequired
public readonly period: number;
  • Type: number

statisticRequired
public readonly statistic: string;
  • Type: string

tagsRequired
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

tagsAllRequired
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

thresholdRequired
public readonly threshold: number;
  • Type: number

thresholdMetricIdRequired
public readonly thresholdMetricId: string;
  • Type: string

treatMissingDataRequired
public readonly treatMissingData: string;
  • Type: string

unitRequired
public readonly unit: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
public readonly tfResourceType: string;
  • Type: string

Structs

CloudwatchMetricAlarmConfig

Initializer

import { cloudwatchMetricAlarm } from '@cdktf/aws-cdk'

const cloudwatchMetricAlarmConfig: cloudwatchMetricAlarm.CloudwatchMetricAlarmConfig = { ... }

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.
alarmName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#alarm_name CloudwatchMetricAlarm#alarm_name}.
comparisonOperator string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#comparison_operator CloudwatchMetricAlarm#comparison_operator}.
evaluationPeriods number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#evaluation_periods CloudwatchMetricAlarm#evaluation_periods}.
actionsEnabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#actions_enabled CloudwatchMetricAlarm#actions_enabled}.
alarmActions string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#alarm_actions CloudwatchMetricAlarm#alarm_actions}.
alarmDescription string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#alarm_description CloudwatchMetricAlarm#alarm_description}.
datapointsToAlarm number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#datapoints_to_alarm CloudwatchMetricAlarm#datapoints_to_alarm}.
dimensions {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#dimensions CloudwatchMetricAlarm#dimensions}.
evaluateLowSampleCountPercentiles string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#evaluate_low_sample_count_percentiles CloudwatchMetricAlarm#evaluate_low_sample_count_percentiles}.
extendedStatistic string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#extended_statistic CloudwatchMetricAlarm#extended_statistic}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#id CloudwatchMetricAlarm#id}.
insufficientDataActions string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#insufficient_data_actions CloudwatchMetricAlarm#insufficient_data_actions}.
metricName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#metric_name CloudwatchMetricAlarm#metric_name}.
metricQuery cdktf.IResolvable | CloudwatchMetricAlarmMetricQuery[] metric_query block.
namespace string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#namespace CloudwatchMetricAlarm#namespace}.
okActions string[] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#ok_actions CloudwatchMetricAlarm#ok_actions}.
period number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#period CloudwatchMetricAlarm#period}.
statistic string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#statistic CloudwatchMetricAlarm#statistic}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#tags CloudwatchMetricAlarm#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#tags_all CloudwatchMetricAlarm#tags_all}.
threshold number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#threshold CloudwatchMetricAlarm#threshold}.
thresholdMetricId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#threshold_metric_id CloudwatchMetricAlarm#threshold_metric_id}.
treatMissingData string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#treat_missing_data CloudwatchMetricAlarm#treat_missing_data}.
unit string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#unit CloudwatchMetricAlarm#unit}.

connectionOptional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

countOptional
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount

dependsOnOptional
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]

forEachOptional
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator

lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle

providerOptional
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider

provisionersOptional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

alarmNameRequired
public readonly alarmName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#alarm_name CloudwatchMetricAlarm#alarm_name}.


comparisonOperatorRequired
public readonly comparisonOperator: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#comparison_operator CloudwatchMetricAlarm#comparison_operator}.


evaluationPeriodsRequired
public readonly evaluationPeriods: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#evaluation_periods CloudwatchMetricAlarm#evaluation_periods}.


actionsEnabledOptional
public readonly actionsEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#actions_enabled CloudwatchMetricAlarm#actions_enabled}.


alarmActionsOptional
public readonly alarmActions: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#alarm_actions CloudwatchMetricAlarm#alarm_actions}.


alarmDescriptionOptional
public readonly alarmDescription: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#alarm_description CloudwatchMetricAlarm#alarm_description}.


datapointsToAlarmOptional
public readonly datapointsToAlarm: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#datapoints_to_alarm CloudwatchMetricAlarm#datapoints_to_alarm}.


dimensionsOptional
public readonly dimensions: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#dimensions CloudwatchMetricAlarm#dimensions}.


evaluateLowSampleCountPercentilesOptional
public readonly evaluateLowSampleCountPercentiles: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#evaluate_low_sample_count_percentiles CloudwatchMetricAlarm#evaluate_low_sample_count_percentiles}.


extendedStatisticOptional
public readonly extendedStatistic: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#extended_statistic CloudwatchMetricAlarm#extended_statistic}.


idOptional
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#id CloudwatchMetricAlarm#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.


insufficientDataActionsOptional
public readonly insufficientDataActions: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#insufficient_data_actions CloudwatchMetricAlarm#insufficient_data_actions}.


metricNameOptional
public readonly metricName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#metric_name CloudwatchMetricAlarm#metric_name}.


metricQueryOptional
public readonly metricQuery: IResolvable | CloudwatchMetricAlarmMetricQuery[];

metric_query block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#metric_query CloudwatchMetricAlarm#metric_query}


namespaceOptional
public readonly namespace: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#namespace CloudwatchMetricAlarm#namespace}.


okActionsOptional
public readonly okActions: string[];
  • Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#ok_actions CloudwatchMetricAlarm#ok_actions}.


periodOptional
public readonly period: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#period CloudwatchMetricAlarm#period}.


statisticOptional
public readonly statistic: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#statistic CloudwatchMetricAlarm#statistic}.


tagsOptional
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#tags CloudwatchMetricAlarm#tags}.


tagsAllOptional
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#tags_all CloudwatchMetricAlarm#tags_all}.


thresholdOptional
public readonly threshold: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#threshold CloudwatchMetricAlarm#threshold}.


thresholdMetricIdOptional
public readonly thresholdMetricId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#threshold_metric_id CloudwatchMetricAlarm#threshold_metric_id}.


treatMissingDataOptional
public readonly treatMissingData: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#treat_missing_data CloudwatchMetricAlarm#treat_missing_data}.


unitOptional
public readonly unit: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#unit CloudwatchMetricAlarm#unit}.


CloudwatchMetricAlarmMetricQuery

Initializer

import { cloudwatchMetricAlarm } from '@cdktf/aws-cdk'

const cloudwatchMetricAlarmMetricQuery: cloudwatchMetricAlarm.CloudwatchMetricAlarmMetricQuery = { ... }

Properties

Name Type Description
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#id CloudwatchMetricAlarm#id}.
accountId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#account_id CloudwatchMetricAlarm#account_id}.
expression string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#expression CloudwatchMetricAlarm#expression}.
label string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#label CloudwatchMetricAlarm#label}.
metric CloudwatchMetricAlarmMetricQueryMetric metric block.
returnData boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#return_data CloudwatchMetricAlarm#return_data}.

idRequired
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#id CloudwatchMetricAlarm#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.


accountIdOptional
public readonly accountId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#account_id CloudwatchMetricAlarm#account_id}.


expressionOptional
public readonly expression: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#expression CloudwatchMetricAlarm#expression}.


labelOptional
public readonly label: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#label CloudwatchMetricAlarm#label}.


metricOptional
public readonly metric: CloudwatchMetricAlarmMetricQueryMetric;

metric block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#metric CloudwatchMetricAlarm#metric}


returnDataOptional
public readonly returnData: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#return_data CloudwatchMetricAlarm#return_data}.


CloudwatchMetricAlarmMetricQueryMetric

Initializer

import { cloudwatchMetricAlarm } from '@cdktf/aws-cdk'

const cloudwatchMetricAlarmMetricQueryMetric: cloudwatchMetricAlarm.CloudwatchMetricAlarmMetricQueryMetric = { ... }

Properties

Name Type Description
metricName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#metric_name CloudwatchMetricAlarm#metric_name}.
period number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#period CloudwatchMetricAlarm#period}.
stat string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#stat CloudwatchMetricAlarm#stat}.
dimensions {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#dimensions CloudwatchMetricAlarm#dimensions}.
namespace string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#namespace CloudwatchMetricAlarm#namespace}.
unit string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#unit CloudwatchMetricAlarm#unit}.

metricNameRequired
public readonly metricName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#metric_name CloudwatchMetricAlarm#metric_name}.


periodRequired
public readonly period: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#period CloudwatchMetricAlarm#period}.


statRequired
public readonly stat: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#stat CloudwatchMetricAlarm#stat}.


dimensionsOptional
public readonly dimensions: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#dimensions CloudwatchMetricAlarm#dimensions}.


namespaceOptional
public readonly namespace: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#namespace CloudwatchMetricAlarm#namespace}.


unitOptional
public readonly unit: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/cloudwatch_metric_alarm#unit CloudwatchMetricAlarm#unit}.


Classes

CloudwatchMetricAlarmMetricQueryList

Initializers

import { cloudwatchMetricAlarm } from '@cdktf/aws-cdk'

new cloudwatchMetricAlarm.CloudwatchMetricAlarmMetricQueryList(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).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


wrapsSetRequired
  • 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.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
get No description.

computeFqn
public computeFqn(): string
resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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): CloudwatchMetricAlarmMetricQueryOutputReference
indexRequired
  • 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.
internalValue cdktf.IResolvable | CloudwatchMetricAlarmMetricQuery[] No description.

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


fqnRequired
public readonly fqn: string;
  • Type: string

internalValueOptional
public readonly internalValue: IResolvable | CloudwatchMetricAlarmMetricQuery[];

CloudwatchMetricAlarmMetricQueryMetricOutputReference

Initializers

import { cloudwatchMetricAlarm } from '@cdktf/aws-cdk'

new cloudwatchMetricAlarm.CloudwatchMetricAlarmMetricQueryMetricOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


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.
resetDimensions No description.
resetNamespace No description.
resetUnit No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetDimensions
public resetDimensions(): void
resetNamespace
public resetNamespace(): void
resetUnit
public resetUnit(): void

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.
dimensionsInput {[ key: string ]: string} No description.
metricNameInput string No description.
namespaceInput string No description.
periodInput number No description.
statInput string No description.
unitInput string No description.
dimensions {[ key: string ]: string} No description.
metricName string No description.
namespace string No description.
period number No description.
stat string No description.
unit string No description.
internalValue CloudwatchMetricAlarmMetricQueryMetric No description.

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


fqnRequired
public readonly fqn: string;
  • Type: string

dimensionsInputOptional
public readonly dimensionsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

metricNameInputOptional
public readonly metricNameInput: string;
  • Type: string

namespaceInputOptional
public readonly namespaceInput: string;
  • Type: string

periodInputOptional
public readonly periodInput: number;
  • Type: number

statInputOptional
public readonly statInput: string;
  • Type: string

unitInputOptional
public readonly unitInput: string;
  • Type: string

dimensionsRequired
public readonly dimensions: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

metricNameRequired
public readonly metricName: string;
  • Type: string

namespaceRequired
public readonly namespace: string;
  • Type: string

periodRequired
public readonly period: number;
  • Type: number

statRequired
public readonly stat: string;
  • Type: string

unitRequired
public readonly unit: string;
  • Type: string

internalValueOptional
public readonly internalValue: CloudwatchMetricAlarmMetricQueryMetric;

CloudwatchMetricAlarmMetricQueryOutputReference

Initializers

import { cloudwatchMetricAlarm } from '@cdktf/aws-cdk'

new cloudwatchMetricAlarm.CloudwatchMetricAlarmMetricQueryOutputReference(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).

terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.


terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.


complexObjectIndexRequired
  • Type: number

the index of this item in the list.


complexObjectIsFromSetRequired
  • 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.
putMetric No description.
resetAccountId No description.
resetExpression No description.
resetLabel No description.
resetMetric No description.
resetReturnData No description.

computeFqn
public computeFqn(): string
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string

getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string

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

getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string

getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string

getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string

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

getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string

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

interpolationForAttribute
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string

resolve
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext

toString
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

putMetric
public putMetric(value: CloudwatchMetricAlarmMetricQueryMetric): void
valueRequired

resetAccountId
public resetAccountId(): void
resetExpression
public resetExpression(): void
resetLabel
public resetLabel(): void
resetMetric
public resetMetric(): void
resetReturnData
public resetReturnData(): void

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.
metric CloudwatchMetricAlarmMetricQueryMetricOutputReference No description.
accountIdInput string No description.
expressionInput string No description.
idInput string No description.
labelInput string No description.
metricInput CloudwatchMetricAlarmMetricQueryMetric No description.
returnDataInput boolean | cdktf.IResolvable No description.
accountId string No description.
expression string No description.
id string No description.
label string No description.
returnData boolean | cdktf.IResolvable No description.
internalValue cdktf.IResolvable | CloudwatchMetricAlarmMetricQuery No description.

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


fqnRequired
public readonly fqn: string;
  • Type: string

metricRequired
public readonly metric: CloudwatchMetricAlarmMetricQueryMetricOutputReference;

accountIdInputOptional
public readonly accountIdInput: string;
  • Type: string

expressionInputOptional
public readonly expressionInput: string;
  • Type: string

idInputOptional
public readonly idInput: string;
  • Type: string

labelInputOptional
public readonly labelInput: string;
  • Type: string

metricInputOptional
public readonly metricInput: CloudwatchMetricAlarmMetricQueryMetric;

returnDataInputOptional
public readonly returnDataInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

accountIdRequired
public readonly accountId: string;
  • Type: string

expressionRequired
public readonly expression: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

labelRequired
public readonly label: string;
  • Type: string

returnDataRequired
public readonly returnData: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

internalValueOptional
public readonly internalValue: IResolvable | CloudwatchMetricAlarmMetricQuery;