Package software.amazon.awscdk.services.observabilityadmin

Interface CfnTelemetryRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTelemetryRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:44.158Z")
@Stability(Stable)
public interface CfnTelemetryRuleProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnTelemetryRule.

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.*;
 CfnTelemetryRuleProps cfnTelemetryRuleProps = CfnTelemetryRuleProps.builder()
         .rule(TelemetryRuleProperty.builder()
                 .resourceType("resourceType")
                 .telemetryType("telemetryType")
                 // the properties below are optional
                 .destinationConfiguration(TelemetryDestinationConfigurationProperty.builder()
                         .destinationPattern("destinationPattern")
                         .destinationType("destinationType")
                         .retentionInDays(123)
                         .vpcFlowLogParameters(VPCFlowLogParametersProperty.builder()
                                 .logFormat("logFormat")
                                 .maxAggregationInterval(123)
                                 .trafficType("trafficType")
                                 .build())
                         .build())
                 .selectionCriteria("selectionCriteria")
                 .build())
         .ruleName("ruleName")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTelemetryRuleProps.Builder	builder()
Object	getRule()	Retrieves the details of a specific telemetry rule in your account.
String	getRuleName()	The name of the telemetry rule.
default List<CfnTag>	getTags()	Lists all tags attached to the specified telemetry rule resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRule

@Stability(Stable)
@NotNull
Object getRule()

Retrieves the details of a specific telemetry rule in your account.

Returns union: either IResolvable or CfnTelemetryRule.TelemetryRuleProperty

See Also:

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

getRuleName

@Stability(Stable)
@NotNull
String getRuleName()

The name of the telemetry rule.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

Lists all tags attached to the specified telemetry rule resource.

See Also:

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

builder

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

Returns:

a CfnTelemetryRuleProps.Builder of CfnTelemetryRuleProps