aws-cdk-lib.aws_ssm.CfnResourceDataSync.S3DestinationProperty

interface S3DestinationProperty

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

Information about the target S3 bucket for the resource data sync.

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 s3DestinationProperty: ssm.CfnResourceDataSync.S3DestinationProperty = {
  bucketName: 'bucketName',
  bucketRegion: 'bucketRegion',
  syncFormat: 'syncFormat',

  // the properties below are optional
  bucketPrefix: 'bucketPrefix',
  kmsKeyArn: 'kmsKeyArn',
};

Properties

NameTypeDescription
bucketNamestringThe name of the S3 bucket where the aggregated data is stored.
bucketRegionstringThe AWS Region with the S3 bucket targeted by the resource data sync.
syncFormatstringA supported sync format.
bucketPrefix?stringAn Amazon S3 prefix for the bucket.
kmsKeyArn?stringThe ARN of an encryption key for a destination in Amazon S3.

bucketName

Type: string

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


bucketRegion

Type: string

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


syncFormat

Type: string

A supported sync format.

The following format is currently supported: JsonSerDe


bucketPrefix?

Type: string (optional)

An Amazon S3 prefix for the bucket.


kmsKeyArn?

Type: string (optional)

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

Must belong to the same Region as the destination S3 bucket.