Package software.amazon.awscdk.services.observabilityadmin

Class CfnTelemetryRule

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.observabilityadmin.CfnTelemetryRule
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ITelemetryRuleRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)", date="2026-01-09T10:20:22.564Z") @Stability(Stable) public class CfnTelemetryRule extends CfnResource implements IInspectable, ITelemetryRuleRef, ITaggableV2
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.services.observabilityadmin.*;
 CfnTelemetryRule cfnTelemetryRule = CfnTelemetryRule.Builder.create(this, "MyCfnTelemetryRule")
         .rule(TelemetryRuleProperty.builder()
                 .resourceType("resourceType")
                 .telemetryType("telemetryType")
                 // the properties below are optional
                 .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()))
                                         // the properties below are optional
                                         .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())
                 .selectionCriteria("selectionCriteria")
                 .telemetrySourceTypes(List.of("telemetrySourceTypes"))
                 .build())
         .ruleName("ruleName")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .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

    • CfnTelemetryRule

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

    • CfnTelemetryRule

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

    • CfnTelemetryRule

      @Stability(Stable) public CfnTelemetryRule(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnTelemetryRuleProps props)
      Create a new AWS::ObservabilityAdmin::TelemetryRule.

      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

    • isCfnTelemetryRule

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

      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.

    • getAttrRuleArn

      @Stability(Stable) @NotNull public String getAttrRuleArn()
      The Amazon Resource Name (ARN) of the telemetry rule.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

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

    • getTelemetryRuleRef

      @Stability(Stable) @NotNull public TelemetryRuleReference getTelemetryRuleRef()
      A reference to a TelemetryRule resource.
      Specified by:
      getTelemetryRuleRef in interface ITelemetryRuleRef

    • getRule

      @Stability(Stable) @NotNull public Object getRule()
      Retrieves the details of a specific telemetry rule in your account.

      Returns union: either IResolvable or CfnTelemetryRule.TelemetryRuleProperty

    • setRule

      @Stability(Stable) public void setRule(@NotNull IResolvable value)
      Retrieves the details of a specific telemetry rule in your account.

    • setRule

      @Stability(Stable) public void setRule(@NotNull CfnTelemetryRule.TelemetryRuleProperty value)
      Retrieves the details of a specific telemetry rule in your account.

    • getRuleName

      @Stability(Stable) @NotNull public String getRuleName()
      The name of the telemetry rule.

    • setRuleName

      @Stability(Stable) public void setRuleName(@NotNull String value)
      The name of the telemetry rule.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Lists all tags attached to the specified resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Lists all tags attached to the specified resource.