Skip to content
v2.275.0

StringMutatorProps Struct ​

Properties for creating string mutator processors.

Example ​

ts
// 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 stringMutatorProps: logs.StringMutatorProps = {
  type: logs.StringMutatorType.LOWER_CASE,

  // the properties below are optional
  lowerCaseKeys: ['lowerCaseKeys'],
  splitOptions: {
    entries: [{
      delimiter: logs.DelimiterCharacter.COMMA,
      source: 'source',
    }],
  },
  substituteOptions: {
    entries: [{
      from: 'from',
      source: 'source',
      to: 'to',
    }],
  },
  trimKeys: ['trimKeys'],
  upperCaseKeys: ['upperCaseKeys'],
};

Properties ​

lowerCaseKeysoptionalstring[]lower_case_keysoptionaltyping.List[str]lowerCaseKeysoptionalList<String>LowerCaseKeysoptionalstring[]LowerCaseKeysoptional*[]*string#
Keys for strings to convert to lowercase.

Default: No lowercase processor is created if props not set

Required when type is LOWER_CASE.

splitOptionsoptionalSplitStringPropertysplit_optionsoptionalSplitStringPropertysplitOptionsoptionalSplitStringPropertySplitOptionsoptionalSplitStringPropertySplitOptionsoptionalSplitStringProperty#
Options for string splitting.

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

Required when type is SPLIT.

substituteOptionsoptionalSubstituteStringPropertysubstitute_optionsoptionalSubstituteStringPropertysubstituteOptionsoptionalSubstituteStringPropertySubstituteOptionsoptionalSubstituteStringPropertySubstituteOptionsoptionalSubstituteStringProperty#
Options for string substitution.

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

Required when type is SUBSTITUTE.

trimKeysoptionalstring[]trim_keysoptionaltyping.List[str]trimKeysoptionalList<String>TrimKeysoptionalstring[]TrimKeysoptional*[]*string#
Keys for strings to trim.

Default: No trim processor is created if props not set

Required when type is TRIM.

The type of string mutation operation.
upperCaseKeysoptionalstring[]upper_case_keysoptionaltyping.List[str]upperCaseKeysoptionalList<String>UpperCaseKeysoptionalstring[]UpperCaseKeysoptional*[]*string#
Keys for strings to convert to uppercase.

Default: No uppercase processor is created if props not set

Required when type is UPPER_CASE.