class CfnResourceDataSyncPropsMixin
| Language | Type name |
|---|---|
.NET | Amazon.CDK.Mixins.Preview.AWS.SSM.Mixins.CfnResourceDataSyncPropsMixin |
Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsssm/mixins#CfnResourceDataSyncPropsMixin |
Java | software.amazon.awscdk.mixins.preview.services.ssm.mixins.CfnResourceDataSyncPropsMixin |
Python | aws_cdk.mixins_preview.aws_ssm.mixins.CfnResourceDataSyncPropsMixin |
TypeScript | @aws-cdk/mixins-preview » aws_ssm » mixins » CfnResourceDataSyncPropsMixin |
Implements
IMixin
Extends
Mixin
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.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as ssm_mixins } from '@aws-cdk/mixins-preview/aws-ssm';
const cfnResourceDataSyncPropsMixin = new ssm_mixins.CfnResourceDataSyncPropsMixin({
bucketName: 'bucketName',
bucketPrefix: 'bucketPrefix',
bucketRegion: 'bucketRegion',
kmsKeyArn: 'kmsKeyArn',
s3Destination: {
bucketName: 'bucketName',
bucketPrefix: 'bucketPrefix',
bucketRegion: 'bucketRegion',
kmsKeyArn: 'kmsKeyArn',
syncFormat: 'syncFormat',
},
syncFormat: 'syncFormat',
syncName: 'syncName',
syncSource: {
awsOrganizationsSource: {
organizationalUnits: ['organizationalUnits'],
organizationSourceType: 'organizationSourceType',
},
includeFutureRegions: false,
sourceRegions: ['sourceRegions'],
sourceType: 'sourceType',
},
syncType: 'syncType',
}, /* all optional props */ {
strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});
Initializer
new CfnResourceDataSyncPropsMixin(props: CfnResourceDataSyncMixinProps, options?: CfnPropertyMixinOptions)
Parameters
- props
Cfn— L1 properties to apply.Resource Data Sync Mixin Props - options
Cfn— Mixin options.Property Mixin Options
Create a mixin to apply properties to AWS::SSM::ResourceDataSync.
Properties
| Name | Type | Description |
|---|---|---|
| props | Cfn | |
| strategy | Property | |
| static CFN_PROPERTY_KEYS | string[] |
props
Type:
Cfn
strategy
Type:
Property
static CFN_PROPERTY_KEYS
Type:
string[]
Methods
| Name | Description |
|---|---|
| apply | Apply the mixin properties to the construct. |
| supports(construct) | Check if this mixin supports the given construct. |
applyTo(construct)
public applyTo(construct: IConstruct): IConstruct
Parameters
- construct
IConstruct
Returns
Apply the mixin properties to the construct.
supports(construct)
public supports(construct: IConstruct): boolean
Parameters
- construct
IConstruct
Returns
boolean
Check if this mixin supports the given construct.

.NET
Go
Java
Python
TypeScript