CfnQueryDefinitionPropsMixin

class aws_cdk.cfn_property_mixins.aws_logs.CfnQueryDefinitionPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a query definition for CloudWatch Logs Insights.

For more information, see Analyzing Log Data with CloudWatch Logs Insights .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-querydefinition.html
CloudformationResource:: AWS::Logs::QueryDefinition
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_logs as logs
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_query_definition_props_mixin = logs.CfnQueryDefinitionPropsMixin(logs.CfnQueryDefinitionMixinProps(
    log_group_names=["logGroupNames"],
    name="name",
    parameters=[logs.CfnQueryDefinitionPropsMixin.QueryParameterProperty(
        default_value="defaultValue",
        description="description",
        name="name"
    )],
    query_language="queryLanguage",
    query_string="queryString"
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::Logs::QueryDefinition.

Parameters:

props (Union[CfnQueryDefinitionMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['logGroupNames', 'name', 'parameters', 'queryLanguage', 'queryString']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

QueryParameterProperty

class CfnQueryDefinitionPropsMixin.QueryParameterProperty(*, default_value=None, description=None, name=None)

Bases: object

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.

Parameters:

default_value (Optional[str]) – The default value to use for this query parameter if no value is supplied at execution time.
description (Optional[str]) – A description of the query parameter that explains its purpose or expected values.
name (Optional[str]) – 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:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_logs as logs

query_parameter_property = logs.CfnQueryDefinitionPropsMixin.QueryParameterProperty(
    default_value="defaultValue",
    description="description",
    name="name"
)

Attributes

default_value

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

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

description

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

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

name

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-logs-querydefinition-queryparameter.html#cfn-logs-querydefinition-queryparameter-name