Package software.amazon.awscdk.services.pipes

Interface CfnPipe.S3LogDestinationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipe.S3LogDestinationProperty.Jsii$Proxy

Enclosing class:

CfnPipe

@Stability(Stable)
public static interface CfnPipe.S3LogDestinationProperty
extends software.amazon.jsii.JsiiSerializable

Represents the Amazon S3 logging configuration settings for the pipe.

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.*;
 S3LogDestinationProperty s3LogDestinationProperty = S3LogDestinationProperty.builder()
         .bucketName("bucketName")
         .bucketOwner("bucketOwner")
         .outputFormat("outputFormat")
         .prefix("prefix")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-s3logdestination.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPipe.S3LogDestinationProperty.Builder	builder()
default String	getBucketName()	The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
default String	getBucketOwner()	The AWS account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
default String	getOutputFormat()	The format EventBridge uses for the log records.
default String	getPrefix()	The prefix text with which to begin Amazon S3 log object names.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucketName

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

The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

See Also:

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

getBucketOwner

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

The AWS account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.

See Also:

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

getOutputFormat

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

The format EventBridge uses for the log records.

• json : JSON
• plain : Plain text
• w3c : W3C extended logging file format

See Also:

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

getPrefix

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

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

For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide .

See Also:

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

builder

@Stability(Stable)
static CfnPipe.S3LogDestinationProperty.Builder builder()

Returns:

a CfnPipe.S3LogDestinationProperty.Builder of CfnPipe.S3LogDestinationProperty