package awscloudwatch import ( _init_ "github.com/aws/aws-cdk-go/awscdk/v2/jsii" _jsii_ "github.com/aws/jsii-runtime-go/runtime" "github.com/aws/aws-cdk-go/awscdk/v2" "github.com/aws/constructs-go/constructs/v10" ) // An alarm on a CloudWatch metric. // // Example: // import "github.com/aws/aws-cdk-go/awscdk" // // var alias alias // // // or add alarms to an existing group // var blueGreenAlias alias // // alarm := cloudwatch.NewAlarm(this, jsii.String("Errors"), &AlarmProps{ // ComparisonOperator: cloudwatch.ComparisonOperator_GREATER_THAN_THRESHOLD, // Threshold: jsii.Number(1), // EvaluationPeriods: jsii.Number(1), // Metric: alias.metricErrors(), // }) // deploymentGroup := codedeploy.NewLambdaDeploymentGroup(this, jsii.String("BlueGreenDeployment"), &LambdaDeploymentGroupProps{ // Alias: Alias, // DeploymentConfig: codedeploy.LambdaDeploymentConfig_LINEAR_10PERCENT_EVERY_1MINUTE(), // Alarms: []iAlarm{ // alarm, // }, // }) // deploymentGroup.AddAlarm(cloudwatch.NewAlarm(this, jsii.String("BlueGreenErrors"), &AlarmProps{ // ComparisonOperator: cloudwatch.ComparisonOperator_GREATER_THAN_THRESHOLD, // Threshold: jsii.Number(1), // EvaluationPeriods: jsii.Number(1), // Metric: blueGreenAlias.metricErrors(), // })) // type Alarm interface { AlarmBase AlarmActionArns() *[]*string SetAlarmActionArns(val *[]*string) // ARN of this alarm. AlarmArn() *string // Name of this alarm. AlarmName() *string // The environment this resource belongs to. // // For resources that are created and managed by the CDK // (generally, those created by creating new class instances like Role, Bucket, etc.), // this is always the same as the environment of the stack they belong to; // however, for imported resources // (those obtained from static methods like fromRoleArn, fromBucketName, etc.), // that might be different than the stack they were imported into. Env() *awscdk.ResourceEnvironment InsufficientDataActionArns() *[]*string SetInsufficientDataActionArns(val *[]*string) // The metric object this alarm was based on. Metric() IMetric // The tree node. Node() constructs.Node OkActionArns() *[]*string SetOkActionArns(val *[]*string) // Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by CloudFormation // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. PhysicalName() *string // The stack in which this resource is defined. Stack() awscdk.Stack // Trigger this action if the alarm fires. // // Typically SnsAcion or AutoScalingAction. AddAlarmAction(actions ...IAlarmAction) // Trigger this action if there is insufficient data to evaluate the alarm. // // Typically SnsAcion or AutoScalingAction. AddInsufficientDataAction(actions ...IAlarmAction) // Trigger this action if the alarm returns from breaching state into ok state. // // Typically SnsAcion or AutoScalingAction. AddOkAction(actions ...IAlarmAction) // Apply the given removal policy to this resource. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). ApplyRemovalPolicy(policy awscdk.RemovalPolicy) GeneratePhysicalName() *string // Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`). // // Normally, this token will resolve to `arnAttr`, but if the resource is // referenced across environments, `arnComponents` will be used to synthesize // a concrete ARN with the resource's physical name. Make sure to reference // `this.physicalName` in `arnComponents`. GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string // Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`). // // Normally, this token will resolve to `nameAttr`, but if the resource is // referenced across environments, it will be resolved to `this.physicalName`, // which will be a concrete name. GetResourceNameAttribute(nameAttr *string) *string // AlarmRule indicating ALARM state for Alarm. RenderAlarmRule() *string // Turn this alarm into a horizontal annotation. // // This is useful if you want to represent an Alarm in a non-AlarmWidget. // An `AlarmWidget` can directly show an alarm, but it can only show a // single alarm and no other metrics. Instead, you can convert the alarm to // a HorizontalAnnotation and add it as an annotation to another graph. // // This might be useful if: // // - You want to show multiple alarms inside a single graph, for example if // you have both a "small margin/long period" alarm as well as a // "large margin/short period" alarm. // // - You want to show an Alarm line in a graph with multiple metrics in it. ToAnnotation() *HorizontalAnnotation // Returns a string representation of this construct. ToString() *string } // The jsii proxy struct for Alarm type jsiiProxy_Alarm struct { jsiiProxy_AlarmBase } func (j *jsiiProxy_Alarm) AlarmActionArns() *[]*string { var returns *[]*string _jsii_.Get( j, "alarmActionArns", &returns, ) return returns } func (j *jsiiProxy_Alarm) AlarmArn() *string { var returns *string _jsii_.Get( j, "alarmArn", &returns, ) return returns } func (j *jsiiProxy_Alarm) AlarmName() *string { var returns *string _jsii_.Get( j, "alarmName", &returns, ) return returns } func (j *jsiiProxy_Alarm) Env() *awscdk.ResourceEnvironment { var returns *awscdk.ResourceEnvironment _jsii_.Get( j, "env", &returns, ) return returns } func (j *jsiiProxy_Alarm) InsufficientDataActionArns() *[]*string { var returns *[]*string _jsii_.Get( j, "insufficientDataActionArns", &returns, ) return returns } func (j *jsiiProxy_Alarm) Metric() IMetric { var returns IMetric _jsii_.Get( j, "metric", &returns, ) return returns } func (j *jsiiProxy_Alarm) Node() constructs.Node { var returns constructs.Node _jsii_.Get( j, "node", &returns, ) return returns } func (j *jsiiProxy_Alarm) OkActionArns() *[]*string { var returns *[]*string _jsii_.Get( j, "okActionArns", &returns, ) return returns } func (j *jsiiProxy_Alarm) PhysicalName() *string { var returns *string _jsii_.Get( j, "physicalName", &returns, ) return returns } func (j *jsiiProxy_Alarm) Stack() awscdk.Stack { var returns awscdk.Stack _jsii_.Get( j, "stack", &returns, ) return returns } func NewAlarm(scope constructs.Construct, id *string, props *AlarmProps) Alarm { _init_.Initialize() if err := validateNewAlarmParameters(scope, id, props); err != nil { panic(err) } j := jsiiProxy_Alarm{} _jsii_.Create( "aws-cdk-lib.aws_cloudwatch.Alarm", []interface{}{scope, id, props}, &j, ) return &j } func NewAlarm_Override(a Alarm, scope constructs.Construct, id *string, props *AlarmProps) { _init_.Initialize() _jsii_.Create( "aws-cdk-lib.aws_cloudwatch.Alarm", []interface{}{scope, id, props}, a, ) } func (j *jsiiProxy_Alarm)SetAlarmActionArns(val *[]*string) { _jsii_.Set( j, "alarmActionArns", val, ) } func (j *jsiiProxy_Alarm)SetInsufficientDataActionArns(val *[]*string) { _jsii_.Set( j, "insufficientDataActionArns", val, ) } func (j *jsiiProxy_Alarm)SetOkActionArns(val *[]*string) { _jsii_.Set( j, "okActionArns", val, ) } // Import an existing CloudWatch alarm provided an ARN. func Alarm_FromAlarmArn(scope constructs.Construct, id *string, alarmArn *string) IAlarm { _init_.Initialize() if err := validateAlarm_FromAlarmArnParameters(scope, id, alarmArn); err != nil { panic(err) } var returns IAlarm _jsii_.StaticInvoke( "aws-cdk-lib.aws_cloudwatch.Alarm", "fromAlarmArn", []interface{}{scope, id, alarmArn}, &returns, ) return returns } // Import an existing CloudWatch alarm provided an Name. func Alarm_FromAlarmName(scope constructs.Construct, id *string, alarmName *string) IAlarm { _init_.Initialize() if err := validateAlarm_FromAlarmNameParameters(scope, id, alarmName); err != nil { panic(err) } var returns IAlarm _jsii_.StaticInvoke( "aws-cdk-lib.aws_cloudwatch.Alarm", "fromAlarmName", []interface{}{scope, id, alarmName}, &returns, ) return returns } // 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. // // Returns: true if `x` is an object created from a class which extends `Construct`. func Alarm_IsConstruct(x interface{}) *bool { _init_.Initialize() if err := validateAlarm_IsConstructParameters(x); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_cloudwatch.Alarm", "isConstruct", []interface{}{x}, &returns, ) return returns } // Returns true if the construct was created by CDK, and false otherwise. func Alarm_IsOwnedResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateAlarm_IsOwnedResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_cloudwatch.Alarm", "isOwnedResource", []interface{}{construct}, &returns, ) return returns } // Check whether the given construct is a Resource. func Alarm_IsResource(construct constructs.IConstruct) *bool { _init_.Initialize() if err := validateAlarm_IsResourceParameters(construct); err != nil { panic(err) } var returns *bool _jsii_.StaticInvoke( "aws-cdk-lib.aws_cloudwatch.Alarm", "isResource", []interface{}{construct}, &returns, ) return returns } func (a *jsiiProxy_Alarm) AddAlarmAction(actions ...IAlarmAction) { args := []interface{}{} for _, a := range actions { args = append(args, a) } _jsii_.InvokeVoid( a, "addAlarmAction", args, ) } func (a *jsiiProxy_Alarm) AddInsufficientDataAction(actions ...IAlarmAction) { args := []interface{}{} for _, a := range actions { args = append(args, a) } _jsii_.InvokeVoid( a, "addInsufficientDataAction", args, ) } func (a *jsiiProxy_Alarm) AddOkAction(actions ...IAlarmAction) { args := []interface{}{} for _, a := range actions { args = append(args, a) } _jsii_.InvokeVoid( a, "addOkAction", args, ) } func (a *jsiiProxy_Alarm) ApplyRemovalPolicy(policy awscdk.RemovalPolicy) { if err := a.validateApplyRemovalPolicyParameters(policy); err != nil { panic(err) } _jsii_.InvokeVoid( a, "applyRemovalPolicy", []interface{}{policy}, ) } func (a *jsiiProxy_Alarm) GeneratePhysicalName() *string { var returns *string _jsii_.Invoke( a, "generatePhysicalName", nil, // no parameters &returns, ) return returns } func (a *jsiiProxy_Alarm) GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string { if err := a.validateGetResourceArnAttributeParameters(arnAttr, arnComponents); err != nil { panic(err) } var returns *string _jsii_.Invoke( a, "getResourceArnAttribute", []interface{}{arnAttr, arnComponents}, &returns, ) return returns } func (a *jsiiProxy_Alarm) GetResourceNameAttribute(nameAttr *string) *string { if err := a.validateGetResourceNameAttributeParameters(nameAttr); err != nil { panic(err) } var returns *string _jsii_.Invoke( a, "getResourceNameAttribute", []interface{}{nameAttr}, &returns, ) return returns } func (a *jsiiProxy_Alarm) RenderAlarmRule() *string { var returns *string _jsii_.Invoke( a, "renderAlarmRule", nil, // no parameters &returns, ) return returns } func (a *jsiiProxy_Alarm) ToAnnotation() *HorizontalAnnotation { var returns *HorizontalAnnotation _jsii_.Invoke( a, "toAnnotation", nil, // no parameters &returns, ) return returns } func (a *jsiiProxy_Alarm) ToString() *string { var returns *string _jsii_.Invoke( a, "toString", nil, // no parameters &returns, ) return returns }