interface ParseToOCSFProperty

Language	Type name
.NET	Amazon.CDK.AWS.Logs.CfnTransformer.ParseToOCSFProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awslogs#CfnTransformer_ParseToOCSFProperty
Java	software.amazon.awscdk.services.logs.CfnTransformer.ParseToOCSFProperty
Python	aws_cdk.aws_logs.CfnTransformer.ParseToOCSFProperty
TypeScript	aws-cdk-lib » aws_logs » CfnTransformer » ParseToOCSFProperty

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 .

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_logs as logs } from 'aws-cdk-lib';
const parseToOCSFProperty: logs.CfnTransformer.ParseToOCSFProperty = {
  eventSource: 'eventSource',
  ocsfVersion: 'ocsfVersion',

  // the properties below are optional
  mappingVersion: 'mappingVersion',
  source: 'source',
};

Properties

Name	Type	Description
eventSource	string	Specify the service or process that produces the log events that will be converted with this processor.
ocsfVersion	string	Specify which version of the OCSF schema to use for the transformed log events.
mappingVersion?	string
source?	string	The path to the field in the log event that you want to parse.

---

eventSource

Type: string

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

---

ocsfVersion

Type: string

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

---

mappingVersion?

Type: string (optional)

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

---

source?

Type: string (optional)

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