Class: AWSCDK::StepFunctionsTasks::CallAPIGatewayEndpointBaseOptions

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

Overview

Base CallApiGatewayEdnpoint Task Props.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(method:, api_path: nil, auth_type: nil, headers: nil, query_parameters: nil, request_body: nil) ⇒ CallAPIGatewayEndpointBaseOptions

Returns a new instance of CallAPIGatewayEndpointBaseOptions.

Parameters:



13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'step_functions_tasks/call_api_gateway_endpoint_base_options.rb', line 13

def initialize(method:, api_path: nil, auth_type: nil, headers: nil, query_parameters: nil, request_body: nil)
  @method = method
  Jsii::Type.check_type(@method, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5IdHRwTWV0aG9kIn0=")), "method")
  @api_path = api_path
  Jsii::Type.check_type(@api_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiPath") unless @api_path.nil?
  @auth_type = auth_type
  Jsii::Type.check_type(@auth_type, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9uc190YXNrcy5BdXRoVHlwZSJ9")), "authType") unless @auth_type.nil?
  @headers = headers
  Jsii::Type.check_type(@headers, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UYXNrSW5wdXQifQ==")), "headers") unless @headers.nil?
  @query_parameters = query_parameters
  Jsii::Type.check_type(@query_parameters, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UYXNrSW5wdXQifQ==")), "queryParameters") unless @query_parameters.nil?
  @request_body = request_body
  Jsii::Type.check_type(@request_body, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5UYXNrSW5wdXQifQ==")), "requestBody") unless @request_body.nil?
end

Instance Attribute Details

#api_path ⇒ String? (readonly)

Note:

Default: - No path

Path parameters appended after API endpoint.

Returns:

  • (String, nil) 


36
37
38
 
# File 'step_functions_tasks/call_api_gateway_endpoint_base_options.rb', line 36

def api_path
  @api_path
end

#auth_type ⇒ AWSCDK::StepFunctionsTasks::AuthType? (readonly)

Note:

Default: AuthType.NO_AUTH

Authentication methods.

Returns:



41
42
43
 
# File 'step_functions_tasks/call_api_gateway_endpoint_base_options.rb', line 41

def auth_type
  @auth_type
end

#headers ⇒ AWSCDK::StepFunctions::TaskInput? (readonly)

Note:

Default: - No headers

HTTP request information that does not relate to contents of the request.

Returns:



46
47
48
 
# File 'step_functions_tasks/call_api_gateway_endpoint_base_options.rb', line 46

def headers
  @headers
end

#method ⇒ AWSCDK::StepFunctionsTasks::HttpMethod (readonly)

Http method for the API.

Returns:



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

def method
  @method
end

#query_parameters ⇒ AWSCDK::StepFunctions::TaskInput? (readonly)

Note:

Default: - No query parameters

Query strings attached to end of request.

Returns:



51
52
53
 
# File 'step_functions_tasks/call_api_gateway_endpoint_base_options.rb', line 51

def query_parameters
  @query_parameters
end

#request_body ⇒ AWSCDK::StepFunctions::TaskInput? (readonly)

Note:

Default: - No request body

HTTP Request body.

Returns:



56
57
58
 
# File 'step_functions_tasks/call_api_gateway_endpoint_base_options.rb', line 56

def request_body
  @request_body
end

Class Method Details

.jsii_properties ⇒ Object 



58
59
60
61
62
63
64
65
66
67
 
# File 'step_functions_tasks/call_api_gateway_endpoint_base_options.rb', line 58

def self.jsii_properties
  {
    :method => "method",
    :api_path => "apiPath",
    :auth_type => "authType",
    :headers => "headers",
    :query_parameters => "queryParameters",
    :request_body => "requestBody",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'step_functions_tasks/call_api_gateway_endpoint_base_options.rb', line 69

def to_jsii
  result = {}
  result.merge!({
    "method" => @method,
    "apiPath" => @api_path,
    "authType" => @auth_type,
    "headers" => @headers,
    "queryParameters" => @query_parameters,
    "requestBody" => @request_body,
  })
  result.compact
end