Package software.amazon.awscdk.services.logs

Interface ParseToOCSFProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ParseToOCSFProperty.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-07-24T11:33:17.325Z")
@Stability(Stable)
public interface ParseToOCSFProperty
extends software.amazon.jsii.JsiiSerializable

Processor to parse events from CloudTrail, Route53Resolver, VPCFlow, EKSAudit and AWSWAF into OCSF V1.1 format.

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.logs.*;
 ParseToOCSFProperty parseToOCSFProperty = ParseToOCSFProperty.builder()
         .eventSource(OCSFSourceType.CLOUD_TRAIL)
         .ocsfVersion(OCSFVersion.V1_1)
         // the properties below are optional
         .source("source")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ParseToOCSFProperty.Builder	builder()
OCSFSourceType	getEventSource()	Type of input log event source to convert to OCSF format.
OCSFVersion	getOcsfVersion()	Version of OCSF schema to convert to.
default String	getSource()	Path to the field in the log event that will be parsed.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEventSource

@Stability(Stable)
@NotNull
OCSFSourceType getEventSource()

Type of input log event source to convert to OCSF format.

getOcsfVersion

@Stability(Stable)
@NotNull
OCSFVersion getOcsfVersion()

Version of OCSF schema to convert to.

getSource

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

Path to the field in the log event that will be parsed.

Use dot notation to access child fields.

Default: '@message'

builder

@Stability(Stable)
static ParseToOCSFProperty.Builder builder()

Returns:

a ParseToOCSFProperty.Builder of ParseToOCSFProperty