Package software.amazon.awscdk.services.logs

Interface CfnQueryDefinitionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnQueryDefinitionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:09.581Z")
@Stability(Stable)
public interface CfnQueryDefinitionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnQueryDefinition.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.logs.*;
 CfnQueryDefinitionProps cfnQueryDefinitionProps = CfnQueryDefinitionProps.builder()
         .name("name")
         .queryString("queryString")
         // the properties below are optional
         .logGroupNames(List.of("logGroupNames"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnQueryDefinitionProps.Builder	A builder for CfnQueryDefinitionProps
static final class	CfnQueryDefinitionProps.Jsii$Proxy	An implementation for CfnQueryDefinitionProps

Method Summary

Modifier and Type	Method	Description
static CfnQueryDefinitionProps.Builder	builder()
default List<String>	getLogGroupNames()	Use this parameter if you want the query to query only certain log groups.
String	getName()	A name for the query definition.
String	getQueryString()	The query string to use for this query definition.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

A name for the query definition.

You can use the name to create a folder structure for your queries. To create a folder, use a forward slash (/) to prefix your desired query name with your desired folder name. For example, / *folder-name* / *query-name* .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-name

getQueryString

@Stability(Stable)
@NotNull
String getQueryString()

The query string to use for this query definition.

For more information, see CloudWatch Logs Insights Query Syntax .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-querystring

getLogGroupNames

@Stability(Stable)
@Nullable
default List<String> getLogGroupNames()

Use this parameter if you want the query to query only certain log groups.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html#cfn-logs-querydefinition-loggroupnames

builder

@Stability(Stable)
static CfnQueryDefinitionProps.Builder builder()

Returns:

a CfnQueryDefinitionProps.Builder of CfnQueryDefinitionProps