[ aws . ssm ]

update-resource-data-sync

Description

Update a resource data sync. After you create a resource data sync for a Region, you can’t change the account options for that sync. For example, if you create a sync in the us-east-2 (Ohio) Region and you choose the Include only the current account option, you can’t edit that sync later and choose the Include all accounts from my AWS Organizations configuration option. Instead, you must delete the first resource data sync, and create a new one.

Note

This API action only supports a resource data sync that was created with a SyncFromSource SyncType .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-resource-data-sync
--sync-name <value>
--sync-type <value>
--sync-source <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--sync-name (string)

The name of the resource data sync you want to update.

--sync-type (string)

The type of resource data sync. The supported SyncType is SyncFromSource.

--sync-source (structure)

Specify information about the data sources to synchronize.

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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To update a resource data sync

The following update-resource-data-sync example updates a SyncFromSource resource data sync.

aws ssm update-resource-data-sync \
    --sync-name exampleSync \
    --sync-type SyncFromSource \
    --sync-source '{"SourceType":"SingleAccountMultiRegions", "SourceRegions":["us-east-1", "us-west-2"]}'

This command produces no output.

For more information, see Setting Up Systems Manager Explorer to Display Data from Multiple Accounts and Regions in the AWS Systems Manager User Guide.

Output

None