AWS::SSM::ResourceDataSync - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::SSM::ResourceDataSync

AWS::SSM::ResourceDataSync 资源为 AWS Systems Manager 创建、更新或删除资源数据同步。资源数据可同步帮助您在一个位置查看来自多个源的数据。Systems Manager 提供两种类型的资源数据同步:SyncToDestinationSyncFromSource

您可以将 Systems Manager Inventory 配置为使用 SyncToDestination 类型将多个 AWS 区域的 Inventory 数据同步到单个 Amazon S3 存储桶。

您可以将 Systems Manager Explorer 配置为使用 SyncFromSource 类型同步来自多个 AWS 区域的操作工作项 (OpsItems) 和操作数据 (OpsData)。此类型可以同步来自多个 AWS 账户和区域的 OpsItems 和 OpsData,也可以使用 AWS Organizations 从 EntireOrganization 同步。

资源数据同步是一个立即返回的异步操作。成功完成初始同步后,系统会持续同步数据。

默认情况下,Amazon S3 中的数据不加密。我们强烈建议您在 Amazon S3 中启用加密,以确保安全的数据存储。我们还建议您通过创建限制性的存储桶策略,保护对 Amazon S3 存储桶的访问。

有关更多信息,请参阅 AWS Systems Manager 用户指南 中的配置清单收集设置 Systems Manager Explorer 以显示来自多个账户和区域的数据

重要说明:以下语法 部分显示资源数据同步支持的所有字段。以下示例 部分显示为每种同步类型指定配置的推荐方法。在您创建资源数据同步时,请参阅示例 部分。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

{ "Type" : "AWS::SSM::ResourceDataSync", "Properties" : { "BucketName" : String, "BucketPrefix" : String, "BucketRegion" : String, "KMSKeyArn" : String, "S3Destination" : S3Destination, "SyncFormat" : String, "SyncName" : String, "SyncSource" : SyncSource, "SyncType" : String } }

YAML

Type: AWS::SSM::ResourceDataSync Properties: BucketName: String BucketPrefix: String BucketRegion: String KMSKeyArn: String S3Destination: S3Destination SyncFormat: String SyncName: String SyncSource: SyncSource SyncType: String

属性

BucketName

存储聚合数据的 S3 存储桶的名称。

必需:否

类型:字符串

最低1

最高2048

Update requires: Replacement

BucketPrefix

存储桶的 Amazon S3 前缀。

必需:否

类型:字符串

最低1

最高256

Update requires: Replacement

BucketRegion

资源数据同步所针对的 S3 存储桶的 AWS 区域。

必需:否

类型:字符串

最低1

最高64

Update requires: Replacement

KMSKeyArn

Amazon S3 中目标的加密密钥的 ARN。您可以使用 KMS 密钥加密 Amazon S3 中的清单数据。您必须指定与目标 Amazon S3 存储桶位于相同区域中的密钥。

必需:否

类型:字符串

最低1

最高512

模式arn:.*

Update requires: Replacement

S3Destination

目标 S3 存储桶的配置信息。

必需:否

类型S3Destination

Update requires: Replacement

SyncFormat

支持的同步格式。当前支持以下格式:JsonSerDe

必需:否

类型:字符串

允许的值JsonSerDe

Update requires: Replacement

SyncName

资源数据同步的名称。

必需:是

类型:字符串

最低1

最高64

Update requires: Replacement

SyncSource

有关同步了数据的源的信息。

必需:否

类型SyncSource

Update requires: No interruption

SyncType

资源数据同步的类型。如果 SyncTypeSyncToDestination,则资源数据同步将数据同步到 S3 存储桶。如果 SyncTypeSyncFromSource,则资源数据同步将从 AWS Organizations 或从多个 AWS 区域同步数据。

必需:否

类型:字符串

最低1

最高64

Update requires: Replacement

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回资源数据同步的名称,例如 TestResourceDataSync

For more information about using the Ref function, see Ref.

示例

AWS Systems Manager 资源数据同步 - SyncToDestination

以下示例将美国东部(俄亥俄)区域 (us-east-2) 中的 Systems Manager Inventory 元数据同步到单个 Amazon S3 存储桶。在收集新的数据时,资源数据同步自动更新集中式数据。

JSON

