2.233.0

interface CfnResourceDataSyncMixinProps

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.SSM.Mixins.CfnResourceDataSyncMixinProps
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsssm/mixins#CfnResourceDataSyncMixinProps
Javasoftware.amazon.awscdk.mixins.preview.services.ssm.mixins.CfnResourceDataSyncMixinProps
Pythonaws_cdk.mixins_preview.aws_ssm.mixins.CfnResourceDataSyncMixinProps
TypeScript @aws-cdk/mixins-preview » aws_ssm » mixins » CfnResourceDataSyncMixinProps

Properties for CfnResourceDataSyncPropsMixin.

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 as ssm_mixins } from '@aws-cdk/mixins-preview/aws-ssm';
const cfnResourceDataSyncMixinProps: ssm_mixins.CfnResourceDataSyncMixinProps = {
  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',
};

Properties

NameTypeDescription
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 Amazon Resource Name (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.
syncName?stringA name for the resource data sync.
syncSource?IResolvable | SyncSourcePropertyInformation about the source where the data was synchronized.
syncType?stringThe type of resource data sync.

bucketName?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketname

bucketPrefix?

Type: string (optional)

An Amazon S3 prefix for the bucket.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketprefix

bucketRegion?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketregion

kmsKeyArn?

Type: string (optional)

The Amazon Resource Name (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 AWS Region as the destination Amazon S3 bucket.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-kmskeyarn

s3Destination?

Type: IResolvable | S3DestinationProperty (optional)

Configuration information for the target S3 bucket.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-s3destination

syncFormat?

Type: string (optional)

A supported sync format.

The following format is currently supported: JsonSerDe

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncformat

syncName?

Type: string (optional)

A name for the resource data sync.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncname

syncSource?

Type: IResolvable | SyncSourceProperty (optional)

Information about the source where the data was synchronized.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncsource

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-synctype

← PreviousNext →