Interface UpdateOpsItemRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateOpsItemRequest.Builder,
,UpdateOpsItemRequest> SdkBuilder<UpdateOpsItemRequest.Builder,
,UpdateOpsItemRequest> SdkPojo
,SdkRequest.Builder
,SsmRequest.Builder
- Enclosing class:
UpdateOpsItemRequest
-
Method Summary
Modifier and TypeMethodDescriptionactualEndTime
(Instant actualEndTime) The time a runbook workflow ended.actualStartTime
(Instant actualStartTime) The time a runbook workflow started.Specify a new category for an OpsItem.description
(String description) User-defined text that contains information about the OpsItem, in Markdown format.notifications
(Collection<OpsItemNotification> notifications) The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.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.notifications
(OpsItemNotification... notifications) The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.operationalData
(Map<String, OpsItemDataValue> operationalData) Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.operationalDataToDelete
(String... operationalDataToDelete) Keys that you want to remove from the OperationalData map.operationalDataToDelete
(Collection<String> operationalDataToDelete) Keys that you want to remove from the OperationalData map.opsItemArn
(String opsItemArn) The OpsItem Amazon Resource Name (ARN).The ID of the OpsItem.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.plannedEndTime
(Instant plannedEndTime) The time specified in a change request for a runbook workflow to end.plannedStartTime
(Instant plannedStartTime) The time specified in a change request for a runbook workflow to start.The importance of this OpsItem in relation to other OpsItems in the system.relatedOpsItems
(Collection<RelatedOpsItem> relatedOpsItems) One or more OpsItems that share something in common with the current OpsItems.relatedOpsItems
(Consumer<RelatedOpsItem.Builder>... relatedOpsItems) One or more OpsItems that share something in common with the current OpsItems.relatedOpsItems
(RelatedOpsItem... relatedOpsItems) One or more OpsItems that share something in common with the current OpsItems.Specify a new severity for an OpsItem.The OpsItem status.status
(OpsItemStatus status) The OpsItem status.A short heading that describes the nature of the OpsItem and the impacted resource.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmRequest.Builder
build
-
Method Details
-
description
User-defined text that contains information about the OpsItem, in Markdown format.
- Parameters:
description
- User-defined text that contains information about the OpsItem, in Markdown format.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
operationalData
Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.
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 Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.- Parameters:
operationalData
- Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.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 Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
operationalDataToDelete
Keys that you want to remove from the OperationalData map.
- Parameters:
operationalDataToDelete
- Keys that you want to remove from the OperationalData map.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
operationalDataToDelete
Keys that you want to remove from the OperationalData map.
- Parameters:
operationalDataToDelete
- Keys that you want to remove from the OperationalData map.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
This is a convenience method that creates an instance of theOpsItemNotification.Builder
avoiding the need to create one manually viaOpsItemNotification.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonotifications(List<OpsItemNotification>)
.- Parameters:
notifications
- a consumer that will call methods onOpsItemNotification.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
status
The OpsItem status. Status can be
Open
,In Progress
, orResolved
. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.- Parameters:
status
- The OpsItem status. Status can beOpen
,In Progress
, orResolved
. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
status
The OpsItem status. Status can be
Open
,In Progress
, orResolved
. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.- Parameters:
status
- The OpsItem status. Status can beOpen
,In Progress
, orResolved
. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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.
-
category
Specify a new category for an OpsItem.
- Parameters:
category
- Specify a new category for an OpsItem.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
severity
Specify a new severity for an OpsItem.
- Parameters:
severity
- Specify a new severity for an OpsItem.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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
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.
-
opsItemArn
The OpsItem Amazon Resource Name (ARN).
- Parameters:
opsItemArn
- The OpsItem Amazon Resource Name (ARN).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
UpdateOpsItemRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
UpdateOpsItemRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-