software.amazon.awscdk.services.logs

Class CfnQueryDefinition

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.logs.CfnQueryDefinition

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.700Z")
 @Stability(value=Stable)
public class CfnQueryDefinition
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Logs::QueryDefinition`.

Creates a query definition for CloudWatch Logs Insights. For more information, see Analyzing Log Data with CloudWatch Logs Insights .

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.*;
 CfnQueryDefinition cfnQueryDefinition = CfnQueryDefinition.Builder.create(this, "MyCfnQueryDefinition")
         .name("name")
         .queryString("queryString")
         // the properties below are optional
         .logGroupNames(List.of("logGroupNames"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnQueryDefinition.Builder A fluent builder for CfnQueryDefinition.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnQueryDefinition(software.constructs.Construct scope, String id, CfnQueryDefinitionProps props) Create a new `AWS::Logs::QueryDefinition`.
protected	CfnQueryDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnQueryDefinition(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrQueryDefinitionId() The ID of the query definition.
protected Map<String,Object>	getCfnProperties()
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.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setLogGroupNames(List<String> value) Use this parameter if you want the query to query only certain log groups.
void	setName(String value) A name for the query definition.
void	setQueryString(String value) The query string to use for this query definition.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnQueryDefinition

protected CfnQueryDefinition(software.amazon.jsii.JsiiObjectRef objRef)

CfnQueryDefinition

protected CfnQueryDefinition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnQueryDefinition

@Stability(value=Stable)
public CfnQueryDefinition(@NotNull
                                                   software.constructs.Construct scope,
                                                   @NotNull
                                                   String id,
                                                   @NotNull
                                                   CfnQueryDefinitionProps props)

Create a new `AWS::Logs::QueryDefinition`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrQueryDefinitionId

@Stability(value=Stable)
 @NotNull
public String getAttrQueryDefinitionId()

The ID of the query definition.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getName

@Stability(value=Stable)
 @NotNull
public String getName()

A name for the query definition.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

A name for the query definition.

getQueryString

@Stability(value=Stable)
 @NotNull
public String getQueryString()

The query string to use for this query definition.

For more information, see CloudWatch Logs Insights Query Syntax .

setQueryString

@Stability(value=Stable)
public void setQueryString(@NotNull
                                                    String value)

The query string to use for this query definition.

For more information, see CloudWatch Logs Insights Query Syntax .

getLogGroupNames

@Stability(value=Stable)
 @Nullable
public List<String> getLogGroupNames()

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

setLogGroupNames

@Stability(value=Stable)
public void setLogGroupNames(@Nullable
                                                      List<String> value)

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