Package com.pulumi.aws.cloudwatch

Class QueryDefinition

  • public class QueryDefinition
extends com.pulumi.resources.CustomResource
    Provides a CloudWatch Logs query definition resource. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.cloudwatch.QueryDefinition;
 import com.pulumi.aws.cloudwatch.QueryDefinitionArgs;
 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 QueryDefinition("example", QueryDefinitionArgs.builder()
             .name("custom_query")
             .logGroupNames(            
                 "/aws/logGroup1",
                 "/aws/logGroup2")
             .queryString("""
 fields @timestamp, @message
 | sort @timestamp desc
 | limit 25
             """)
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `queryDefinitionId` (String) ID of the query definition. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import Query Definitions using `arn`. The ARN can be found on the "Edit Query" page for the query in the AWS Console. For example: ```sh $ pulumi import aws:cloudwatch/queryDefinition:QueryDefinition example arn:aws:logs:us-west-2:123456789012:query-definition:269951d7-6f75-496d-9d7b-6b7a5486bdbd ```

    • 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.lang.String> arn()  
      static QueryDefinition get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, QueryDefinitionState 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.util.Optional<java.util.List<java.lang.String>>> logGroupNames()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> queryDefinitionId()  
      com.pulumi.core.Output<java.lang.String> queryString()  
      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

      • QueryDefinition

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

      • QueryDefinition

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

      • QueryDefinition

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

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        The query definition ARN.

      • logGroupNames

        public com.pulumi.core.Output<java.util.Optional<java.util.List<java.lang.String>>> logGroupNames()
        Returns:
        Specific log groups to use with the query.

      • name

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

      • queryDefinitionId

        public com.pulumi.core.Output<java.lang.String> queryDefinitionId()
        Returns:
        The query definition ID.

      • queryString

        public com.pulumi.core.Output<java.lang.String> queryString()
        Returns:
        The query to save. You can read more about CloudWatch Logs Query Syntax in the [documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html).

      • 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 QueryDefinition get​(java.lang.String name,
                                  com.pulumi.core.Output<java.lang.String> id,
                                  @Nullable
                                  QueryDefinitionState 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.