Package software.amazon.awscdk.services.pipes.alpha

Interface S3LogDestinationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

S3LogDestinationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-17T21:37:41.773Z")
@Stability(Experimental)
public interface S3LogDestinationProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties for S3LogDestination.

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.pipes.alpha.*;
 import software.amazon.awscdk.services.s3.*;
 Bucket bucket;
 S3LogDestinationProps s3LogDestinationProps = S3LogDestinationProps.builder()
         .bucket(bucket)
         // the properties below are optional
         .bucketOwner("bucketOwner")
         .outputFormat(S3OutputFormat.PLAIN)
         .prefix("prefix")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static S3LogDestinationProps.Builder	builder()
IBucket	getBucket()	(experimental) The S3 bucket to deliver the log records for the pipe.
default String	getBucketOwner()	(experimental) The AWS Account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
default S3OutputFormat	getOutputFormat()	(experimental) The format for the log records.
default String	getPrefix()	(experimental) The prefix text with which to begin Amazon S3 log object names.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucket

@Stability(Experimental)
@NotNull
IBucket getBucket()

(experimental) The S3 bucket to deliver the log records for the pipe.

The bucket can be in the same or a different AWS Account. If the bucket is in a different acccount, specify bucketOwner. You must also allow access to the Pipes role in the bucket policy of the cross-account bucket.

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-s3logdestination.html#cfn-pipes-pipe-s3logdestination-bucketname

getBucketOwner

@Stability(Experimental)
@Nullable
default String getBucketOwner()

(experimental) The AWS Account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

Default: - account ID derived from `bucket`

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-s3logdestination.html#cfn-pipes-pipe-s3logdestination-bucketowner

getOutputFormat

@Stability(Experimental)
@Nullable
default S3OutputFormat getOutputFormat()

(experimental) The format for the log records.

Default: `S3OutputFormat.JSON`

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-s3logdestination.html#cfn-pipes-pipe-s3logdestination-outputformat

getPrefix

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

(experimental) The prefix text with which to begin Amazon S3 log object names.

Default: - no prefix

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-s3logdestination.html#cfn-pipes-pipe-s3logdestination-prefix

builder

@Stability(Experimental)
static S3LogDestinationProps.Builder builder()

Returns:

a S3LogDestinationProps.Builder of S3LogDestinationProps