CfnTransformerProps

class aws_cdk.aws_logs.CfnTransformerProps(*, log_group_identifier, transformer_config)

Bases: object

Properties for defining a CfnTransformer.

Parameters:
  • log_group_identifier (str) – Specify either the name or ARN of the log group to create the transformer for.

  • transformer_config (Union[IResolvable, Sequence[Union[IResolvable, ProcessorProperty, Dict[str, Any]]]]) – This structure is an array that contains the configuration of this log transformer. A log transformer is an array of processors, where each processor applies one type of transformation to the log events that are ingested.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-transformer.html

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

cfn_transformer_props = logs.CfnTransformerProps(
    log_group_identifier="logGroupIdentifier",
    transformer_config=[logs.CfnTransformer.ProcessorProperty(
        add_keys=logs.CfnTransformer.AddKeysProperty(
            entries=[logs.CfnTransformer.AddKeyEntryProperty(
                key="key",
                value="value",

                # the properties below are optional
                overwrite_if_exists=False
            )]
        ),
        copy_value=logs.CfnTransformer.CopyValueProperty(
            entries=[logs.CfnTransformer.CopyValueEntryProperty(
                source="source",
                target="target",

                # the properties below are optional
                overwrite_if_exists=False
            )]
        ),
        csv=logs.CfnTransformer.CsvProperty(
            columns=["columns"],
            delimiter="delimiter",
            quote_character="quoteCharacter",
            source="source"
        ),
        date_time_converter=logs.CfnTransformer.DateTimeConverterProperty(
            match_patterns=["matchPatterns"],
            source="source",
            target="target",

            # the properties below are optional
            locale="locale",
            source_timezone="sourceTimezone",
            target_format="targetFormat",
            target_timezone="targetTimezone"
        ),
        delete_keys=logs.CfnTransformer.DeleteKeysProperty(
            with_keys=["withKeys"]
        ),
        grok=logs.CfnTransformer.GrokProperty(
            match="match",

            # the properties below are optional
            source="source"
        ),
        list_to_map=logs.CfnTransformer.ListToMapProperty(
            key="key",
            source="source",

            # the properties below are optional
            flatten=False,
            flattened_element="flattenedElement",
            target="target",
            value_key="valueKey"
        ),
        lower_case_string=logs.CfnTransformer.LowerCaseStringProperty(
            with_keys=["withKeys"]
        ),
        move_keys=logs.CfnTransformer.MoveKeysProperty(
            entries=[logs.CfnTransformer.MoveKeyEntryProperty(
                source="source",
                target="target",

                # the properties below are optional
                overwrite_if_exists=False
            )]
        ),
        parse_cloudfront=logs.CfnTransformer.ParseCloudfrontProperty(
            source="source"
        ),
        parse_json=logs.CfnTransformer.ParseJSONProperty(
            destination="destination",
            source="source"
        ),
        parse_key_value=logs.CfnTransformer.ParseKeyValueProperty(
            destination="destination",
            field_delimiter="fieldDelimiter",
            key_prefix="keyPrefix",
            key_value_delimiter="keyValueDelimiter",
            non_match_value="nonMatchValue",
            overwrite_if_exists=False,
            source="source"
        ),
        parse_postgres=logs.CfnTransformer.ParsePostgresProperty(
            source="source"
        ),
        parse_route53=logs.CfnTransformer.ParseRoute53Property(
            source="source"
        ),
        parse_vpc=logs.CfnTransformer.ParseVPCProperty(
            source="source"
        ),
        parse_waf=logs.CfnTransformer.ParseWAFProperty(
            source="source"
        ),
        rename_keys=logs.CfnTransformer.RenameKeysProperty(
            entries=[logs.CfnTransformer.RenameKeyEntryProperty(
                key="key",
                rename_to="renameTo",

                # the properties below are optional
                overwrite_if_exists=False
            )]
        ),
        split_string=logs.CfnTransformer.SplitStringProperty(
            entries=[logs.CfnTransformer.SplitStringEntryProperty(
                delimiter="delimiter",
                source="source"
            )]
        ),
        substitute_string=logs.CfnTransformer.SubstituteStringProperty(
            entries=[logs.CfnTransformer.SubstituteStringEntryProperty(
                from="from",
                source="source",
                to="to"
            )]
        ),
        trim_string=logs.CfnTransformer.TrimStringProperty(
            with_keys=["withKeys"]
        ),
        type_converter=logs.CfnTransformer.TypeConverterProperty(
            entries=[logs.CfnTransformer.TypeConverterEntryProperty(
                key="key",
                type="type"
            )]
        ),
        upper_case_string=logs.CfnTransformer.UpperCaseStringProperty(
            with_keys=["withKeys"]
        )
    )]
)

Attributes

log_group_identifier

Specify either the name or ARN of the log group to create the transformer for.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-transformer.html#cfn-logs-transformer-loggroupidentifier

transformer_config

This structure is an array that contains the configuration of this log transformer.

A log transformer is an array of processors, where each processor applies one type of transformation to the log events that are ingested.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-transformer.html#cfn-logs-transformer-transformerconfig