Class: AWSCDK::Pipes::CfnPipe::PipeTargetStateMachineParametersProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Pipes::CfnPipe::PipeTargetStateMachineParametersProperty

Defined in:

pipes/cfn_pipe.rb

Overview

The parameters for using a Step Functions state machine as a target.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetstatemachineparameters.html

Instance Attribute Summary

• #invocation_type ⇒ String^? readonly

  Specify whether to invoke the Step Functions state machine synchronously or asynchronously.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(invocation_type: nil) ⇒ PipeTargetStateMachineParametersProperty constructor

  A new instance of PipeTargetStateMachineParametersProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(invocation_type: nil) ⇒ PipeTargetStateMachineParametersProperty

Returns a new instance of PipeTargetStateMachineParametersProperty.

Parameters:

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

  Specify whether to invoke the Step Functions state machine synchronously or asynchronously.

# File 'pipes/cfn_pipe.rb', line 3851

def initialize(invocation_type: nil)
  @invocation_type = invocation_type
  Jsii::Type.check_type(@invocation_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "invocationType") unless @invocation_type.nil?
end

Instance Attribute Details

#invocation_type ⇒ String^? (readonly)

Specify whether to invoke the Step Functions state machine synchronously or asynchronously.

• REQUEST_RESPONSE (default) - Invoke synchronously. For more information, see StartSyncExecution in the AWS Step Functions API Reference .

REQUEST_RESPONSE is not supported for STANDARD state machine workflows.

• FIRE_AND_FORGET - Invoke asynchronously. For more information, see StartExecution in the AWS Step Functions API Reference .

For more information, see Invocation types in the Amazon EventBridge User Guide .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipetargetstatemachineparameters.html#cfn-pipes-pipe-pipetargetstatemachineparameters-invocationtype

# File 'pipes/cfn_pipe.rb', line 3868

def invocation_type
  @invocation_type
end

Class Method Details

.jsii_properties ⇒ Object

# File 'pipes/cfn_pipe.rb', line 3870

def self.jsii_properties
  {
    :invocation_type => "invocationType",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'pipes/cfn_pipe.rb', line 3876

def to_jsii
  result = {}
  result.merge!({
    "invocationType" => @invocation_type,
  })
  result.compact
end