Interface S3BucketProps
- All Superinterfaces:
CommonDestinationProps,CommonDestinationS3Props,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
S3BucketProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
date="2025-11-17T14:40:54.672Z")
@Stability(Stable)
public interface S3BucketProps
extends software.amazon.jsii.JsiiSerializable, CommonDestinationS3Props, CommonDestinationProps
Props for defining an S3 destination of an Amazon Data Firehose delivery stream.
Example:
// Specify the roles created above when defining the destination and delivery stream.
Bucket bucket;
// Create service roles for the delivery stream and destination.
// These can be used for other purposes and granted access to different resources.
// They must include the Amazon Data Firehose service principal in their trust policies.
// Two separate roles are shown below, but the same role can be used for both purposes.
Role deliveryStreamRole = Role.Builder.create(this, "Delivery Stream Role")
.assumedBy(new ServicePrincipal("firehose.amazonaws.com"))
.build();
Role destinationRole = Role.Builder.create(this, "Destination Role")
.assumedBy(new ServicePrincipal("firehose.amazonaws.com"))
.build();
S3Bucket destination = S3Bucket.Builder.create(bucket).role(destinationRole).build();
DeliveryStream.Builder.create(this, "Delivery Stream")
.destination(destination)
.role(deliveryStreamRole)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forS3BucketPropsstatic final classAn implementation forS3BucketProps -
Method Summary
Modifier and TypeMethodDescriptionstatic S3BucketProps.Builderbuilder()default DataFormatConversionPropsThe input format, output format, and schema config for converting data from the JSON format to the Parquet or ORC format before writing to Amazon S3.default StringSpecify a file extension.default TimeZoneThe time zone you prefer.Methods inherited from interface software.amazon.awscdk.services.kinesisfirehose.CommonDestinationProps
getLoggingConfig, getProcessor, getProcessors, getRole, getS3BackupMethods inherited from interface software.amazon.awscdk.services.kinesisfirehose.CommonDestinationS3Props
getBufferingInterval, getBufferingSize, getCompression, getDataOutputPrefix, getEncryptionKey, getErrorOutputPrefixMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getDataFormatConversion
The input format, output format, and schema config for converting data from the JSON format to the Parquet or ORC format before writing to Amazon S3.Default: no data format conversion is done
- See Also:
-
getFileExtension
Specify a file extension.It will override the default file extension appended by Data Format Conversion or S3 compression features such as
.parquetor.gz.File extension must start with a period (
.) and can contain allowed characters:0-9a-z!-_.*'().Default: - The default file extension appended by Data Format Conversion or S3 compression features
- See Also:
-
getTimeZone
The time zone you prefer.Default: - UTC
- See Also:
-
builder
- Returns:
- a
S3BucketProps.BuilderofS3BucketProps
-