Struct aws_sdk_ssm::types::builders::OpsItemBuilder

#[non_exhaustive]
pub struct OpsItemBuilder { /* private fields */ }

A builder for OpsItem.

Implementations

impl OpsItemBuilder

pub fn created_by(self, input: impl Into<String>) -> Self

The ARN of the Amazon Web Services account that created the OpsItem.

pub fn set_created_by(self, input: Option<String>) -> Self

The ARN of the Amazon Web Services account that created the OpsItem.

pub fn get_created_by(&self) -> &Option<String>

The ARN of the Amazon Web Services account that created the OpsItem.

pub fn ops_item_type(self, input: impl Into<String>) -> Self

The type of OpsItem. 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.

pub fn set_ops_item_type(self, input: Option<String>) -> Self

The type of OpsItem. 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.

pub fn get_ops_item_type(&self) -> &Option<String>

The type of OpsItem. 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.

pub fn created_time(self, input: DateTime) -> Self

The date and time the OpsItem was created.

pub fn set_created_time(self, input: Option<DateTime>) -> Self

The date and time the OpsItem was created.

pub fn get_created_time(&self) -> &Option<DateTime>

The date and time the OpsItem was created.

pub fn description(self, input: impl Into<String>) -> Self

The OpsItem description.

pub fn set_description(self, input: Option<String>) -> Self

The OpsItem description.

pub fn get_description(&self) -> &Option<String>

The OpsItem description.

pub fn last_modified_by(self, input: impl Into<String>) -> Self

The ARN of the Amazon Web Services account that last updated the OpsItem.

pub fn set_last_modified_by(self, input: Option<String>) -> Self

The ARN of the Amazon Web Services account that last updated the OpsItem.

pub fn get_last_modified_by(&self) -> &Option<String>

The ARN of the Amazon Web Services account that last updated the OpsItem.

pub fn last_modified_time(self, input: DateTime) -> Self

The date and time the OpsItem was last updated.

pub fn set_last_modified_time(self, input: Option<DateTime>) -> Self

The date and time the OpsItem was last updated.

pub fn get_last_modified_time(&self) -> &Option<DateTime>

The date and time the OpsItem was last updated.

pub fn notifications(self, input: OpsItemNotification) -> Self

Appends an item to notifications.

To override the contents of this collection use set_notifications.

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

pub fn set_notifications(self, input: Option<Vec<OpsItemNotification>>) -> Self

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

pub fn get_notifications(&self) -> &Option<Vec<OpsItemNotification>>

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

pub fn priority(self, input: i32) -> Self

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

pub fn set_priority(self, input: Option<i32>) -> Self

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

pub fn get_priority(&self) -> &Option<i32>

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

pub fn related_ops_items(self, input: RelatedOpsItem) -> Self

Appends an item to related_ops_items.

To override the contents of this collection use set_related_ops_items.

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.

pub fn set_related_ops_items(self, input: Option<Vec<RelatedOpsItem>>) -> Self

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.

pub fn get_related_ops_items(&self) -> &Option<Vec<RelatedOpsItem>>

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.

pub fn status(self, input: OpsItemStatus) -> Self

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

pub fn set_status(self, input: Option<OpsItemStatus>) -> Self

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

pub fn get_status(&self) -> &Option<OpsItemStatus>

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

pub fn ops_item_id(self, input: impl Into<String>) -> Self

The ID of the OpsItem.

pub fn set_ops_item_id(self, input: Option<String>) -> Self

The ID of the OpsItem.

pub fn get_ops_item_id(&self) -> &Option<String>

The ID of the OpsItem.

pub fn version(self, input: impl Into<String>) -> Self

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

pub fn set_version(self, input: Option<String>) -> Self

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

pub fn get_version(&self) -> &Option<String>

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

pub fn title(self, input: impl Into<String>) -> Self

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

pub fn set_title(self, input: Option<String>) -> Self

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

pub fn get_title(&self) -> &Option<String>

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

pub fn source(self, input: impl Into<String>) -> Self

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

pub fn set_source(self, input: Option<String>) -> Self

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

pub fn get_source(&self) -> &Option<String>

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

pub fn operational_data(self, k: impl Into<String>, v: OpsItemDataValue) -> Self

Adds a key-value pair to operational_data.

To override the contents of this collection use set_operational_data.

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.

pub fn set_operational_data( self, input: Option<HashMap<String, OpsItemDataValue>> ) -> Self

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.

pub fn get_operational_data(&self) -> &Option<HashMap<String, OpsItemDataValue>>

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.

pub fn category(self, input: impl Into<String>) -> Self

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

pub fn set_category(self, input: Option<String>) -> Self

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

pub fn get_category(&self) -> &Option<String>

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

pub fn severity(self, input: impl Into<String>) -> Self

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

pub fn set_severity(self, input: Option<String>) -> Self

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

pub fn get_severity(&self) -> &Option<String>

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

pub fn actual_start_time(self, input: DateTime) -> Self

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

pub fn set_actual_start_time(self, input: Option<DateTime>) -> Self

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

pub fn get_actual_start_time(&self) -> &Option<DateTime>

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

pub fn actual_end_time(self, input: DateTime) -> Self

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

pub fn set_actual_end_time(self, input: Option<DateTime>) -> Self

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

pub fn get_actual_end_time(&self) -> &Option<DateTime>

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

pub fn planned_start_time(self, input: DateTime) -> Self

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

pub fn set_planned_start_time(self, input: Option<DateTime>) -> Self

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

pub fn get_planned_start_time(&self) -> &Option<DateTime>

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

pub fn planned_end_time(self, input: DateTime) -> Self

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

pub fn set_planned_end_time(self, input: Option<DateTime>) -> Self

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

pub fn get_planned_end_time(&self) -> &Option<DateTime>

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

pub fn ops_item_arn(self, input: impl Into<String>) -> Self

The OpsItem Amazon Resource Name (ARN).

pub fn set_ops_item_arn(self, input: Option<String>) -> Self

The OpsItem Amazon Resource Name (ARN).

pub fn get_ops_item_arn(&self) -> &Option<String>

The OpsItem Amazon Resource Name (ARN).

pub fn build(self) -> OpsItem

Consumes the builder and constructs a OpsItem.

Trait Implementations

impl Clone for OpsItemBuilder

fn clone(&self) -> OpsItemBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpsItemBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OpsItemBuilder

fn default() -> OpsItemBuilder

Returns the “default value” for a type.

impl PartialEq for OpsItemBuilder

fn eq(&self, other: &OpsItemBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OpsItemBuilder