Package software.amazon.awscdk.mixins.preview.services.logs

Interface S3LogsDeliveryProps

All Superinterfaces:

DeliveryProps, software.amazon.jsii.JsiiSerializable, RecordFieldDeliveryProps

All Known Implementing Classes:

S3LogsDeliveryProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-02T12:05:27.414Z")
@Stability(Experimental)
public interface S3LogsDeliveryProps
extends software.amazon.jsii.JsiiSerializable, DeliveryProps

(experimental) Props for S3LogsDelivery.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.mixins.preview.services.logs.*;
 import software.amazon.awscdk.interfaces.kms.*;
 IKeyRef keyRef;
 S3LogsDeliveryProps s3LogsDeliveryProps = S3LogsDeliveryProps.builder()
         .kmsKey(keyRef)
         .mandatoryFields(List.of("mandatoryFields"))
         .outputFormat("outputFormat")
         .permissionsVersion(S3LogsDeliveryPermissionsVersion.V1)
         .providedFields(List.of("providedFields"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static S3LogsDeliveryProps.Builder	builder()
default IKeyRef	getKmsKey()	(experimental) KMS key to use for encrypting logs in the S3 bucket.
default S3LogsDeliveryPermissionsVersion	getPermissionsVersion()	(experimental) The permissions version ('V1' or 'V2') to be used for this delivery.

Methods inherited from interface software.amazon.awscdk.mixins.preview.services.logs.DeliveryProps

getOutputFormat

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.mixins.preview.services.logs.RecordFieldDeliveryProps

getMandatoryFields, getProvidedFields

Method Details

getKmsKey

@Stability(Experimental)
@Nullable
default IKeyRef getKmsKey()

(experimental) KMS key to use for encrypting logs in the S3 bucket.

When provided, grants the logs delivery service permissions to use the key.

Default: - No encryption key is configured

getPermissionsVersion

@Stability(Experimental)
@Nullable
default S3LogsDeliveryPermissionsVersion getPermissionsVersion()

(experimental) The permissions version ('V1' or 'V2') to be used for this delivery.

Depending on the source of the logs, different permissions are required.

Default: "V2"

builder

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

Returns:

a S3LogsDeliveryProps.Builder of S3LogsDeliveryProps