observabilityadmin/aws.sdk.kotlin.services.observabilityadmin.model/TelemetryRule

TelemetryRule

class TelemetryRule

Defines how telemetry should be configured for specific Amazon Web Services resources.

Types

Builder

class Builder

Companion

object Companion

Properties

allRegions

val allRegions: Boolean?

If set to true, the telemetry rule is replicated to all Amazon Web Services Regions where Amazon CloudWatch Observability Admin is available in the current partition. When new regions become available, the rule automatically replicates to them. Mutually exclusive with Regions.

destinationConfiguration

val destinationConfiguration: TelemetryDestinationConfiguration?

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

regions

val regions: List<String>?

An optional list of Amazon Web Services Regions where this telemetry rule should be replicated. When specified, the rule is created in the home region and automatically replicated to all listed regions. Mutually exclusive with AllRegions.

resourceType

val resourceType: ResourceType?

The type of Amazon Web Services resource to configure telemetry for (e.g., "AWS::EC2::VPC", "AWS::EKS::Cluster", "AWS::WAFv2::WebACL").

scope

val scope: String?

The organizational scope to which the rule applies, specified using accounts or organizational units.

selectionCriteria

val selectionCriteria: String?

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

telemetrySourceTypes

val telemetrySourceTypes: List<TelemetrySourceType>?

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.

telemetryType

val telemetryType: TelemetryType

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

Functions

copy

inline fun copy(block: TelemetryRule.Builder.() -> Unit = {}): TelemetryRule

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String