Package software.amazon.awscdk.services.logs

Class CfnTransformer

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.logs.CfnTransformer
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ITransformerRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:13.179Z") @Stability(Stable) public class CfnTransformer extends CfnResource implements IInspectable, ITransformerRef
Creates or updates a log transformer for a single log group.

You use log transformers to transform log events into a different format, making them easier for you to process and analyze. You can also transform logs from different sources into standardized formats that contains relevant, source-specific information.

After you have created a transformer, CloudWatch Logs performs the transformations at the time of log ingestion. You can then refer to the transformed versions of the logs during operations such as querying with CloudWatch Logs Insights or creating metric filters or subscription filers.

You can also use a transformer to copy metadata from metadata keys into the log events themselves. This metadata can include log group name, log stream name, account ID and Region.

A transformer for a log group is a series of processors, where each processor applies one type of transformation to the log events ingested into this log group. The processors work one after another, in the order that you list them, like a pipeline. For more information about the available processors to use in a transformer, see Processors that you can use .

Having log events in standardized format enables visibility across your applications for your log analysis, reporting, and alarming needs. CloudWatch Logs provides transformation for common log types with out-of-the-box transformation templates for major AWS log sources such as VPC flow logs, Lambda, and Amazon RDS. You can use pre-built transformation templates or create custom transformation policies.

You can create transformers only for the log groups in the Standard log class.

