Class: AWSCDK::StepFunctions::CfnStateMachineVersionProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
step_functions/cfn_state_machine_version_props.rb

Overview

Properties for defining a CfnStateMachineVersion.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(state_machine_arn:, description: nil, state_machine_revision_id: nil) ⇒ CfnStateMachineVersionProps

Returns a new instance of CfnStateMachineVersionProps.

Parameters:

  • state_machine_arn (String) —

    The Amazon Resource Name (ARN) of the state machine.

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

    An optional description of the state machine version.

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

    Identifier for a state machine revision, which is an immutable, read-only snapshot of a state machine’s definition and configuration.



12
13
14
15
16
17
18
19
 
# File 'step_functions/cfn_state_machine_version_props.rb', line 12

def initialize(state_machine_arn:, description: nil, state_machine_revision_id: nil)
  @state_machine_arn = state_machine_arn
  Jsii::Type.check_type(@state_machine_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stateMachineArn")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @state_machine_revision_id = state_machine_revision_id
  Jsii::Type.check_type(@state_machine_revision_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stateMachineRevisionId") unless @state_machine_revision_id.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

An optional description of the state machine version.

Returns:

  • (String, nil)

See Also:



30
31
32
 
# File 'step_functions/cfn_state_machine_version_props.rb', line 30

def description
  @description
end

#state_machine_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the state machine.

Returns:

  • (String)

See Also:



25
26
27
 
# File 'step_functions/cfn_state_machine_version_props.rb', line 25

def state_machine_arn
  @state_machine_arn
end

#state_machine_revision_id ⇒ String? (readonly)

Identifier for a state machine revision, which is an immutable, read-only snapshot of a state machine’s definition and configuration.

Only publish the state machine version if the current state machine's revision ID matches the specified ID. Use this option to avoid publishing a version if the state machine has changed since you last updated it.

To specify the initial state machine revision, set the value as INITIAL .

Returns:

  • (String, nil)

See Also:



39
40
41
 
# File 'step_functions/cfn_state_machine_version_props.rb', line 39

def state_machine_revision_id
  @state_machine_revision_id
end

Class Method Details

.jsii_properties ⇒ Object 



41
42
43
44
45
46
47
 
# File 'step_functions/cfn_state_machine_version_props.rb', line 41

def self.jsii_properties
  {
    :state_machine_arn => "stateMachineArn",
    :description => "description",
    :state_machine_revision_id => "stateMachineRevisionId",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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

def to_jsii
  result = {}
  result.merge!({
    "stateMachineArn" => @state_machine_arn,
    "description" => @description,
    "stateMachineRevisionId" => @state_machine_revision_id,
  })
  result.compact
end