Class TelemetryEvaluation


  • public class TelemetryEvaluation
    extends com.pulumi.resources.CustomResource
    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](https://docs.aws.amazon.com/cloudwatch/latest/observabilityadmin/what-is-observabilityadmin.html). > **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
     
     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");
     
         }
     }
     
     
    ### All Regions
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.observabilityadmin.TelemetryEvaluation;
     import com.pulumi.aws.observabilityadmin.TelemetryEvaluationArgs;
     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", TelemetryEvaluationArgs.builder()
                 .allRegions(true)
                 .build());
     
         }
     }
     
     
    ### Specific Regions
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.observabilityadmin.TelemetryEvaluation;
     import com.pulumi.aws.observabilityadmin.TelemetryEvaluationArgs;
     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", TelemetryEvaluationArgs.builder()
                 .regions(            
                     "us-east-1",
                     "eu-west-1")
                 .build());
     
         }
     }
     
     
    ## 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: ```sh $ pulumi import aws:observabilityadmin/telemetryEvaluation:TelemetryEvaluation example us-west-2 ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> allRegions()  
      com.pulumi.core.Output<java.lang.String> failureReason()  
      static TelemetryEvaluation get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, TelemetryEvaluationState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> regions()  
      com.pulumi.core.Output<java.lang.String> status()  
      com.pulumi.core.Output<java.util.Optional<TelemetryEvaluationTimeouts>> timeouts()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • TelemetryEvaluation

        public TelemetryEvaluation​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • TelemetryEvaluation

        public TelemetryEvaluation​(java.lang.String name,
                                   @Nullable
                                   TelemetryEvaluationArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • TelemetryEvaluation

        public TelemetryEvaluation​(java.lang.String name,
                                   @Nullable
                                   TelemetryEvaluationArgs args,
                                   @Nullable
                                   com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • allRegions

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> allRegions()
        Returns:
        Whether to start telemetry evaluation in all AWS Regions where CloudWatch Observability Admin is available. The current region becomes the home region. Mutually exclusive with `regions`.
      • failureReason

        public com.pulumi.core.Output<java.lang.String> failureReason()
        Returns:
        Reason for the failure status. Only populated if `status` is `FAILED_START` or `FAILED_STOP`.
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
      • regions

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> regions()
        Returns:
        List of AWS Regions to include in multi-region telemetry evaluation. The current region is always implicitly included. Mutually exclusive with `allRegions`.
      • status

        public com.pulumi.core.Output<java.lang.String> status()
        Returns:
        Onboarding status of the telemetry config feature. Valid values: `NOT_STARTED`, `STARTING`, `FAILED_START`, `RUNNING`, `STOPPING`, `FAILED_STOP`, `STOPPED`.
      • get

        public static TelemetryEvaluation get​(java.lang.String name,
                                              com.pulumi.core.Output<java.lang.String> id,
                                              @Nullable
                                              TelemetryEvaluationState state,
                                              @Nullable
                                              com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.