Skip to content
This repository was archived by the owner on Jun 15, 2023. It is now read-only.

Commit b68d124

Browse files
committed
1 parent 3591e38 commit b68d124

31 files changed

+195
-68
lines changed

doc_source/OpsCenter-about-incident-manager.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Incident Manager<a name="OpsCenter-about-incident-manager"></a>
22

3-
Incident Manager, a capability of AWS Systems Manager, provides an incident management console that helps you mitigate and recover from incidents affecting your AWS hosted applications\. An *incident* is any unplanned interruption or reduction in quality of services\. After you set up and configure [Incident Manager](https://docs.aws.amazon.com/latest/userguide/what-is-incident-manager.html), the system automatically creates OpsItems in OpsCenter\.
3+
Incident Manager, a capability of AWS Systems Manager, provides an incident management console that helps you mitigate and recover from incidents affecting your AWS hosted applications\. An *incident* is any unplanned interruption or reduction in quality of services\. After you set up and configure [Incident Manager](https://docs.aws.amazon.com/incident-manager/latest/userguide/what-is-incident-manager.html), the system automatically creates OpsItems in OpsCenter\.
44

55
When the system creates an incident in Incident Manager, it also creates an OpsItem in OpsCenter, and displays the incident as a related item\. If the OpsItem already exists, Incident Manager doesn't create an OpsItem\. The first OpsItem is known as the parent OpsItem\. If an incident grows in scale and scope, you can add incidents to an existing OpsItem\. If required, you can manually create an incident for an OpsItem\. After an incident is closed, you can create an analysis in Incident Manager to review and improve the remediation process for similar issues\.
66

doc_source/OpsCenter-getting-started-multiple-accounts.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# \(Optional\) Setting up OpsCenter to centrally manage OpsItems across accounts<a name="OpsCenter-getting-started-multiple-accounts"></a>
22

3-
You can set up a central account to create manual OpsItems for member accounts, and manage and remediate those OpsItems\. The central account can be the AWS Organizations management account, or both the AWS Organizations management account and Systems Manager administrator account\. You can only use this feature after you configure AWS Organizations\.
3+
You can set up a central account to create manual OpsItems for member accounts, and manage and remediate those OpsItems\. The central account can be the AWS Organizations management account, or both the AWS Organizations management account and Systems Manager delegated administrator account\. We recommend that you use the Systems Manager delegated administrator account as a central account\. You can only use this feature after you configure AWS Organizations\.
44

5-
With AWS Organizations, you can consolidate multiple AWS accounts into an organization that you create and manage centrally\. A management account user, or both management account user and delegated administrator, can create OpsItems for all selected member accounts simultaneously, and manage those OpsItems\.
5+
With AWS Organizations, you can consolidate multiple AWS accounts into an organization that you create and manage centrally\. The central account user can create OpsItems for all selected member accounts simultaneously, and manage those OpsItems\.
66

77
Use the process in this section to enable the Systems Manager service principal in Organizations and configure AWS Identity and Access Management \(IAM\) permissions for working with OpsItems across accounts\.
88

doc_source/OpsCenter-settingup.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Setting up OpsCenter<a name="OpsCenter-settingup"></a>
2+
3+
AWS Systems Manager uses an integrated setup experience to help you get started with OpsCenter and Explorer, which are capabilities of Systems Manager\. Explorer is a customizable operations dashboard that reports information about your AWS resources\. In this documentation, Explorer and OpsCenter setup is called *Integrated Setup*\.
4+
5+
You must use Integrated Setup to set up OpsCenter with Explorer\. You can't set up Explorer and OpsCenter programmatically\. For more information, see [Getting started with Systems Manager Explorer and OpsCenter](Explorer-setup.md)\.
6+
7+
**To set up OpsCenter**
8+
9+
1. Open the AWS Systems Manager console at [https://console\.aws\.amazon\.com/systems\-manager/](https://console.aws.amazon.com/systems-manager/)\.
10+
11+
1. In the navigation pane, choose **OpsCenter**\.
12+
13+
1. On the OpsCenter home page, choose **Get started**\.
14+
15+
1. On the OpsCenter setup page, choose **Enable this option to have Explorer configure AWS Config and Amazon CloudWatch events to automatically create OpsItems based on commonly\-used rules and events**\. If you don't choose this option, OpsCenter remains disabled\.
16+
**Note**
17+
Amazon EventBridge \(formerly Amazon CloudWatch Events\) provides all functionality of CloudWatch Events and some new features, such as custom event buses, third\-party event sources and schema registry\.
18+
19+
1. Choose **Enable OpsCenter**\.
20+
21+
After you enable OpsCenter, you can do the following from **Settings**:
22+
+ Create CloudWatch alarms using the **Open CloudWatch console** button\. For more information, see [Configure CloudWatch alarms to create OpsItems](OpsCenter-create-OpsItems-from-CloudWatch-Alarms.md)\.
23+
+ Enable operational insights\. For more information, see [Analyzing operational insights to reduce duplicate OpsItems](OpsCenter-working-operational-insights.md)\.
24+
+ Enable AWS Security Hub findings alarms\. For more information, see [Security Hub](OpsCenter-integrate-with-security-hub.md)\.
25+
+ Enable or disable the default EventBridge rules and custom rules that you have created\. You can also edit the category and severity for default and custom EventBridge rules\. The following EventBridge rules are available by default:
26+
+ **SSMOpsItems\-Autoscaling\-instance\-launch\-failure** – This rule creates OpsItems when the launch of the EC2 auto scaling instance is failed\.
27+
+ **SSMOpsItems\-Autoscaling\-instance\-termination\-failure** – This rule creates OpsItems when the termination of the EC2 auto scaling instance is failed\.
28+
+ **SSMOpsItems\-EBS\-snapshot\-copy\-failed** – This rule creates OpsItems when the system failed to copy the Amazon Elastic Block Store \(Amazon EBS\) snapshot\.
29+
+ **SSMOpsItems\-EBS\-snapshot\-creation\-failed** – This rule creates OpsItems when the system failed to create the Amazon EBS snapshot\.
30+
+ **SSMOpsItems\-EBS\-volume\-performance\-issue** – This rule creates OpsItems whenever there is a performance issue with Amazon EBS volume\.
31+
+ **SSMOpsItems\-EC2\-issue** – This rule creates OpsItems whenever there is an issue with EC2 instances\.
32+
+ **SSMOpsItems\-EC2\-scheduled\-change** – This rule creates OpsItems for EC2 scheduled updates\.
33+
+ **SSMOpsItems\-RDS\-issue** – This rule creates OpsItems whenever there is an issue with Amazon Relational Database Service \(Amazon RDS\)\.
34+
+ **SSMOpsItems\-RDS\-scheduled\-change** – This rule creates OpsItems for Amazon RDS scheduled updates\.
35+
+ **SSMOpsItems\-SSM\-maintenance\-window\-execution\-failed** – This rule creates OpsItems when the execution of the Systems Managermaintenance window is failed\.
36+
+ **SSMOpsItems\-SSM\-maintenance\-window\-execution\-timedout** – This rule creates OpsItems when the execution of the Systems Manager maintenance window is timeout\.
37+
38+
You can choose a rule to view, edit, and manage in EventBridge\. For more information, see [Configure EventBridge rules to create OpsItems](OpsCenter-automatically-create-OpsItems-2.md)

doc_source/OpsCenter-setup.md

+3-23
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,7 @@
11
# Set up OpsCenter<a name="OpsCenter-setup"></a>
22

3-
AWS Systems Manager uses an integrated setup experience to help you get started with OpsCenter and Explorer, which are capabilities of Systems Manager\. Explorer is a customizable operations dashboard that reports information about your AWS resources\. In this documentation, Explorer and OpsCenter setup is called *Integrated Setup*\.
3+
Set up OpsCenter, a capability of AWS Systems Manager, for your AWS Region\. Based on your requirements, you can set up OpsCenter by performing the following steps:
44

5-
You must use Integrated Setup to set up OpsCenter with Explorer\. If you already set up OpsCenter, you still need to complete Integrated Setup to verify settings and options\. Integrated Setup is only available in the AWS Systems Manager console\. You can't set up Explorer and OpsCenter programmatically\. For more information, see [Getting started with Systems Manager Explorer and OpsCenter](Explorer-setup.md)\.
5+
1. [Set up OpsCenter using the Integrated Setup experience ](OpsCenter-settingup.md) available for OpsCenter and Explorer\.
66

7-
**To set up OpsCenter**
8-
9-
1. Open the AWS Systems Manager console at [https://console\.aws\.amazon\.com/systems\-manager/](https://console.aws.amazon.com/systems-manager/)\.
10-
11-
1. In the navigation pane, choose **OpsCenter**\.
12-
13-
1. Choose **Enable OpsCenter**\.
14-
15-
1. Choose **Enable this option to have Explorer configure AWS Config and Amazon CloudWatch events to automatically create OpsItems**\. If you don't choose this option, OpsCenter remains disabled\.
16-
**Note**
17-
Amazon EventBridge \(formerly Amazon CloudWatch Events\) provides all functionality of CloudWatch Events and some new features, such as custom event buses, third\-party event sources and schema registry\.
18-
19-
1. Choose **Enable OpsCenter**\.
20-
21-
After you enable OpsCenter, you can do the following:
22-
+ Create CloudWatch alarms using the **Open CloudWatch console** button\. For more information, see [Configure CloudWatch alarms to create OpsItems](OpsCenter-create-OpsItems-from-CloudWatch-Alarms.md)\.
23-
+ Enable operational insights\. For more information, see [Analyzing operational insights to reduce duplicate OpsItems](OpsCenter-working-operational-insights.md)\.
24-
+ Enable AWS Security Hub findings alarms\. For more information, see [Security Hub](OpsCenter-integrate-with-security-hub.md)\.
25-
+ Edit the category, severity, and state of EventBridge rules\. You can choose a rule to view, edit, and manage in EventBridge\. For more information, see [Configure EventBridge rules to create OpsItems](OpsCenter-automatically-create-OpsItems-2.md)\.
26-
27-
After you set up OpsCenter, you can decide if you want to use a central account to create and manage OpsItems for member accounts\. For more information, see [\(Optional\) Setting up OpsCenter to centrally manage OpsItems across accounts](OpsCenter-getting-started-multiple-accounts.md)\.
7+
1. \(Optional\) [Set up OpsCenter to use a central account](OpsCenter-getting-started-multiple-accounts.md) to create and manage OpsItems for member accounts if needed\.

doc_source/OpsCenter.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ You can view quotas for all Systems Manager capabilities in [Systems Manager ser
1616

1717
To set up and work with OpsCenter to remediate OpsItems, perform the following steps:
1818

19-
1. [Set up OpsCenter using Integrated Setup](OpsCenter-setup.md)\.
19+
1. [Set up OpsCenter using Integrated Setup](OpsCenter-setup.md)\. You can also [set up OpsCenter to centrally manage OpsItems across accounts ](OpsCenter-getting-started-multiple-accounts.md) if needed\.
2020

2121
1. [Integrate AWS services with OpsCenter](OpsCenter-applications-that-integrate.md)\. OpsCenter can integrate with Amazon CloudWatch, Amazon CloudWatch Application Insights, Amazon EventBridge, Amazon DevOps Guru, AWS Config, AWS Security Hub, and AWS Systems Manager Incident Manager\.
2222

doc_source/automation-action-executeAwsApi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# `aws:executeAwsApi` – Call and run AWS API operations<a name="automation-action-executeAwsApi"></a>
22

3-
Calls and runs AWS API operations\. Most API operations are supported, although not all API operations have been tested\. Streaming API operations, such as the [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html) operation, aren't supported\. If you're not sure if an API operation you want to use is a streaming operation, review the [Boto3](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/index.html) documentation for the service to determine if an API requires streaming inputs\. Each `aws:executeAwsApi` action can run up to a maximum duration of 25 seconds\. For more examples of how to use this action, see [Additional runbook examples](automation-document-examples.md)\.
3+
Calls and runs AWS API operations\. Most API operations are supported, although not all API operations have been tested\. Streaming API operations, such as the [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html) operation, aren't supported\. If you're not sure if an API operation you want to use is a streaming operation, review the [Boto3](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/index.html) documentation for the service to determine if an API requires streaming inputs\. We regularly update the Boto3 version used by this action\. However, following the release of a new Boto3 version it can take up to a few weeks for changes to be reflected in this action\. Each `aws:executeAwsApi` action can run up to a maximum duration of 25 seconds\. For more examples of how to use this action, see [Additional runbook examples](automation-document-examples.md)\.
44

55
**Inputs**
66
Inputs are defined by the API operation that you choose\.

doc_source/automation-actions.md

+5
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@ If you run an automation workflow that invokes other services by using an AWS Id
4545

4646
Common properties are parameters or options that are found in all actions\. Some options define behavior for a step, such as how long to wait for a step to complete and what to do if the step fails\. The following properties are common to all actions\.
4747

48+
[description](#descriptProp)
49+
Information you provide to describe the purpose of a runbook or a step\.
50+
Type: String
51+
Required: No
52+
4853
[name](#nameProp)
4954
An identifier that must be unique across all step names in the runbook\.
5055
Type: String

doc_source/getting-started-create-preferences-cli.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
1-
# Create Session Manager preferences \(command line\)<a name="getting-started-create-preferences-cli"></a>
1+
# Create a Session Manager preferences document \(command line\)<a name="getting-started-create-preferences-cli"></a>
22

3-
The following procedure describes how to use your preferred command line tool to create AWS Systems Manager Session Manager preferences for your AWS account in the selected AWS Region\. Use Session Manager preferences to specify options for logging session data in an Amazon Simple Storage Service \(Amazon S3\) bucket or Amazon CloudWatch Logs log group\. You can also use Session Manager preferences to encrypt your session data\.
3+
Use the following procedure to create SSM documents that define your preferences for AWS Systems Manager Session Manager sessions\. You can use the document to configure session options including data encryption, session duration, and logging\. For example, you can specify whether to store session log data in an Amazon Simple Storage Service \(Amazon S3\) bucket or Amazon CloudWatch Logs log group\. You can create documents that define general preferences for all sessions for an AWS account and AWS Region, or that define preferences for individual sessions\.
44

5-
For information about using command line tools to update existing Session Manager preferences, see [Update Session Manager preferences \(command line\)](getting-started-configure-preferences-cli.md)\.
5+
**Note**
6+
You can also configure general session preferences by using the Session Manager console\.
7+
8+
Documents used to set Session Manager preferences must have a `sessionType` of `Standard_Stream`\. For more information about Session documents, see [Session document schema](session-manager-schema.md)\.
9+
10+
For information about using the command line to update existing Session Manager preferences, see [Update Session Manager preferences \(command line\)](getting-started-configure-preferences-cli.md)\.
611

712
For an example of how to create session preferences using AWS CloudFormation, see [Create a Systems Manager document for Session Manager preferences](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#aws-resource-ssm-document--examples) in the *AWS CloudFormation User Guide*\.
813

914
**Note**
10-
You can use this procedure to create custom Session documents for your Session Manager preferences that override account level settings\. When you create your custom Session documents, specify a value other than `SSM-SessionManagerRunShell` for the name parameter and modify the inputs as needed\. To use your custom Session documents, you must provide the name of your custom Session document for the `--document-name` parameter when starting a session from the AWS Command Line Interface \(AWS CLI\)\. When you start a session from the console, you can't specify custom Session documents\.
15+
This procedure describes how to create documents for setting Session Manager preferences at the AWS account level\. To create documents that will be used for setting session\-level preferences, specify a value other than `SSM-SessionManagerRunShell` for the file name related command inputs \.
16+
To use your document to set preferences for sessions started from the AWS Command Line Interface \(AWS CLI\), provide the document name as the `--document-name` parameter value\. To set preferences for sessions started from the Session Manager console, you can type or select the name of your document from a list\.
1117

1218
**To create Session Manager preferences \(command line\)**
1319

0 commit comments

Comments
 (0)