Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » AWS Systems Manager Resource Types Reference » AWS::SSM::ResourceDataSync

AWS::SSM::ResourceDataSync

The AWS::SSM::ResourceDataSync resource creates or deletes a Resource Data Sync for 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 Resource Data Sync for Inventory 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" : {
    "KMSKeyArn" : String,
    "BucketName" : String,
    "BucketRegion" : String,
    "SyncFormat" : String,
    "SyncName" : String,
    "BucketPrefix" : String
  }
}

YAML

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

Properties

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

Update requires: Replacement

BucketName

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

Required: Yes

Type: String

Update requires: Replacement

BucketRegion

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

Required: Yes

Type: String

Update requires: Replacement

SyncFormat

The format in which Resource Data Sync output will be stored in Amazon S3. The following format is currently supported: JsonSerDe

Required: Yes

Type: String

Update requires: Replacement

SyncName

A name for the Resource Data Sync.

Required: Yes

Type: String

Update requires: Replacement

BucketPrefix

An Amazon S3 prefix for the bucket.

Required: No

Type: String

Update requires: Replacement

Return Values

Ref

When you pass the logical ID of an AWS::SSM::ResourceDataSync resource to the intrinsic Ref function, the function 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