AWS Systems Manager
用户指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS-SetupInventory

描述

为一个或多个托管实例创建 Systems Manager Inventory 关联。系统根据关联中的计划从实例收集元数据。有关更多信息,请参阅 AWS Systems Manager Inventory

文档类型

Automation

所有者

Amazon

平台

Windows、Linux

参数

  • 应用程序

    类型:字符串

    默认值:Enabled

    说明:(可选)收集有关已安装的应用程序的元数据。

  • AssociatedDocName

    类型:字符串

    默认值:AWS-GatherSoftwareInventory

    说明:(可选)用于从托管实例收集清单的 SSM 文档的名称。

  • AssociationName

    类型:字符串

    说明:(可选)将分配给实例的清单关联的名称。

  • AssocWaitTime

    类型:字符串

    默认值:PT5M

    说明:(可选)到达清单关联开始时间时,清单集合应暂停的时间。时间使用 ISO 8601 格式。

  • AutomationAssumeRole

    类型:字符串

    说明:(可选)允许 Automation 代表您执行操作的角色的 ARN。

  • AwsComponents

    类型:字符串

    默认值:Enabled

    说明:(可选)收集 AWS 组件(例如 amazon-ssm-agent)的元数据。

  • CustomInventory

    类型:字符串

    默认值:Enabled

    说明:(可选)收集自定义清单元数据。

  • 文件

    类型:字符串

    说明:(可选)收集有关实例上的文件的元数据。有关如何收集此类清单数据的更多信息,请参阅使用文件和 Windows 注册表清单。需要 SSMAgent 版本 2.2.64.0 或更高版本。Linux 示例:[{"Path":"/usr/bin", "Pattern":["aws*", "*ssm*"],"Recursive":false},{"Path":"/var/log", "Pattern":["amazon*.*"], "Recursive":true, "DirScanLimit":1000}] Windows 示例:[{"Path":"%PROGRAMFILES%", "Pattern":["*.exe"],"Recursive":true}]

  • InstanceDetailedInformation

    类型:字符串

    默认值:Enabled

    说明:(可选)收集有关实例的其他信息,包括 CPU 型号、速度和内核数等。

  • InstanceIds

    类型:字符串

    默认值:*

    说明:(必需)要清点的 Amazon EC2 实例。

  • LambdaAssumeRole

    类型:字符串

    说明:(可选)允许 Automation 创建的 Lambda 代表您执行操作的角色的 ARN。如果未指定,将创建临时角色来运行 Lambda 函数。

  • NetworkConfig

    类型:字符串

    默认值:Enabled

    说明:(可选)收集有关网络配置的元数据。

  • OutputS3BucketName

    类型:字符串

    说明:(可选)要将清单日志数据写入到的 Amazon S3 存储桶的名称。

  • OutputS3KeyPrefix

    类型:字符串

    说明:(可选)要将清单日志数据写入到的 Amazon S3 键前缀(子文件夹)。

  • OutputS3Region

    类型:字符串

    说明:(可选)Amazon S3 所在的 AWS 区域的名称。

  • Schedule

    类型:字符串

    默认值:cron(0 */30 * * * ? *)

    说明:(可选)清单关联计划的 cron 表达式。默认为每 30 分钟一次。

  • 服务

    类型:字符串

    默认值:Enabled

    说明:(可选,仅限 Windows 操作系统,需要 SSMAgent 版本 2.2.64.0 或更高版本)收集有关服务配置的数据。

  • WindowsRegistry

    类型:字符串

    说明:(可选)收集有关 Microsoft Windows 注册表项的元数据。有关如何收集此类清单数据的更多信息,请参阅使用文件和 Windows 注册表清单。需要 SSM 代理 版本 2.2.64.0 或更高版本。示例:[ {"Path":"HKEY_CURRENT_CONFIG\System","Recursive":true},{"Path":"HKEY_LOCAL_MACHINE\SOFTWARE\Amazon\MachineImage", "ValueNames":["AMIName"]}]

  • WindowsRoles

    类型:字符串

    默认值:Enabled

    说明:(可选)收集有关实例上的 Windows 角色的信息。仅适用于 Windows 操作系统。需要 SSMAgent 版本 2.2.64.0 或更高版本。

  • WindowsUpdates

    类型:字符串

    默认值:Enabled

    说明:(可选)收集有关实例上的所有 Windows 更新的数据。

示例

启动 Automation

aws ssm start-automation-execution --document-name AWS-SetupInventory --parameters parameters

检索执行输出

aws ssm get-automation-execution --automation-execution-id EXECUTIONID --output text --query 'AutomationExecution.Output'

文档步骤

aws:createStack

aws:invokeLambdaFunction

aws:sleep

aws:invokeLambdaFunction

aws:deleteStack

输出