You can also set up a transformer at the account level. For more information, see PutAccountPolicy . If there is both a log-group level transformer created with PutTransformer and an account-level transformer that could apply to the same log group, the log group uses only the log-group level transformer. It ignores the account-level transformer.

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.*;
 CfnTransformer cfnTransformer = CfnTransformer.Builder.create(this, "MyCfnTransformer")
         .logGroupIdentifier("logGroupIdentifier")
         .transformerConfig(List.of(ProcessorProperty.builder()
                 .addKeys(AddKeysProperty.builder()
                         .entries(List.of(AddKeyEntryProperty.builder()
                                 .key("key")
                                 .value("value")
                                 // the properties below are optional
                                 .overwriteIfExists(false)
                                 .build()))
                         .build())
                 .copyValue(CopyValueProperty.builder()
                         .entries(List.of(CopyValueEntryProperty.builder()
                                 .source("source")
                                 .target("target")
                                 // the properties below are optional
                                 .overwriteIfExists(false)
                                 .build()))
                         .build())
                 .csv(CsvProperty.builder()
                         .columns(List.of("columns"))
                         .delimiter("delimiter")
                         .quoteCharacter("quoteCharacter")
                         .source("source")
                         .build())
                 .dateTimeConverter(DateTimeConverterProperty.builder()
                         .matchPatterns(List.of("matchPatterns"))
                         .source("source")
                         .target("target")
                         // the properties below are optional
                         .locale("locale")
                         .sourceTimezone("sourceTimezone")
                         .targetFormat("targetFormat")
                         .targetTimezone("targetTimezone")
                         .build())
                 .deleteKeys(DeleteKeysProperty.builder()
                         .withKeys(List.of("withKeys"))
                         .build())
                 .grok(GrokProperty.builder()
                         .match("match")
                         // the properties below are optional
                         .source("source")
                         .build())
                 .listToMap(ListToMapProperty.builder()
                         .key("key")
                         .source("source")
                         // the properties below are optional
                         .flatten(false)
                         .flattenedElement("flattenedElement")
                         .target("target")
                         .valueKey("valueKey")
                         .build())
                 .lowerCaseString(LowerCaseStringProperty.builder()
                         .withKeys(List.of("withKeys"))
                         .build())
                 .moveKeys(MoveKeysProperty.builder()
                         .entries(List.of(MoveKeyEntryProperty.builder()
                                 .source("source")
                                 .target("target")
                                 // the properties below are optional
                                 .overwriteIfExists(false)
                                 .build()))
                         .build())
                 .parseCloudfront(ParseCloudfrontProperty.builder()
                         .source("source")
                         .build())
                 .parseJson(ParseJSONProperty.builder()
                         .destination("destination")
                         .source("source")
                         .build())
                 .parseKeyValue(ParseKeyValueProperty.builder()
                         .destination("destination")
                         .fieldDelimiter("fieldDelimiter")
                         .keyPrefix("keyPrefix")
                         .keyValueDelimiter("keyValueDelimiter")
                         .nonMatchValue("nonMatchValue")
                         .overwriteIfExists(false)
                         .source("source")
                         .build())
                 .parsePostgres(ParsePostgresProperty.builder()
                         .source("source")
                         .build())
                 .parseRoute53(ParseRoute53Property.builder()
                         .source("source")
                         .build())
                 .parseToOcsf(ParseToOCSFProperty.builder()
                         .eventSource("eventSource")
                         .ocsfVersion("ocsfVersion")
                         // the properties below are optional
                         .mappingVersion("mappingVersion")
                         .source("source")
                         .build())
                 .parseVpc(ParseVPCProperty.builder()
                         .source("source")
                         .build())
                 .parseWaf(ParseWAFProperty.builder()
                         .source("source")
                         .build())
                 .renameKeys(RenameKeysProperty.builder()
                         .entries(List.of(RenameKeyEntryProperty.builder()
                                 .key("key")
                                 .renameTo("renameTo")
                                 // the properties below are optional
                                 .overwriteIfExists(false)
                                 .build()))
                         .build())
                 .splitString(SplitStringProperty.builder()
                         .entries(List.of(SplitStringEntryProperty.builder()
                                 .delimiter("delimiter")
                                 .source("source")
                                 .build()))
                         .build())
                 .substituteString(SubstituteStringProperty.builder()
                         .entries(List.of(SubstituteStringEntryProperty.builder()
                                 .from("from")
                                 .source("source")
                                 .to("to")
                                 .build()))
                         .build())
                 .trimString(TrimStringProperty.builder()
                         .withKeys(List.of("withKeys"))
                         .build())
                 .typeConverter(TypeConverterProperty.builder()
                         .entries(List.of(TypeConverterEntryProperty.builder()
                                 .key("key")
                                 .type("type")
                                 .build()))
                         .build())
                 .upperCaseString(UpperCaseStringProperty.builder()
                         .withKeys(List.of("withKeys"))
                         .build())
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnTransformer

      protected CfnTransformer(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnTransformer

      protected CfnTransformer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnTransformer

      @Stability(Stable) public CfnTransformer(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnTransformerProps props)
      Create a new AWS::Logs::Transformer.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnTransformer

      @Stability(Stable) @NotNull public static Boolean isCfnTransformer(@NotNull Object x)
      Checks whether the given object is a CfnTransformer.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTransformerRef

      @Stability(Stable) @NotNull public TransformerReference getTransformerRef()
      A reference to a Transformer resource.
      Specified by:
      getTransformerRef in interface ITransformerRef

    • getLogGroupIdentifier

      @Stability(Stable) @NotNull public String getLogGroupIdentifier()
      Specify either the name or ARN of the log group to create the transformer for.

    • setLogGroupIdentifier

      @Stability(Stable) public void setLogGroupIdentifier(@NotNull String value)
      Specify either the name or ARN of the log group to create the transformer for.

    • getTransformerConfig

      @Stability(Stable) @NotNull public Object getTransformerConfig()
      This structure is an array that contains the configuration of this log transformer.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnTransformer.ProcessorProperty>

    • setTransformerConfig

      @Stability(Stable) public void setTransformerConfig(@NotNull IResolvable value)
      This structure is an array that contains the configuration of this log transformer.

    • setTransformerConfig

      @Stability(Stable) public void setTransformerConfig(@NotNull List<Object> value)
      This structure is an array that contains the configuration of this log transformer.