Class: AWSCDK::APIGateway::StepFunctionsIntegration

Inherits:
Jsii::Object
  • Object
show all
Defined in:
api_gateway/step_functions_integration.rb

Overview

Options to integrate with various StepFunction API.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ StepFunctionsIntegration

Returns a new instance of StepFunctionsIntegration.



8
9
10
 
# File 'api_gateway/step_functions_integration.rb', line 8

def initialize
  Jsii::Object.instance_method(:initialize).bind(self).call
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



12
13
14
15
 
# File 'api_gateway/step_functions_integration.rb', line 12

def self.jsii_overridable_methods
  {
  }
end

.start_execution(state_machine, options = nil) ⇒ AWSCDK::APIGateway::AWSIntegration

Integrates a Synchronous Express State Machine from AWS Step Functions to an API Gateway method.

Examples:

state_machine = AWSCDK::StepFunctions::StateMachine.new(self, "MyStateMachine", {
    state_machine_type: AWSCDK::StepFunctions::StateMachineType::EXPRESS,
    definition: AWSCDK::StepFunctions::Chain.start(AWSCDK::StepFunctions::Pass.new(self, "Pass")),
})

api = AWSCDK::APIGateway::RestAPI.new(self, "Api", {
    rest_api_name: "MyApi",
})
api.root.add_method("GET", AWSCDK::APIGateway::StepFunctionsIntegration.start_execution(state_machine))

Parameters:

Returns:



32
33
34
35
36
37
 
# File 'api_gateway/step_functions_integration.rb', line 32

def self.start_execution(state_machine, options = nil)
  Jsii::Type.check_type(state_machine, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5JU3RhdGVNYWNoaW5lIn0=")), "stateMachine")
  options = options.is_a?(Hash) ? ::AWSCDK::APIGateway::StepFunctionsExecutionIntegrationOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5TdGVwRnVuY3Rpb25zRXhlY3V0aW9uSW50ZWdyYXRpb25PcHRpb25zIn0=")), "options") unless options.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.StepFunctionsIntegration", "startExecution", [state_machine, options])
end