Package software.amazon.awscdk.services.s3

Class TargetObjectKeyFormat

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.s3.TargetObjectKeyFormat

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:47.798Z")
@Stability(Stable)
public abstract class TargetObjectKeyFormat
extends software.amazon.jsii.JsiiObject

The key format for the log object.

Example:

 Bucket accessLogsBucket = new Bucket(this, "AccessLogsBucket");
 Bucket bucket = Bucket.Builder.create(this, "MyBucket")
         .serverAccessLogsBucket(accessLogsBucket)
         .serverAccessLogsPrefix("logs")
         // You can use a simple prefix with `TargetObjectKeyFormat.simplePrefix()`, but it is the same even if you do not specify `targetObjectKeyFormat` property.
         .targetObjectKeyFormat(TargetObjectKeyFormat.simplePrefix())
         .build();
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TargetObjectKeyFormat()
protected	TargetObjectKeyFormat(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	TargetObjectKeyFormat(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
static TargetObjectKeyFormat	partitionedPrefix()	Use partitioned prefix for log objects.
static TargetObjectKeyFormat	partitionedPrefix(PartitionDateSource dateSource)	Use partitioned prefix for log objects.
static TargetObjectKeyFormat	simplePrefix()	Use the simple prefix for log objects.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

TargetObjectKeyFormat

protected TargetObjectKeyFormat(software.amazon.jsii.JsiiObjectRef objRef)

TargetObjectKeyFormat

protected TargetObjectKeyFormat(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

TargetObjectKeyFormat

@Stability(Stable)
protected TargetObjectKeyFormat()

Method Details

partitionedPrefix

@Stability(Stable)
@NotNull
public static TargetObjectKeyFormat partitionedPrefix(@Nullable
 PartitionDateSource dateSource)

Use partitioned prefix for log objects. If you do not specify the dateSource argument, the default is EventTime.

The partitioned prefix format as follow: [DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]

Parameters:

dateSource -

partitionedPrefix

@Stability(Stable)
@NotNull
public static TargetObjectKeyFormat partitionedPrefix()

Use partitioned prefix for log objects. If you do not specify the dateSource argument, the default is EventTime.

The partitioned prefix format as follow: [DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]

simplePrefix

@Stability(Stable)
@NotNull
public static TargetObjectKeyFormat simplePrefix()

Use the simple prefix for log objects.

The simple prefix format as follow: [DestinationPrefix][YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]