Transformer L2 construct
Represent the L2 construct for the AWS::Logs::Transformer CloudFormation resource.
Example
// Create a log group
const logGroup = new logs.LogGroup(this, 'MyLogGroup');
// Create a JSON parser processor
const jsonParser = new logs.ParserProcessor({
type: logs.ParserProcessorType.JSON
});
// Create a processor to add keys
const addKeysProcessor = new logs.JsonMutatorProcessor({
type: logs.JsonMutatorType.ADD_KEYS,
addKeysOptions: {
entries: [{
key: 'metadata.transformed_in',
value: 'CloudWatchLogs'
}]
}
});
// Create a transformer with these processors
new logs.Transformer(this, 'Transformer', {
transformerName: 'MyTransformer',
logGroup: logGroup,
transformerConfig: [jsonParser, addKeysProcessor]
});
# Create a log group
log_group = logs.LogGroup(self, "MyLogGroup")
# Create a JSON parser processor
json_parser = logs.ParserProcessor(
type=logs.ParserProcessorType.JSON
)
# Create a processor to add keys
add_keys_processor = logs.JsonMutatorProcessor(
type=logs.JsonMutatorType.ADD_KEYS,
add_keys_options=logs.AddKeysProperty(
entries=[logs.AddKeyEntryProperty(
key="metadata.transformed_in",
value="CloudWatchLogs"
)]
)
)
# Create a transformer with these processors
logs.Transformer(self, "Transformer",
transformer_name="MyTransformer",
log_group=log_group,
transformer_config=[json_parser, add_keys_processor]
)
// 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();
// Install: dotnet add package Amazon.CDK.Lib
// Create a log group
var logGroup = new LogGroup(this, "MyLogGroup");
// Create a JSON parser processor
var jsonParser = new ParserProcessor(new ParserProcessorProps {
Type = ParserProcessorType.JSON
});
// Create a processor to add keys
var addKeysProcessor = new JsonMutatorProcessor(new JsonMutatorProps {
Type = JsonMutatorType.ADD_KEYS,
AddKeysOptions = new AddKeysProperty {
Entries = new [] { new AddKeyEntryProperty {
Key = "metadata.transformed_in",
Value = "CloudWatchLogs"
} }
}
});
// Create a transformer with these processors
// Create a transformer with these processors
new Transformer(this, "Transformer", new TransformerProps {
TransformerName = "MyTransformer",
LogGroup = logGroup,
TransformerConfig = new [] { jsonParser, addKeysProcessor }
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// Create a log group
logGroup := logs.NewLogGroup(this, jsii.String("MyLogGroup"))
// Create a JSON parser processor
jsonParser := logs.NewParserProcessor(&ParserProcessorProps{
Type: logs.ParserProcessorType_JSON,
})
// Create a processor to add keys
addKeysProcessor := logs.NewJsonMutatorProcessor(&JsonMutatorProps{
Type: logs.JsonMutatorType_ADD_KEYS,
AddKeysOptions: &AddKeysProperty{
Entries: []AddKeyEntryProperty{
&AddKeyEntryProperty{
Key: jsii.String("metadata.transformed_in"),
Value: jsii.String("CloudWatchLogs"),
},
},
},
})
// Create a transformer with these processors
// Create a transformer with these processors
logs.NewTransformer(this, jsii.String("Transformer"), &TransformerProps{
TransformerName: jsii.String("MyTransformer"),
LogGroup: logGroup,
TransformerConfig: []IProcessor{
jsonParser,
addKeysProcessor,
},
})
Initializer
new Transformer(scope: Construct, id: string, props: TransformerProps)
Transformer(scope: Construct, id: str, props: TransformerProps)
new Transformer(Construct scope, String id, TransformerProps props)
new Transformer(Construct scope, string id, TransformerProps props)
NewTransformer(Scope Construct, Id *string, Props TransformerProps)
Construct Props
logGroupILogGroupReflog_groupILogGroupReflogGroupILogGroupRefLogGroupILogGroupRefLogGroupILogGroupRefrequired#transformerConfigIProcessor[]transformer_configtyping.List[IProcessor]transformerConfigList<IProcessor>TransformerConfigIProcessor[]TransformerConfig*[]IProcessorrequired#transformerNamestringtransformer_namestrtransformerNameStringTransformerNamestringTransformerName*stringrequired#Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Used by the CDK frameworks for managing resource lifecycle.
Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.