{ "Description": "Create a Resource Data Sync for Systems Manager", "Resources": { "BasicResourceDataSync": { "Type": "AWS::SSM::ResourceDataSync", "Properties": { "SyncName": "test-sync", "SyncType": "SyncToDestination", "S3Destination": { "BucketName": "test-bucket", "BucketRegion": "us-east-2", "SyncFormat": "JsonSerDe", "BucketPrefix": "cfn", "KMSKeyArn": "kmsKeyARN" } } } } }

YAML

--- Description: Create a Resource Data Sync for Systems Manager Resources: BasicResourceDataSync: Type: AWS::SSM::ResourceDataSync Properties: SyncName: test-sync SyncType: SyncToDestination S3Destination: BucketName: test-bucket BucketRegion: us-east-2 SyncFormat: JsonSerDe BucketPrefix: cfn KMSKeyArn: kmsKeyARN

AWS Systems Manager 资源数据同步 - SyncFromSource - SingleAccountMultipleRegions

以下示例从单个 AWS 账户中的多个 AWS 区域同步 Systems Manager Explorer OpsData 和 OpsItems。

JSON

{ "Description": "Create a Resource Data Sync for Systems Manager Explorer", "Resources": { "BasicResourceDataSync": { "Type": "Dev::SSM::ResourceDataSync", "Properties": { "SyncName": "test-sync", "SyncType": "SyncFromSource", "SyncSource": { "SourceType": "SingleAccountMultiRegions", "SourceRegions": [ "us-east-1", "us-west-1", "us-west-2" ], "IncludeFutureRegions": false } } } } }

YAML

--- Description: Create a Resource Data Sync for Systems Manager Explorer Resources: BasicResourceDataSync: Type: Dev::SSM::ResourceDataSync Properties: SyncName: test-sync SyncType: SyncFromSource SyncSource: SourceType: SingleAccountMultiRegions SourceRegions: - us-east-1 - us-west-1 - us-west-2 IncludeFutureRegions: false

AWS Systems Manager 资源数据同步 - SyncFromSource - EntireOrganization

以下示例从 us-west-1 区域的 AWS Organizations 中,同步您整个组织的 Systems Manager Explorer OpsData 和 OpsItems。

JSON

{ "Description": "Create a Resource Data Sync for Systems Manager Explorer", "Resources": { "BasicResourceDataSync": { "Type": "Dev::SSM::ResourceDataSync", "Properties": { "SyncName": "test-sync", "SyncType": "SyncFromSource", "SyncSource": { "SourceType": "AwsOrganizations", "AwsOrganizationsSource": { "OrganizationSourceType": "EntireOrganization" }, "SourceRegions": [ "us-west-1" ], "IncludeFutureRegions": false } } } } }

YAML

--- Description: Create a Resource Data Sync for Systems Manager Explorer Resources: BasicResourceDataSync: Type: Dev::SSM::ResourceDataSync Properties: SyncName: test-sync SyncType: SyncFromSource SyncSource: SourceType: AwsOrganizations AwsOrganizationsSource: OrganizationSourceType: EntireOrganization SourceRegions: - us-west-1 IncludeFutureRegions: false

AWS Systems Manager 资源数据同步 - SyncFromSource - OrganizationalUnits

以下示例从 us-west-1 区域的 AWS Organizations 中,同步组织部门 12345 的 Systems Manager Explorer OpsData 和 OpsItems。

JSON

{ "Description": "Create a Resource Data Sync for Systems Manager Explorer", "Resources": { "BasicResourceDataSync": { "Type": "AWS::SSM::ResourceDataSync", "Properties": { "SyncName": "test-sync", "SyncType": "SyncFromSource", "SyncSource": { "SourceType": "AwsOrganizations", "AwsOrganizationsSource": { "OrganizationSourceType": "OrganizationalUnits", "OrganizationalUnits": [ "ou-12345" ] }, "SourceRegions": [ "us-west-1" ], "IncludeFutureRegions": false } } } } }

YAML

--- Description: Create a Resource Data Sync for Systems Manager Explorer Resources: BasicResourceDataSync: Type: AWS::SSM::ResourceDataSync Properties: SyncName: test-sync SyncType: SyncFromSource SyncSource: SourceType: AwsOrganizations AwsOrganizationsSource: OrganizationSourceType: OrganizationalUnits OrganizationalUnits: - ou-12345 SourceRegions: - us-west-1 IncludeFutureRegions: false

另请参阅