从 AWS Automation 运行手册调用其他 Systems Manager 服务

从运行手册调用 Amazon RDS API 操作

1. 打开文本编辑器并将以下运行手册内容粘贴到该文件中。指定 Automation 角色和要检查的实例 ID。稍后您将添加 mainSteps 操作。

   ---
   description: Start RDS instance
   schemaVersion: "0.3"
   assumeRole: "The_Automation_role_to_use_when_running_the_runbook"
   parameters:
     InstanceId: The_instance_ID_to_start
       type: String
       description: (Required) RDS instance ID to start
     AutomationAssumeRole:
       type: String
       description: (Optional) The ARN of the role that allows Automation to perform the actions on your behalf.
       default: ""
   mainSteps:
   

2. 在自动化的第一步中，您需要确定实例是否已运行。可以使用 aws:assertAwsResourceProperty 操作来确定和断言特定的实例状态。您必须先确定并指定所需的输入，然后才能将 aws：assertAwsResourceProperty 操作添加到运行手册中。下面的列表介绍如何确定和指定所需的输入。您可以查看一个示例，了解如何在列表后面的运行手册中输入此信息。

   1. 查看架构以了解 aws:assertAwsResourceProperty – 声明 AWS 资源状态或事件状态 操作的所有可用输入。

   2. 确定要调用的服务的命名空间。您可以在 AWS 的 Amazon 资源名称 （ARN） 和 AWS 服务命名空间中查看 服务命名空间的列表。Amazon Web Services 一般参考Amazon RDS 的命名空间为 rds.

   3. 确定哪个 Amazon RDS API 操作可用于查看数据库实例的状态。您可以在 Amazon RDS 方法页面上查看 API 操作（也称为方法）。

   4. 为 DescribeDBInstances API 操作指定一个或多个请求参数。例如，此操作使用 DBInstanceIdentifier 请求参数。

   5. 确定一个或多个 PropertySelectors。PropertySelector 是此 API 操作的请求返回的响应对象。例如，在 Amazon RDS 方法.上。选择 describe_db_instances 方法并向下滚动到 Response Structure 部分。DBInstances 被列为响应对象。出于本演练的目的，请将 DBInstances 和 DBInstanceStatus 指定为 PropertySelectors。请注意，PropertySelectors 是使用 JSONPath 输入的。这意味着，您需要按如下所示设置运行手册中的信息的格式：

      PropertySelector: "$.DBInstances[0].DBInstanceStatus".

   6. 指定一个或多个 DesiredValues。如果您不知道要指定的值，请运行 DescribeDBInstances API 操作以确定可能的值。在本演练中，请指定 available 和 starting.

   7. 将收集的信息输入到运行手册中，如以下示例所示。

   ---
   description: Start RDS instance
   schemaVersion: "0.3"
   assumeRole: "The_Automation_role_to_use_when_running_the_runbook"
   parameters:
     InstanceId: The_instance_ID_to_start
       type: String
       description: (Required) RDS Instance Id to stop
     AutomationAssumeRole:
       type: String
       description: (Optional) The ARN of the role that allows Automation to perform the actions on your behalf.
       default: ""
   mainSteps:
     -
       name: AssertNotStartingOrAvailable
       action: aws:assertAwsResourceProperty
       isCritical: false
       onFailure: step:StartInstance
       nextStep: CheckStart
       inputs:
         Service: rds
         Api: DescribeDBInstances
         DBInstanceIdentifier: "{{InstanceId}}"
         PropertySelector: "$.DBInstances[0].DBInstanceStatus"
         DesiredValues: ["available", "starting"]

