

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# Amazon EBS
<a name="automation-ref-ebs"></a>

 AWS Systems Manager Automation 为 Amazon Elastic Block Store 提供 有关运行手册的更多信息，请参阅[使用运行手册](https://docs.aws.amazon.com/systems-manager/latest/userguide/automation-documents.html)。有关如何查看运行手册内容的信息，请参阅 [查看运行手册内容](automation-runbook-reference.md#view-automation-json)。

**Topics**
+ [`AWSSupport-AnalyzeEBSResourceUsage`](automation-aws-analyze-ebs-resource-usage.md)
+ [`AWS-ArchiveEBSSnapshots`](aws-archiveebssnapshots.md)
+ [`AWS-AttachEBSVolume`](automation-aws-attachebsvolume.md)
+ [`AWSSupport-CalculateEBSPerformanceMetrics`](automation-calculate-ebs-performance-metrics.md)
+ [`AWS-CopySnapshot`](automation-aws-copysnapshot.md)
+ [`AWS-CreateSnapshot`](automation-aws-createsnapshot.md)
+ [`AWS-DeleteSnapshot`](automation-aws-deletesnapshot.md)
+ [`AWSConfigRemediation-DeleteUnusedEBSVolume`](automation-aws-delete-ebs-volume.md)
+ [`AWS-DeregisterAMIs`](aws-deregisteramis.md)
+ [`AWS-DetachEBSVolume`](automation-aws-detachebsvolume.md)
+ [`AWSConfigRemediation-EnableEbsEncryptionByDefault`](automation-aws-enable-ebs-encryption.md)
+ [`AWS-ExtendEbsVolume`](aws-extendebsvolume.md)
+ [`AWSSupport-ModifyEBSSnapshotPermission`](automation-awssupport-modifyebssnapshotpermission.md)
+ [`AWSConfigRemediation-ModifyEBSVolumeType`](automation-aws-modify-ebs-type.md)

# `AWSSupport-AnalyzeEBSResourceUsage`
<a name="automation-aws-analyze-ebs-resource-usage"></a>

 **描述** 

 `AWSSupport-AnalyzeEBSResourceUsage`自动化运行手册用于分析亚马逊 Elastic Block Store (Amazon EBS) 上的资源使用情况。它会分析卷使用情况并识别给定 AWS 区域中废弃的卷、图像和快照。

 **如何工作？** 

运行手册执行以下四项任务：

1. 验证亚马逊简单存储服务 (Amazon S3) 存储桶是否存在，或者创建一个新的亚马逊 S3 存储桶。

1. 收集所有处于可用状态的 Amazon EBS 卷。

1. 收集源卷已被删除的所有 Amazon EBS 快照。

1. 收集所有未被任何未终止的亚马逊弹性计算云 (Amazon EC2) 实例使用的亚马逊机器映像 (AMI)。

 运行手册生成 CSV 报告并将其存储在用户提供的 Amazon S3 存储桶中。所提供的存储桶应按照最后概述 AWS 的安全最佳实践进行保护。如果账户中不存在用户提供的 Amazon S3 存储桶，则运行手册会创建一个名称格式的新 Amazon S3 存储桶`<User-provided-name>-awssupport-YYYY-MM-DD`，使用自定义 AWS Key Management Service (AWS KMS) 密钥加密，启用对象版本控制，禁止公开访问，并要求请求使用 SSL/TLS。

 如果您想指定自己的 Amazon S3 存储桶，请确保按照以下最佳实践对其进行配置：
+ 阻止公众访问存储桶（设置`IsPublic`为`False`）。
+ 打开 Amazon S3 访问日志记录。
+ [仅允许向您的存储桶发出 SSL 请求](https://repost.aws/knowledge-center/s3-bucket-policy-for-config-rule)。
+ 开启对象版本控制。
+ 使用 AWS Key Management Service (AWS KMS) 密钥加密您的存储桶。

**重要**  
使用此运行手册可能会因创建 Amazon S3 存储桶和对象而对您的账户产生额外费用。有关可能产生的费用的更多详细信息，请参阅 [Amazon S3 定价](https://aws.amazon.com/s3/pricing/)。

**文档类型**

自动化

**所有者**

Amazon

**平台**

Linux、macOS、Windows

**参数**
+ AutomationAssumeRole

  类型：字符串

  描述：（可选）允许 Systems Manager Automation 代表您执行操作 AWS Identity and Access Management (IAM) 角色的 Amazon 资源名称（ARN）。如果未指定角色，Systems Manager Automation 将使用启动此运行手册的用户的权限。
+ S3 BucketName

  类型：`AWS::S3::Bucket::Name`

  描述：（必填）您账户中用于上传报告的 Amazon S3 存储桶。确保存储桶策略不会向不需要访问所收集日志的各方授予不必要的 read/write 权限。如果账户中不存在指定的存储桶，则自动化会在以名称格式启动自动化的区域中创建一个新的存储桶`<User-provided-name>-awssupport-YYYY-MM-DD`，并使用自定义 AWS KMS 密钥进行加密。

  允许的模式：`$|^(?!(^(([0-9]{1,3}[.]){3}[0-9]{1,3}$)))^((?!xn—)(?!.*-s3alias))[a-z0-9][-.a-z0-9]{1,61}[a-z0-9]$`
+ CustomerManagedKmsKeyArn

  类型：字符串

  描述：（可选）自定义 AWS KMS 密钥 Amazon 资源名称 (ARN)，用于加密新的 Amazon S3 存储桶，如果账户中不存在指定的存储桶，则将创建该存储桶。如果在未指定自定义 AWS KMS 密钥 ARN 的情况下尝试创建存储桶，则自动化将失败。

  允许的模式：`(^$|^arn:aws:kms:[-a-z0-9]:[0-9]:key/[-a-z0-9]*$)`

**所需的 IAM 权限**

`AutomationAssumeRole` 参数需要执行以下操作才能成功使用运行手册。
+ `ec2:DescribeImages`
+ `ec2:DescribeInstances`
+ `ec2:DescribeSnapshots`
+ `ec2:DescribeVolumes`
+ `kms:Decrypt`
+ `kms:GenerateDataKey`
+ `s3:CreateBucket`
+ `s3:GetBucketAcl`
+ `s3:GetBucketPolicyStatus`
+ `s3:GetBucketPublicAccessBlock`
+ `s3:ListBucket`
+ `s3:ListAllMyBuckets`
+ `s3:PutObject`
+ `s3:PutBucketLogging`
+ `s3:PutBucketPolicy`
+ `s3:PutBucketPublicAccessBlock`
+ `s3:PutBucketTagging`
+ `s3:PutBucketVersioning`
+ `s3:PutEncryptionConfiguration`
+ `ssm:DescribeAutomationExecutions`

 **具有运行此运行手册所需的最低 IAM 权限的策略示例：**

------
#### [ JSON ]

****  

```
        {
            "Version":"2012-10-17",		 	 	 
            "Statement": [{
                "Sid": "ReadOnlyPermissions",
                "Effect": "Allow",
                "Action": [
                    "ec2:DescribeImages",
                    "ec2:DescribeInstances",
                    "ec2:DescribeSnapshots",
                    "ec2:DescribeVolumes",
                    "ssm:DescribeAutomationExecutions"
                ],
                "Resource": "*"
            }, {
                "Sid": "KMSGeneratePermissions",
                "Effect": "Allow",
                "Action": ["kms:GenerateDataKey", "kms:Decrypt"],
                "Resource": "arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
            }, {
                "Sid": "S3ReadOnlyPermissions",
                "Effect": "Allow",
                "Action": [
                    "s3:GetBucketAcl",
                    "s3:GetBucketPolicyStatus",
                    "s3:GetBucketPublicAccessBlock",
                    "s3:ListBucket"
                ],
                "Resource": [
                    "arn:aws:s3:::amzn-s3-demo-bucket1",
                    "arn:aws:s3:::amzn-s3-demo-bucket2/"
                ]
            }, {
                "Sid": "S3CreatePermissions",
                "Effect": "Allow",
                "Action": [
                    "s3:CreateBucket",
                    "s3:PutObject",
                    "s3:PutBucketLogging",
                    "s3:PutBucketPolicy",
                    "s3:PutBucketPublicAccessBlock",
                    "s3:PutBucketTagging",
                    "s3:PutBucketVersioning",
                    "s3:PutEncryptionConfiguration"
                ],
                "Resource": "*"
            }]
        }
```

------

 **说明** 

按照这些步骤对自动化进行配置：

1. 导航到 AWS Systems Manager 控制台[AWSSupport-AnalyzeEBSResourceUsage](https://console.aws.amazon.com/systems-manager/documents/AWSSupport-AnalyzeEBSResourceUsage/description)中的。

1. 要输入参数，请输入以下内容：
   + **AutomationAssumeRole （可选）：**

     允许 Systems Manager Automation 代表您执行操作的 AWS Identity and Access Management (IAM) 角色的亚马逊资源名称 (ARN)。如果未指定角色，Systems Manager Automation 将使用启动此运行手册的用户的权限。
   + **S3BucketName （必填）：**

     您账户中用于将报告上传到的 Amazon S3 存储桶。
   + **CustomerManagedKmsKeyArn（可选）：**

     自定义 AWS KMS 密钥 Amazon 资源名称 (ARN)，用于加密在账户中不存在指定的存储桶时创建的新 Amazon S3 存储桶。  
![\[Input parameters for S3 bucket configuration, including bucket name and KMS key ARN.\]](http://docs.aws.amazon.com/zh_cn/systems-manager-automation-runbooks/latest/userguide/images/awssupport-analyze-ebs-resource-usage_input_parameters.png)

1. 选择**执行**。

1. 自动化启动。

1. 自动化运行手册执行以下步骤：
   + **检查并发性：**

     确保该地区只有一个启动该运行手册。如果 runbook 发现另一个正在执行的执行，则会返回错误并结束。
   + **verifyOrCreates3Bucket：**

     验证 Amazon S3 存储桶是否存在。否则，它会在以名称格式启动自动化的区域创建一个新的 Amazon S3 存储桶`<User-provided-name>-awssupport-YYYY-MM-DD`，并使用自定义 AWS KMS 密钥进行加密。
   + **gatherAmiDetails:**

     搜索任何 Amazon EC2 实例未使用的 AMI，生成名称格式的报告`<region>-images.csv`，然后将其上传到 Amazon S3 存储桶。
   + **gatherVolumeDetails:**

     验证 Amazon EBS 卷是否处于可用状态，生成名称格式的报告`<region>-volume.csv`，然后将其上传到 Amazon S3 存储桶中。
   + **gatherSnapshotDetails:**

     查找已删除的 Amazon EBS 卷的 Amazon EBS 快照，生成名称格式的报告`<region>-snapshot.csv`，然后将其上传到 Amazon S3 存储桶。

1. 完成后，查看“输出”部分以了解执行的详细结果。  
![\[Output details showing volume, AMI, and snapshot information for AWS resources.\]](http://docs.aws.amazon.com/zh_cn/systems-manager-automation-runbooks/latest/userguide/images/awssupport-analyze-ebs-resource-usage_outputs.png)

 **参考** 

Systems Manager Automation
+ [运行此自动化（控制台）](https://console.aws.amazon.com/systems-manager/automation/execute/AWSSupport-AnalyzeEBSResourceUsage)
+ [运行自动化](https://docs.aws.amazon.com//systems-manager/latest/userguide/automation-working-executing.html)
+ [设置自动化](https://docs.aws.amazon.com//systems-manager/latest/userguide/automation-setup.html)
+ [支持自动化工作流登录页面](https://aws.amazon.com/premiumsupport/technology/saw/)

# `AWS-ArchiveEBSSnapshots`
<a name="aws-archiveebssnapshots"></a>

 **描述** 

 `AWS-ArchiveEBSSnapshots` 运行手册通过指定您应用于快照的标签，帮助您归档 Amazon Elastic Block Store (Amazon EBS) 卷的快照。或者，如果您的快照未加标签，您可以提供卷的 ID。

 [运行此自动化（控制台）](https://console.aws.amazon.com/systems-manager/automation/execute/AWS-ArchiveEBSSnapshots) 

**文档类型**

自动化

**所有者**

Amazon

**平台**

Linux、macOS、Windows

**参数**
+ AutomationAssumeRole

  类型：字符串

  描述：（可选）允许 Systems Manager Automation 代表您执行操作 AWS Identity and Access Management (IAM) 角色的 Amazon 资源名称（ARN）。如果未指定角色，Systems Manager Automation 将使用启动此运行手册的用户的权限。
+ 说明

  类型：字符串

  描述：（可选）对 Amazon EBS 快照的说明。
+ DryRun

  类型：字符串

  有效值：是 \$1 否

  描述：（必需）在未实际发出请求的情况下检查您是否拥有该操作所需的权限，并提供错误响应。
+ RetentionCount

  类型：字符串

  描述：（可选）要归档的快照数量。如果您为 `RetentionDays` 参数指定了一个值，则不要为此参数指定值。
+ RetentionDays

  类型：字符串

  描述：（可选）要归档的前几天快照的数量。如果您为 `RetentionCount` 参数指定了一个值，则不要为此参数指定值。
+ SnapshotWithTag

  类型：字符串

  有效值：是 \$1 否

  描述：（必需）指定要归档的快照是否已添加标签。
+ TagKey

  类型：字符串

  描述：（可选）分配给要归档快照的标签的键。
+ TagValue

  类型：字符串

  描述：（可选）分配给要归档快照的标签的值。
+ VolumeId

  类型：字符串

  描述：（可选）要归档快照的卷 ID。如果快照未添加标签，请使用此参数。

**所需的 IAM 权限**

`AutomationAssumeRole` 参数需要执行以下操作才能成功使用运行手册。
+  `ec2:ArchiveSnapshots` 
+  `ec2:DescribeSnapshots` 

 **文档步骤** 

`aws:executeScript` - 使用您用 `TagKey` 和 `TagValue` 参数指定的标签或参数 `VolumeId` 对快照进行归档。

# `AWS-AttachEBSVolume`
<a name="automation-aws-attachebsvolume"></a>

 **描述** 

将 Amazon Elastic Block Store (Amazon EBS) 卷挂载到 Amazon Elastic Compute Cloud (Amazon EC2) 实例。

 [运行此自动化（控制台）](https://console.aws.amazon.com/systems-manager/automation/execute/AWS-AttachEBSVolume) 

**文档类型**

自动化

**所有者**

Amazon

**平台**

Linux、macOS、Windows

**参数**
+ AutomationAssumeRole

  类型：字符串

  描述：（可选）允许 Systems Manager Automation 代表您执行操作 AWS Identity and Access Management (IAM) 角色的 Amazon 资源名称（ARN）。如果未指定角色，Systems Manager Automation 将使用启动此运行手册的用户的权限。
+ 设备

  类型：字符串

  描述：（必需）设备名称（例如，/dev/sdh 或 xvdh）。
+ InstanceId

  类型：字符串

  描述：（必需）要附加卷的实例的 ID。
+ VolumeId

  类型：字符串

  描述：（必需）Amazon EBS 卷的 ID。该卷与实例必须位于同一可用区。

# `AWSSupport-CalculateEBSPerformanceMetrics`
<a name="automation-calculate-ebs-performance-metrics"></a>

 **描述** 

 该`AWSSupport-CalculateEBSPerformanceMetrics`运行手册通过计算性能指标并将其发布到控制面板来帮助诊断 Amazon EBS 性能问题。 CloudWatch 控制面板显示目标亚马逊 EBS 卷或连接到目标亚马逊弹性计算云 (Amazon EC2) 实例的所有卷的估计平均 IOPS 和吞吐量。对于 Amazon EC2 实例，它还会显示实例的平均 IOPS 和吞吐量。运行手册输出指向新创建的仪表板的链接，该 CloudWatch 仪表板显示了相关的计算 CloudWatch 指标。 CloudWatch 控制面板是在您的账户中创建的，名称为:`AWSSupport-<ResourceId>-EBS-Performance-<automation:EXECUTION_ID>`。

 **如何工作？** 

 运行手册执行以下步骤：
+ 确保指定的时间戳有效。
+ 验证资源 ID（亚马逊 EBS 卷或亚马逊 EC2 实例）是否有效。
+ 当您提供 Amazon EC2 作为资源 ID 时，它会 CloudWatch 创建一个控制面板，其中包含该亚马逊 EC2 实例的实际 IOPS/Throughput 总计，以及附加到 Amazon EC2 实例的所有亚马逊 EBS 卷的估计平均 IOPS/吞吐量图表。
+ 当您提供 Amazon EBS 卷作为资源 ID 时，它会 CloudWatch 创建一个包含该交易量的 “估计 IOPS/Throughput 平均值” 图表的控制面板。
+ 生成 CloudWatch 控制面板后，如果估计平均 IOPS 或估计平均吞吐量分别超过最大 IOPS 或最大吞吐量，则连接到 Amazon EC2 实例的一个或多个卷可能会出现微爆发。

**注意**  
 对于可突发卷（gp2、sc2 和 st1），在获得突发平衡之前， IOPS/throughput 应考虑最大值。在完全利用突发平衡（即突发平衡变为零）之后，请考虑基线 IOPS/throughput 指标。

**重要**  
 创建 CloudWatch 控制面板可能会导致您的账户产生额外费用。有关更多信息，请参阅 [Amazon CloudWatch 定价指南](https://aws.amazon.com/cloudwatch/pricing)。

 [运行此自动化（控制台）](https://console.aws.amazon.com/systems-manager/automation/execute/AWSSupport-CalculateEBSPerformanceMetrics) 

**文档类型**

自动化

**所有者**

Amazon

**平台**

Linux、macOS、Windows

**参数**

**所需的 IAM 权限**

`AutomationAssumeRole` 参数需要执行以下操作才能成功使用运行手册。
+ `ec2:DescribeVolumes`
+ `ec2:DescribeInstances`
+ `ec2:DescribeInstanceTypes`
+ `cloudwatch:PutDashboard`

政策示例

------
#### [ JSON ]

****  

```
{
    "Version":"2012-10-17",		 	 	 
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": "cloudwatch:PutDashboard",
            "Resource": "arn:aws:cloudwatch::111122223333:dashboard/*-EBS-Performance-*"
        },
        {
            "Sid": "VisualEditor1",
            "Effect": "Allow",
            "Action": [
                "ec2:DescribeInstances",
                "ec2:DescribeVolumes",
                "ec2:DescribeInstanceTypes"
            ],
            "Resource": "*"
        }
    ]
}
```

------

 **说明** 

按照这些步骤对自动化进行配置：

1. [https://console.aws.amazon.com/systems-manager/documents/AWSSupport-CalculateEBSPerformanceMetrics/description](https://console.aws.amazon.com/systems-manager/documents/AWSSupport-CalculateEBSPerformanceMetrics/description)在 Systems Manager 的 “文档” 下导航至。

1. 选择 Execute automation（执行自动化）。

1. 对于输入参数，请输入以下内容：
   + **AutomationAssumeRole （可选）：**

     允许 Systems Manager Automation 代表您执行操作的 AWS AWS Identity and Access Management (IAM) 角色的亚马逊资源名称 (ARN)。如果未指定角色，Systems Manager Automation 将使用启动此运行手册的用户的权限。
   + **资源 ID（必填）：**

     亚马逊 EC2 实例或亚马逊 EBS 卷的 ID。
   + **开始时间（必填）：**

     查看数据的开始时间 CloudWatch。时间必须采用格式`yyyy-mm-ddThh:mm:ss`和 UTC。
   + **结束时间（必填）：**

     查看数据的结束时间 CloudWatch。时间必须采用格式`yyyy-mm-ddThh:mm:ss`和 UTC。  
![\[Input parameters form for AWS Systems Manager Automation with fields for role, resource ID, and time range.\]](http://docs.aws.amazon.com/zh_cn/systems-manager-automation-runbooks/latest/userguide/images/awssupport-calculate-ebs-performance-metrics_input_parameters.png)

1. 选择执行。

1. 自动化启动。

1. 文档将执行以下步骤：
   + **CheckResourceIdAndTimeStamps:**

     检查结束时间是否比开始时间大于开始时间至少一分钟，以及所提供的资源是否存在。
   + **CreateCloudWatchDashboard:**

     计算 Amazon EBS 绩效并根据您的资源 ID 显示图表。如果您为参数 “资源 ID” 提供了 Amazon EBS 卷 ID，则本运行手册将创建一个 CloudWatch 控制面板，其中包含估算的平均 IOPS 和估算的 Amazon EBS 卷平均吞吐量。如果您为参数 “资源 ID” 提供了 Amazon EC2 实例 ID，则本运行手册将创建一个 CloudWatch 控制面板，其中包含亚马逊 EC2 实例的平均总 IOPS 和平均总吞吐量，以及附加到 Amazon EC2 实例的所有 Amazon EBS 卷的估计平均 IOPS 和估计的平均吞吐量。

1. 完成后，请查看 “输出” 部分，了解执行的详细结果：  
![\[CloudWatch dashboard creation output showing a URL link and a message with instructions.\]](http://docs.aws.amazon.com/zh_cn/systems-manager-automation-runbooks/latest/userguide/images/awssupport-calculate-ebs-performance-metrics_outputs.png)

   作为 Amazon EC2 实例的资源 ID 的示例 CloudWatch 控制面板  
![\[CloudWatch dashboard showing EC2 instance metrics with graphs for IOPS, throughput, and volume performance.\]](http://docs.aws.amazon.com/zh_cn/systems-manager-automation-runbooks/latest/userguide/images/awssupport-calculate-ebs-performance-metrics_dashboard_ec2_instance.png)

   资源标识为 Amazon EBS 卷 ID 的示例 CloudWatch 控制面板  
![\[CloudWatch dashboard showing EBS volume performance metrics with IOPS and throughput graphs.\]](http://docs.aws.amazon.com/zh_cn/systems-manager-automation-runbooks/latest/userguide/images/awssupport-calculate-ebs-performance-metrics_dashboard_ebs_volume.png)

 **参考** 

Systems Manager Automation
+ [运行此自动化（控制台）](https://console.aws.amazon.com/systems-manager/documents/AWSSupport-CalculateEBSPerformanceMetrics/description)
+ [运行自动化](https://docs.aws.amazon.com//systems-manager/latest/userguide/automation-working-executing.html)
+ [设置自动化](https://docs.aws.amazon.com//systems-manager/latest/userguide/automation-setup.html)
+ [支持自动化工作流登录页面](https://aws.amazon.com/premiumsupport/technology/saw/)

AWS 服务文档
+ [如何识别我的 Amazon EBS 交易量是否处于微爆状态，然后防止这种情况发生？](https://repost.aws/knowledge-center/ebs-identify-micro-bursting)
+ [ CloudWatch 如何使用查看 EC2 实例的 Amazon EBS 综合性能指标？](https://repost.aws/knowledge-center/ebs-aggregate-cloudwatch-performance)

# `AWS-CopySnapshot`
<a name="automation-aws-copysnapshot"></a>

 **描述** 

复制亚马逊 Elastic Block Store (Amazon EBS) 卷的 point-in-time快照。您可以在同一区域内复制快照， AWS 区域 也可以将快照从一个区域复制到另一个区域。加密 Amazon EBS 快照的副本保持加密状态。未加密快照的副本保持未加密状态。要复制从另一个账户共享的加密快照，您必须拥有对用于加密快照的 KMS 密钥的权限。通过复制其他快照创建的快照具有一个不应用于任何用途的任意卷 ID。

 [运行此自动化（控制台）](https://console.aws.amazon.com/systems-manager/automation/execute/AWS-CopySnapshot) 

**文档类型**

自动化

**所有者**

Amazon

**平台**

Linux、macOS、Windows

**参数**
+ AutomationAssumeRole

  类型：字符串

  描述：（可选）允许 Systems Manager Automation 代表您执行操作 AWS Identity and Access Management (IAM) 角色的 Amazon 资源名称（ARN）。如果未指定角色，Systems Manager Automation 将使用启动此运行手册的用户的权限。
+ 说明

  类型：字符串

  描述：（可选）对 Amazon EBS 快照的说明。
+ SnapshotId

  类型：字符串

  描述：（必需）要复制的 Amazon EBS 快照的 ID。
+ SourceRegion

  类型：字符串

  描述：（必需）源快照当前所在的区域。

 **文档步骤** 

copySnapshot - 复制 Amazon EBS 卷的快照。

 **输出** 

CopySnapshot。 SnapshotId -新快照的 ID。

# `AWS-CreateSnapshot`
<a name="automation-aws-createsnapshot"></a>

 **描述** 

创建 Amazon EBS 卷的快照。

 [运行此自动化（控制台）](https://console.aws.amazon.com/systems-manager/automation/execute/AWS-CreateSnapshot) 

**文档类型**

自动化

**所有者**

Amazon

**平台**

Linux、macOS、Windows

**参数**
+ AutomationAssumeRole

  类型：字符串

  描述：（可选）允许 Systems Manager Automation 代表您执行操作 AWS Identity and Access Management (IAM) 角色的 Amazon 资源名称（ARN）。如果未指定角色，Systems Manager Automation 将使用启动此运行手册的用户的权限。
+ 说明

  类型：字符串

  描述：（可选）对快照的说明
+ VolumeId

  类型：字符串

  描述：（必需）卷的 ID。

# `AWS-DeleteSnapshot`
<a name="automation-aws-deletesnapshot"></a>

 **描述** 

删除 Amazon EBS 卷快照。

 [运行此自动化（控制台）](https://console.aws.amazon.com/systems-manager/automation/execute/AWS-DeleteSnapshot) 

**文档类型**

自动化

**所有者**

Amazon

**平台**

Linux、macOS、Windows

**参数**
+ AutomationAssumeRole

  类型：字符串

  描述：（可选）允许 Systems Manager Automation 代表您执行操作 AWS Identity and Access Management (IAM) 角色的 Amazon 资源名称（ARN）。如果未指定角色，Systems Manager Automation 将使用启动此运行手册的用户的权限。
+ SnapshotId

  类型：字符串

  描述：（必需）EBS 快照的 ID。

# `AWSConfigRemediation-DeleteUnusedEBSVolume`
<a name="automation-aws-delete-ebs-volume"></a>

 **描述** 

 `AWSConfigRemediation-DeleteUnusedEBSVolume` 运行手册将删除未使用的 Amazon Elastic Block Store (Amazon EBS) 卷。

 [运行此自动化（控制台）](https://console.aws.amazon.com/systems-manager/automation/execute/AWSConfigRemediation-DeleteUnusedEBSVolume) 

**文档类型**

自动化

**所有者**

Amazon

**平台**

Linux、macOS、Windows

**参数**
+ AutomationAssumeRole

  类型：字符串

  描述：（必需）允许 Systems Manager Automation 代表您执行操作的 AWS Identity and Access Management (IAM) 角色的 Amazon 资源名称（ARN）。
+ CreateSnapshot

  类型：布尔值

   描述：（可选）如果设置为 `true`，则自动化会在 Amazon EBS 卷删除之前创建该卷的快照。
+ VolumeId

  类型：字符串

  描述：（必需）要删除的 Amazon EBS 卷的 ID。

**所需的 IAM 权限**

`AutomationAssumeRole` 参数需要执行以下操作才能成功使用运行手册。
+  `ssm:StartAutomationExecution` 
+  `ssm:GetAutomationExecution` 
+  `ec2:CreateSnapshot` 
+  `ec2:DeleteVolume` 
+  `ec2:DescribeSnapshots` 
+  `ec2:DescribeVolumes` 

 **文档步骤** 
+  `aws:executeScript` - 验证您在 `VolumeId` 参数中指定的 Amazon EBS 卷未在用，并根据您为 `CreateSnapshot` 参数选择的值创建一个快照。
+  `aws:branch` - 根据您为 `CreateSnapshot` 参数选择的值进行分支。
+  `aws:waitForAwsResourceProperty` - 等待快照完成。
+  `aws:executeAwsApi` - 在快照创建失败时删除快照。
+  `aws:executeAwsApi` - 删除您在 `VolumeId` 参数中指定的 Amazon EBS 卷。
+  `aws:executeScript` - 验证 Amazon EBS 卷已被删除。

# `AWS-DeregisterAMIs`
<a name="aws-deregisteramis"></a>

 **描述** 

 `AWS-DeregisterAMIs`运行手册使用指定已应用于 AMIs 的标签来帮助您取消注册 Amazon Machine Images (AMIs)。

 [运行此自动化（控制台）](https://console.aws.amazon.com/systems-manager/automation/execute/AWS-DeregisterAMIs) 

**文档类型**

自动化

**所有者**

Amazon

**平台**

Linux、macOS、Windows

**参数**
+ AutomationAssumeRole

  类型：字符串

  描述：（可选）允许 Systems Manager Automation 代表您执行操作 AWS Identity and Access Management (IAM) 角色的 Amazon 资源名称（ARN）。如果未指定角色，Systems Manager Automation 将使用启动此运行手册的用户的权限。
+ DryRun

  类型：字符串

  有效值：是 \$1 否

  描述：（必需）在未实际发出请求的情况下检查您是否拥有该操作所需的权限，并提供错误响应。
+ RetainNumber

  类型：字符串

  描述：（可选）要保留的 AMIs 的数量。如果您为 `Age` 参数指定了一个值，则不要为此参数指定值。
+ 天数

  类型：字符串

  描述：（可选）要保留的前几天的 AMIs 数量。如果您为 `RetainNumber` 参数指定了一个值，则不要为此参数指定值。
+ TagKey

  类型：字符串

  描述：（必需）分配给要取消注册 AMIs 的标签的键。
+ TagValue

  类型：字符串

  描述：（必需）分配给要取消注册 AMIs 的标签的值。

**所需的 IAM 权限**

`AutomationAssumeRole` 参数需要执行以下操作才能成功使用运行手册。
+  `ec2:DeregisterImage` 
+  `ec2:DescribeImages` 

 **文档步骤** 
+  `aws:executeAwsApi` - 验证您为运行手册输入参数指定的值。
+  `aws:executeAwsApi` - 使用您用 `TagKey` 和 `TagValue` 参数指定的标签来取消 AMIs 的注册。

# `AWS-DetachEBSVolume`
<a name="automation-aws-detachebsvolume"></a>

 **描述** 

将 Amazon EBS 卷与 Amazon Elastic Compute Cloud (Amazon EC2) 实例分离。

 [运行此自动化（控制台）](https://console.aws.amazon.com/systems-manager/automation/execute/AWS-DetachEBSVolume) 

**文档类型**

自动化

**所有者**

Amazon

**平台**

Linux、macOS、Windows

**参数**
+ AutomationAssumeRole

  类型：字符串

  描述：（可选）允许 Systems Manager Automation 代表您执行操作 AWS Identity and Access Management (IAM) 角色的 Amazon 资源名称（ARN）。如果未指定角色，Systems Manager Automation 将使用启动此运行手册的用户的权限。
+ LambdaAssumeRole

  类型：字符串

  描述：（可选）Lambda担任的角色的 ARN。
+ VolumeId

  类型：字符串

  描述：（必需）EBS 卷的 ID。卷和实例必须位于同一可用区内

# `AWSConfigRemediation-EnableEbsEncryptionByDefault`
<a name="automation-aws-enable-ebs-encryption"></a>

 **描述** 

 该`AWSConfigRemediation-EnableEbsEncryptionByDefault`运行手册支持对运行自动化的所有新的亚马逊弹性区块存储 (Amazon EBS) 卷进行 AWS 账户 加密。 AWS 区域 在运行自动化之前创建的卷不会被加密。

 [运行此自动化（控制台）](https://console.aws.amazon.com/systems-manager/automation/execute/AWSConfigRemediation-EnableEbsEncryptionByDefault) 

**文档类型**

自动化

**所有者**

Amazon

**平台**

Linux、macOS、Windows

**参数**
+ AutomationAssumeRole

  类型：字符串

  描述：（必需）允许 Systems Manager Automation 代表您执行操作的 AWS Identity and Access Management (IAM) 角色的 Amazon 资源名称（ARN）。

**所需的 IAM 权限**

`AutomationAssumeRole` 参数需要执行以下操作才能成功使用运行手册。
+  `ec2:EnableEbsEncryptionByDefault` 
+  `ec2:GetEbsEncryptionByDefault` 
+  `ssm:StartAutomationExecution` 
+  `ssm:GetAutomationExecution` 

 **文档步骤** 
+  `aws:executeAwsApi` - 在当前账户和区域，启用默认 Amazon EBS 加密设置。
+  `aws:assertAwsResourceProperty` - 验证是否已启用默认 Amazon EBS 加密设置。

# `AWS-ExtendEbsVolume`
<a name="aws-extendebsvolume"></a>

 **描述** 

`AWS-ExtendEbsVolume` 运行手册将增加 Amazon EBS 卷的大小并扩展文件系统。此自动化支持 `xfs` 和 `ext4` 文件系统。

 [运行此自动化（控制台）](https://console.aws.amazon.com/systems-manager/automation/execute/AWS-ExtendEbsVolume) 

**文档类型**

自动化

**所有者**

Amazon

**平台**

Linux、Windows

**参数**
+ AutomationAssumeRole

  类型：字符串

  描述：（可选）允许 Systems Manager Automation 代表您执行操作 AWS Identity and Access Management (IAM) 角色的 Amazon 资源名称（ARN）。如果未指定角色，Systems Manager Automation 将使用启动此运行手册的用户的权限。
+ DriveLetter

  类型：字符串

  描述：（可选）要扩展其文件系统的驱动器的盘符。Windows 实例需要此参数。
+ InstanceId

  类型：字符串

  描述：（可选）要扩展的 Amazon EBS 卷所附加到的 Amazon EC2 实例的 ID。
+ KeepSnapshot

  类型：布尔值

  默认：True

  描述：（可选）确定是否保留在增加 Amazon EBS 卷大小之前创建的快照。
+ MountPoint

  类型：字符串

  描述：（可选）要扩展其文件系统的驱动器的装载点。Linux 实例需要此参数。
+ SizeGib

  类型：字符串

  描述：（必需）要将 Amazon EBS 卷修改成的大小，以 GiB 为单位。
+ VolumeId

  类型：字符串

  描述：（必需）要扩展的 EBS 卷 的 ID。

**所需的 IAM 权限**

`AutomationAssumeRole` 参数需要执行以下操作才能成功使用运行手册。
+  `ec2:CreateSnapshot` 
+  `ec2:CreateTags` 
+  `ec2:DeleteSnapshot` 
+  `ec2:DescribeVolumes` 
+  `ec2:ModifyVolume` 
+  `ssm:DescribeInstanceInformation` 
+  `ssm:GetCommandInvocation` 
+  `ssm:SendCommand` 

 **文档步骤** 
+  `aws:executeScript` - 将卷的大小增加到您在 `VolumeId` 参数中指定的值并扩展文件系统。

# `AWSSupport-ModifyEBSSnapshotPermission`
<a name="automation-awssupport-modifyebssnapshotpermission"></a>

 **描述** 

 `AWSSupport-ModifyEBSSnapshotPermission` 运行手册可帮助修改多个 Amazon Elastic Block Store (Amazon EBS) 快照的权限。使用此运行手册，您可以制作快照 `Public` 或 `Private` 并将其与其他 AWS 账户分享。使用默认 KMS 密钥加密的快照无法与使用此运行手册的其他账户分享。

 [运行此自动化（控制台）](https://console.aws.amazon.com/systems-manager/automation/execute/AWSSupport-ModifyEBSSnapshotPermissions) 

**文档类型**

自动化

**所有者**

Amazon

**平台**

Linux、macOS、Windows

**参数**
+ AutomationAssumeRole

  类型：字符串

  描述：（可选）允许 Systems Manager Automation 代表您执行操作 AWS Identity and Access Management (IAM) 角色的 Amazon 资源名称（ARN）。如果未指定角色，Systems Manager Automation 将使用启动此运行手册的用户的权限。
+ AccountIds

  类型： StringList

  默认：无

   描述：（可选）您要与 IDs 之共享快照的账户。如果您为 `Private` 参数值输入 `No`，则此参数为必选项。
+ AccountPermissionOperation

  类型：字符串

  有效值：添加 \$1 移除

  默认：无

  描述：（可选）要执行的操作类型。
+ 专属

  类型：字符串

  有效值：是 \$1 否

   描述：（必需）如果要与特定账户共享快照，则为该值输入 `No`。
+ SnapshotIds

  类型： StringList

  描述：（必填）您想要修改其权限的 Amazon EBS 快照。 IDs 

**所需的 IAM 权限**

`AutomationAssumeRole` 参数需要执行以下操作才能成功使用运行手册。
+  `ssm:StartAutomationExecution` 
+  `ssm:GetAutomationExecution` 
+  `ec2:DescribeSnapshots` 
+  `ec2:ModifySnapshotAttribute` 

 **文档步骤** 

1.  `aws:executeScript`-验证`SnapshotIds`参数中提供的快照。 IDs 验证后 IDs，脚本会检查是否有加密快照，如果找到任何快照，则输出一个列表。

1.  `aws:branch`- 根据为 `Private` 参数输入的值对自动化进行分支。

1.  `aws:executeScript`- 修改指定快照的权限，以便与指定账户共享快照。

1.  `aws:executeScript`- 修改快照的权限，将其从改 `Public` 为 `Private`。

 **输出** 

ValidateSnapshots.EncryptedSnapshots

SharewithOtherAccounts.Result

MakePrivate.Result

MakePrivate. 命令

# `AWSConfigRemediation-ModifyEBSVolumeType`
<a name="automation-aws-modify-ebs-type"></a>

 **描述** 

 `AWSConfigRemediation-ModifyEBSVolumeType` 运行手册将修改 Amazon Elastic Block Store (Amazon EBS) 卷的卷类型。修改卷类型后，该卷将进入 `optimizing` 状态。有关监控卷修改进度的信息，请参阅 *Amazon EC2 用户指南*中的[监控卷修改进度](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-volume-modifications.html)。

 [运行此自动化（控制台）](https://console.aws.amazon.com/systems-manager/automation/execute/AWSConfigRemediation-ModifyEBSVolumeType) 

**文档类型**

自动化

**所有者**

Amazon

**平台**

Linux、macOS、Windows

**参数**
+ AutomationAssumeRole

  类型：字符串

  描述：（必需）允许 Systems Manager Automation 代表您执行操作的 AWS Identity and Access Management (IAM) 角色的 Amazon 资源名称（ARN）。
+ EbsVolumeId

  类型：字符串

  描述：（必需）要修改的 Amazon EBS 卷的 ID。
+ EbsVolumeType

  类型：字符串

  有效值：标准 \$1 io1 \$1 io2 \$1 gp2 \$1 gp3 \$1 sc1 \$1 st1

   描述：要将 Amazon EBS 卷更改成的卷类型。有关亚马逊 EBS 卷类型的信息，请参阅[亚马逊 *EC2 用户指南中的亚马逊* EBS 卷类型](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html)。

**所需的 IAM 权限**

`AutomationAssumeRole` 参数需要执行以下操作才能成功使用运行手册。
+  `ssm:StartAutomationExecution` 
+  `ssm:GetAutomationExecution` 
+  `ec2:DescribeVolumes` 
+  `ec2:ModifyVolume` 

 **文档步骤** 
+  `aws:waitForAwsResourceProperty` - 验证卷的状态是否为 `available` 或 `in-use`。
+  `aws:executeAwsApi` - 修改在您 `EbsVolumeId` 参数中指定的 Amazon EBS 卷。
+  `aws:waitForAwsResourceProperty` - 验证卷的类型是否已更改为您在 `EbsVolumeType` 参数中指定的值。