aws-cdk-lib.aws_ssm.CfnResourceDataSyncProps

interface CfnResourceDataSyncProps

LanguageType name
.NETAmazon.CDK.AWS.SSM.CfnResourceDataSyncProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsssm#CfnResourceDataSyncProps
Javasoftware.amazon.awscdk.services.ssm.CfnResourceDataSyncProps
Pythonaws_cdk.aws_ssm.CfnResourceDataSyncProps
TypeScript aws-cdk-lib » aws_ssm » CfnResourceDataSyncProps

Properties for defining a CfnResourceDataSync.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ssm as ssm } from 'aws-cdk-lib';
const cfnResourceDataSyncProps: ssm.CfnResourceDataSyncProps = {
  syncName: 'syncName',

  // the properties below are optional
  bucketName: 'bucketName',
  bucketPrefix: 'bucketPrefix',
  bucketRegion: 'bucketRegion',
  kmsKeyArn: 'kmsKeyArn',
  s3Destination: {
    bucketName: 'bucketName',
    bucketRegion: 'bucketRegion',
    syncFormat: 'syncFormat',

    // the properties below are optional
    bucketPrefix: 'bucketPrefix',
    kmsKeyArn: 'kmsKeyArn',
  },
  syncFormat: 'syncFormat',
  syncSource: {
    sourceRegions: ['sourceRegions'],
    sourceType: 'sourceType',

    // the properties below are optional
    awsOrganizationsSource: {
      organizationSourceType: 'organizationSourceType',

      // the properties below are optional
      organizationalUnits: ['organizationalUnits'],
    },
    includeFutureRegions: false,
  },
  syncType: 'syncType',
};

Properties

NameTypeDescription
syncNamestringA name for the resource data sync.
bucketName?stringThe name of the S3 bucket where the aggregated data is stored.
bucketPrefix?stringAn Amazon S3 prefix for the bucket.
bucketRegion?stringThe AWS Region with the S3 bucket targeted by the resource data sync.
kmsKeyArn?stringThe ARN of an encryption key for a destination in Amazon S3 .
s3Destination?IResolvable | S3DestinationPropertyConfiguration information for the target S3 bucket.
syncFormat?stringA supported sync format.
syncSource?IResolvable | SyncSourcePropertyInformation about the source where the data was synchronized.
syncType?stringThe type of resource data sync.

syncName

Type: string

A name for the resource data sync.


bucketName?

Type: string (optional)

The name of the S3 bucket where the aggregated data is stored.


bucketPrefix?

Type: string (optional)

An Amazon S3 prefix for the bucket.


bucketRegion?

Type: string (optional)

The AWS Region with the S3 bucket targeted by the resource data sync.


kmsKeyArn?

Type: string (optional)

The ARN of an encryption key for a destination in Amazon S3 .

You can use a KMS key to encrypt inventory data in Amazon S3 . You must specify a key that exist in the same region as the destination Amazon S3 bucket.


s3Destination?

Type: IResolvable | S3DestinationProperty (optional)

Configuration information for the target S3 bucket.


syncFormat?

Type: string (optional)

A supported sync format.

The following format is currently supported: JsonSerDe


syncSource?

Type: IResolvable | SyncSourceProperty (optional)

Information about the source where the data was synchronized.


syncType?

Type: string (optional)

The type of resource data sync.

If SyncType is SyncToDestination , then the resource data sync synchronizes data to an S3 bucket. If the SyncType is SyncFromSource then the resource data sync synchronizes data from AWS Organizations or from multiple AWS Regions .