Class: AWSCDK::APIGatewayv2::CfnRoutingRule::ActionInvokeAPIProperty

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

Overview

Represents an InvokeApi action.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_id:, stage:, strip_base_path: nil) ⇒ ActionInvokeAPIProperty

Returns a new instance of ActionInvokeAPIProperty.

Parameters:

  • api_id (String) —

    The API identifier of the target API.

  • stage (String) —

    The name of the target stage.

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

    The strip base path setting.



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

def initialize(api_id:, stage:, strip_base_path: nil)
  @api_id = api_id
  Jsii::Type.check_type(@api_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiId")
  @stage = stage
  Jsii::Type.check_type(@stage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stage")
  @strip_base_path = strip_base_path
  Jsii::Type.check_type(@strip_base_path, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "stripBasePath") unless @strip_base_path.nil?
end

Instance Attribute Details

#api_id ⇒ String (readonly)

The API identifier of the target API.

Returns:

  • (String)

See Also:



571
572
573
 
# File 'api_gatewayv2/cfn_routing_rule.rb', line 571

def api_id
  @api_id
end

#stage ⇒ String (readonly)

The name of the target stage.

Returns:

  • (String)

See Also:



576
577
578
 
# File 'api_gatewayv2/cfn_routing_rule.rb', line 576

def stage
  @stage
end

#strip_base_path ⇒ Boolean, ... (readonly)

The strip base path setting.

When true, API Gateway strips the incoming matched base path when forwarding the request to the target API.

Returns:

See Also:



583
584
585
 
# File 'api_gatewayv2/cfn_routing_rule.rb', line 583

def strip_base_path
  @strip_base_path
end

Class Method Details

.jsii_properties ⇒ Object 



585
586
587
588
589
590
591
 
# File 'api_gatewayv2/cfn_routing_rule.rb', line 585

def self.jsii_properties
  {
    :api_id => "apiId",
    :stage => "stage",
    :strip_base_path => "stripBasePath",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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

def to_jsii
  result = {}
  result.merge!({
    "apiId" => @api_id,
    "stage" => @stage,
    "stripBasePath" => @strip_base_path,
  })
  result.compact
end