Package software.amazon.awscdk.cfnpropertymixins.services.logs

Interface CfnQueryDefinitionPropsMixin.QueryParameterProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnQueryDefinitionPropsMixin.QueryParameterProperty.Jsii$Proxy

Enclosing class:

CfnQueryDefinitionPropsMixin

@Stability(Stable)
public static interface CfnQueryDefinitionPropsMixin.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.cfnpropertymixins.services.logs.*;
 QueryParameterProperty queryParameterProperty = QueryParameterProperty.builder()
         .defaultValue("defaultValue")
         .description("description")
         .name("name")
         .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	CfnQueryDefinitionPropsMixin.QueryParameterProperty.Builder	A builder for CfnQueryDefinitionPropsMixin.QueryParameterProperty
static final class	CfnQueryDefinitionPropsMixin.QueryParameterProperty.Jsii$Proxy	An implementation for CfnQueryDefinitionPropsMixin.QueryParameterProperty

Method Summary

Modifier and Type	Method	Description
static CfnQueryDefinitionPropsMixin.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.
default String	getName()	The name of the query parameter.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

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

getName

@Stability(Stable)
@Nullable
default 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

builder

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

Returns:

a CfnQueryDefinitionPropsMixin.QueryParameterProperty.Builder of CfnQueryDefinitionPropsMixin.QueryParameterProperty