3. 在 mainSteps 部分中指定 aws:executeAwsApi 操作，以便在上一个操作确定实例未启动时启动实例。

   1. 查看架构以了解 的所有可用输入。aws:executeAwsApi – 调用并运行 AWS API 操作.

   2. 指定 Amazon RDS StartDBInstance API 操作以启动实例。

   3. 将收集的信息输入到运行手册中，如以下示例所示。

   ---
   description: Start RDS instance
   schemaVersion: "0.3"
   assumeRole: "{{ The_Automation_role_to_use_when_running_the_runbook }}"
   parameters:
     InstanceId:
       type: String
       description: (Required) RDS Instance Id to stop
     AutomationAssumeRole:
       type: String
       description: (Optional) The ARN of the role that allows Automation to perform the actions on your behalf.
       default: ""
   mainSteps:
     -
       name: AssertNotStartingOrAvailable
       action: aws:assertAwsResourceProperty
       isCritical: false
       onFailure: step:StartInstance
       nextStep: CheckStart
       inputs:
         Service: rds
         Api: DescribeDBInstances
         DBInstanceIdentifier: "{{InstanceId}}"
         PropertySelector: "$.DBInstances[0].DBInstanceStatus"
         DesiredValues: ["available", "starting"]
     -
       name: StartInstance
       action: aws:executeAwsApi
       inputs:
         Service: rds
         Api: StartDBInstance
         DBInstanceIdentifier: "{{InstanceId}}"
   

4. 在 mainSteps 部分中指定 aws：waitForAwsResourceProperty 操作，以等待实例启动后再完成自动化。

   1. 查看架构以了解 的所有可用输入。aws:waitForAwsResourceProperty – 等待 AWS 资源属性.

   2. 指定 Amazon RDS DescribeDBInstances API 操作来确定实例状态。

   3. 将 $.DBInstances[0].DBInstanceStatus 指定为 PropertySelector

   4. 将 available 指定为 DesiredValue.

   5. 将收集的信息输入到运行手册中，如以下示例所示。

   ---
   description: Start RDS instance
   schemaVersion: "0.3"
   assumeRole: "{{ The_Automation_role_to_use_when_running_the_runbook }}"
   parameters:
     InstanceId:
       type: String
       description: (Required) RDS Instance Id to stop
     AutomationAssumeRole:
       type: String
       description: (Optional) The ARN of the role that allows Automation to perform the actions on your behalf.
       default: ""
   mainSteps:
     -
       name: AssertNotStartingOrAvailable
       action: aws:assertAwsResourceProperty
       isCritical: false
       onFailure: step:StartInstance
       nextStep: CheckStart
       inputs:
         Service: rds
         Api: DescribeDBInstances
         DBInstanceIdentifier: "{{InstanceId}}"
         PropertySelector: "$.DBInstances[0].DBInstanceStatus"
         DesiredValues: ["available", "starting"]
     -
       name: StartInstance
       action: aws:executeAwsApi
       inputs:
         Service: rds
         Api: StartDBInstance
         DBInstanceIdentifier: "{{InstanceId}}"
     -
       name: CheckStart
       action: aws:waitForAwsResourceProperty
       onFailure: Abort
       maxAttempts: 10
       timeoutSeconds: 600
       inputs:
         Service: rds
         Api: DescribeDBInstances
         DBInstanceIdentifier: "{{InstanceId}}"
         PropertySelector: "$.DBInstances[0].DBInstanceStatus"
         DesiredValues: ["available"]
       isEnd: true
   ...
   

5. 将文件保存为 sample.yaml。

6. 在 AWS CLI 中运行以下命令以将运行手册添加到您的 AWS 账户。

   aws ssm create-document --name sampleRunbook --document-type Automation --document-format YAML --content file://sample.yaml

7. 运行以下命令以使用刚创建的运行手册启动自动化。启动自动化后，记下 Systems Manager 返回的执行 ID。

   aws ssm start-automation-execution --document-name sampleRunbook 

8. 运行以下命令查看执行状态。

   aws ssm get-automation-execution --automation-execution-id automation_execution_id

1. 通过以下网址打开 AWS Systems Manager 控制台：https://console.amazonaws.cn/systems-manager/。

2. 在导航窗格中，选择文档。

   -或者-

   如果 AWS Systems Manager 主页首先打开，请选择菜单图标 ( ) 以打开导航窗格，然后在导航窗格中选择文档。

3. 选择运行手册，然后选择 View details （查看详细信息）。

4. 选择 Content 选项卡。