AWS CloudFormation
User Guide (Version )

AWS::SSM::ResourceDataSync

The AWS::SSM::ResourceDataSync resource creates or deletes a Resource Data Sync for AWS Systems Manager Inventory. You can use Resource Data Sync to send Inventory data collected from all of your Systems Manager managed instances to a single Amazon S3 bucket that you have already created in your account. Resource Data Sync then automatically updates the centralized data when new Inventory data is collected.

For more information, see Configuring Inventory Collection in the AWS Systems Manager User Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

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

YAML

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

Properties

BucketName

The name of the Amazon S3 bucket where the aggregated data is stored.

Required: Yes

Type: String

Minimum: 1

Maximum: 2048

Update requires: Replacement

BucketPrefix

An Amazon S3 prefix for the bucket.

Required: No

Type: String

Minimum: 1

Maximum: 256

Update requires: Replacement

BucketRegion

The AWS Region with the Amazon S3 bucket targeted by the Resource Data Sync.

Required: Yes

Type: String

Minimum: 1

Maximum: 64

Update requires: Replacement

KMSKeyArn

The ARN of an encryption key for a destination in Amazon S3. You can use a KMS key to encrypt inventory data in Amazon S3. You must specify a key that exist in the same region as the destination Amazon S3 bucket.

Required: No

Type: String

Minimum: 1

Maximum: 512

Pattern: arn:.*

Update requires: Replacement

SyncFormat

A supported sync format. The following format is currently supported: JsonSerDe

Required: Yes

Type: String

Allowed Values: JsonSerDe

Update requires: Replacement

SyncName

A name for the Resource Data Sync.

Required: Yes

Type: String

Minimum: 1

Maximum: 64

Update requires: Replacement

Return Values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the name of the Resource Data Sync, such as TestResourceDataSync.

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

Examples

AWS Systems Manager Resource Data Sync

The following examples send Inventory data collected from all of your managed instances in the US East (Ohio) Region (us-east-2) to a single Amazon S3 bucket. Resource Data Sync then automatically updates the centralized data when new Inventory data is collected.

JSON

{ "Description": "Create a Resource Data Sync for Systems Manager Inventory", "Resources": { "BasicResourceDataSync": { "Type": "AWS::SSM::ResourceDataSync", "Properties": { "SyncName": "My-USEAST2-Resource-Data-Sync", "BucketName": "my-us-east-2-rds-bucket", "BucketRegion": "us-east-2", "SyncFormat": "JsonSerDe", "BucketPrefix": "rds" } } } }

YAML

--- Description: "Create a Resource Data Sync for Systems Manager Inventory" Resources: BasicResourceDataSync: Type: "AWS::SSM::ResourceDataSync" Properties: SyncName: "My-USEAST2-Resource-Data-Sync" BucketName: "my-us-east-2-rds-bucket" BucketRegion: "us-east-2" SyncFormat: "JsonSerDe" BucketPrefix: "rds"

See Also