Interface CreateOpsItemRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateOpsItemRequest.Builder,CreateOpsItemRequest>
,SdkBuilder<CreateOpsItemRequest.Builder,CreateOpsItemRequest>
,SdkPojo
,SdkRequest.Builder
,SsmRequest.Builder
- Enclosing class:
- CreateOpsItemRequest
public static interface CreateOpsItemRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<CreateOpsItemRequest.Builder,CreateOpsItemRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CreateOpsItemRequest.Builder
accountId(String accountId)
The target Amazon Web Services account where you want to create an OpsItem.CreateOpsItemRequest.Builder
actualEndTime(Instant actualEndTime)
The time a runbook workflow ended.CreateOpsItemRequest.Builder
actualStartTime(Instant actualStartTime)
The time a runbook workflow started.CreateOpsItemRequest.Builder
category(String category)
Specify a category to assign to an OpsItem.CreateOpsItemRequest.Builder
description(String description)
User-defined text that contains information about the OpsItem, in Markdown format.CreateOpsItemRequest.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.CreateOpsItemRequest.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.CreateOpsItemRequest.Builder
notifications(OpsItemNotification... notifications)
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.CreateOpsItemRequest.Builder
operationalData(Map<String,OpsItemDataValue> operationalData)
Operational data is custom data that provides useful reference details about the OpsItem.CreateOpsItemRequest.Builder
opsItemType(String opsItemType)
The type of OpsItem to create.CreateOpsItemRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateOpsItemRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateOpsItemRequest.Builder
plannedEndTime(Instant plannedEndTime)
The time specified in a change request for a runbook workflow to end.CreateOpsItemRequest.Builder
plannedStartTime(Instant plannedStartTime)
The time specified in a change request for a runbook workflow to start.CreateOpsItemRequest.Builder
priority(Integer priority)
The importance of this OpsItem in relation to other OpsItems in the system.CreateOpsItemRequest.Builder
relatedOpsItems(Collection<RelatedOpsItem> relatedOpsItems)
One or more OpsItems that share something in common with the current OpsItems.CreateOpsItemRequest.Builder
relatedOpsItems(Consumer<RelatedOpsItem.Builder>... relatedOpsItems)
One or more OpsItems that share something in common with the current OpsItems.CreateOpsItemRequest.Builder
relatedOpsItems(RelatedOpsItem... relatedOpsItems)
One or more OpsItems that share something in common with the current OpsItems.CreateOpsItemRequest.Builder
severity(String severity)
Specify a severity to assign to an OpsItem.CreateOpsItemRequest.Builder
source(String source)
The origin of the OpsItem, such as Amazon EC2 or Systems Manager.CreateOpsItemRequest.Builder
tags(Collection<Tag> tags)
Optional metadata that you assign to a resource.CreateOpsItemRequest.Builder
tags(Consumer<Tag.Builder>... tags)
Optional metadata that you assign to a resource.CreateOpsItemRequest.Builder
tags(Tag... tags)
Optional metadata that you assign to a resource.CreateOpsItemRequest.Builder
title(String title)
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 Detail
-
description
CreateOpsItemRequest.Builder description(String description)
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.
- Parameters:
description
- 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
opsItemType
CreateOpsItemRequest.Builder opsItemType(String opsItemType)
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/changerequest
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.
-
/aws/insight
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.
- Parameters:
opsItemType
- 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/changerequest
This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.
-
/aws/insight
This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
operationalData
CreateOpsItemRequest.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 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
- 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.
-
notifications
CreateOpsItemRequest.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
CreateOpsItemRequest.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
CreateOpsItemRequest.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 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 to#notifications(List
.) - 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:
#notifications(java.util.Collection
)
-
priority
CreateOpsItemRequest.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
CreateOpsItemRequest.Builder relatedOpsItems(Collection<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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
relatedOpsItems
CreateOpsItemRequest.Builder relatedOpsItems(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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
relatedOpsItems
CreateOpsItemRequest.Builder relatedOpsItems(Consumer<RelatedOpsItem.Builder>... 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.
This is a convenience method that creates an instance of theRelatedOpsItem.Builder
avoiding the need to create one manually viaRelatedOpsItem.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#relatedOpsItems(List
.) - Parameters:
relatedOpsItems
- a consumer that will call methods onRelatedOpsItem.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#relatedOpsItems(java.util.Collection
)
-
source
CreateOpsItemRequest.Builder source(String source)
The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
The source name can't contain the following strings:
aws
,amazon
, andamzn
.- Parameters:
source
- The origin of the OpsItem, such as Amazon EC2 or Systems Manager.The source name can't contain the following strings:
aws
,amazon
, andamzn
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
title
CreateOpsItemRequest.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.
-
tags
CreateOpsItemRequest.Builder tags(Collection<Tag> tags)
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 thessm:AddTagsToResource
operation. To add tags to an existing OpsItem, use the AddTagsToResource operation.- Parameters:
tags
- 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 thessm:AddTagsToResource
operation. To add tags to an existing OpsItem, use the AddTagsToResource operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
CreateOpsItemRequest.Builder tags(Tag... tags)
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 thessm:AddTagsToResource
operation. To add tags to an existing OpsItem, use the AddTagsToResource operation.- Parameters:
tags
- 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 thessm:AddTagsToResource
operation. To add tags to an existing OpsItem, use the AddTagsToResource operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
CreateOpsItemRequest.Builder tags(Consumer<Tag.Builder>... tags)
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 thessm:AddTagsToResource
operation. To add tags to an existing OpsItem, use the AddTagsToResource operation.Tag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#tags(List
.) - Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#tags(java.util.Collection
)
-
category
CreateOpsItemRequest.Builder category(String category)
Specify a category to assign to an OpsItem.
- Parameters:
category
- Specify a category to assign to an OpsItem.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
severity
CreateOpsItemRequest.Builder severity(String severity)
Specify a severity to assign to an OpsItem.
- Parameters:
severity
- Specify a severity to assign to an OpsItem.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
actualStartTime
CreateOpsItemRequest.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
CreateOpsItemRequest.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
CreateOpsItemRequest.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
CreateOpsItemRequest.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.
-
accountId
CreateOpsItemRequest.Builder accountId(String accountId)
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.
- Parameters:
accountId
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateOpsItemRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
CreateOpsItemRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-