StringMutatorProps

class aws_cdk.aws_logs.StringMutatorProps(*, type, lower_case_keys=None, split_options=None, substitute_options=None, trim_keys=None, upper_case_keys=None)

Bases: BaseProcessorProps

Properties for creating string mutator processors.

Parameters:
  • type (StringMutatorType) – The type of string mutation operation.

  • lower_case_keys (Optional[Sequence[str]]) – Keys for strings to convert to lowercase. Required when type is LOWER_CASE. Default: - No lowercase processor is created if props not set

  • split_options (Union[SplitStringProperty, Dict[str, Any], None]) – Options for string splitting. Required when type is SPLIT. Default: - No string splitting processor is created if props not set

  • substitute_options (Union[SubstituteStringProperty, Dict[str, Any], None]) – Options for string substitution. Required when type is SUBSTITUTE. Default: - No string substitution processor is created if props not set

  • trim_keys (Optional[Sequence[str]]) – Keys for strings to trim. Required when type is TRIM. Default: - No trim processor is created if props not set

  • upper_case_keys (Optional[Sequence[str]]) – Keys for strings to convert to uppercase. Required when type is UPPER_CASE. Default: - No uppercase processor is created if props not set

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_logs as logs

string_mutator_props = logs.StringMutatorProps(
    type=logs.StringMutatorType.LOWER_CASE,

    # the properties below are optional
    lower_case_keys=["lowerCaseKeys"],
    split_options=logs.SplitStringProperty(
        entries=[logs.SplitStringEntryProperty(
            delimiter=logs.DelimiterCharacter.COMMA,
            source="source"
        )]
    ),
    substitute_options=logs.SubstituteStringProperty(
        entries=[logs.SubstituteStringEntryProperty(
            from="from",
            source="source",
            to="to"
        )]
    ),
    trim_keys=["trimKeys"],
    upper_case_keys=["upperCaseKeys"]
)

Attributes

lower_case_keys

Keys for strings to convert to lowercase.

Required when type is LOWER_CASE.

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

split_options

Options for string splitting.

Required when type is SPLIT.

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

substitute_options

Options for string substitution.

Required when type is SUBSTITUTE.

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

trim_keys

Keys for strings to trim.

Required when type is TRIM.

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

type

The type of string mutation operation.

upper_case_keys

Keys for strings to convert to uppercase.

Required when type is UPPER_CASE.

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