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

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

aws-native.observabilityadmin.getOrganizationTelemetryRule

Start a Neo task
Explain and create an aws-native.observabilityadmin.getOrganizationTelemetryRule resource
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

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

    Using getOrganizationTelemetryRule

    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 getOrganizationTelemetryRule(args: GetOrganizationTelemetryRuleArgs, opts?: InvokeOptions): Promise<GetOrganizationTelemetryRuleResult>
    function getOrganizationTelemetryRuleOutput(args: GetOrganizationTelemetryRuleOutputArgs, opts?: InvokeOptions): Output<GetOrganizationTelemetryRuleResult>
    def get_organization_telemetry_rule(rule_arn: Optional[str] = None,
                                        opts: Optional[InvokeOptions] = None) -> GetOrganizationTelemetryRuleResult
    def get_organization_telemetry_rule_output(rule_arn: Optional[pulumi.Input[str]] = None,
                                        opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationTelemetryRuleResult]
    func LookupOrganizationTelemetryRule(ctx *Context, args *LookupOrganizationTelemetryRuleArgs, opts ...InvokeOption) (*LookupOrganizationTelemetryRuleResult, error)
    func LookupOrganizationTelemetryRuleOutput(ctx *Context, args *LookupOrganizationTelemetryRuleOutputArgs, opts ...InvokeOption) LookupOrganizationTelemetryRuleResultOutput

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

    public static class GetOrganizationTelemetryRule 
    {
        public static Task<GetOrganizationTelemetryRuleResult> InvokeAsync(GetOrganizationTelemetryRuleArgs args, InvokeOptions? opts = null)
        public static Output<GetOrganizationTelemetryRuleResult> Invoke(GetOrganizationTelemetryRuleInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetOrganizationTelemetryRuleResult> getOrganizationTelemetryRule(GetOrganizationTelemetryRuleArgs args, InvokeOptions options)
    public static Output<GetOrganizationTelemetryRuleResult> getOrganizationTelemetryRule(GetOrganizationTelemetryRuleArgs args, InvokeOptions options)
    
    fn::invoke:
      function: aws-native:observabilityadmin:getOrganizationTelemetryRule
      arguments:
        # arguments dictionary

    The following arguments are supported:

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

    getOrganizationTelemetryRule Result

    The following output properties are available:

    Rule Pulumi.AwsNative.ObservabilityAdmin.Outputs.OrganizationTelemetryRuleTelemetryRule
    The name of the organization telemetry rule.
    RuleArn string
    The arn of the organization telemetry rule
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource
    Rule OrganizationTelemetryRuleTelemetryRule
    The name of the organization telemetry rule.
    RuleArn string
    The arn of the organization telemetry rule
    Tags Tag
    An array of key-value pairs to apply to this resource
    rule OrganizationTelemetryRuleTelemetryRule
    The name of the organization telemetry rule.
    ruleArn String
    The arn of the organization telemetry rule
    tags List<Tag>
    An array of key-value pairs to apply to this resource
    rule OrganizationTelemetryRuleTelemetryRule
    The name of the organization telemetry rule.
    ruleArn string
    The arn of the organization telemetry rule
    tags Tag[]
    An array of key-value pairs to apply to this resource
    rule OrganizationTelemetryRuleTelemetryRule
    The name of the organization telemetry rule.
    rule_arn str
    The arn of the organization telemetry rule
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource
    rule Property Map
    The name of the organization telemetry rule.
    ruleArn String
    The arn of the organization telemetry rule
    tags List<Property Map>
    An array of key-value pairs to apply to this resource

    Supporting Types

    OrganizationTelemetryRuleDestinationType

    OrganizationTelemetryRuleResourceType

    OrganizationTelemetryRuleTelemetryDestinationConfiguration

    DestinationPattern string
    The pattern used to generate the destination path or name, supporting macros like and .
    DestinationType Pulumi.AwsNative.ObservabilityAdmin.OrganizationTelemetryRuleDestinationType
    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.OrganizationTelemetryRuleVpcFlowLogParameters
    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 OrganizationTelemetryRuleDestinationType
    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 OrganizationTelemetryRuleVpcFlowLogParameters
    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 OrganizationTelemetryRuleDestinationType
    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 OrganizationTelemetryRuleVpcFlowLogParameters
    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 OrganizationTelemetryRuleDestinationType
    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 OrganizationTelemetryRuleVpcFlowLogParameters
    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 OrganizationTelemetryRuleDestinationType
    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 OrganizationTelemetryRuleVpcFlowLogParameters
    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.

    OrganizationTelemetryRuleTelemetryRule

    ResourceType Pulumi.AwsNative.ObservabilityAdmin.OrganizationTelemetryRuleResourceType
    The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC").
    TelemetryType Pulumi.AwsNative.ObservabilityAdmin.OrganizationTelemetryRuleTelemetryType
    The type of telemetry to collect (Logs, Metrics, or Traces).
    DestinationConfiguration Pulumi.AwsNative.ObservabilityAdmin.Inputs.OrganizationTelemetryRuleTelemetryDestinationConfiguration
    Configuration specifying where and how the telemetry data should be delivered.
    Scope string
    The organizational scope to which the rule applies, specified using accounts or organizational units.
    SelectionCriteria string
    Criteria for selecting which resources the rule applies to, such as resource tags.
    ResourceType OrganizationTelemetryRuleResourceType
    The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC").
    TelemetryType OrganizationTelemetryRuleTelemetryType
    The type of telemetry to collect (Logs, Metrics, or Traces).
    DestinationConfiguration OrganizationTelemetryRuleTelemetryDestinationConfiguration
    Configuration specifying where and how the telemetry data should be delivered.
    Scope string
    The organizational scope to which the rule applies, specified using accounts or organizational units.
    SelectionCriteria string
    Criteria for selecting which resources the rule applies to, such as resource tags.
    resourceType OrganizationTelemetryRuleResourceType
    The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC").
    telemetryType OrganizationTelemetryRuleTelemetryType
    The type of telemetry to collect (Logs, Metrics, or Traces).
    destinationConfiguration OrganizationTelemetryRuleTelemetryDestinationConfiguration
    Configuration specifying where and how the telemetry data should be delivered.
    scope String
    The organizational scope to which the rule applies, specified using accounts or organizational units.
    selectionCriteria String
    Criteria for selecting which resources the rule applies to, such as resource tags.
    resourceType OrganizationTelemetryRuleResourceType
    The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC").
    telemetryType OrganizationTelemetryRuleTelemetryType
    The type of telemetry to collect (Logs, Metrics, or Traces).
    destinationConfiguration OrganizationTelemetryRuleTelemetryDestinationConfiguration
    Configuration specifying where and how the telemetry data should be delivered.
    scope string
    The organizational scope to which the rule applies, specified using accounts or organizational units.
    selectionCriteria string
    Criteria for selecting which resources the rule applies to, such as resource tags.
    resource_type OrganizationTelemetryRuleResourceType
    The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC").
    telemetry_type OrganizationTelemetryRuleTelemetryType
    The type of telemetry to collect (Logs, Metrics, or Traces).
    destination_configuration OrganizationTelemetryRuleTelemetryDestinationConfiguration
    Configuration specifying where and how the telemetry data should be delivered.
    scope str
    The organizational scope to which the rule applies, specified using accounts or organizational units.
    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.
    scope String
    The organizational scope to which the rule applies, specified using accounts or organizational units.
    selectionCriteria String
    Criteria for selecting which resources the rule applies to, such as resource tags.

    OrganizationTelemetryRuleTelemetryType

    OrganizationTelemetryRuleVpcFlowLogParameters

    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

    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

    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
      Meet Neo: Your AI Platform Teammate