Package software.amazon.awscdk.services.logs

Interface CfnTransformer.ProcessorProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTransformer.ProcessorProperty.Jsii$Proxy

Enclosing class:

CfnTransformer

@Stability(Stable)
public static interface CfnTransformer.ProcessorProperty
extends software.amazon.jsii.JsiiSerializable

This structure contains the information about one processor in a log transformer.

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.*;
 ProcessorProperty processorProperty = ProcessorProperty.builder()
         .addKeys(AddKeysProperty.builder()
                 .entries(List.of(AddKeyEntryProperty.builder()
                         .key("key")
                         .value("value")
                         // the properties below are optional
                         .overwriteIfExists(false)
                         .build()))
                 .build())
         .copyValue(CopyValueProperty.builder()
                 .entries(List.of(CopyValueEntryProperty.builder()
                         .source("source")
                         .target("target")
                         // the properties below are optional
                         .overwriteIfExists(false)
                         .build()))
                 .build())
         .csv(CsvProperty.builder()
                 .columns(List.of("columns"))
                 .delimiter("delimiter")
                 .quoteCharacter("quoteCharacter")
                 .source("source")
                 .build())
         .dateTimeConverter(DateTimeConverterProperty.builder()
                 .matchPatterns(List.of("matchPatterns"))
                 .source("source")
                 .target("target")
                 // the properties below are optional
                 .locale("locale")
                 .sourceTimezone("sourceTimezone")
                 .targetFormat("targetFormat")
                 .targetTimezone("targetTimezone")
                 .build())
         .deleteKeys(DeleteKeysProperty.builder()
                 .withKeys(List.of("withKeys"))
                 .build())
         .grok(GrokProperty.builder()
                 .match("match")
                 // the properties below are optional
                 .source("source")
                 .build())
         .listToMap(ListToMapProperty.builder()
                 .key("key")
                 .source("source")
                 // the properties below are optional
                 .flatten(false)
                 .flattenedElement("flattenedElement")
                 .target("target")
                 .valueKey("valueKey")
                 .build())
         .lowerCaseString(LowerCaseStringProperty.builder()
                 .withKeys(List.of("withKeys"))
                 .build())
         .moveKeys(MoveKeysProperty.builder()
                 .entries(List.of(MoveKeyEntryProperty.builder()
                         .source("source")
                         .target("target")
                         // the properties below are optional
                         .overwriteIfExists(false)
                         .build()))
                 .build())
         .parseCloudfront(ParseCloudfrontProperty.builder()
                 .source("source")
                 .build())
         .parseJson(ParseJSONProperty.builder()
                 .destination("destination")
                 .source("source")
                 .build())
         .parseKeyValue(ParseKeyValueProperty.builder()
                 .destination("destination")
                 .fieldDelimiter("fieldDelimiter")
                 .keyPrefix("keyPrefix")
                 .keyValueDelimiter("keyValueDelimiter")
                 .nonMatchValue("nonMatchValue")
                 .overwriteIfExists(false)
                 .source("source")
                 .build())
         .parsePostgres(ParsePostgresProperty.builder()
                 .source("source")
                 .build())
         .parseRoute53(ParseRoute53Property.builder()
                 .source("source")
                 .build())
         .parseToOcsf(ParseToOCSFProperty.builder()
                 .eventSource("eventSource")
                 .ocsfVersion("ocsfVersion")
                 // the properties below are optional
                 .source("source")
                 .build())
         .parseVpc(ParseVPCProperty.builder()
                 .source("source")
                 .build())
         .parseWaf(ParseWAFProperty.builder()
                 .source("source")
                 .build())
         .renameKeys(RenameKeysProperty.builder()
                 .entries(List.of(RenameKeyEntryProperty.builder()
                         .key("key")
                         .renameTo("renameTo")
                         // the properties below are optional
                         .overwriteIfExists(false)
                         .build()))
                 .build())
         .splitString(SplitStringProperty.builder()
                 .entries(List.of(SplitStringEntryProperty.builder()
                         .delimiter("delimiter")
                         .source("source")
                         .build()))
                 .build())
         .substituteString(SubstituteStringProperty.builder()
                 .entries(List.of(SubstituteStringEntryProperty.builder()
                         .from("from")
                         .source("source")
                         .to("to")
                         .build()))
                 .build())
         .trimString(TrimStringProperty.builder()
                 .withKeys(List.of("withKeys"))
                 .build())
         .typeConverter(TypeConverterProperty.builder()
                 .entries(List.of(TypeConverterEntryProperty.builder()
                         .key("key")
                         .type("type")
                         .build()))
                 .build())
         .upperCaseString(UpperCaseStringProperty.builder()
                 .withKeys(List.of("withKeys"))
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTransformer.ProcessorProperty.Builder	builder()
default Object	getAddKeys()	Use this parameter to include the addKeys processor in your transformer.
default Object	getCopyValue()	Use this parameter to include the copyValue processor in your transformer.
default Object	getCsv()	Use this parameter to include the CSV processor in your transformer.
default Object	getDateTimeConverter()	Use this parameter to include the datetimeConverter processor in your transformer.
default Object	getDeleteKeys()	Use this parameter to include the deleteKeys processor in your transformer.
default Object	getGrok()	Use this parameter to include the grok processor in your transformer.
default Object	getListToMap()	Use this parameter to include the listToMap processor in your transformer.
default Object	getLowerCaseString()	Use this parameter to include the lowerCaseString processor in your transformer.
default Object	getMoveKeys()	Use this parameter to include the moveKeys processor in your transformer.
default Object	getParseCloudfront()	Use this parameter to include the parseCloudfront processor in your transformer.
default Object	getParseJson()	Use this parameter to include the parseJSON processor in your transformer.
default Object	getParseKeyValue()	Use this parameter to include the parseKeyValue processor in your transformer.
default Object	getParsePostgres()	Use this parameter to include the parsePostGres processor in your transformer.
default Object	getParseRoute53()	Use this parameter to include the parseRoute53 processor in your transformer.
default Object	getParseToOcsf()	Use this parameter to convert logs into Open Cybersecurity Schema (OCSF) format.
default Object	getParseVpc()	Use this parameter to include the parseVPC processor in your transformer.
default Object	getParseWaf()	Use this parameter to include the parseWAF processor in your transformer.
default Object	getRenameKeys()	Use this parameter to include the renameKeys processor in your transformer.
default Object	getSplitString()	Use this parameter to include the splitString processor in your transformer.
default Object	getSubstituteString()	Use this parameter to include the substituteString processor in your transformer.
default Object	getTrimString()	Use this parameter to include the trimString processor in your transformer.
default Object	getTypeConverter()	Use this parameter to include the typeConverter processor in your transformer.
default Object	getUpperCaseString()	Use this parameter to include the upperCaseString processor in your transformer.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAddKeys

@Stability(Stable)
@Nullable
default Object getAddKeys()

Use this parameter to include the addKeys processor in your transformer.

Returns union: either IResolvable or CfnTransformer.AddKeysProperty

See Also:

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

getCopyValue

@Stability(Stable)
@Nullable
default Object getCopyValue()

Use this parameter to include the copyValue processor in your transformer.

Returns union: either IResolvable or CfnTransformer.CopyValueProperty

See Also:

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

getCsv

@Stability(Stable)
@Nullable
default Object getCsv()

Use this parameter to include the CSV processor in your transformer.

Returns union: either IResolvable or CfnTransformer.CsvProperty

See Also:

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

getDateTimeConverter

@Stability(Stable)
@Nullable
default Object getDateTimeConverter()

Use this parameter to include the datetimeConverter processor in your transformer.

Returns union: either IResolvable or CfnTransformer.DateTimeConverterProperty

See Also:

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

getDeleteKeys

@Stability(Stable)
@Nullable
default Object getDeleteKeys()

Use this parameter to include the deleteKeys processor in your transformer.

Returns union: either IResolvable or CfnTransformer.DeleteKeysProperty

See Also:

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

getGrok

@Stability(Stable)
@Nullable
default Object getGrok()

Use this parameter to include the grok processor in your transformer.

Returns union: either IResolvable or CfnTransformer.GrokProperty

See Also:

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

getListToMap

@Stability(Stable)
@Nullable
default Object getListToMap()

Use this parameter to include the listToMap processor in your transformer.

Returns union: either IResolvable or CfnTransformer.ListToMapProperty

See Also:

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

getLowerCaseString

@Stability(Stable)
@Nullable
default Object getLowerCaseString()

Use this parameter to include the lowerCaseString processor in your transformer.

Returns union: either IResolvable or CfnTransformer.LowerCaseStringProperty

See Also:

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

getMoveKeys

@Stability(Stable)
@Nullable
default Object getMoveKeys()

Use this parameter to include the moveKeys processor in your transformer.

Returns union: either IResolvable or CfnTransformer.MoveKeysProperty

See Also:

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

getParseCloudfront

@Stability(Stable)
@Nullable
default Object getParseCloudfront()

Use this parameter to include the parseCloudfront processor in your transformer.

If you use this processor, it must be the first processor in your transformer.

Returns union: either IResolvable or CfnTransformer.ParseCloudfrontProperty

See Also:

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

getParseJson

@Stability(Stable)
@Nullable
default Object getParseJson()

Use this parameter to include the parseJSON processor in your transformer.

Returns union: either IResolvable or CfnTransformer.ParseJSONProperty

See Also:

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

getParseKeyValue

@Stability(Stable)
@Nullable
default Object getParseKeyValue()

Use this parameter to include the parseKeyValue processor in your transformer.

Returns union: either IResolvable or CfnTransformer.ParseKeyValueProperty

See Also:

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

getParsePostgres

@Stability(Stable)
@Nullable
default Object getParsePostgres()

Use this parameter to include the parsePostGres processor in your transformer.

If you use this processor, it must be the first processor in your transformer.

Returns union: either IResolvable or CfnTransformer.ParsePostgresProperty

See Also:

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

getParseRoute53

@Stability(Stable)
@Nullable
default Object getParseRoute53()

Use this parameter to include the parseRoute53 processor in your transformer.

If you use this processor, it must be the first processor in your transformer.

Returns union: either IResolvable or CfnTransformer.ParseRoute53Property

See Also:

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

getParseToOcsf

@Stability(Stable)
@Nullable
default Object getParseToOcsf()

Use this parameter to convert logs into Open Cybersecurity Schema (OCSF) format.

Returns union: either IResolvable or CfnTransformer.ParseToOCSFProperty

See Also:

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

getParseVpc

@Stability(Stable)
@Nullable
default Object getParseVpc()

Use this parameter to include the parseVPC processor in your transformer.

If you use this processor, it must be the first processor in your transformer.

Returns union: either IResolvable or CfnTransformer.ParseVPCProperty

See Also:

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

getParseWaf

@Stability(Stable)
@Nullable
default Object getParseWaf()

Use this parameter to include the parseWAF processor in your transformer.

If you use this processor, it must be the first processor in your transformer.

Returns union: either IResolvable or CfnTransformer.ParseWAFProperty

See Also:

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

getRenameKeys

@Stability(Stable)
@Nullable
default Object getRenameKeys()

Use this parameter to include the renameKeys processor in your transformer.

Returns union: either IResolvable or CfnTransformer.RenameKeysProperty

See Also:

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

getSplitString

@Stability(Stable)
@Nullable
default Object getSplitString()

Use this parameter to include the splitString processor in your transformer.

Returns union: either IResolvable or CfnTransformer.SplitStringProperty

See Also:

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

getSubstituteString

@Stability(Stable)
@Nullable
default Object getSubstituteString()

Use this parameter to include the substituteString processor in your transformer.

Returns union: either IResolvable or CfnTransformer.SubstituteStringProperty

See Also:

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

getTrimString

@Stability(Stable)
@Nullable
default Object getTrimString()

Use this parameter to include the trimString processor in your transformer.

Returns union: either IResolvable or CfnTransformer.TrimStringProperty

See Also:

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

getTypeConverter

@Stability(Stable)
@Nullable
default Object getTypeConverter()

Use this parameter to include the typeConverter processor in your transformer.

Returns union: either IResolvable or CfnTransformer.TypeConverterProperty

See Also:

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

getUpperCaseString

@Stability(Stable)
@Nullable
default Object getUpperCaseString()

Use this parameter to include the upperCaseString processor in your transformer.

Returns union: either IResolvable or CfnTransformer.UpperCaseStringProperty

See Also:

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

builder

@Stability(Stable)
static CfnTransformer.ProcessorProperty.Builder builder()

Returns:

a CfnTransformer.ProcessorProperty.Builder of CfnTransformer.ProcessorProperty