Class: AWSCDK::StepFunctionsTasks::CallAPIGatewayHttpAPIEndpointOptions

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
step_functions_tasks/call_api_gateway_http_api_endpoint_options.rb

Overview

Base properties for calling an HTTP API Endpoint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_id:, api_stack:, stage_name: nil) ⇒ CallAPIGatewayHttpAPIEndpointOptions

Returns a new instance of CallAPIGatewayHttpAPIEndpointOptions.

Parameters:

  • api_id (String) —

    The Id of the API to call.

  • api_stack (AWSCDK::Stack) —

    The Stack in which the API is defined.

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

    Name of the stage where the API is deployed to in API Gateway.



10
11
12
13
14
15
16
17
 
# File 'step_functions_tasks/call_api_gateway_http_api_endpoint_options.rb', line 10

def initialize(api_id:, api_stack:, stage_name: nil)
  @api_id = api_id
  Jsii::Type.check_type(@api_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiId")
  @api_stack = api_stack
  Jsii::Type.check_type(@api_stack, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5TdGFjayJ9")), "apiStack")
  @stage_name = stage_name
  Jsii::Type.check_type(@stage_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stageName") unless @stage_name.nil?
end

Instance Attribute Details

#api_id ⇒ String (readonly)

The Id of the API to call.

Returns:

  • (String) 


22
23
24
 
# File 'step_functions_tasks/call_api_gateway_http_api_endpoint_options.rb', line 22

def api_id
  @api_id
end

#api_stack ⇒ AWSCDK::Stack (readonly)

The Stack in which the API is defined.

Returns:



26
27
28
 
# File 'step_functions_tasks/call_api_gateway_http_api_endpoint_options.rb', line 26

def api_stack
  @api_stack
end

#stage_name ⇒ String? (readonly)

Note:

Default: '$default'

Name of the stage where the API is deployed to in API Gateway.

Returns:

  • (String, nil) 


31
32
33
 
# File 'step_functions_tasks/call_api_gateway_http_api_endpoint_options.rb', line 31

def stage_name
  @stage_name
end

Class Method Details

.jsii_properties ⇒ Object 



33
34
35
36
37
38
39
 
# File 'step_functions_tasks/call_api_gateway_http_api_endpoint_options.rb', line 33

def self.jsii_properties
  {
    :api_id => "apiId",
    :api_stack => "apiStack",
    :stage_name => "stageName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



41
42
43
44
45
46
47
48
49
 
# File 'step_functions_tasks/call_api_gateway_http_api_endpoint_options.rb', line 41

def to_jsii
  result = {}
  result.merge!({
    "apiId" => @api_id,
    "apiStack" => @api_stack,
    "stageName" => @stage_name,
  })
  result.compact
end