software.amazon.awssdk.services.ssm.model

Class CreateOpsItemRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssm.model.SsmRequest

software.amazon.awssdk.services.ssm.model.CreateOpsItemRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateOpsItemRequest.Builder,CreateOpsItemRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateOpsItemRequest
extends SsmRequest
implements ToCopyableBuilder<CreateOpsItemRequest.Builder,CreateOpsItemRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateOpsItemRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateOpsItemRequest.Builder	builder()
String	category() Specify a category to assign to an OpsItem.
String	description() Information about the OpsItem.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<OpsItemNotification>	notifications() The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
Map<String,OpsItemDataValue>	operationalData() Operational data is custom data that provides useful reference details about the OpsItem.
Integer	priority() The importance of this OpsItem in relation to other OpsItems in the system.
List<RelatedOpsItem>	relatedOpsItems() One or more OpsItems that share something in common with the current OpsItems.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateOpsItemRequest.Builder>	serializableBuilderClass()
String	severity() Specify a severity to assign to an OpsItem.
String	source() The origin of the OpsItem, such as Amazon EC2 or AWS Systems Manager.
List<Tag>	tags() Optional metadata that you assign to a resource.
String	title() A short heading that describes the nature of the OpsItem and the impacted resource.
CreateOpsItemRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

description

public String description()

Information about the OpsItem.

Returns:

Information about the OpsItem.

operationalData

public Map<String,OpsItemDataValue> operationalData()

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 action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action).

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 AWS CLI example commands that use these keys, see Creating OpsItems Manually in the AWS Systems Manager User Guide.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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 action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action).

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 AWS CLI example commands that use these keys, see Creating OpsItems Manually in the AWS Systems Manager User Guide.

notifications

public List<OpsItemNotification> notifications()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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

priority

public Integer priority()

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

Returns:

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

relatedOpsItems

public List<RelatedOpsItem> relatedOpsItems()

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

source

public String source()

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

Returns:

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

title

public String title()

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

Returns:

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

tags

public List<Tag> tags()

Optional metadata that you assign to a resource. You can restrict access to OpsItems by using an inline IAM policy that specifies tags. For more information, see Getting Started with OpsCenter in the AWS Systems Manager User Guide.

Tags use a key-value pair. For example:

Key=Department,Value=Finance

To add tags to an existing OpsItem, use the AddTagsToResource action.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Optional metadata that you assign to a resource. You can restrict access to OpsItems by using an inline IAM policy that specifies tags. For more information, see Getting Started with OpsCenter in the AWS Systems Manager User Guide.

Tags use a key-value pair. For example:

Key=Department,Value=Finance

To add tags to an existing OpsItem, use the AddTagsToResource action.

category

public String category()

Specify a category to assign to an OpsItem.

Returns:

Specify a category to assign to an OpsItem.

severity

public String severity()

Specify a severity to assign to an OpsItem.

Returns:

Specify a severity to assign to an OpsItem.

toBuilder

public CreateOpsItemRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateOpsItemRequest.Builder,CreateOpsItemRequest>

Specified by:

toBuilder in class SsmRequest

builder

public static CreateOpsItemRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateOpsItemRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo