software.amazon.awssdk.services.ssm.model

Interface OpsItem.Builder

All Superinterfaces:

Buildable, CopyableBuilder<OpsItem.Builder,OpsItem>, SdkBuilder<OpsItem.Builder,OpsItem>, SdkPojo

Enclosing class:

OpsItem

public static interface OpsItem.Builder
extends SdkPojo, CopyableBuilder<OpsItem.Builder,OpsItem>

Method Summary

Modifier and Type	Method and Description
OpsItem.Builder	actualEndTime(Instant actualEndTime) The time a runbook workflow ended.
OpsItem.Builder	actualStartTime(Instant actualStartTime) The time a runbook workflow started.
OpsItem.Builder	category(String category) An OpsItem category.
OpsItem.Builder	createdBy(String createdBy) The ARN of the AWS account that created the OpsItem.
OpsItem.Builder	createdTime(Instant createdTime) The date and time the OpsItem was created.
OpsItem.Builder	description(String description) The OpsItem description.
OpsItem.Builder	lastModifiedBy(String lastModifiedBy) The ARN of the AWS account that last updated the OpsItem.
OpsItem.Builder	lastModifiedTime(Instant lastModifiedTime) The date and time the OpsItem was last updated.
OpsItem.Builder	notifications(Collection<OpsItemNotification> notifications) The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
OpsItem.Builder	notifications(Consumer<OpsItemNotification.Builder>... notifications) The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
OpsItem.Builder	notifications(OpsItemNotification... notifications) The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
OpsItem.Builder	operationalData(Map<String,OpsItemDataValue> operationalData) Operational data is custom data that provides useful reference details about the OpsItem.
OpsItem.Builder	opsItemId(String opsItemId) The ID of the OpsItem.
OpsItem.Builder	opsItemType(String opsItemType) The type of OpsItem.
OpsItem.Builder	plannedEndTime(Instant plannedEndTime) The time specified in a change request for a runbook workflow to end.
OpsItem.Builder	plannedStartTime(Instant plannedStartTime) The time specified in a change request for a runbook workflow to start.
OpsItem.Builder	priority(Integer priority) The importance of this OpsItem in relation to other OpsItems in the system.
OpsItem.Builder	relatedOpsItems(Collection<RelatedOpsItem> relatedOpsItems) One or more OpsItems that share something in common with the current OpsItem.
OpsItem.Builder	relatedOpsItems(Consumer<RelatedOpsItem.Builder>... relatedOpsItems) One or more OpsItems that share something in common with the current OpsItem.
OpsItem.Builder	relatedOpsItems(RelatedOpsItem... relatedOpsItems) One or more OpsItems that share something in common with the current OpsItem.
OpsItem.Builder	severity(String severity) The severity of the OpsItem.
OpsItem.Builder	source(String source) The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
OpsItem.Builder	status(OpsItemStatus status) The OpsItem status.
OpsItem.Builder	status(String status) The OpsItem status.
OpsItem.Builder	title(String title) A short heading that describes the nature of the OpsItem and the impacted resource.
OpsItem.Builder	version(String version) The version of this OpsItem.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

createdBy

OpsItem.Builder createdBy(String createdBy)

The ARN of the AWS account that created the OpsItem.

Parameters:

createdBy - The ARN of the AWS account that created the OpsItem.

Returns:

Returns a reference to this object so that method calls can be chained together.

opsItemType

OpsItem.Builder opsItemType(String opsItemType)

The type of OpsItem. Currently, the only valid values are /aws/changerequest and /aws/issue.

Parameters:

opsItemType - The type of OpsItem. Currently, the only valid values are /aws/changerequest and /aws/issue.

Returns:

Returns a reference to this object so that method calls can be chained together.

createdTime

OpsItem.Builder createdTime(Instant createdTime)

The date and time the OpsItem was created.

Parameters:

createdTime - The date and time the OpsItem was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

OpsItem.Builder description(String description)

The OpsItem description.

Parameters:

description - The OpsItem description.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastModifiedBy

OpsItem.Builder lastModifiedBy(String lastModifiedBy)

The ARN of the AWS account that last updated the OpsItem.

Parameters:

lastModifiedBy - The ARN of the AWS account that last updated the OpsItem.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastModifiedTime

OpsItem.Builder lastModifiedTime(Instant lastModifiedTime)

The date and time the OpsItem was last updated.

Parameters:

lastModifiedTime - The date and time the OpsItem was last updated.

Returns:

Returns a reference to this object so that method calls can be chained together.

notifications

OpsItem.Builder notifications(Collection<OpsItemNotification> notifications)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

notifications

OpsItem.Builder notifications(OpsItemNotification... notifications)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

notifications

OpsItem.Builder notifications(Consumer<OpsItemNotification.Builder>... notifications)

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

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #notifications(List).

Parameters:

notifications - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#notifications(List)

priority

OpsItem.Builder priority(Integer priority)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

relatedOpsItems

OpsItem.Builder relatedOpsItems(Collection<RelatedOpsItem> relatedOpsItems)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

relatedOpsItems

OpsItem.Builder relatedOpsItems(RelatedOpsItem... relatedOpsItems)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

relatedOpsItems

OpsItem.Builder relatedOpsItems(Consumer<RelatedOpsItem.Builder>... relatedOpsItems)

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

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #relatedOpsItems(List).

Parameters:

relatedOpsItems - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#relatedOpsItems(List)

status

OpsItem.Builder status(String status)

The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem details in the AWS Systems Manager User Guide.

Parameters:

status - The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem details in the AWS Systems Manager User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OpsItemStatus, OpsItemStatus

status

OpsItem.Builder status(OpsItemStatus status)

The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem details in the AWS Systems Manager User Guide.

Parameters:

status - The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem details in the AWS Systems Manager User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

OpsItemStatus, OpsItemStatus

opsItemId

OpsItem.Builder opsItemId(String opsItemId)

The ID of the OpsItem.

Parameters:

opsItemId - The ID of the OpsItem.

Returns:

Returns a reference to this object so that method calls can be chained together.

version

OpsItem.Builder version(String version)

The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.

Parameters:

version - The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.

Returns:

Returns a reference to this object so that method calls can be chained together.

title

OpsItem.Builder title(String title)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

source

OpsItem.Builder source(String source)

The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted resource is a subset of source.

Parameters:

source - The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted resource is a subset of source.

Returns:

Returns a reference to this object so that method calls can be chained together.

operationalData

OpsItem.Builder operationalData(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

category

OpsItem.Builder category(String category)

An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.

Parameters:

category - An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.

Returns:

Returns a reference to this object so that method calls can be chained together.

severity

OpsItem.Builder severity(String severity)

The severity of the OpsItem. Severity options range from 1 to 4.

Parameters:

severity - The severity of the OpsItem. Severity options range from 1 to 4.

Returns:

Returns a reference to this object so that method calls can be chained together.

actualStartTime

OpsItem.Builder actualStartTime(Instant actualStartTime)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

actualEndTime

OpsItem.Builder actualEndTime(Instant actualEndTime)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

plannedStartTime

OpsItem.Builder plannedStartTime(Instant plannedStartTime)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

plannedEndTime

OpsItem.Builder plannedEndTime(Instant plannedEndTime)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.