TelemetryRule ¶

class TelemetryRule(TypedDict, closed=True):
    resource_type: NotRequired[
        "capo_observabilityadmin.types.resource_type.ResourceType"
    ]
    """<p> The type of Amazon Web Services resource to configure telemetry for (for example, <code>AWS::EC2::VPC</code>, <code>AWS::EKS::Cluster</code>, <code>AWS::ElasticLoadBalancingV2::LoadBalancer</code>, <code>AWS::Bedrock::KnowledgeBase</code>, or <code>AWS::BedrockAgentCore::PaymentManager</code>). </p>"""
    telemetry_type: "capo_observabilityadmin.types.telemetry_type.TelemetryType"
    """<p> The type of telemetry to collect (Logs, Metrics, or Traces). </p>"""
    telemetry_source_types: NotRequired[
        "capo_observabilityadmin.types.telemetry_source_types.TelemetrySourceTypes"
    ]
    """<p> 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. </p>"""
    destination_configuration: NotRequired[
        "capo_observabilityadmin.types.telemetry_destination_configuration.TelemetryDestinationConfiguration"
    ]
    """<p> Configuration specifying where and how the telemetry data should be delivered. </p>"""
    scope: NotRequired["str"]
    """<p> The organizational scope to which the rule applies, specified using accounts or organizational units. </p>"""
    selection_criteria: NotRequired["str"]
    """<p> Criteria for selecting which resources the rule applies to, such as resource tags. </p>"""
    allow_field_updates: NotRequired["bool"]
    """<p> If set to <code>true</code>, Amazon CloudWatch Observability Admin detects and remediates configuration drift in telemetry resources that it manages. For example, if a VPC flow log's format, traffic type, or aggregation interval no longer matches the rule's destination configuration, the flow log is replaced with one that matches. Only Observability Admin-managed resources are updated; customer-created resources are never modified. Currently supported for <code>AWS::EC2::VPC</code> resources (VPC flow logs). </p>"""
    regions: NotRequired["capo_observabilityadmin.types.regions.Regions"]
    """<p> 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 <code>AllRegions</code>. </p>"""
    all_regions: NotRequired["capo_observabilityadmin.types.all_regions.AllRegions"]
    """<p> If set to <code>true</code>, 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 <code>Regions</code>. </p>"""