Package software.amazon.awscdk.services.logs

Class CfnQueryDefinitionProps.Builder

java.lang.Object

software.amazon.awscdk.services.logs.CfnQueryDefinitionProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnQueryDefinitionProps>

Enclosing interface:

CfnQueryDefinitionProps

@Stability(Stable)
public static final class CfnQueryDefinitionProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnQueryDefinitionProps>

A builder for CfnQueryDefinitionProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnQueryDefinitionProps	build()	Builds the configured instance.
CfnQueryDefinitionProps.Builder	logGroupNames(List<? extends Object> logGroupNames)	Sets the value of CfnQueryDefinitionProps.getLogGroupNames()
CfnQueryDefinitionProps.Builder	name(String name)	Sets the value of CfnQueryDefinitionProps.getName()
CfnQueryDefinitionProps.Builder	parameters(List<? extends Object> parameters)	Sets the value of CfnQueryDefinitionProps.getParameters()
CfnQueryDefinitionProps.Builder	parameters(IResolvable parameters)	Sets the value of CfnQueryDefinitionProps.getParameters()
CfnQueryDefinitionProps.Builder	queryLanguage(String queryLanguage)	Sets the value of CfnQueryDefinitionProps.getQueryLanguage()
CfnQueryDefinitionProps.Builder	queryString(String queryString)	Sets the value of CfnQueryDefinitionProps.getQueryString()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

name

@Stability(Stable)
public CfnQueryDefinitionProps.Builder name(String name)

Sets the value of CfnQueryDefinitionProps.getName()

Parameters:

name - A name for the query definition. This parameter is required.

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

Returns:

this

queryString

@Stability(Stable)
public CfnQueryDefinitionProps.Builder queryString(String queryString)

Sets the value of CfnQueryDefinitionProps.getQueryString()

Parameters:

queryString - The query string to use for this query definition. This parameter is required. For more information, see CloudWatch Logs Insights Query Syntax .

Returns:

this

logGroupNames

@Stability(Stable)
public CfnQueryDefinitionProps.Builder logGroupNames(List<? extends Object> logGroupNames)

Sets the value of CfnQueryDefinitionProps.getLogGroupNames()

Parameters:

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

Returns:

this

parameters

@Stability(Stable)
public CfnQueryDefinitionProps.Builder parameters(IResolvable parameters)

Sets the value of CfnQueryDefinitionProps.getParameters()

Parameters:

parameters - Use this parameter to include specific query parameters as part of your query definition. Query parameters are supported only for Logs Insights QL queries. Query parameters allow you to use placeholder variables in your query string that are substituted with values at execution time. Use the {{parameterName}} syntax in your query string to reference a parameter.

Returns:

this

parameters

@Stability(Stable)
public CfnQueryDefinitionProps.Builder parameters(List<? extends Object> parameters)

Sets the value of CfnQueryDefinitionProps.getParameters()

Parameters:

parameters - Use this parameter to include specific query parameters as part of your query definition. Query parameters are supported only for Logs Insights QL queries. Query parameters allow you to use placeholder variables in your query string that are substituted with values at execution time. Use the {{parameterName}} syntax in your query string to reference a parameter.

Returns:

this

queryLanguage

@Stability(Stable)
public CfnQueryDefinitionProps.Builder queryLanguage(String queryLanguage)

Sets the value of CfnQueryDefinitionProps.getQueryLanguage()

Parameters:

queryLanguage - The query language used for this query. For more information about the query languages that CloudWatch Logs supports, see Supported query languages .

Returns:

this

build

@Stability(Stable)
public CfnQueryDefinitionProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnQueryDefinitionProps>

Returns:

a new instance of CfnQueryDefinitionProps

Throws:

NullPointerException - if any required attribute was not provided