Class: AWSCDK::Logs::CfnQueryDefinition::QueryParameterProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
logs/cfn_query_definition.rb

Overview

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.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, default_value: nil, description: nil) ⇒ QueryParameterProperty

Returns a new instance of QueryParameterProperty.

Parameters:

  • name (String) —

    The name of the query parameter.

  • default_value (String, nil) (defaults to: nil) —

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

  • description (String, nil) (defaults to: nil) —

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



558
559
560
561
562
563
564
565
 
# File 'logs/cfn_query_definition.rb', line 558

def initialize(name:, default_value: nil, description: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @default_value = default_value
  Jsii::Type.check_type(@default_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultValue") unless @default_value.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
end

Instance Attribute Details

#default_value ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



578
579
580
 
# File 'logs/cfn_query_definition.rb', line 578

def default_value
  @default_value
end

#description ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



583
584
585
 
# File 'logs/cfn_query_definition.rb', line 583

def description
  @description
end

#name ⇒ String (readonly)

The name of the query parameter.

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

Returns:

  • (String)

See Also:



573
574
575
 
# File 'logs/cfn_query_definition.rb', line 573

def name
  @name
end

Class Method Details

.jsii_properties ⇒ Object 



585
586
587
588
589
590
591
 
# File 'logs/cfn_query_definition.rb', line 585

def self.jsii_properties
  {
    :name => "name",
    :default_value => "defaultValue",
    :description => "description",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



593
594
595
596
597
598
599
600
601
 
# File 'logs/cfn_query_definition.rb', line 593

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "defaultValue" => @default_value,
    "description" => @description,
  })
  result.compact
end