class Amazonite::Ssm::OpsItem

• Amazonite::Ssm::OpsItem
• Reference
• Object

Overview

Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational work items (OpsItems) impacting the performance and health of their Amazon Web Services 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 Amazon Web Services service that publishes events. Configuring Amazon CloudWatch alarms and EventBridge events to automatically create OpsItems allows you to quickly diagnose and remediate issues with Amazon Web Services resources from a single console.

To help you diagnose issues, each OpsItem includes contextually relevant information such as the name and ID of the Amazon Web Services resource that generated the OpsItem, alarm or event details, alarm history, and an alarm timeline graph. For the Amazon Web Services resource, OpsCenter aggregates information from Config, CloudTrail logs, and EventBridge, so you don't have to navigate across multiple console pages during your investigation. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.

Included Modules

• JSON::Serializable

Defined in:

ssm/ops_item.cr

Constructors

• .new(pull : JSON::PullParser)
• .new(created_by : String | Nil = nil, ops_item_type : String | Nil = nil, created_time : Time | Nil = nil, description : String | Nil = nil, last_modified_by : String | Nil = nil, last_modified_time : Time | Nil = nil, notifications : Array(OpsItemNotification) | Nil = nil, priority : Int32 | Nil = nil, related_ops_items : Array(RelatedOpsItem) | Nil = nil, status : OpsItemStatus | Nil = nil, ops_item_id : String | Nil = nil, version : String | Nil = nil, title : String | Nil = nil, source : String | Nil = nil, operational_data : Hash(String, OpsItemDataValue) | Nil = nil, category : String | Nil = nil, severity : String | Nil = nil, actual_start_time : Time | Nil = nil, actual_end_time : Time | Nil = nil, planned_start_time : Time | Nil = nil, planned_end_time : Time | Nil = nil, ops_item_arn : String | Nil = nil)

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #actual_end_time : Time | Nil

  The time a runbook workflow ended.

• #actual_end_time=(actual_end_time : Time | Nil)

  The time a runbook workflow ended.

• #actual_start_time : Time | Nil

  The time a runbook workflow started.

• #actual_start_time=(actual_start_time : Time | Nil)

  The time a runbook workflow started.

• #category : String | Nil

  An OpsItem category.

• #category=(category : String | Nil)

  An OpsItem category.

• #created_by : String | Nil

  The ARN of the Amazon Web Services account that created the OpsItem.

• #created_by=(created_by : String | Nil)

  The ARN of the Amazon Web Services account that created the OpsItem.

• #created_time : Time | Nil

  The date and time the OpsItem was created.

• #created_time=(created_time : Time | Nil)

  The date and time the OpsItem was created.

• #description : String | Nil

  The OpsItem description.

• #description=(description : String | Nil)

  The OpsItem description.

• #hash(hasher)

  See Object#hash(hasher)

• #last_modified_by : String | Nil

  The ARN of the Amazon Web Services account that last updated the OpsItem.

• #last_modified_by=(last_modified_by : String | Nil)

  The ARN of the Amazon Web Services account that last updated the OpsItem.

• #last_modified_time : Time | Nil

  The date and time the OpsItem was last updated.

• #last_modified_time=(last_modified_time : Time | Nil)

  The date and time the OpsItem was last updated.

• #notifications : Array(OpsItemNotification) | Nil

  The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.

• #notifications=(notifications : Array(OpsItemNotification) | Nil)

  The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.

• #operational_data : Hash(String, OpsItemDataValue) | Nil

  Operational data is custom data that provides useful reference details about the OpsItem.

• #operational_data=(operational_data : Hash(String, OpsItemDataValue) | Nil)

  Operational data is custom data that provides useful reference details about the OpsItem.

• #ops_item_arn : String | Nil

  The OpsItem Amazon Resource Name (ARN).

• #ops_item_arn=(ops_item_arn : String | Nil)

  The OpsItem Amazon Resource Name (ARN).

• #ops_item_id : String | Nil

  The ID of the OpsItem.

• #ops_item_id=(ops_item_id : String | Nil)

  The ID of the OpsItem.

• #ops_item_type : String | Nil

  The type of OpsItem.

• #ops_item_type=(ops_item_type : String | Nil)

  The type of OpsItem.

• #planned_end_time : Time | Nil

  The time specified in a change request for a runbook workflow to end.

• #planned_end_time=(planned_end_time : Time | Nil)

  The time specified in a change request for a runbook workflow to end.

• #planned_start_time : Time | Nil

  The time specified in a change request for a runbook workflow to start.

• #planned_start_time=(planned_start_time : Time | Nil)

  The time specified in a change request for a runbook workflow to start.

• #priority : Int32 | Nil

  The importance of this OpsItem in relation to other OpsItems in the system.

• #priority=(priority : Int32 | Nil)

  The importance of this OpsItem in relation to other OpsItems in the system.

• #related_ops_items : Array(RelatedOpsItem) | Nil

  One or more OpsItems that share something in common with the current OpsItem.

• #related_ops_items=(related_ops_items : Array(RelatedOpsItem) | Nil)

  One or more OpsItems that share something in common with the current OpsItem.

• #severity : String | Nil

  The severity of the OpsItem.

• #severity=(severity : String | Nil)

  The severity of the OpsItem.

• #source : String | Nil

  The origin of the OpsItem, such as Amazon EC2 or Systems Manager.

• #source=(source : String | Nil)

  The origin of the OpsItem, such as Amazon EC2 or Systems Manager.

• #status : OpsItemStatus | Nil

  The OpsItem status.

• #status=(status : OpsItemStatus | Nil)

  The OpsItem status.

• #title : String | Nil

  A short heading that describes the nature of the OpsItem and the impacted resource.

• #title=(title : String | Nil)

  A short heading that describes the nature of the OpsItem and the impacted resource.

• #validate! : Nil
• #version : String | Nil

  The version of this OpsItem.

• #version=(version : String | Nil)

  The version of this OpsItem.

Constructor Detail

Instance Method Detail