Class: AWSCDK::APIGatewayv2::CfnStage::RouteSettingsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
api_gatewayv2/cfn_stage.rb

Overview

Represents a collection of route settings.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data_trace_enabled: nil, detailed_metrics_enabled: nil, logging_level: nil, throttling_burst_limit: nil, throttling_rate_limit: nil) ⇒ RouteSettingsProperty

Returns a new instance of RouteSettingsProperty.

Parameters:

  • data_trace_enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether ( true ) or not ( false ) data trace logging is enabled for this route.

  • detailed_metrics_enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Specifies whether detailed metrics are enabled.

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

    Specifies the logging level for this route: INFO , ERROR , or OFF .

  • throttling_burst_limit (Numeric, nil) (defaults to: nil) —

    Specifies the throttling burst limit.

  • throttling_rate_limit (Numeric, nil) (defaults to: nil) —

    Specifies the throttling rate limit.



699
700
701
702
703
704
705
706
707
708
709
710
 
# File 'api_gatewayv2/cfn_stage.rb', line 699

def initialize(data_trace_enabled: nil, detailed_metrics_enabled: nil, logging_level: nil, throttling_burst_limit: nil, throttling_rate_limit: nil)
  @data_trace_enabled = data_trace_enabled
  Jsii::Type.check_type(@data_trace_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "dataTraceEnabled") unless @data_trace_enabled.nil?
  @detailed_metrics_enabled = detailed_metrics_enabled
  Jsii::Type.check_type(@detailed_metrics_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "detailedMetricsEnabled") unless @detailed_metrics_enabled.nil?
  @logging_level = logging_level
  Jsii::Type.check_type(@logging_level, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "loggingLevel") unless @logging_level.nil?
  @throttling_burst_limit = throttling_burst_limit
  Jsii::Type.check_type(@throttling_burst_limit, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "throttlingBurstLimit") unless @throttling_burst_limit.nil?
  @throttling_rate_limit = throttling_rate_limit
  Jsii::Type.check_type(@throttling_rate_limit, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "throttlingRateLimit") unless @throttling_rate_limit.nil?
end

Instance Attribute Details

#data_trace_enabled ⇒ Boolean, ... (readonly)

Specifies whether ( true ) or not ( false ) data trace logging is enabled for this route.

This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

Returns:

See Also:



718
719
720
 
# File 'api_gatewayv2/cfn_stage.rb', line 718

def data_trace_enabled
  @data_trace_enabled
end

#detailed_metrics_enabled ⇒ Boolean, ... (readonly)

Specifies whether detailed metrics are enabled.

Returns:

See Also:



723
724
725
 
# File 'api_gatewayv2/cfn_stage.rb', line 723

def detailed_metrics_enabled
  @detailed_metrics_enabled
end

#logging_level ⇒ String? (readonly)

Specifies the logging level for this route: INFO , ERROR , or OFF .

This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.

Returns:

  • (String, nil)

See Also:



730
731
732
 
# File 'api_gatewayv2/cfn_stage.rb', line 730

def logging_level
  @logging_level
end

#throttling_burst_limit ⇒ Numeric? (readonly)

Specifies the throttling burst limit.

Returns:

  • (Numeric, nil)

See Also:



735
736
737
 
# File 'api_gatewayv2/cfn_stage.rb', line 735

def throttling_burst_limit
  @throttling_burst_limit
end

#throttling_rate_limit ⇒ Numeric? (readonly)

Specifies the throttling rate limit.

Returns:

  • (Numeric, nil)

See Also:



740
741
742
 
# File 'api_gatewayv2/cfn_stage.rb', line 740

def throttling_rate_limit
  @throttling_rate_limit
end

Class Method Details

.jsii_properties ⇒ Object 



742
743
744
745
746
747
748
749
750
 
# File 'api_gatewayv2/cfn_stage.rb', line 742

def self.jsii_properties
  {
    :data_trace_enabled => "dataTraceEnabled",
    :detailed_metrics_enabled => "detailedMetricsEnabled",
    :logging_level => "loggingLevel",
    :throttling_burst_limit => "throttlingBurstLimit",
    :throttling_rate_limit => "throttlingRateLimit",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



752
753
754
755
756
757
758
759
760
761
762
 
# File 'api_gatewayv2/cfn_stage.rb', line 752

def to_jsii
  result = {}
  result.merge!({
    "dataTraceEnabled" => @data_trace_enabled,
    "detailedMetricsEnabled" => @detailed_metrics_enabled,
    "loggingLevel" => @logging_level,
    "throttlingBurstLimit" => @throttling_burst_limit,
    "throttlingRateLimit" => @throttling_rate_limit,
  })
  result.compact
end