TelemetryEvaluation class

Manages an AWS CloudWatch Observability Admin Telemetry Evaluation.

Telemetry evaluation begins onboarding the caller AWS account to the telemetry config feature, enabling CloudWatch to evaluate and discover the state of telemetry configuration for your AWS resources.

For more information, see the AWS CloudWatch Observability Admin documentation.

> NOTE: Only one telemetry evaluation can exist per account per region. Creating this resource enables the feature; destroying it disables the feature.

> NOTE: Do not use this resource in an account where telemetry evaluation is centrally managed by an AWS Organization via aws.observabilityadmin.TelemetryEvaluationForOrganization. In that case, the per-account StartTelemetryEvaluation API silently returns success without changing per-account state, and GetTelemetryEvaluationStatus reports the org-derived RUNNING status — so pulumi up appears to succeed. However, the matching StopTelemetryEvaluation call is rejected with ValidationException: Telemetry evaluation is managed by the caller's organization, so a later terraform destroy will fail and leave the resource in state. Use the organization variant from the management account instead.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.observabilityadmin.TelemetryEvaluation("example", {});
import pulumi
import pulumi_aws as aws

example = aws.observabilityadmin.TelemetryEvaluation("example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Observabilityadmin.TelemetryEvaluation("example");

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/observabilityadmin"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := observabilityadmin.NewTelemetryEvaluation(ctx, "example", nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_observabilityadmin_telemetryevaluation" "example" {
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.observabilityadmin.TelemetryEvaluation;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new TelemetryEvaluation("example");

    }
}
resources:
  example:
    type: aws:observabilityadmin:TelemetryEvaluation

Import

Identity Schema

Optional

  • accountId (String) AWS Account where this resource is managed.
  • region (String) Region where this resource is managed.

Using pulumi import, import CloudWatch Observability Admin Telemetry Evaluation using the region name. For example:

$ pulumi import aws:observabilityadmin/telemetryEvaluation:TelemetryEvaluation example us-west-2

Constructors

TelemetryEvaluation(String name, {TelemetryEvaluationArgs? args, CustomResourceOptions? options})
Creates a new TelemetryEvaluation. name The Pulumi resource name. args Arguments used to configure this TelemetryEvaluation. The set of arguments for TelemetryEvaluation. options Resource options controlling this resource's behavior.
TelemetryEvaluation.reference(String urn)
Creates a typed reference to an existing TelemetryEvaluation resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
failureReason ↔ Output<String>
Reason for the failure status. Only populated if status is FAILED_START or FAILED_STOP.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
status ↔ Output<String>
Onboarding status of the telemetry config feature. Valid values: NOT_STARTED, STARTING, FAILED_START, RUNNING, STOPPING, FAILED_STOP, STOPPED.
latefinal
timeouts ↔ Output<TelemetryEvaluationTimeouts?>
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {TelemetryEvaluationState? state, CustomResourceOptions? options}) → TelemetryEvaluation
Gets an existing TelemetryEvaluation resource's state with the given name and id.