Package software.amazon.awscdk.cfnpropertymixins.services.ssm

Class CfnResourceDataSyncPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.ssm.CfnResourceDataSyncPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:20:05.710Z") @Stability(Stable) public class CfnResourceDataSyncPropsMixin extends Mixin implements software.constructs.IMixin
The AWS::SSM::ResourceDataSync resource creates, updates, or deletes a resource data sync for AWS Systems Manager .

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.

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 . This type can synchronize OpsItems and OpsData from multiple AWS accounts and Regions or from an EntireOrganization by using AWS Organizations .

A resource data sync is an asynchronous operation that returns immediately. After a successful initial sync is completed, the system continuously syncs data.

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.

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

The following Syntax section shows all fields that are supported for a resource data sync. The Examples section below shows the recommended way to specify configurations for each sync type. Refer to the Examples section when you create your resource data sync.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.ssm.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnResourceDataSyncPropsMixin cfnResourceDataSyncPropsMixin = CfnResourceDataSyncPropsMixin.Builder.create(CfnResourceDataSyncMixinProps.builder()
         .bucketName("bucketName")
         .bucketPrefix("bucketPrefix")
         .bucketRegion("bucketRegion")
         .kmsKeyArn("kmsKeyArn")
         .s3Destination(S3DestinationProperty.builder()
                 .bucketName("bucketName")
                 .bucketPrefix("bucketPrefix")
                 .bucketRegion("bucketRegion")
                 .kmsKeyArn("kmsKeyArn")
                 .syncFormat("syncFormat")
                 .build())
         .syncFormat("syncFormat")
         .syncName("syncName")
         .syncSource(SyncSourceProperty.builder()
                 .awsOrganizationsSource(AwsOrganizationsSourceProperty.builder()
                         .organizationalUnits(List.of("organizationalUnits"))
                         .organizationSourceType("organizationSourceType")
                         .build())
                 .includeFutureRegions(false)
                 .sourceRegions(List.of("sourceRegions"))
                 .sourceType("sourceType")
                 .build())
         .syncType("syncType")
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnResourceDataSyncPropsMixin

      protected CfnResourceDataSyncPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnResourceDataSyncPropsMixin

      protected CfnResourceDataSyncPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnResourceDataSyncPropsMixin

      @Stability(Stable) public CfnResourceDataSyncPropsMixin(@NotNull CfnResourceDataSyncMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::SSM::ResourceDataSync.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnResourceDataSyncPropsMixin

      @Stability(Stable) public CfnResourceDataSyncPropsMixin(@NotNull CfnResourceDataSyncMixinProps props)
      Create a mixin to apply properties to AWS::SSM::ResourceDataSync.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnResourceDataSyncMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()