TelemetryEvaluationForOrganization class

Manages an AWS CloudWatch Observability Admin Telemetry Evaluation For Organization.

Telemetry evaluation for organization begins onboarding the organization and all member accounts to the telemetry config feature, enabling CloudWatch to evaluate and discover the state of telemetry configuration for AWS resources across the organization.

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

> NOTE: This resource can only be used from the management account or a delegated admin account of an AWS Organization. Only one telemetry evaluation for organization can exist per organization. Creating this resource enables the feature; destroying it disables the feature.

Example Usage

Basic Usage (Current Region Only)

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

const example = new aws.observabilityadmin.TelemetryEvaluationForOrganization("example", {});

import pulumi
import pulumi_aws as aws

example = aws.observabilityadmin.TelemetryEvaluationForOrganization("example")

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Observabilityadmin.TelemetryEvaluationForOrganization("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.NewTelemetryEvaluationForOrganization(ctx, "example", nil)
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_observabilityadmin_telemetryevaluationfororganization" "example" {
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.observabilityadmin.TelemetryEvaluationForOrganization;
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 TelemetryEvaluationForOrganization("example");

    }
}

resources:
  example:
    type: aws:observabilityadmin:TelemetryEvaluationForOrganization

All Regions

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

const example = new aws.observabilityadmin.TelemetryEvaluationForOrganization("example", {allRegions: true});

import pulumi
import pulumi_aws as aws

example = aws.observabilityadmin.TelemetryEvaluationForOrganization("example", all_regions=True)

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Observabilityadmin.TelemetryEvaluationForOrganization("example", new()
    {
        AllRegions = true,
    });

});

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.NewTelemetryEvaluationForOrganization(ctx, "example", &observabilityadmin.TelemetryEvaluationForOrganizationArgs{
			AllRegions: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_observabilityadmin_telemetryevaluationfororganization" "example" {
  all_regions = true
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.observabilityadmin.TelemetryEvaluationForOrganization;
import com.pulumi.aws.observabilityadmin.TelemetryEvaluationForOrganizationArgs;
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 TelemetryEvaluationForOrganization("example", TelemetryEvaluationForOrganizationArgs.builder()
            .allRegions(true)
            .build());

    }
}

resources:
  example:
    type: aws:observabilityadmin:TelemetryEvaluationForOrganization
    properties:
      allRegions: true

Specific Regions

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

const example = new aws.observabilityadmin.TelemetryEvaluationForOrganization("example", {regions: [
    "us-east-1",
    "eu-west-1",
]});

import pulumi
import pulumi_aws as aws

example = aws.observabilityadmin.TelemetryEvaluationForOrganization("example", regions=[
    "us-east-1",
    "eu-west-1",
])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Observabilityadmin.TelemetryEvaluationForOrganization("example", new()
    {
        Regions = new[]
        {
            "us-east-1",
            "eu-west-1",
        },
    });

});

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.NewTelemetryEvaluationForOrganization(ctx, "example", &observabilityadmin.TelemetryEvaluationForOrganizationArgs{
			Regions: pulumi.StringArray{
				pulumi.String("us-east-1"),
				pulumi.String("eu-west-1"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_observabilityadmin_telemetryevaluationfororganization" "example" {
  regions = ["us-east-1", "eu-west-1"]
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.observabilityadmin.TelemetryEvaluationForOrganization;
import com.pulumi.aws.observabilityadmin.TelemetryEvaluationForOrganizationArgs;
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 TelemetryEvaluationForOrganization("example", TelemetryEvaluationForOrganizationArgs.builder()
            .regions(
                "us-east-1",
                "eu-west-1")
            .build());

    }
}

resources:
  example:
    type: aws:observabilityadmin:TelemetryEvaluationForOrganization
    properties:
      regions:
        - us-east-1
        - eu-west-1

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 For Organization using the region name. For example:

$ pulumi import aws:observabilityadmin/telemetryEvaluationForOrganization:TelemetryEvaluationForOrganization example us-west-2

Constructors

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

Properties

allRegions ↔ Output<bool?>: 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.
latefinal
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
homeRegion ↔ Output<String>: AWS Region designated as the home region for multi-region telemetry evaluation. Only present when multi-region evaluation is active.
latefinal
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
regions ↔ Output<List<String>?>: List of AWS Regions to include in multi-region telemetry evaluation. The current region is always implicitly included. Mutually exclusive with allRegions.
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 for the organization. Valid values: NOT_STARTED, STARTING, FAILED_START, RUNNING, STOPPING, FAILED_STOP, STOPPED.
latefinal
timeouts ↔ Output<TelemetryEvaluationForOrganizationTimeouts?>: 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, {TelemetryEvaluationForOrganizationState? state, CustomResourceOptions? options}) → TelemetryEvaluationForOrganization: Gets an existing TelemetryEvaluationForOrganization resource's state with the given name and id.