# StringMutatorProps

Properties for creating string mutator processors.

Extends: StringMutatorProps
Extends: BaseProcessorProps
Used as props by: StringMutatorProcessor

- Source: [`aws-logs/lib/transformer.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-logs/lib/transformer.ts#L591)
- Type last changed: v2.207.0 · 24 Jul 2025

## 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

- `lowerCaseKeys`: string[] = No lowercase processor is created if props not set — Keys for strings to convert to lowercase.

  Required when type is LOWER_CASE.

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

- `splitOptions`: [SplitStringProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_logs.SplitStringProperty.html) = No string splitting processor is created if props not set — Options for string splitting.

  Required when type is SPLIT.

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

- `substituteOptions`: [SubstituteStringProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_logs.SubstituteStringProperty.html) = No string substitution processor is created if props not set — Options for string substitution.

  Required when type is SUBSTITUTE.

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

- `trimKeys`: string[] = No trim processor is created if props not set — Keys for strings to trim.

  Required when type is TRIM.

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

- `type`: [StringMutatorType](/cdk/api/v2/docs/aws-cdk-lib.aws_logs.StringMutatorType.html) (required) — The type of string mutation operation.

- `upperCaseKeys`: string[] = No uppercase processor is created if props not set — Keys for strings to convert to uppercase.

  Required when type is UPPER_CASE.

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