class Amazonite::Ssm::CreateOpsItemRequest

Included Modules

Defined in:

ssm/create_ops_item_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(description : String, source : String, title : String, ops_item_type : String | Nil = nil, operational_data : Hash(String, OpsItemDataValue) | Nil = nil, notifications : Array(OpsItemNotification) | Nil = nil, priority : Int32 | Nil = nil, related_ops_items : Array(RelatedOpsItem) | Nil = nil, tags : Array(Tag) | 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, account_id : String | Nil = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def account_id : String | Nil #

The target Amazon Web Services account where you want to create an OpsItem. To make this call, your account must be configured to work with OpsItems across accounts. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.


[View source]
def account_id=(account_id : String | Nil) #

The target Amazon Web Services account where you want to create an OpsItem. To make this call, your account must be configured to work with OpsItems across accounts. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.


[View source]
def actual_end_time : Time | Nil #

The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.


[View source]
def actual_end_time=(actual_end_time : Time | Nil) #

The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.


[View source]
def actual_start_time : Time | Nil #

The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.


[View source]
def actual_start_time=(actual_start_time : Time | Nil) #

The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.


[View source]
def category : String | Nil #

Specify a category to assign to an OpsItem.


[View source]
def category=(category : String | Nil) #

Specify a category to assign to an OpsItem.


[View source]
def description : String #

User-defined text that contains information about the OpsItem, in Markdown format.

Provide enough information so that users viewing this OpsItem for the first time understand the issue.


[View source]
def description=(description : String) #

User-defined text that contains information about the OpsItem, in Markdown format.

Provide enough information so that users viewing this OpsItem for the first time understand the issue.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def notifications : Array(OpsItemNotification) | Nil #

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


[View source]
def notifications=(notifications : Array(OpsItemNotification) | Nil) #

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


[View source]
def operational_data : Hash(String, OpsItemDataValue) | Nil #

Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).

Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Create OpsItems manually in the Amazon Web Services Systems Manager User Guide.


[View source]
def operational_data=(operational_data : Hash(String, OpsItemDataValue) | Nil) #

Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).

Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Create OpsItems manually in the Amazon Web Services Systems Manager User Guide.


[View source]
def ops_item_type : String | Nil #

The type of OpsItem to create. Systems Manager supports the following types of OpsItems:

  • /aws/issue

This type of OpsItem is used for default OpsItems created by OpsCenter.

  • /aws/insight

This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.

  • /aws/changerequest

This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.

Amazon Web Services Systems Manager Change Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services Systems Manager Change Manager availability change.


[View source]
def ops_item_type=(ops_item_type : String | Nil) #

The type of OpsItem to create. Systems Manager supports the following types of OpsItems:

  • /aws/issue

This type of OpsItem is used for default OpsItems created by OpsCenter.

  • /aws/insight

This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.

  • /aws/changerequest

This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.

Amazon Web Services Systems Manager Change Manager is no longer open to new customers. Existing customers can continue to use the service as normal. For more information, see Amazon Web Services Systems Manager Change Manager availability change.


[View source]
def planned_end_time : Time | Nil #

The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.


[View source]
def planned_end_time=(planned_end_time : Time | Nil) #

The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.


[View source]
def planned_start_time : Time | Nil #

The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.


[View source]
def planned_start_time=(planned_start_time : Time | Nil) #

The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.


[View source]
def priority : Int32 | Nil #

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


[View source]
def priority=(priority : Int32 | Nil) #

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


[View source]
def related_ops_items : Array(RelatedOpsItem) | Nil #

One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.


[View source]
def related_ops_items=(related_ops_items : Array(RelatedOpsItem) | Nil) #

One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.


[View source]
def severity : String | Nil #

Specify a severity to assign to an OpsItem.


[View source]
def severity=(severity : String | Nil) #

Specify a severity to assign to an OpsItem.


[View source]
def source : String #

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

The source name can't contain the following strings: aws, amazon, and amzn.


[View source]
def source=(source : String) #

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

The source name can't contain the following strings: aws, amazon, and amzn.


[View source]
def tags : Array(Tag) | Nil #

Optional metadata that you assign to a resource.

Tags use a key-value pair. For example:

Key=Department,Value=Finance

To add tags to a new OpsItem, a user must have IAM permissions for both the ssm:CreateOpsItems operation and the ssm:AddTagsToResource operation. To add tags to an existing OpsItem, use the AddTagsToResource operation.


[View source]
def tags=(tags : Array(Tag) | Nil) #

Optional metadata that you assign to a resource.

Tags use a key-value pair. For example:

Key=Department,Value=Finance

To add tags to a new OpsItem, a user must have IAM permissions for both the ssm:CreateOpsItems operation and the ssm:AddTagsToResource operation. To add tags to an existing OpsItem, use the AddTagsToResource operation.


[View source]
def title : String #

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


[View source]
def title=(title : String) #

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


[View source]
def validate! : Nil #

[View source]