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

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
pulumi/pulumi-aws-native

aws-native.observabilityadmin.TelemetryRule

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

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

    Create TelemetryRule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new TelemetryRule(name: string, args: TelemetryRuleArgs, opts?: CustomResourceOptions);
    @overload
def TelemetryRule(resource_name: str,
                  args: TelemetryRuleInitArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def TelemetryRule(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  rule: Optional[TelemetryRuleArgs] = None,
                  rule_name: Optional[str] = None,
                  tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewTelemetryRule(ctx *Context, name string, args TelemetryRuleArgs, opts ...ResourceOption) (*TelemetryRule, error)
    public TelemetryRule(string name, TelemetryRuleArgs args, CustomResourceOptions? opts = null)
    public TelemetryRule(String name, TelemetryRuleArgs args)
public TelemetryRule(String name, TelemetryRuleArgs args, CustomResourceOptions options)

    type: aws-native:observabilityadmin:TelemetryRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args TelemetryRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TelemetryRuleInitArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TelemetryRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TelemetryRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TelemetryRuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    TelemetryRule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The TelemetryRule resource accepts the following input properties:

    Rule Pulumi.AwsNative.ObservabilityAdmin.Inputs.TelemetryRule
    Retrieves the details of a specific telemetry rule in your account.
    RuleName string
    The name of the telemetry rule
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource
    Rule TelemetryRuleTypeArgs
    Retrieves the details of a specific telemetry rule in your account.
    RuleName string
    The name of the telemetry rule
    Tags TagArgs
    An array of key-value pairs to apply to this resource
    rule TelemetryRule
    Retrieves the details of a specific telemetry rule in your account.
    ruleName String
    The name 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.
    ruleName string
    The name of the telemetry rule
    tags Tag[]
    An array of key-value pairs to apply to this resource
    rule TelemetryRuleArgs
    Retrieves the details of a specific telemetry rule in your account.
    rule_name str
    The name of the telemetry rule
    tags Sequence[TagArgs]
    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.
    ruleName String
    The name of the telemetry rule
    tags List<Property Map>
    An array of key-value pairs to apply to this resource

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TelemetryRule resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    RuleArn string
    The arn of the telemetry rule
    Id string
    The provider-assigned unique ID for this managed resource.
    RuleArn string
    The arn of the telemetry rule
    id String
    The provider-assigned unique ID for this managed resource.
    ruleArn String
    The arn of the telemetry rule
    id string
    The provider-assigned unique ID for this managed resource.
    ruleArn string
    The arn of the telemetry rule
    id str
    The provider-assigned unique ID for this managed resource.
    rule_arn str
    The arn of the telemetry rule
    id String
    The provider-assigned unique ID for this managed resource.
    ruleArn String
    The arn of the telemetry rule

    Supporting Types

    Tag, TagArgs

    A set of tags to apply to the resource.
    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, TelemetryRuleArgs

    The telemetry rule
    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, TelemetryRuleDestinationTypeArgs

    CloudWatchLogs
    cloud-watch-logs
    TelemetryRuleDestinationTypeCloudWatchLogs
    cloud-watch-logs
    CloudWatchLogs
    cloud-watch-logs
    CloudWatchLogs
    cloud-watch-logs
    CLOUD_WATCH_LOGS
    cloud-watch-logs
    "cloud-watch-logs"
    cloud-watch-logs

    TelemetryRuleResourceType, TelemetryRuleResourceTypeArgs

    Awsec2vpc
    AWS::EC2::VPC
    TelemetryRuleResourceTypeAwsec2vpc
    AWS::EC2::VPC
    Awsec2vpc
    AWS::EC2::VPC
    Awsec2vpc
    AWS::EC2::VPC
    AWSEC2VPC
    AWS::EC2::VPC
    "AWS::EC2::VPC"
    AWS::EC2::VPC

    TelemetryRuleTelemetryDestinationConfiguration, TelemetryRuleTelemetryDestinationConfigurationArgs

    The destination configuration for telemetry data
    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, TelemetryRuleTelemetryTypeArgs

    Logs
    Logs
    TelemetryRuleTelemetryTypeLogs
    Logs
    Logs
    Logs
    Logs
    Logs
    LOGS
    Logs
    "Logs"
    Logs

    TelemetryRuleVpcFlowLogParameters, TelemetryRuleVpcFlowLogParametersArgs

    Telemetry parameters for VPC Flow logs
    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
    pulumi/pulumi-aws-native
      Meet Neo: Your AI Platform Teammate