Package com.pulumi.aws.cloudwatch

Class Dashboard

  • public class Dashboard
extends com.pulumi.resources.CustomResource
    Provides a CloudWatch Dashboard resource. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.cloudwatch.Dashboard;
 import com.pulumi.aws.cloudwatch.DashboardArgs;
 import static com.pulumi.codegen.internal.Serialization.*;
 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 main = new Dashboard("main", DashboardArgs.builder()
             .dashboardName("my-dashboard")
             .dashboardBody(serializeJson(
                 jsonObject(
                     jsonProperty("widgets", jsonArray(
                         jsonObject(
                             jsonProperty("type", "metric"),
                             jsonProperty("x", 0),
                             jsonProperty("y", 0),
                             jsonProperty("width", 12),
                             jsonProperty("height", 6),
                             jsonProperty("properties", jsonObject(
                                 jsonProperty("metrics", jsonArray(jsonArray(
                                     "AWS/EC2", 
                                     "CPUUtilization", 
                                     "InstanceId", 
                                     "i-012345"
                                 ))),
                                 jsonProperty("period", 300),
                                 jsonProperty("stat", "Average"),
                                 jsonProperty("region", "us-east-1"),
                                 jsonProperty("title", "EC2 Instance CPU")
                             ))
                         ), 
                         jsonObject(
                             jsonProperty("type", "text"),
                             jsonProperty("x", 0),
                             jsonProperty("y", 7),
                             jsonProperty("width", 3),
                             jsonProperty("height", 3),
                             jsonProperty("properties", jsonObject(
                                 jsonProperty("markdown", "Hello world")
                             ))
                         )
                     ))
                 )))
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `dashboardName` (String) Name of the dashboard. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import Dashboards using `dashboardName`. For example: ```sh $ pulumi import aws:cloudwatch/dashboard:Dashboard example example-dashboard ```

    • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      Dashboard​(java.lang.String name)  
      Dashboard​(java.lang.String name, DashboardArgs args)  
      Dashboard​(java.lang.String name, DashboardArgs 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.lang.String> dashboardArn()  
      com.pulumi.core.Output<java.lang.String> dashboardBody()  
      com.pulumi.core.Output<java.lang.String> dashboardName()  
      static Dashboard get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, DashboardState 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()  

      • 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

      • Dashboard

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

      • Dashboard

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

      • Dashboard

        public Dashboard​(java.lang.String name,
                 DashboardArgs 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

      • dashboardArn

        public com.pulumi.core.Output<java.lang.String> dashboardArn()
        Returns:
        ARN of the dashboard.

      • dashboardBody

        public com.pulumi.core.Output<java.lang.String> dashboardBody()
        Returns:
        The detailed information about the dashboard, including what widgets are included and their location on the dashboard. You can read more about the body structure in the [documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html).

      • dashboardName

        public com.pulumi.core.Output<java.lang.String> dashboardName()
        Returns:
        The name of the dashboard.

      • 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.

      • get

        public static Dashboard get​(java.lang.String name,
                            com.pulumi.core.Output<java.lang.String> id,
                            @Nullable
                            DashboardState 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.