AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Systems Manager CreateResourceDataSync API operation.

Syntax

New-SSMResourceDataSync
-SyncName <String>
-S3Destination_AWSKMSKeyARN <String>
-S3Destination_BucketName <String>
-SyncSource_IncludeFutureRegion <Boolean>
-AwsOrganizationsSource_OrganizationalUnit <ResourceDataSyncOrganizationalUnit[]>
-AwsOrganizationsSource_OrganizationSourceType <String>
-S3Destination_Prefix <String>
-S3Destination_Region <String>
-SyncSource_SourceRegion <String[]>
-SyncSource_SourceType <String>
-S3Destination_SyncFormat <ResourceDataSyncS3Format>
-SyncType <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

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 Amazon 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 SyncToDestination type to synchronize operational work items (OpsItems) and operational data (OpsData) from multiple AWS Regions to a single Amazon S3 bucket. You can also configure Explorer to use the SyncFromSource type. This type synchronizes OpsItems and OpsData from multiple AWS accounts and Regions by using AWS Organizations. For more information, see Setting Up 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. 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.

Parameters

-AwsOrganizationsSource_OrganizationalUnit <ResourceDataSyncOrganizationalUnit[]>
The AWS Organizations organization units included in the sync.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSyncSource_AwsOrganizationsSource_OrganizationalUnits
-AwsOrganizationsSource_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSyncSource_AwsOrganizationsSource_OrganizationSourceType
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the SyncName parameter. The -PassThru parameter is deprecated, use -Select '^SyncName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3Destination_AWSKMSKeyARN <String>
The ARN of an encryption key for a destination in Amazon S3. Must belong to the same Region as the destination Amazon S3 bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3Destination_BucketName <String>
The name of the Amazon S3 bucket where the aggregated data is stored.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3Destination_Prefix <String>
An Amazon S3 prefix for the bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3Destination_Region <String>
The AWS Region with the Amazon S3 bucket targeted by the Resource Data Sync.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3Destination_SyncFormat <ResourceDataSyncS3Format>
A supported sync format. The following format is currently supported: JsonSerDe
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SimpleSystemsManagement.Model.CreateResourceDataSyncResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SyncName <String>
A name for the configuration.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-SyncSource_IncludeFutureRegion <Boolean>
Whether to automatically synchronize and aggregate data from new AWS Regions when those Regions come online.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSyncSource_IncludeFutureRegions
-SyncSource_SourceRegion <String[]>
The SyncSource AWS Regions included in the resource data sync.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSyncSource_SourceRegions
-SyncSource_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SyncType <String>
Specify SyncToDestination to create a resource data sync that synchronizes data from multiple AWS Regions to an Amazon S3 bucket. Specify SyncFromSource to synchronize data from multiple AWS accounts and Regions, as listed in AWS Organizations.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases AK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases AWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases AWSProfileName, StoredCredentials
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases SecretAccessKey, SK
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases ST
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)
Aliases RegionToCall
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? True (ByPropertyName)

Inputs

You can pipe a String object to this cmdlet for the SyncName parameter.

Outputs

This cmdlet does not generate any output.The service response (type Amazon.SimpleSystemsManagement.Model.CreateResourceDataSyncResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z