Package software.amazon.awscdk.services.logs

Interface StringMutatorProps

All Superinterfaces:

BaseProcessorProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

StringMutatorProps.Jsii$Proxy

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

Properties for creating string mutator processors.

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.*;
 StringMutatorProps stringMutatorProps = StringMutatorProps.builder()
         .type(StringMutatorType.LOWER_CASE)
         // the properties below are optional
         .lowerCaseKeys(List.of("lowerCaseKeys"))
         .splitOptions(SplitStringProperty.builder()
                 .entries(List.of(SplitStringEntryProperty.builder()
                         .delimiter(DelimiterCharacter.COMMA)
                         .source("source")
                         .build()))
                 .build())
         .substituteOptions(SubstituteStringProperty.builder()
                 .entries(List.of(SubstituteStringEntryProperty.builder()
                         .from("from")
                         .source("source")
                         .to("to")
                         .build()))
                 .build())
         .trimKeys(List.of("trimKeys"))
         .upperCaseKeys(List.of("upperCaseKeys"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static StringMutatorProps.Builder	builder()
default List<String>	getLowerCaseKeys()	Keys for strings to convert to lowercase.
default SplitStringProperty	getSplitOptions()	Options for string splitting.
default SubstituteStringProperty	getSubstituteOptions()	Options for string substitution.
default List<String>	getTrimKeys()	Keys for strings to trim.
StringMutatorType	getType()	The type of string mutation operation.
default List<String>	getUpperCaseKeys()	Keys for strings to convert to uppercase.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Stable)
@NotNull
StringMutatorType getType()

The type of string mutation operation.

getLowerCaseKeys

@Stability(Stable)
@Nullable
default List<String> getLowerCaseKeys()

Keys for strings to convert to lowercase.

Required when type is LOWER_CASE.

Default: - No lowercase processor is created if props not set

getSplitOptions

@Stability(Stable)
@Nullable
default SplitStringProperty getSplitOptions()

Options for string splitting.

Required when type is SPLIT.

Default: - No string splitting processor is created if props not set

getSubstituteOptions

@Stability(Stable)
@Nullable
default SubstituteStringProperty getSubstituteOptions()

Options for string substitution.

Required when type is SUBSTITUTE.

Default: - No string substitution processor is created if props not set

getTrimKeys

@Stability(Stable)
@Nullable
default List<String> getTrimKeys()

Keys for strings to trim.

Required when type is TRIM.

Default: - No trim processor is created if props not set

getUpperCaseKeys

@Stability(Stable)
@Nullable
default List<String> getUpperCaseKeys()

Keys for strings to convert to uppercase.

Required when type is UPPER_CASE.

Default: - No uppercase processor is created if props not set

builder

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

Returns:

a StringMutatorProps.Builder of StringMutatorProps