Package software.amazon.awscdk.cfnpropertymixins.services.observabilityadmin

Class CfnTelemetryRulePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.observabilityadmin.CfnTelemetryRulePropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:01.944Z")
@Stability(Stable)
public class CfnTelemetryRulePropsMixin
extends Mixin
implements software.constructs.IMixin

Creates a telemetry rule that defines how telemetry should be configured for AWS resources in your account.

The rule specifies which resources should have telemetry enabled and how that telemetry data should be collected based on resource type, telemetry type, and selection criteria.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.observabilityadmin.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnTelemetryRulePropsMixin cfnTelemetryRulePropsMixin = CfnTelemetryRulePropsMixin.Builder.create(CfnTelemetryRuleMixinProps.builder()
         .rule(TelemetryRuleProperty.builder()
                 .destinationConfiguration(TelemetryDestinationConfigurationProperty.builder()
                         .cloudtrailParameters(CloudtrailParametersProperty.builder()
                                 .advancedEventSelectors(List.of(AdvancedEventSelectorProperty.builder()
                                         .fieldSelectors(List.of(AdvancedFieldSelectorProperty.builder()
                                                 .endsWith(List.of("endsWith"))
                                                 .equalTo(List.of("equalTo"))
                                                 .field("field")
                                                 .notEndsWith(List.of("notEndsWith"))
                                                 .notEquals(List.of("notEquals"))
                                                 .notStartsWith(List.of("notStartsWith"))
                                                 .startsWith(List.of("startsWith"))
                                                 .build()))
                                         .name("name")
                                         .build()))
                                 .build())
                         .destinationPattern("destinationPattern")
                         .destinationType("destinationType")
                         .elbLoadBalancerLoggingParameters(ELBLoadBalancerLoggingParametersProperty.builder()
                                 .fieldDelimiter("fieldDelimiter")
                                 .outputFormat("outputFormat")
                                 .build())
                         .logDeliveryParameters(LogDeliveryParametersProperty.builder()
                                 .logTypes(List.of("logTypes"))
                                 .build())
                         .retentionInDays(123)
                         .vpcFlowLogParameters(VPCFlowLogParametersProperty.builder()
                                 .logFormat("logFormat")
                                 .maxAggregationInterval(123)
                                 .trafficType("trafficType")
                                 .build())
                         .wafLoggingParameters(WAFLoggingParametersProperty.builder()
                                 .loggingFilter(LoggingFilterProperty.builder()
                                         .defaultBehavior("defaultBehavior")
                                         .filters(List.of(FilterProperty.builder()
                                                 .behavior("behavior")
                                                 .conditions(List.of(ConditionProperty.builder()
                                                         .actionCondition(ActionConditionProperty.builder()
                                                                 .action("action")
                                                                 .build())
                                                         .labelNameCondition(LabelNameConditionProperty.builder()
                                                                 .labelName("labelName")
                                                                 .build())
                                                         .build()))
                                                 .requirement("requirement")
                                                 .build()))
                                         .build())
                                 .logType("logType")
                                 .redactedFields(List.of(FieldToMatchProperty.builder()
                                         .method("method")
                                         .queryString("queryString")
                                         .singleHeader(SingleHeaderProperty.builder()
                                                 .name("name")
                                                 .build())
                                         .uriPath("uriPath")
                                         .build()))
                                 .build())
                         .build())
                 .resourceType("resourceType")
                 .selectionCriteria("selectionCriteria")
                 .telemetrySourceTypes(List.of("telemetrySourceTypes"))
                 .telemetryType("telemetryType")
                 .build())
         .ruleName("ruleName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetryrule.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnTelemetryRulePropsMixin.ActionConditionProperty	Condition that matches based on the specific WAF action taken on the request.
static interface	CfnTelemetryRulePropsMixin.AdvancedEventSelectorProperty	Advanced event selectors let you create fine-grained selectors for management, data, and network activity events.
static interface	CfnTelemetryRulePropsMixin.AdvancedFieldSelectorProperty	Defines criteria for selecting resources based on field values.
static final class	CfnTelemetryRulePropsMixin.Builder	A fluent builder for CfnTelemetryRulePropsMixin.
static interface	CfnTelemetryRulePropsMixin.CloudtrailParametersProperty	Parameters specific to AWS CloudTrail telemetry configuration.
static interface	CfnTelemetryRulePropsMixin.ConditionProperty	A single condition that can match based on WAF rule action or label name.
static interface	CfnTelemetryRulePropsMixin.ELBLoadBalancerLoggingParametersProperty	Configuration parameters for ELB load balancer logging, including output format and field delimiter settings.
static interface	CfnTelemetryRulePropsMixin.FieldToMatchProperty	Specifies a field in the request to redact from WAF logs, such as headers, query parameters, or body content.
static interface	CfnTelemetryRulePropsMixin.FilterProperty	A single filter condition that specifies behavior, requirement, and matching conditions for WAF log records.
static interface	CfnTelemetryRulePropsMixin.LabelNameConditionProperty	Condition that matches based on WAF rule labels, with label names limited to 1024 characters.
static interface	CfnTelemetryRulePropsMixin.LogDeliveryParametersProperty	Configuration parameters for Amazon Bedrock AgentCore logging, including logType settings.
static interface	CfnTelemetryRulePropsMixin.LoggingFilterProperty	Configuration that determines which WAF log records to keep or drop based on specified conditions.
static interface	CfnTelemetryRulePropsMixin.SingleHeaderProperty	Structure containing a name field limited to 64 characters for header or query parameter identification.
static interface	CfnTelemetryRulePropsMixin.TelemetryDestinationConfigurationProperty	Configuration specifying where and how telemetry data should be delivered for AWS resources.
static interface	CfnTelemetryRulePropsMixin.TelemetryRuleProperty	Defines how telemetry should be configured for specific AWS resources.
static interface	CfnTelemetryRulePropsMixin.VPCFlowLogParametersProperty	Configuration parameters specific to VPC Flow Logs.
static interface	CfnTelemetryRulePropsMixin.WAFLoggingParametersProperty	Configuration parameters for WAF logging, including redacted fields and logging filters.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnTelemetryRulePropsMixin(CfnTelemetryRuleMixinProps props)	Create a mixin to apply properties to AWS::ObservabilityAdmin::TelemetryRule.
	CfnTelemetryRulePropsMixin(CfnTelemetryRuleMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::ObservabilityAdmin::TelemetryRule.
protected	CfnTelemetryRulePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTelemetryRulePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnTelemetryRuleMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnTelemetryRulePropsMixin

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

CfnTelemetryRulePropsMixin

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

CfnTelemetryRulePropsMixin

@Stability(Stable)
public CfnTelemetryRulePropsMixin(@NotNull
 CfnTelemetryRuleMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::ObservabilityAdmin::TelemetryRule.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnTelemetryRulePropsMixin

@Stability(Stable)
public CfnTelemetryRulePropsMixin(@NotNull
 CfnTelemetryRuleMixinProps props)

Create a mixin to apply properties to AWS::ObservabilityAdmin::TelemetryRule.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnTelemetryRuleMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()