Class: AWSCDK::StepFunctions::StateMachine

Inherits:
Resource
  • Object
show all
Includes:
IStateMachine
Defined in:
step_functions/state_machine.rb

Overview

Define a StepFunctions State Machine.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ StateMachine

Returns a new instance of StateMachine.

Parameters:



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

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::StepFunctions::StateMachineProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZU1hY2hpbmVQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_state_machine_arn(scope, id, state_machine_arn) ⇒ AWSCDK::StepFunctions::IStateMachine

Import a state machine.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • state_machine_arn (String)

Returns:



66
67
68
69
70
71
 
# File 'step_functions/state_machine.rb', line 66

def self.from_state_machine_arn(scope, id, state_machine_arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(state_machine_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stateMachineArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions.StateMachine", "fromStateMachineArn", [scope, id, state_machine_arn])
end

.from_state_machine_name(scope, id, state_machine_name) ⇒ AWSCDK::StepFunctions::IStateMachine

Import a state machine via resource name.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • state_machine_name (String)

Returns:



79
80
81
82
83
84
 
# File 'step_functions/state_machine.rb', line 79

def self.from_state_machine_name(scope, id, state_machine_name)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(state_machine_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stateMachineName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions.StateMachine", "fromStateMachineName", [scope, id, state_machine_name])
end

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'step_functions/state_machine.rb', line 20

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :grant_principal => { kind: :property, name: "grantPrincipal", is_optional: false },
    :role => { kind: :property, name: "role", is_optional: false },
    :state_machine_arn => { kind: :property, name: "stateMachineArn", is_optional: false },
    :state_machine_name => { kind: :property, name: "stateMachineName", is_optional: false },
    :state_machine_ref => { kind: :property, name: "stateMachineRef", is_optional: false },
    :state_machine_revision_id => { kind: :property, name: "stateMachineRevisionId", is_optional: false },
    :state_machine_type => { kind: :property, name: "stateMachineType", is_optional: false },
    :grants => { kind: :property, name: "grants", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :add_to_role_policy => { kind: :method, name: "addToRolePolicy", is_optional: false },
    :grant => { kind: :method, name: "grant", is_optional: false },
    :grant_execution => { kind: :method, name: "grantExecution", is_optional: false },
    :grant_read => { kind: :method, name: "grantRead", is_optional: false },
    :grant_redrive_execution => { kind: :method, name: "grantRedriveExecution", is_optional: false },
    :grant_start_execution => { kind: :method, name: "grantStartExecution", is_optional: false },
    :grant_start_sync_execution => { kind: :method, name: "grantStartSyncExecution", is_optional: false },
    :grant_task_response => { kind: :method, name: "grantTaskResponse", is_optional: false },
    :metric => { kind: :method, name: "metric", is_optional: false },
    :metric_aborted => { kind: :method, name: "metricAborted", is_optional: false },
    :metric_failed => { kind: :method, name: "metricFailed", is_optional: false },
    :metric_started => { kind: :method, name: "metricStarted", is_optional: false },
    :metric_succeeded => { kind: :method, name: "metricSucceeded", is_optional: false },
    :metric_throttled => { kind: :method, name: "metricThrottled", is_optional: false },
    :metric_time => { kind: :method, name: "metricTime", is_optional: false },
    :metric_timed_out => { kind: :method, name: "metricTimedOut", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


132
133
134
 
# File 'step_functions/state_machine.rb', line 132

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_stepfunctions.StateMachine", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#add_to_role_policy(statement) ⇒ void

This method returns an undefined value.

Add the given statement to the role's policy.

Parameters:



291
292
293
294
 
# File 'step_functions/state_machine.rb', line 291

def add_to_role_policy(statement)
  Jsii::Type.check_type(statement, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLlBvbGljeVN0YXRlbWVudCJ9")), "statement")
  jsii_call_method("addToRolePolicy", [statement])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



230
231
232
233
 
# File 'step_functions/state_machine.rb', line 230

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



247
248
249
250
 
# File 'step_functions/state_machine.rb', line 247

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



104
105
106
 
# File 'step_functions/state_machine.rb', line 104

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


253
254
255
 
# File 'step_functions/state_machine.rb', line 253

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


267
268
269
270
271
272
 
# File 'step_functions/state_machine.rb', line 267

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


282
283
284
285
 
# File 'step_functions/state_machine.rb', line 282

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#grant(identity, *actions) ⇒ AWSCDK::IAM::Grant

Grant the given identity custom permissions.

[disable-awslint:no-grants]

Parameters:

Returns:



303
304
305
306
307
308
309
 
# File 'step_functions/state_machine.rb', line 303

def grant(identity, *actions)
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity")
  actions.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actions[#{index}]")
  end
  jsii_call_method("grant", [identity, *actions])
end

#grant_execution(identity, *actions) ⇒ AWSCDK::IAM::Grant

Grant the given identity permissions on all executions of the state machine.

The use of this method is discouraged. Please use grants.execution() instead.

[disable-awslint:no-grants]

Parameters:

Returns:



320
321
322
323
324
325
326
 
# File 'step_functions/state_machine.rb', line 320

def grant_execution(identity, *actions)
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity")
  actions.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actions[#{index}]")
  end
  jsii_call_method("grantExecution", [identity, *actions])
end

#grant_principal ⇒ AWSCDK::IAM::IPrincipal

The principal this state machine is running as.

Returns:



139
140
141
 
# File 'step_functions/state_machine.rb', line 139

def grant_principal()
  jsii_get_property("grantPrincipal")
end

#grant_read(identity) ⇒ AWSCDK::IAM::Grant

Grant the given identity permissions to read results from state machine.

The use of this method is discouraged. Please use grants.read() instead.

[disable-awslint:no-grants]

Parameters:

Returns:



336
337
338
339
 
# File 'step_functions/state_machine.rb', line 336

def grant_read(identity)
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity")
  jsii_call_method("grantRead", [identity])
end

#grant_redrive_execution(identity) ⇒ AWSCDK::IAM::Grant

Grant the given identity permission to redrive the execution of the state machine.

The use of this method is discouraged. Please use grants.redriveExecution() instead.

[disable-awslint:no-grants]

Parameters:

Returns:



349
350
351
352
 
# File 'step_functions/state_machine.rb', line 349

def grant_redrive_execution(identity)
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity")
  jsii_call_method("grantRedriveExecution", [identity])
end

#grant_start_execution(identity) ⇒ AWSCDK::IAM::Grant

Grant the given identity permissions to start an execution of this state machine.

The use of this method is discouraged. Please use grants.startExecution() instead.

[disable-awslint:no-grants]

Parameters:

Returns:



362
363
364
365
 
# File 'step_functions/state_machine.rb', line 362

def grant_start_execution(identity)
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity")
  jsii_call_method("grantStartExecution", [identity])
end

#grant_start_sync_execution(identity) ⇒ AWSCDK::IAM::Grant

Grant the given identity permissions to start a synchronous execution of this state machine.

The use of this method is discouraged. Please use grants.startSyncExecution() instead.

[disable-awslint:no-grants]

Parameters:

Returns:



375
376
377
378
 
# File 'step_functions/state_machine.rb', line 375

def grant_start_sync_execution(identity)
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity")
  jsii_call_method("grantStartSyncExecution", [identity])
end

#grant_task_response(identity) ⇒ AWSCDK::IAM::Grant

Grant the given identity task response permissions on a state machine.

The use of this method is discouraged. Please use grants.taskResponse() instead.

[disable-awslint:no-grants]

Parameters:

Returns:



388
389
390
391
 
# File 'step_functions/state_machine.rb', line 388

def grant_task_response(identity)
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity")
  jsii_call_method("grantTaskResponse", [identity])
end

#grants ⇒ AWSCDK::StepFunctions::StateMachineGrants

Collection of grant methods for a StateMachine.

Returns:



188
189
190
 
# File 'step_functions/state_machine.rb', line 188

def grants()
  jsii_get_property("grants")
end

#grants=(value) ⇒ Object 



192
193
194
195
 
# File 'step_functions/state_machine.rb', line 192

def grants=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5TdGF0ZU1hY2hpbmVHcmFudHMifQ==")), "grants")
  jsii_set_property("grants", value)
end

#metric(metric_name, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - sum over 5 minutes

Return the given named metric for this State Machine's executions.

Parameters:

Returns:



399
400
401
402
403
404
 
# File 'step_functions/state_machine.rb', line 399

def metric(metric_name, props = nil)
  Jsii::Type.check_type(metric_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricName")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metric", [metric_name, props])
end

#metric_aborted(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - sum over 5 minutes

Metric for the number of executions that were aborted.

Parameters:

Returns:



411
412
413
414
415
 
# File 'step_functions/state_machine.rb', line 411

def metric_aborted(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricAborted", [props])
end

#metric_failed(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - sum over 5 minutes

Metric for the number of executions that failed.

Parameters:

Returns:



422
423
424
425
426
 
# File 'step_functions/state_machine.rb', line 422

def metric_failed(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricFailed", [props])
end

#metric_started(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - sum over 5 minutes

Metric for the number of executions that were started.

Parameters:

Returns:



433
434
435
436
437
 
# File 'step_functions/state_machine.rb', line 433

def metric_started(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricStarted", [props])
end

#metric_succeeded(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - sum over 5 minutes

Metric for the number of executions that succeeded.

Parameters:

Returns:



444
445
446
447
448
 
# File 'step_functions/state_machine.rb', line 444

def metric_succeeded(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricSucceeded", [props])
end

#metric_throttled(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - sum over 5 minutes

Metric for the number of executions that were throttled.

Parameters:

Returns:



455
456
457
458
459
 
# File 'step_functions/state_machine.rb', line 455

def metric_throttled(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricThrottled", [props])
end

#metric_time(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - average over 5 minutes

Metric for the interval, in milliseconds, between the time the execution starts and the time it closes.

Parameters:

Returns:



466
467
468
469
470
 
# File 'step_functions/state_machine.rb', line 466

def metric_time(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricTime", [props])
end

#metric_timed_out(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - sum over 5 minutes

Metric for the number of executions that timed out.

Parameters:

Returns:



477
478
479
480
481
 
# File 'step_functions/state_machine.rb', line 477

def metric_timed_out(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricTimedOut", [props])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


89
90
91
 
# File 'step_functions/state_machine.rb', line 89

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


118
119
120
 
# File 'step_functions/state_machine.rb', line 118

def physical_name()
  jsii_get_property("physicalName")
end

#role ⇒ AWSCDK::IAM::IRole

Execution role of this state machine.

Returns:



146
147
148
 
# File 'step_functions/state_machine.rb', line 146

def role()
  jsii_get_property("role")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



125
126
127
 
# File 'step_functions/state_machine.rb', line 125

def stack()
  jsii_get_property("stack")
end

#state_machine_arn ⇒ String

The ARN of the state machine.

Returns:

  • (String) 


153
154
155
 
# File 'step_functions/state_machine.rb', line 153

def state_machine_arn()
  jsii_get_property("stateMachineArn")
end

#state_machine_name ⇒ String

The name of the state machine.

Returns:

  • (String) 


160
161
162
 
# File 'step_functions/state_machine.rb', line 160

def state_machine_name()
  jsii_get_property("stateMachineName")
end

#state_machine_ref ⇒ AWSCDK::Interfaces::AWSStepfunctions::StateMachineReference

A reference to a StateMachine resource.

Returns:



167
168
169
 
# File 'step_functions/state_machine.rb', line 167

def state_machine_ref()
  jsii_get_property("stateMachineRef")
end

#state_machine_revision_id ⇒ String

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

Returns:

  • (String) 


174
175
176
 
# File 'step_functions/state_machine.rb', line 174

def state_machine_revision_id()
  jsii_get_property("stateMachineRevisionId")
end

#state_machine_type ⇒ AWSCDK::StepFunctions::StateMachineType

Type of the state machine.

Returns:



181
182
183
 
# File 'step_functions/state_machine.rb', line 181

def state_machine_type()
  jsii_get_property("stateMachineType")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


200
201
202
 
# File 'step_functions/state_machine.rb', line 200

def to_string()
  jsii_call_method("toString", [])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


213
214
215
216
217
218
 
# File 'step_functions/state_machine.rb', line 213

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end