Package software.amazon.awscdk.services.observabilityadmin

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
         .destinationConfiguration(TelemetryDestinationConfigurationProperty.builder()
                 .destinationPattern("destinationPattern")
                 .destinationType("destinationType")
                 .retentionInDays(123)
                 .vpcFlowLogParameters(VPCFlowLogParametersProperty.builder()
                         .logFormat("logFormat")
                         .maxAggregationInterval(123)
                         .trafficType("trafficType")
                         .build())
                 .build())
         .selectionCriteria("selectionCriteria")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTelemetryRule.TelemetryRuleProperty.Builder	builder()
default Object	getDestinationConfiguration()	Configuration specifying where and how the telemetry data should be delivered.
String	getResourceType()	The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC").
default String	getSelectionCriteria()	Criteria for selecting which resources the rule applies to, such as resource tags.
String	getTelemetryType()	The type of telemetry to collect (Logs, Metrics, or Traces).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getResourceType

@Stability(Stable)
@NotNull
String getResourceType()

The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC").

See Also:

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

getTelemetryType

@Stability(Stable)
@NotNull
String getTelemetryType()

The type of telemetry to collect (Logs, Metrics, or Traces).

See Also:

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

getDestinationConfiguration

@Stability(Stable)
@Nullable
default Object getDestinationConfiguration()

Configuration specifying where and how the telemetry data should be delivered.

Returns union: either IResolvable or CfnTelemetryRule.TelemetryDestinationConfigurationProperty

See Also:

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

getSelectionCriteria

@Stability(Stable)
@Nullable
default String getSelectionCriteria()

Criteria for selecting which resources the rule applies to, such as resource tags.

See Also:

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

builder

@Stability(Stable)
static CfnTelemetryRule.TelemetryRuleProperty.Builder builder()

Returns:

a CfnTelemetryRule.TelemetryRuleProperty.Builder of CfnTelemetryRule.TelemetryRuleProperty