Package software.amazon.awscdk.services.logs

Interface TransformerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

TransformerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-07-24T11:33:17.376Z")
@Stability(Stable)
public interface TransformerProps
extends software.amazon.jsii.JsiiSerializable

The Resource properties for AWS::Logs::Transformer resource.

This interface defines all configuration options for the CfnTransformer construct.

Example:

 // Create a log group
 LogGroup logGroup = new LogGroup(this, "MyLogGroup");
 // Create a JSON parser processor
 ParserProcessor jsonParser = ParserProcessor.Builder.create()
         .type(ParserProcessorType.JSON)
         .build();
 // Create a processor to add keys
 JsonMutatorProcessor addKeysProcessor = JsonMutatorProcessor.Builder.create()
         .type(JsonMutatorType.ADD_KEYS)
         .addKeysOptions(AddKeysProperty.builder()
                 .entries(List.of(AddKeyEntryProperty.builder()
                         .key("metadata.transformed_in")
                         .value("CloudWatchLogs")
                         .build()))
                 .build())
         .build();
 // Create a transformer with these processors
 // Create a transformer with these processors
 Transformer.Builder.create(this, "Transformer")
         .transformerName("MyTransformer")
         .logGroup(logGroup)
         .transformerConfig(List.of(jsonParser, addKeysProcessor))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	TransformerProps.Builder	A builder for TransformerProps
static final class	TransformerProps.Jsii$Proxy	An implementation for TransformerProps

Method Summary

Modifier and Type	Method	Description
static TransformerProps.Builder	builder()
ILogGroup	getLogGroup()	Existing log group that you want to associate with this transformer.
List<IProcessor>	getTransformerConfig()	List of processors in a transformer.
String	getTransformerName()	Name of the transformer.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLogGroup

@Stability(Stable)
@NotNull
ILogGroup getLogGroup()

Existing log group that you want to associate with this transformer.

getTransformerConfig

@Stability(Stable)
@NotNull
List<IProcessor> getTransformerConfig()

List of processors in a transformer.

getTransformerName

@Stability(Stable)
@NotNull
String getTransformerName()

Name of the transformer.

builder

@Stability(Stable)
static TransformerProps.Builder builder()

Returns:

a TransformerProps.Builder of TransformerProps