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 haves3:PutObject
ands3: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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnBucket.LoggingConfigurationProperty
static final class
An implementation forCfnBucket.LoggingConfigurationProperty
-
Method Summary
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
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:
-
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:
-
getTargetObjectKeyFormat
Amazon S3 key format for log objects.Only one format, either PartitionedPrefix or SimplePrefix, is allowed.
- See Also:
-
builder
-