Package software.amazon.awscdk.services.s3

Interface CfnBucket.DestinationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBucket.DestinationProperty.Jsii$Proxy

Enclosing class:

CfnBucket

@Stability(Stable)
public static interface CfnBucket.DestinationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.s3.*;
 DestinationProperty destinationProperty = DestinationProperty.builder()
         .bucketArn("bucketArn")
         .format("format")
         // the properties below are optional
         .bucketAccountId("bucketAccountId")
         .prefix("prefix")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBucket.DestinationProperty.Builder	A builder for CfnBucket.DestinationProperty
static final class	CfnBucket.DestinationProperty.Jsii$Proxy	An implementation for CfnBucket.DestinationProperty

Method Summary

Modifier and Type	Method	Description
static CfnBucket.DestinationProperty.Builder	builder()
default String	getBucketAccountId()	The account ID that owns the destination S3 bucket.
String	getBucketArn()	The Amazon Resource Name (ARN) of the bucket to which data is exported.
String	getFormat()	Specifies the file format used when exporting data to Amazon S3.
default String	getPrefix()	The prefix to use when exporting data.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucketArn

@Stability(Stable)
@NotNull
String getBucketArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-bucketarn

getFormat

@Stability(Stable)
@NotNull
String getFormat()

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

Allowed values : CSV | ORC | Parquet

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-format

getBucketAccountId

@Stability(Stable)
@Nullable
default String getBucketAccountId()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-bucketaccountid

getPrefix

@Stability(Stable)
@Nullable
default String getPrefix()

The prefix to use when exporting data.

The prefix is prepended to all results.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-destination.html#cfn-s3-bucket-destination-prefix

builder

@Stability(Stable)
static CfnBucket.DestinationProperty.Builder builder()

Returns:

a CfnBucket.DestinationProperty.Builder of CfnBucket.DestinationProperty