This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::SSM::OpsItem
Operations engineers and IT professionals use AWS Systems Manager OpsCenter to view, investigate, and remediate operational work items (OpsItems) impacting the performance and health of their AWS resources. OpsCenter is integrated with Amazon EventBridge and Amazon CloudWatch. This means you can configure these services to automatically create an OpsItem in OpsCenter when a CloudWatch alarm enters the ALARM state or when EventBridge processes an event from any AWS service that publishes events. Configuring Amazon CloudWatch alarms and EventBridge events to automatically create OpsItems allows you to quickly diagnose and remediate issues with AWS resources from a single console.
To help you diagnose issues, each OpsItem includes contextually relevant information such as the name and ID of the AWS resource that generated the OpsItem, alarm or event details, alarm history, and an alarm timeline graph. For the AWS resource, OpsCenter aggregates information from AWS Config, AWS CloudTrail logs, and EventBridge, so you don't have to navigate across multiple console pages during your investigation. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.
Syntax
To declare this entity in your CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::SSM::OpsItem", "Properties" : { "Category" :String, "Description" :String, "Priority" :Integer, "Severity" :String, "Source" :String, "Tags" :[ Tag, ... ], "Title" :String} }
YAML
Type: AWS::SSM::OpsItem Properties: Category:StringDescription:StringPriority:IntegerSeverity:StringSource:StringTags:- TagTitle:String
Properties
Category-
An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.
Required: No
Type: String
Pattern:
^(?!\s*$).+Minimum:
1Maximum:
64Update requires: No interruption
Description-
The OpsItem description.
Required: Yes
Type: String
Pattern:
[\s\S]*\S[\s\S]*Minimum:
1Maximum:
2048Update requires: No interruption
Priority-
The importance of this OpsItem in relation to other OpsItems in the system.
Required: No
Type: Integer
Minimum:
1Maximum:
5Update requires: No interruption
Severity-
The severity of the OpsItem. Severity options range from 1 to 4.
Required: No
Type: String
Pattern:
^(?!\s*$).+Minimum:
1Maximum:
64Update requires: No interruption
Source-
The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted resource is a subset of source.
Required: Yes
Type: String
Pattern:
^(?!\s*$).+Minimum:
1Maximum:
128Update requires: Replacement
Property description not available.
Required: No
Type: Array of Tag
Update requires: No interruption
Title-
A short heading that describes the nature of the OpsItem and the impacted resource.
Required: Yes
Type: String
Pattern:
^(?!\s*$).+Minimum:
1Maximum:
1024Update requires: No interruption
Return values
Ref
Fn::GetAtt
CreatedBy-
The ARN of the AWS account that created the OpsItem.
CreatedTime-
The date and time the OpsItem was created.
LastModifiedBy-
The ARN of the AWS account that last updated the OpsItem.
LastModifiedTime-
The date and time the OpsItem was last updated.
OpsItemArn-
The OpsItem Amazon Resource Name (ARN).
OpsItemId-
The ID of the OpsItem.
OpsItemType-
The type of OpsItem. Systems Manager supports the following types of OpsItems:
-
/aws/issueThis type of OpsItem is used for default OpsItems created by OpsCenter.
-
/aws/changerequestThis type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.
-
/aws/insightThis type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.
-
Status-
The OpsItem status. For more information, see Editing OpsItem details in the AWS Systems Manager User Guide.
Version-
The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.
