interface DestinationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.S3.CfnBucket.DestinationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awss3#CfnBucket_DestinationProperty`
Java	`software.amazon.awscdk.services.s3.CfnBucket.DestinationProperty`
Python	`aws_cdk.aws_s3.CfnBucket.DestinationProperty`
TypeScript	`aws-cdk-lib` » `aws_s3` » `CfnBucket` » `DestinationProperty`

Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_s3 as s3 } from 'aws-cdk-lib';
const destinationProperty: s3.CfnBucket.DestinationProperty = {
  bucketArn: 'bucketArn',
  format: 'format',

  // the properties below are optional
  bucketAccountId: 'bucketAccountId',
  prefix: 'prefix',
};

Properties

Name	Type	Description
bucketArn	`string`	The Amazon Resource Name (ARN) of the bucket to which data is exported.
format	`string`	Specifies the file format used when exporting data to Amazon S3.
bucketAccountId?	`string`	The account ID that owns the destination S3 bucket.
prefix?	`string`	The prefix to use when exporting data.

bucketArn

Type: string

The Amazon Resource Name (ARN) of the bucket to which data is exported.

format

Type: string

Specifies the file format used when exporting data to Amazon S3.

Allowed values : CSV | ORC | Parquet

bucketAccountId?

Type: string (optional)

The account ID that owns the destination S3 bucket.

If no account ID is provided, the owner is not validated before exporting data.

Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.

prefix?

Type: string (optional)

The prefix to use when exporting data.

The prefix is prepended to all results.