Class TelemetryEvaluationForOrganization
- java.lang.Object
-
- com.pulumi.resources.Resource
-
- com.pulumi.resources.CustomResource
-
- com.pulumi.aws.observabilityadmin.TelemetryEvaluationForOrganization
-
public class TelemetryEvaluationForOrganization extends com.pulumi.resources.CustomResourceManages 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](https://docs.aws.amazon.com/cloudwatch/latest/observabilityadmin/what-is-observabilityadmin.html). > **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)
### All Regionspackage 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"); } }
### Specific Regionspackage 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()); } }
## 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: ```sh $ pulumi import aws:observabilityadmin/telemetryEvaluationForOrganization:TelemetryEvaluationForOrganization example us-west-2 ```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()); } }
-
-
Constructor Summary
Constructors Constructor Description TelemetryEvaluationForOrganization(java.lang.String name)TelemetryEvaluationForOrganization(java.lang.String name, TelemetryEvaluationForOrganizationArgs args)TelemetryEvaluationForOrganization(java.lang.String name, TelemetryEvaluationForOrganizationArgs args, com.pulumi.resources.CustomResourceOptions options)
-
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 TelemetryEvaluationForOrganizationget(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, TelemetryEvaluationForOrganizationState 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>homeRegion()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<TelemetryEvaluationForOrganizationTimeouts>>timeouts()
-
-
-
Constructor Detail
-
TelemetryEvaluationForOrganization
public TelemetryEvaluationForOrganization(java.lang.String name)
- Parameters:
name- The _unique_ name of the resulting resource.
-
TelemetryEvaluationForOrganization
public TelemetryEvaluationForOrganization(java.lang.String name, @Nullable TelemetryEvaluationForOrganizationArgs args)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.
-
TelemetryEvaluationForOrganization
public TelemetryEvaluationForOrganization(java.lang.String name, @Nullable TelemetryEvaluationForOrganizationArgs 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`.
-
homeRegion
public com.pulumi.core.Output<java.lang.String> homeRegion()
- Returns:
- AWS Region designated as the home region for multi-region telemetry evaluation. Only present when multi-region evaluation is active.
-
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 for the organization. Valid values: `NOT_STARTED`, `STARTING`, `FAILED_START`, `RUNNING`, `STOPPING`, `FAILED_STOP`, `STOPPED`.
-
timeouts
public com.pulumi.core.Output<java.util.Optional<TelemetryEvaluationForOrganizationTimeouts>> timeouts()
-
get
public static TelemetryEvaluationForOrganization get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, @Nullable TelemetryEvaluationForOrganizationState 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.
-
-