[ aws . ssm ]

create-resource-data-sync

Description

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 S3 bucket. For more information, see Configuring Resource Data Sync for Inventory in the AWS Systems Manager User Guide .

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 to a single S3 bucket. This type can synchronize OpsItems and OpsData from multiple AWS accounts and Regions or EntireOrganization by using AWS Organizations. For more information, see Setting up Systems Manager Explorer to display data from multiple accounts and Regions in the AWS Systems Manager User Guide .

A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data. To check the status of a sync, use the ListResourceDataSync .

Note

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-resource-data-sync
--sync-name <value>
[--s3-destination <value>]
[--sync-type <value>]
[--sync-source <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--sync-name (string)

A name for the configuration.

--s3-destination (structure)

Amazon S3 configuration details for the sync. This parameter is required if the SyncType value is SyncToDestination.

BucketName -> (string)

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

Prefix -> (string)

An Amazon S3 prefix for the bucket.

SyncFormat -> (string)

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

Region -> (string)

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

AWSKMSKeyARN -> (string)

The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination S3 bucket.

DestinationDataSharing -> (structure)

Enables destination data sharing. By default, this field is null .

DestinationDataSharingType -> (string)

The sharing data type. Only Organization is supported.

Shorthand Syntax:

BucketName=string,Prefix=string,SyncFormat=string,Region=string,AWSKMSKeyARN=string,DestinationDataSharing={DestinationDataSharingType=string}

JSON Syntax:

{
  "BucketName": "string",
  "Prefix": "string",
  "SyncFormat": "JsonSerDe",
  "Region": "string",
  "AWSKMSKeyARN": "string",
  "DestinationDataSharing": {
    "DestinationDataSharingType": "string"
  }
}

--sync-type (string)

Specify SyncToDestination to create a resource data sync that synchronizes data to an S3 bucket for Inventory. If you specify SyncToDestination , you must provide a value for S3Destination . Specify SyncFromSource to synchronize data from a single account and multiple Regions, or multiple AWS accounts and Regions, as listed in AWS Organizations for Explorer. If you specify SyncFromSource , you must provide a value for SyncSource . The default value is SyncToDestination .

--sync-source (structure)

Specify information about the data sources to synchronize. This parameter is required if the SyncType value is SyncFromSource.

SourceType -> (string)

The type of data source for the resource data sync. SourceType is either AwsOrganizations (if an organization is present in AWS Organizations) or singleAccountMultiRegions .

AwsOrganizationsSource -> (structure)

Information about the AwsOrganizationsSource resource data sync source. A sync source of this type can synchronize data from AWS Organizations.

OrganizationSourceType -> (string)

If an AWS Organization is present, this is either OrganizationalUnits or EntireOrganization . For OrganizationalUnits , the data is aggregated from a set of organization units. For EntireOrganization , the data is aggregated from the entire AWS Organization.

OrganizationalUnits -> (list)

The AWS Organizations organization units included in the sync.

(structure)

The AWS Organizations organizational unit data source for the sync.

OrganizationalUnitId -> (string)

The AWS Organization unit ID data source for the sync.

SourceRegions -> (list)

The SyncSource AWS Regions included in the resource data sync.

(string)

IncludeFutureRegions -> (boolean)

Whether to automatically synchronize and aggregate data from new AWS Regions when those Regions come online.

JSON Syntax:

{
  "SourceType": "string",
  "AwsOrganizationsSource": {
    "OrganizationSourceType": "string",
    "OrganizationalUnits": [
      {
        "OrganizationalUnitId": "string"
      }
      ...
    ]
  },
  "SourceRegions": ["string", ...],
  "IncludeFutureRegions": true|false
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To create a resource data sync

This example creates a resource data sync. There is no output if the command succeeds.

Command:

aws ssm create-resource-data-sync --sync-name "ssm-resource-data-sync" --s3-destination "BucketName=ssm-bucket,Prefix=inventory,SyncFormat=JsonSerDe,Region=us-east-1"

Output

None