Interface CfnTelemetryRule.TelemetryRuleProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnTelemetryRule.TelemetryRuleProperty.Jsii$Proxy
- Enclosing class:
CfnTelemetryRule
@Stability(Stable)
public static interface CfnTelemetryRule.TelemetryRuleProperty
extends software.amazon.jsii.JsiiSerializable
Defines how telemetry should be configured for specific AWS resources.
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.*;
TelemetryRuleProperty telemetryRuleProperty = TelemetryRuleProperty.builder()
.resourceType("resourceType")
.telemetryType("telemetryType")
// the properties below are optional
.allowFieldUpdates(false)
.allRegions(false)
.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())
.regions(List.of("regions"))
.selectionCriteria("selectionCriteria")
.telemetrySourceTypes(List.of("telemetrySourceTypes"))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnTelemetryRule.TelemetryRulePropertystatic final classAn implementation forCfnTelemetryRule.TelemetryRuleProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectWhen true, configuration drift in managed telemetry resources will be detected and remediated for resource-level fields.default ObjectWhen true, the rule is replicated to all supported regions.default ObjectConfiguration specifying where and how the telemetry data should be delivered.List of AWS region codes where the rule should be replicated.The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC", "AWS::EKS::Cluster", "AWS::WAFv2::WebACL").default StringCriteria for selecting which resources the rule applies to, such as resource tags.The specific telemetry source types to configure for the resource, such as VPC_FLOW_LOGS or EKS_AUDIT_LOGS.The type of telemetry to collect (Logs, Metrics, or Traces).Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getResourceType
The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC", "AWS::EKS::Cluster", "AWS::WAFv2::WebACL").- See Also:
-
getTelemetryType
The type of telemetry to collect (Logs, Metrics, or Traces).- See Also:
-
getAllowFieldUpdates
When true, configuration drift in managed telemetry resources will be detected and remediated for resource-level fields.Returns union: either
BooleanorIResolvableDefault: - false
- See Also:
-
getAllRegions
When true, the rule is replicated to all supported regions.Returns union: either
BooleanorIResolvable- See Also:
-
getDestinationConfiguration
Configuration specifying where and how the telemetry data should be delivered.Returns union: either
IResolvableorCfnTelemetryRule.TelemetryDestinationConfigurationProperty- See Also:
-
getRegions
List of AWS region codes where the rule should be replicated.- See Also:
-
getSelectionCriteria
Criteria for selecting which resources the rule applies to, such as resource tags.- See Also:
-
getTelemetrySourceTypes
The specific telemetry source types to configure for the resource, such as VPC_FLOW_LOGS or EKS_AUDIT_LOGS.TelemetrySourceTypes must be correlated with the specific resource type.
- See Also:
-
builder
-