Menu
AWS Systems Manager
API Reference (API Version 2014-11-06)

CreateResourceDataSync

Creates a resource data sync configuration to a single bucket in Amazon S3. This is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data to the Amazon S3 bucket. To check the status of the sync, use the ListResourceDataSync.

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. To view an example of a restrictive Amazon S3 bucket policy for Resource Data Sync, see Configuring Resource Data Sync for Inventory.

Request Syntax

{ "S3Destination": { "AWSKMSKeyARN": "string", "BucketName": "string", "Prefix": "string", "Region": "string", "SyncFormat": "string" }, "SyncName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

S3Destination

Amazon S3 configuration details for the sync.

Type: ResourceDataSyncS3Destination object

Required: Yes

SyncName

A name for the configuration.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerError

An error occurred on the server side.

HTTP Status Code: 400

ResourceDataSyncAlreadyExistsException

A sync configuration with the same name already exists.

HTTP Status Code: 400

ResourceDataSyncCountExceededException

You have exceeded the allowed maximum sync configurations.

HTTP Status Code: 400

ResourceDataSyncInvalidConfigurationException

The specified sync configuration is invalid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: