Class: AWSCDK::IoT::CfnTopicRule::StepFunctionsActionProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t/cfn_topic_rule.rb

Overview

Starts execution of a Step Functions state machine.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(role_arn:, state_machine_name:, execution_name_prefix: nil) ⇒ StepFunctionsActionProperty

Returns a new instance of StepFunctionsActionProperty.

Parameters:

  • role_arn (String) —

    The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").

  • state_machine_name (String) —

    The name of the Step Functions state machine whose execution will be started.

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

    (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID.



2796
2797
2798
2799
2800
2801
2802
2803
 
# File 'io_t/cfn_topic_rule.rb', line 2796

def initialize(role_arn:, state_machine_name:, execution_name_prefix: nil)
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  @state_machine_name = state_machine_name
  Jsii::Type.check_type(@state_machine_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stateMachineName")
  @execution_name_prefix = execution_name_prefix
  Jsii::Type.check_type(@execution_name_prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "executionNamePrefix") unless @execution_name_prefix.nil?
end

Instance Attribute Details

#execution_name_prefix ⇒ String? (readonly)

(Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID.

Step Functions automatically creates a unique name for each state machine execution if one is not provided.

Returns:

  • (String, nil)

See Also:



2821
2822
2823
 
# File 'io_t/cfn_topic_rule.rb', line 2821

def execution_name_prefix
  @execution_name_prefix
end

#role_arn ⇒ String (readonly)

The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").

Returns:

  • (String)

See Also:



2809
2810
2811
 
# File 'io_t/cfn_topic_rule.rb', line 2809

def role_arn
  @role_arn
end

#state_machine_name ⇒ String (readonly)

The name of the Step Functions state machine whose execution will be started.

Returns:

  • (String)

See Also:



2814
2815
2816
 
# File 'io_t/cfn_topic_rule.rb', line 2814

def state_machine_name
  @state_machine_name
end

Class Method Details

.jsii_properties ⇒ Object 



2823
2824
2825
2826
2827
2828
2829
 
# File 'io_t/cfn_topic_rule.rb', line 2823

def self.jsii_properties
  {
    :role_arn => "roleArn",
    :state_machine_name => "stateMachineName",
    :execution_name_prefix => "executionNamePrefix",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2831
2832
2833
2834
2835
2836
2837
2838
2839
 
# File 'io_t/cfn_topic_rule.rb', line 2831

def to_jsii
  result = {}
  result.merge!({
    "roleArn" => @role_arn,
    "stateMachineName" => @state_machine_name,
    "executionNamePrefix" => @execution_name_prefix,
  })
  result.compact
end