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

Class S3LogsDelivery.Builder

java.lang.Object

software.amazon.awscdk.mixins.preview.services.logs.S3LogsDelivery.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<S3LogsDelivery>

Enclosing class:

S3LogsDelivery

@Stability(Experimental)
public static final class S3LogsDelivery.Builder
extends Object
implements software.amazon.jsii.Builder<S3LogsDelivery>

(experimental) A fluent builder for S3LogsDelivery.

Method Summary

Modifier and Type	Method	Description
S3LogsDelivery	build()
static S3LogsDelivery.Builder	create(IBucketRef bucket)
S3LogsDelivery.Builder	kmsKey(IKeyRef kmsKey)	(experimental) KMS key to use for encrypting logs in the S3 bucket.
S3LogsDelivery.Builder	mandatoryFields(List<String> mandatoryFields)	(experimental) Any recordFields that a mandatory to be included in a log delivery of a certain log type.
S3LogsDelivery.Builder	outputFormat(String outputFormat)	(experimental) Format of the logs that are sent to the delivery destination specified.
S3LogsDelivery.Builder	permissionsVersion(S3LogsDeliveryPermissionsVersion permissionsVersion)	(experimental) The permissions version ('V1' or 'V2') to be used for this delivery.
S3LogsDelivery.Builder	providedFields(List<String> providedFields)	(experimental) RecordFields the user has defined to be used in log delivery.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Experimental)
public static S3LogsDelivery.Builder create(IBucketRef bucket)

Parameters:

bucket - This parameter is required.

Returns:

a new instance of S3LogsDelivery.Builder.

mandatoryFields

@Stability(Experimental)
public S3LogsDelivery.Builder mandatoryFields(List<String> mandatoryFields)

(experimental) Any recordFields that a mandatory to be included in a log delivery of a certain log type.

Default: - log type has no mandatory fields

Parameters:

mandatoryFields - Any recordFields that a mandatory to be included in a log delivery of a certain log type. This parameter is required.

Returns:

this

providedFields

@Stability(Experimental)
public S3LogsDelivery.Builder providedFields(List<String> providedFields)

(experimental) RecordFields the user has defined to be used in log delivery.

Parameters:

providedFields - RecordFields the user has defined to be used in log delivery. This parameter is required.

Returns:

this

outputFormat

@Stability(Experimental)
public S3LogsDelivery.Builder outputFormat(String outputFormat)

(experimental) Format of the logs that are sent to the delivery destination specified.

Parameters:

outputFormat - Format of the logs that are sent to the delivery destination specified. This parameter is required.

Returns:

this

kmsKey

@Stability(Experimental)
public S3LogsDelivery.Builder kmsKey(IKeyRef kmsKey)

(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

Parameters:

kmsKey - KMS key to use for encrypting logs in the S3 bucket. This parameter is required.

Returns:

this

permissionsVersion

@Stability(Experimental)
public S3LogsDelivery.Builder permissionsVersion(S3LogsDeliveryPermissionsVersion permissionsVersion)

(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"

Parameters:

permissionsVersion - The permissions version ('V1' or 'V2') to be used for this delivery. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public S3LogsDelivery build()

Specified by:

build in interface software.amazon.jsii.Builder<S3LogsDelivery>

Returns:

a newly built instance of S3LogsDelivery.