Package software.amazon.awscdk.services.logs

Interface CfnQueryDefinition.QueryParameterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnQueryDefinition.QueryParameterProperty.Jsii$Proxy

Enclosing class:

CfnQueryDefinition

@Stability(Stable)
public static interface CfnQueryDefinition.QueryParameterProperty
extends software.amazon.jsii.JsiiSerializable

This structure defines a query parameter for a saved CloudWatch Logs Insights query definition.

Query parameters are supported only for Logs Insights QL queries. They are placeholder variables that you can reference in a query string using the {{parameterName}} syntax. Each parameter can include a default value and a description.

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.*;
 QueryParameterProperty queryParameterProperty = QueryParameterProperty.builder()
         .name("name")
         // the properties below are optional
         .defaultValue("defaultValue")
         .description("description")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnQueryDefinition.QueryParameterProperty.Builder	builder()
default String	getDefaultValue()	The default value to use for this query parameter if no value is supplied at execution time.
default String	getDescription()	A description of the query parameter that explains its purpose or expected values.
String	getName()	The name of the query parameter.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the query parameter.

A query parameter name must start with a letter or underscore, and contain only letters, digits, and underscores.

See Also:

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

getDefaultValue

@Stability(Stable)
@Nullable
default String getDefaultValue()

The default value to use for this query parameter if no value is supplied at execution time.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-querydefinition-queryparameter.html#cfn-logs-querydefinition-queryparameter-defaultvalue

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the query parameter that explains its purpose or expected values.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-querydefinition-queryparameter.html#cfn-logs-querydefinition-queryparameter-description

builder

@Stability(Stable)
static CfnQueryDefinition.QueryParameterProperty.Builder builder()

Returns:

a CfnQueryDefinition.QueryParameterProperty.Builder of CfnQueryDefinition.QueryParameterProperty