Class: AWSCDK::APIGatewayv2Integrations::HttpStepFunctionsIntegrationProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
api_gatewayv2_integrations/http_step_functions_integration_props.rb

Overview

Properties to initialize HttpStepFunctionsIntegration.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(state_machine:, parameter_mapping: nil, subtype: nil) ⇒ HttpStepFunctionsIntegrationProps

Returns a new instance of HttpStepFunctionsIntegrationProps.

Parameters:



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

def initialize(state_machine:, parameter_mapping: nil, subtype: nil)
  @state_machine = state_machine
  Jsii::Type.check_type(@state_machine, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZU1hY2hpbmUifQ==")), "stateMachine")
  @parameter_mapping = parameter_mapping
  Jsii::Type.check_type(@parameter_mapping, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLlBhcmFtZXRlck1hcHBpbmcifQ==")), "parameterMapping") unless @parameter_mapping.nil?
  @subtype = subtype
  Jsii::Type.check_type(@subtype, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheXYyLkh0dHBJbnRlZ3JhdGlvblN1YnR5cGUifQ==")), "subtype") unless @subtype.nil?
end

Instance Attribute Details

#parameter_mapping ⇒ AWSCDK::APIGatewayv2::ParameterMapping? (readonly)

Note:

Default: - specify only StateMachineArn

Specifies how to transform HTTP requests before sending them to the backend.

When the subtype is either START_EXECUTION or START_SYNC_EXECUTION, it is necessary to specify the StateMachineArn. Conversely, when the subtype is STOP_EXECUTION, the ExecutionArn must be specified.

Returns:

See Also:



32
33
34
 
# File 'api_gatewayv2_integrations/http_step_functions_integration_props.rb', line 32

def parameter_mapping
  @parameter_mapping
end

#state_machine ⇒ AWSCDK::StepFunctions::StateMachine (readonly)

Statemachine that Integrates with API Gateway.

Returns:



22
23
24
 
# File 'api_gatewayv2_integrations/http_step_functions_integration_props.rb', line 22

def state_machine
  @state_machine
end

#subtype ⇒ AWSCDK::APIGatewayv2::HttpIntegrationSubtype? (readonly)

Note:

Default: HttpIntegrationSubtype.STEPFUNCTIONS_START_EXECUTION

The subtype of the HTTP integration.

Only subtypes starting with STEPFUNCTIONS_ can be specified.

Returns:



39
40
41
 
# File 'api_gatewayv2_integrations/http_step_functions_integration_props.rb', line 39

def subtype
  @subtype
end

Class Method Details

.jsii_properties ⇒ Object 



41
42
43
44
45
46
47
 
# File 'api_gatewayv2_integrations/http_step_functions_integration_props.rb', line 41

def self.jsii_properties
  {
    :state_machine => "stateMachine",
    :parameter_mapping => "parameterMapping",
    :subtype => "subtype",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



49
50
51
52
53
54
55
56
57
 
# File 'api_gatewayv2_integrations/http_step_functions_integration_props.rb', line 49

def to_jsii
  result = {}
  result.merge!({
    "stateMachine" => @state_machine,
    "parameterMapping" => @parameter_mapping,
    "subtype" => @subtype,
  })
  result.compact
end