1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. observabilityadmin
  5. getTelemetryRule

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.38.0 published on Wednesday, Nov 5, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.observabilityadmin.getTelemetryRule

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.38.0 published on Wednesday, Nov 5, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    The AWS::ObservabilityAdmin::TelemetryRule resource defines a CloudWatch Observability Admin Telemetry Rule.

    Using getTelemetryRule

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getTelemetryRule(args: GetTelemetryRuleArgs, opts?: InvokeOptions): Promise<GetTelemetryRuleResult>
function getTelemetryRuleOutput(args: GetTelemetryRuleOutputArgs, opts?: InvokeOptions): Output<GetTelemetryRuleResult>
    def get_telemetry_rule(rule_arn: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetTelemetryRuleResult
def get_telemetry_rule_output(rule_arn: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetTelemetryRuleResult]
    func LookupTelemetryRule(ctx *Context, args *LookupTelemetryRuleArgs, opts ...InvokeOption) (*LookupTelemetryRuleResult, error)
func LookupTelemetryRuleOutput(ctx *Context, args *LookupTelemetryRuleOutputArgs, opts ...InvokeOption) LookupTelemetryRuleResultOutput

    > Note: This function is named LookupTelemetryRule in the Go SDK.

    public static class GetTelemetryRule 
{
    public static Task<GetTelemetryRuleResult> InvokeAsync(GetTelemetryRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetTelemetryRuleResult> Invoke(GetTelemetryRuleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetTelemetryRuleResult> getTelemetryRule(GetTelemetryRuleArgs args, InvokeOptions options)
public static Output<GetTelemetryRuleResult> getTelemetryRule(GetTelemetryRuleArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:observabilityadmin:getTelemetryRule
  arguments:
    # arguments dictionary

    The following arguments are supported:

    RuleArn string
    The arn of the telemetry rule
    RuleArn string
    The arn of the telemetry rule
    ruleArn String
    The arn of the telemetry rule
    ruleArn string
    The arn of the telemetry rule
    rule_arn str
    The arn of the telemetry rule
    ruleArn String
    The arn of the telemetry rule

    getTelemetryRule Result

    The following output properties are available:

    Rule Pulumi.AwsNative.ObservabilityAdmin.Outputs.TelemetryRule
    Retrieves the details of a specific telemetry rule in your account.
    RuleArn string
    The arn of the telemetry rule
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource
    Rule TelemetryRuleType
    Retrieves the details of a specific telemetry rule in your account.
    RuleArn string
    The arn of the telemetry rule
    Tags Tag
    An array of key-value pairs to apply to this resource
    rule TelemetryRule
    Retrieves the details of a specific telemetry rule in your account.
    ruleArn String
    The arn of the telemetry rule
    tags List<Tag>
    An array of key-value pairs to apply to this resource
    rule TelemetryRule
    Retrieves the details of a specific telemetry rule in your account.
    ruleArn string
    The arn of the telemetry rule
    tags Tag[]
    An array of key-value pairs to apply to this resource
    rule TelemetryRule
    Retrieves the details of a specific telemetry rule in your account.
    rule_arn str
    The arn of the telemetry rule
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource
    rule Property Map
    Retrieves the details of a specific telemetry rule in your account.
    ruleArn String
    The arn of the telemetry rule
    tags List<Property Map>
    An array of key-value pairs to apply to this resource

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    TelemetryRule

    ResourceType Pulumi.AwsNative.ObservabilityAdmin.TelemetryRuleResourceType
    The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC").
    TelemetryType Pulumi.AwsNative.ObservabilityAdmin.TelemetryRuleTelemetryType
    The type of telemetry to collect (Logs, Metrics, or Traces).
    DestinationConfiguration Pulumi.AwsNative.ObservabilityAdmin.Inputs.TelemetryRuleTelemetryDestinationConfiguration
    Configuration specifying where and how the telemetry data should be delivered.
    SelectionCriteria string
    Criteria for selecting which resources the rule applies to, such as resource tags.
    ResourceType TelemetryRuleResourceType
    The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC").
    TelemetryType TelemetryRuleTelemetryType
    The type of telemetry to collect (Logs, Metrics, or Traces).
    DestinationConfiguration TelemetryRuleTelemetryDestinationConfiguration
    Configuration specifying where and how the telemetry data should be delivered.
    SelectionCriteria string
    Criteria for selecting which resources the rule applies to, such as resource tags.
    resourceType TelemetryRuleResourceType
    The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC").
    telemetryType TelemetryRuleTelemetryType
    The type of telemetry to collect (Logs, Metrics, or Traces).
    destinationConfiguration TelemetryRuleTelemetryDestinationConfiguration
    Configuration specifying where and how the telemetry data should be delivered.
    selectionCriteria String
    Criteria for selecting which resources the rule applies to, such as resource tags.
    resourceType TelemetryRuleResourceType
    The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC").
    telemetryType TelemetryRuleTelemetryType
    The type of telemetry to collect (Logs, Metrics, or Traces).
    destinationConfiguration TelemetryRuleTelemetryDestinationConfiguration
    Configuration specifying where and how the telemetry data should be delivered.
    selectionCriteria string
    Criteria for selecting which resources the rule applies to, such as resource tags.
    resource_type TelemetryRuleResourceType
    The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC").
    telemetry_type TelemetryRuleTelemetryType
    The type of telemetry to collect (Logs, Metrics, or Traces).
    destination_configuration TelemetryRuleTelemetryDestinationConfiguration
    Configuration specifying where and how the telemetry data should be delivered.
    selection_criteria str
    Criteria for selecting which resources the rule applies to, such as resource tags.
    resourceType "AWS::EC2::VPC"
    The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC").
    telemetryType "Logs"
    The type of telemetry to collect (Logs, Metrics, or Traces).
    destinationConfiguration Property Map
    Configuration specifying where and how the telemetry data should be delivered.
    selectionCriteria String
    Criteria for selecting which resources the rule applies to, such as resource tags.

    TelemetryRuleDestinationType

    TelemetryRuleResourceType

    TelemetryRuleTelemetryDestinationConfiguration

    DestinationPattern string
    The pattern used to generate the destination path or name, supporting macros like and .
    DestinationType Pulumi.AwsNative.ObservabilityAdmin.TelemetryRuleDestinationType
    The type of destination for the telemetry data (e.g., "Amazon CloudWatch Logs", "S3").
    RetentionInDays int
    The number of days to retain the telemetry data in the destination.
    VpcFlowLogParameters Pulumi.AwsNative.ObservabilityAdmin.Inputs.TelemetryRuleVpcFlowLogParameters
    Configuration parameters specific to VPC Flow Logs when VPC is the resource type.
    DestinationPattern string
    The pattern used to generate the destination path or name, supporting macros like and .
    DestinationType TelemetryRuleDestinationType
    The type of destination for the telemetry data (e.g., "Amazon CloudWatch Logs", "S3").
    RetentionInDays int
    The number of days to retain the telemetry data in the destination.
    VpcFlowLogParameters TelemetryRuleVpcFlowLogParameters
    Configuration parameters specific to VPC Flow Logs when VPC is the resource type.
    destinationPattern String
    The pattern used to generate the destination path or name, supporting macros like and .
    destinationType TelemetryRuleDestinationType
    The type of destination for the telemetry data (e.g., "Amazon CloudWatch Logs", "S3").
    retentionInDays Integer
    The number of days to retain the telemetry data in the destination.
    vpcFlowLogParameters TelemetryRuleVpcFlowLogParameters
    Configuration parameters specific to VPC Flow Logs when VPC is the resource type.
    destinationPattern string
    The pattern used to generate the destination path or name, supporting macros like and .
    destinationType TelemetryRuleDestinationType
    The type of destination for the telemetry data (e.g., "Amazon CloudWatch Logs", "S3").
    retentionInDays number
    The number of days to retain the telemetry data in the destination.
    vpcFlowLogParameters TelemetryRuleVpcFlowLogParameters
    Configuration parameters specific to VPC Flow Logs when VPC is the resource type.
    destination_pattern str
    The pattern used to generate the destination path or name, supporting macros like and .
    destination_type TelemetryRuleDestinationType
    The type of destination for the telemetry data (e.g., "Amazon CloudWatch Logs", "S3").
    retention_in_days int
    The number of days to retain the telemetry data in the destination.
    vpc_flow_log_parameters TelemetryRuleVpcFlowLogParameters
    Configuration parameters specific to VPC Flow Logs when VPC is the resource type.
    destinationPattern String
    The pattern used to generate the destination path or name, supporting macros like and .
    destinationType "cloud-watch-logs"
    The type of destination for the telemetry data (e.g., "Amazon CloudWatch Logs", "S3").
    retentionInDays Number
    The number of days to retain the telemetry data in the destination.
    vpcFlowLogParameters Property Map
    Configuration parameters specific to VPC Flow Logs when VPC is the resource type.

    TelemetryRuleTelemetryType

    TelemetryRuleVpcFlowLogParameters

    LogFormat string
    The fields to include in the flow log record. If you omit this parameter, the flow log is created using the default format.
    MaxAggregationInterval int
    The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record. Default is 600s.
    TrafficType string
    The type of traffic captured for the flow log. Default is ALL
    LogFormat string
    The fields to include in the flow log record. If you omit this parameter, the flow log is created using the default format.
    MaxAggregationInterval int
    The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record. Default is 600s.
    TrafficType string
    The type of traffic captured for the flow log. Default is ALL
    logFormat String
    The fields to include in the flow log record. If you omit this parameter, the flow log is created using the default format.
    maxAggregationInterval Integer
    The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record. Default is 600s.
    trafficType String
    The type of traffic captured for the flow log. Default is ALL
    logFormat string
    The fields to include in the flow log record. If you omit this parameter, the flow log is created using the default format.
    maxAggregationInterval number
    The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record. Default is 600s.
    trafficType string
    The type of traffic captured for the flow log. Default is ALL
    log_format str
    The fields to include in the flow log record. If you omit this parameter, the flow log is created using the default format.
    max_aggregation_interval int
    The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record. Default is 600s.
    traffic_type str
    The type of traffic captured for the flow log. Default is ALL
    logFormat String
    The fields to include in the flow log record. If you omit this parameter, the flow log is created using the default format.
    maxAggregationInterval Number
    The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record. Default is 600s.
    trafficType String
    The type of traffic captured for the flow log. Default is ALL

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.38.0 published on Wednesday, Nov 5, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native
      Meet Neo: Your AI Platform Teammate