AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::SSM::ResourceDataSync

CfnResourceDataSync

The `AWS::SSM::ResourceDataSync` resource creates, updates, or deletes a resource data sync for AWS Systems Manager . A resource data sync helps you view data from multiple sources in a single location. Systems Manager offers two types of resource data sync: `SyncToDestination` and `SyncFromSource` . You can configure Systems Manager Inventory to use the `SyncToDestination` type to synchronize Inventory data from multiple AWS Regions to a single Amazon S3 bucket. You can configure Systems Manager Explorer to use the `SyncFromSource` type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple AWS Regions . This type can synchronize OpsItems and OpsData from multiple AWS accounts and Regions or from an `EntireOrganization` by using AWS Organizations . A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. By default, data is not encrypted in Amazon S3 . We strongly recommend that you enable encryption in Amazon S3 to ensure secure data storage. We also recommend that you secure access to the Amazon S3 bucket by creating a restrictive bucket policy. For more information, see [Configuring Inventory Collection](https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-inventory-configuring.html#sysman-inventory-datasync) and [Setting Up Systems Manager Explorer to Display Data from Multiple Accounts and Regions](https://docs.aws.amazon.com/systems-manager/latest/userguide/Explorer-resource-data-sync.html) in the *AWS Systems Manager User Guide* . > The following *Syntax* section shows all fields that are supported for a resource data sync. The *Examples* section below shows the recommended way to specify configurations for each sync type. Refer to the *Examples* section when you create your resource data sync.

Import

import { CfnResourceDataSync } from 'aws-cdk-lib/aws-ssm';

Or use the module namespace:

import * as ssm from 'aws-cdk-lib/aws-ssm';
// ssm.CfnResourceDataSync

Properties

Configuration passed to the constructor as CfnResourceDataSyncProps.

syncNameRequired
string

A name for the resource data sync.

bucketNameOptional
string | IBucketRef

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

bucketPrefixOptional
string

An Amazon S3 prefix for the bucket.

bucketRegionOptional
string

The AWS Region with the S3 bucket targeted by the resource data sync.

kmsKeyArnOptional
string

The Amazon Resource Name (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 AWS Region as the destination Amazon S3 bucket.

s3DestinationOptional
IResolvable | S3DestinationProperty

Configuration information for the target S3 bucket.

syncFormatOptional
string

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

syncSourceOptional
IResolvable | SyncSourceProperty

Information about the source where the data was synchronized.

syncTypeOptional
string

The type of resource data sync. If `SyncType` is `SyncToDestination` , then the resource data sync synchronizes data to an S3 bucket. If the `SyncType` is `SyncFromSource` then the resource data sync synchronizes data from AWS Organizations or from multiple AWS Regions .

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter