Package software.amazon.awscdk.services.s3

Interface CfnBucket.LoggingConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBucket.LoggingConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnBucket

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

Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket.

For examples and more information, see PUT Bucket logging in the Amazon S3 API Reference .

To successfully complete the AWS::S3::Bucket LoggingConfiguration request, you must have s3:PutObject and s3:PutObjectAcl in your IAM permissions.

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.*;
 Object simplePrefix;
 LoggingConfigurationProperty loggingConfigurationProperty = LoggingConfigurationProperty.builder()
         .destinationBucketName("destinationBucketName")
         .logFilePrefix("logFilePrefix")
         .targetObjectKeyFormat(TargetObjectKeyFormatProperty.builder()
                 .partitionedPrefix(PartitionedPrefixProperty.builder()
                         .partitionDateSource("partitionDateSource")
                         .build())
                 .simplePrefix(simplePrefix)
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnBucket.LoggingConfigurationProperty.Builder	builder()
default String	getDestinationBucketName()	The name of the bucket where Amazon S3 should store server access log files.
default String	getLogFilePrefix()	A prefix for all log object keys.
default Object	getTargetObjectKeyFormat()	Amazon S3 key format for log objects.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDestinationBucketName

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

The name of the bucket where Amazon S3 should store server access log files.

You can store log files in any bucket that you own. By default, logs are stored in the bucket where the LoggingConfiguration property is defined.

See Also:

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

getLogFilePrefix

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

A prefix for all log object keys.

If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.

See Also:

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

getTargetObjectKeyFormat

@Stability(Stable)
@Nullable
default Object getTargetObjectKeyFormat()

Amazon S3 key format for log objects.

Only one format, either PartitionedPrefix or SimplePrefix, is allowed.

See Also:

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

builder

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

Returns:

a CfnBucket.LoggingConfigurationProperty.Builder of CfnBucket.LoggingConfigurationProperty