Package software.amazon.awscdk.cfnpropertymixins.services.logs

Interface CfnTransformerPropsMixin.ParseToOCSFProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTransformerPropsMixin.ParseToOCSFProperty.Jsii$Proxy

Enclosing class:

CfnTransformerPropsMixin

@Stability(Stable)
public static interface CfnTransformerPropsMixin.ParseToOCSFProperty
extends software.amazon.jsii.JsiiSerializable

This processor converts logs into Open Cybersecurity Schema Framework (OCSF) events.

For more information about this processor including examples, see parseToOCSF in the CloudWatch Logs User Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.logs.*;
 ParseToOCSFProperty parseToOCSFProperty = ParseToOCSFProperty.builder()
         .eventSource("eventSource")
         .mappingVersion("mappingVersion")
         .ocsfVersion("ocsfVersion")
         .source("source")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-parsetoocsf.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTransformerPropsMixin.ParseToOCSFProperty.Builder	builder()
default String	getEventSource()	Specify the service or process that produces the log events that will be converted with this processor.
default String	getMappingVersion()	The version of the OCSF mapping to use for parsing log data.
default String	getOcsfVersion()	Specify which version of the OCSF schema to use for the transformed log events.
default String	getSource()	The path to the field in the log event that you want to parse.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEventSource

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

Specify the service or process that produces the log events that will be converted with this processor.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-parsetoocsf.html#cfn-logs-transformer-parsetoocsf-eventsource

getMappingVersion

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

The version of the OCSF mapping to use for parsing log data.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-parsetoocsf.html#cfn-logs-transformer-parsetoocsf-mappingversion

getOcsfVersion

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

Specify which version of the OCSF schema to use for the transformed log events.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-parsetoocsf.html#cfn-logs-transformer-parsetoocsf-ocsfversion

getSource

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

The path to the field in the log event that you want to parse.

If you omit this value, the whole log message is parsed.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-transformer-parsetoocsf.html#cfn-logs-transformer-parsetoocsf-source

builder

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

Returns:

a CfnTransformerPropsMixin.ParseToOCSFProperty.Builder of CfnTransformerPropsMixin.ParseToOCSFProperty