Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

AlarmRecommendation - AWS Resilience Hub

AlarmRecommendation

Defines a recommendation for a CloudWatch alarm.

Contents

name

Name of the alarm recommendation.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 500.

Required: Yes

recommendationId

Identifier of the alarm recommendation.

Type: String

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$

Required: Yes

referenceId

Reference identifier of the alarm recommendation.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 500.

Required: Yes

type

Type of alarm recommendation.

Type: String

Valid Values: Metric | Composite | Canary | Logs | Event

Required: Yes

appComponentName

This member has been deprecated.

AppComponent name for the CloudWatch alarm recommendation. This name is saved as the first item in the appComponentNames list.

Type: String

Pattern: ^\S{1,255}$

Required: No

appComponentNames

List of AppComponent names for the CloudWatch alarm recommendation.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

description

Description of the alarm recommendation.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Required: No

items

List of CloudWatch alarm recommendations.

Type: Array of RecommendationItem objects

Required: No

prerequisite

The prerequisite for the alarm recommendation.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 500.

Required: No

recommendationStatus

Status of the recommended Amazon CloudWatch alarm.

Type: String

Valid Values: Implemented | Inactive | NotImplemented | Excluded

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.