createResourceDataSync method
- required String syncName,
- ResourceDataSyncS3Destination? s3Destination,
- ResourceDataSyncSource? syncSource,
- String? syncType,
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.
May throw InternalServerError. May throw ResourceDataSyncCountExceededException. May throw ResourceDataSyncAlreadyExistsException. May throw ResourceDataSyncInvalidConfigurationException.
Parameter syncName
:
A name for the configuration.
Parameter s3Destination
:
Amazon S3 configuration details for the sync. This parameter is required
if the SyncType
value is SyncToDestination.
Parameter syncSource
:
Specify information about the data sources to synchronize. This parameter
is required if the SyncType
value is SyncFromSource.
Parameter syncType
:
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
.
Implementation
Future<void> createResourceDataSync({
required String syncName,
ResourceDataSyncS3Destination? s3Destination,
ResourceDataSyncSource? syncSource,
String? syncType,
}) async {
ArgumentError.checkNotNull(syncName, 'syncName');
_s.validateStringLength(
'syncName',
syncName,
1,
64,
isRequired: true,
);
_s.validateStringLength(
'syncType',
syncType,
1,
64,
);
final headers = <String, String>{
'Content-Type': 'application/x-amz-json-1.1',
'X-Amz-Target': 'AmazonSSM.CreateResourceDataSync'
};
await _protocol.send(
method: 'POST',
requestUri: '/',
exceptionFnMap: _exceptionFns,
// TODO queryParams
headers: headers,
payload: {
'SyncName': syncName,
if (s3Destination != null) 'S3Destination': s3Destination,
if (syncSource != null) 'SyncSource': syncSource,
if (syncType != null) 'SyncType': syncType,
},
);
}