Class: AWSCDK::StepFunctions::CfnStateMachine

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSStepfunctions::IStateMachineRef
Defined in:
step_functions/cfn_state_machine.rb

Overview

Provisions a state machine.

A state machine consists of a collection of states that can do work ( Task states), determine to which states to transition next ( Choice states), stop an execution with an error ( Fail states), and so on. State machines are specified using a JSON-based, structured language.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnStateMachine

Create a new AWS::StepFunctions::StateMachine.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::StepFunctions::CfnStateMachineProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'step_functions/cfn_state_machine.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::StepFunctions::CfnStateMachineProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3RlcGZ1bmN0aW9ucy5DZm5TdGF0ZU1hY2hpbmVQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_state_machine(resource) ⇒ String

Parameters:

Returns:

  • (String) 


86
87
88
89
 
# File 'step_functions/cfn_state_machine.rb', line 86

def self.arn_for_state_machine(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zdGVwZnVuY3Rpb25zLklTdGF0ZU1hY2hpbmVSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions.CfnStateMachine", "arnForStateMachine", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


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

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

.is_cfn_state_machine(x) ⇒ Boolean

Checks whether the given object is a CfnStateMachine.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


95
96
97
98
 
# File 'step_functions/cfn_state_machine.rb', line 95

def self.is_cfn_state_machine(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_stepfunctions.CfnStateMachine", "isCfnStateMachine", [x])
end

.jsii_overridable_methods ⇒ Object 



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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'step_functions/cfn_state_machine.rb', line 28

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_name => { kind: :property, name: "attrName", is_optional: false },
    :attr_state_machine_revision_id => { kind: :property, name: "attrStateMachineRevisionId", is_optional: false },
    :state_machine_ref => { kind: :property, name: "stateMachineRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :definition => { kind: :property, name: "definition", is_optional: false },
    :role_arn => { kind: :property, name: "roleArn", is_optional: false },
    :definition_s3_location => { kind: :property, name: "definitionS3Location", is_optional: true },
    :definition_string => { kind: :property, name: "definitionString", is_optional: true },
    :definition_substitutions => { kind: :property, name: "definitionSubstitutions", is_optional: true },
    :encryption_configuration => { kind: :property, name: "encryptionConfiguration", is_optional: true },
    :logging_configuration => { kind: :property, name: "loggingConfiguration", is_optional: true },
    :state_machine_name => { kind: :property, name: "stateMachineName", is_optional: true },
    :state_machine_type => { kind: :property, name: "stateMachineType", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :tracing_configuration => { kind: :property, name: "tracingConfiguration", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", 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 },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



417
418
419
420
 
# File 'step_functions/cfn_state_machine.rb', line 417

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



429
430
431
432
 
# File 'step_functions/cfn_state_machine.rb', line 429

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



439
440
441
442
 
# File 'step_functions/cfn_state_machine.rb', line 439

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



450
451
452
453
454
 
# File 'step_functions/cfn_state_machine.rb', line 450

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


507
508
509
510
511
 
# File 'step_functions/cfn_state_machine.rb', line 507

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



517
518
519
520
 
# File 'step_functions/cfn_state_machine.rb', line 517

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



529
530
531
532
533
 
# File 'step_functions/cfn_state_machine.rb', line 529

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



542
543
544
545
 
# File 'step_functions/cfn_state_machine.rb', line 542

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 = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



564
565
566
567
568
569
 
# File 'step_functions/cfn_state_machine.rb', line 564

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

Returns the ARN of the resource.

Returns:

  • (String) 


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

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_name ⇒ String

Returns the name of the state machine. For example:.

{ "Fn::GetAtt": ["MyStateMachine", "Name"] }

Returns the name of your state machine:

HelloWorld-StateMachine

If you did not specify the name it will be similar to the following:

MyStateMachine-1234abcdefgh

For more information about using Fn::GetAtt , see Fn::GetAtt .

Returns:

  • (String) 


219
220
221
 
# File 'step_functions/cfn_state_machine.rb', line 219

def attr_name()
  jsii_get_property("attrName")
end

#attr_state_machine_revision_id ⇒ String

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

Returns:

  • (String) 


226
227
228
 
# File 'step_functions/cfn_state_machine.rb', line 226

def attr_state_machine_revision_id()
  jsii_get_property("attrStateMachineRevisionId")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


151
152
153
 
# File 'step_functions/cfn_state_machine.rb', line 151

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


573
574
575
576
 
# File 'step_functions/cfn_state_machine.rb', line 573

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


156
157
158
 
# File 'step_functions/cfn_state_machine.rb', line 156

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


163
164
165
 
# File 'step_functions/cfn_state_machine.rb', line 163

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


108
109
110
 
# File 'step_functions/cfn_state_machine.rb', line 108

def creation_stack()
  jsii_get_property("creationStack")
end

#definition ⇒ Object

The Amazon States Language definition of the state machine.

Returns:

  • (Object) 


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

def definition()
  jsii_get_property("definition")
end

#definition=(value) ⇒ Object 



251
252
253
254
 
# File 'step_functions/cfn_state_machine.rb', line 251

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

#definition_s3_location ⇒ AWSCDK::IResolvable, ...

The name of the S3 bucket where the state machine definition is stored.

Returns:



271
272
273
 
# File 'step_functions/cfn_state_machine.rb', line 271

def definition_s3_location()
  jsii_get_property("definitionS3Location")
end

#definition_s3_location=(value) ⇒ Object 



275
276
277
278
279
 
# File 'step_functions/cfn_state_machine.rb', line 275

def definition_s3_location=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::StepFunctions::CfnStateMachine::S3LocationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zdGVwZnVuY3Rpb25zLkNmblN0YXRlTWFjaGluZS5TM0xvY2F0aW9uUHJvcGVydHkifV19fQ==")), "definitionS3Location") unless value.nil?
  jsii_set_property("definitionS3Location", value)
end

#definition_string ⇒ String?

The Amazon States Language definition of the state machine.

Returns:

  • (String, nil) 


284
285
286
 
# File 'step_functions/cfn_state_machine.rb', line 284

def definition_string()
  jsii_get_property("definitionString")
end

#definition_string=(value) ⇒ Object 



288
289
290
291
 
# File 'step_functions/cfn_state_machine.rb', line 288

def definition_string=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "definitionString") unless value.nil?
  jsii_set_property("definitionString", value)
end

#definition_substitutions ⇒ AWSCDK::IResolvable, ...

A map (string to string) that specifies the mappings for placeholder variables in the state machine definition.

Returns:



296
297
298
 
# File 'step_functions/cfn_state_machine.rb', line 296

def definition_substitutions()
  jsii_get_property("definitionSubstitutions")
end

#definition_substitutions=(value) ⇒ Object 



300
301
302
303
 
# File 'step_functions/cfn_state_machine.rb', line 300

def definition_substitutions=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "definitionSubstitutions") unless value.nil?
  jsii_set_property("definitionSubstitutions", value)
end

#encryption_configuration ⇒ AWSCDK::IResolvable, ...

Encryption configuration for the state machine.

Returns:



308
309
310
 
# File 'step_functions/cfn_state_machine.rb', line 308

def encryption_configuration()
  jsii_get_property("encryptionConfiguration")
end

#encryption_configuration=(value) ⇒ Object 



312
313
314
315
316
 
# File 'step_functions/cfn_state_machine.rb', line 312

def encryption_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::StepFunctions::CfnStateMachine::EncryptionConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zdGVwZnVuY3Rpb25zLkNmblN0YXRlTWFjaGluZS5FbmNyeXB0aW9uQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "encryptionConfiguration") unless value.nil?
  jsii_set_property("encryptionConfiguration", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



168
169
170
 
# File 'step_functions/cfn_state_machine.rb', line 168

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



586
587
588
589
590
 
# File 'step_functions/cfn_state_machine.rb', line 586

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



597
598
599
600
 
# File 'step_functions/cfn_state_machine.rb', line 597

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



667
668
669
670
 
# File 'step_functions/cfn_state_machine.rb', line 667

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logging_configuration ⇒ AWSCDK::IResolvable, ...

Defines what execution history events are logged and where they are logged.

Returns:



321
322
323
 
# File 'step_functions/cfn_state_machine.rb', line 321

def logging_configuration()
  jsii_get_property("loggingConfiguration")
end

#logging_configuration=(value) ⇒ Object 



325
326
327
328
329
 
# File 'step_functions/cfn_state_machine.rb', line 325

def logging_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::StepFunctions::CfnStateMachine::LoggingConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zdGVwZnVuY3Rpb25zLkNmblN0YXRlTWFjaGluZS5Mb2dnaW5nQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "loggingConfiguration") unless value.nil?
  jsii_set_property("loggingConfiguration", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


120
121
122
 
# File 'step_functions/cfn_state_machine.rb', line 120

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


103
104
105
 
# File 'step_functions/cfn_state_machine.rb', line 103

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



608
609
610
 
# File 'step_functions/cfn_state_machine.rb', line 608

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



615
616
617
 
# File 'step_functions/cfn_state_machine.rb', line 615

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



408
409
410
411
 
# File 'step_functions/cfn_state_machine.rb', line 408

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


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

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



626
627
628
629
 
# File 'step_functions/cfn_state_machine.rb', line 626

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


633
634
635
636
 
# File 'step_functions/cfn_state_machine.rb', line 633

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



643
644
645
646
647
 
# File 'step_functions/cfn_state_machine.rb', line 643

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

Returns:

  • (String) 


259
260
261
 
# File 'step_functions/cfn_state_machine.rb', line 259

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object 



263
264
265
266
 
# File 'step_functions/cfn_state_machine.rb', line 263

def role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  jsii_set_property("roleArn", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



652
653
654
 
# File 'step_functions/cfn_state_machine.rb', line 652

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



129
130
131
 
# File 'step_functions/cfn_state_machine.rb', line 129

def stack()
  jsii_get_property("stack")
end

#state_machine_name ⇒ String?

The name of the state machine.

Returns:

  • (String, nil) 


334
335
336
 
# File 'step_functions/cfn_state_machine.rb', line 334

def state_machine_name()
  jsii_get_property("stateMachineName")
end

#state_machine_name=(value) ⇒ Object 



338
339
340
341
 
# File 'step_functions/cfn_state_machine.rb', line 338

def state_machine_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stateMachineName") unless value.nil?
  jsii_set_property("stateMachineName", value)
end

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

A reference to a StateMachine resource.

Returns:



233
234
235
 
# File 'step_functions/cfn_state_machine.rb', line 233

def state_machine_ref()
  jsii_get_property("stateMachineRef")
end

#state_machine_type ⇒ String?

Determines whether a STANDARD or EXPRESS state machine is created.

Returns:

  • (String, nil) 


346
347
348
 
# File 'step_functions/cfn_state_machine.rb', line 346

def state_machine_type()
  jsii_get_property("stateMachineType")
end

#state_machine_type=(value) ⇒ Object 



350
351
352
353
 
# File 'step_functions/cfn_state_machine.rb', line 350

def state_machine_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stateMachineType") unless value.nil?
  jsii_set_property("stateMachineType", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



240
241
242
 
# File 'step_functions/cfn_state_machine.rb', line 240

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::StepFunctions::CfnStateMachine::TagsEntryProperty>?

The list of tags to add to a resource.

Returns:



358
359
360
 
# File 'step_functions/cfn_state_machine.rb', line 358

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



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

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::StepFunctions::CfnStateMachine::TagsEntryProperty.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zdGVwZnVuY3Rpb25zLkNmblN0YXRlTWFjaGluZS5UYWdzRW50cnlQcm9wZXJ0eSJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



384
385
386
 
# File 'step_functions/cfn_state_machine.rb', line 384

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

#tracing_configuration ⇒ AWSCDK::IResolvable, ...

Selects whether or not the state machine's AWS X-Ray tracing is enabled.

Returns:



371
372
373
 
# File 'step_functions/cfn_state_machine.rb', line 371

def tracing_configuration()
  jsii_get_property("tracingConfiguration")
end

#tracing_configuration=(value) ⇒ Object 



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

def tracing_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::StepFunctions::CfnStateMachine::TracingConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zdGVwZnVuY3Rpb25zLkNmblN0YXRlTWFjaGluZS5UcmFjaW5nQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "tracingConfiguration") unless value.nil?
  jsii_set_property("tracingConfiguration", value)
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


176
177
178
 
# File 'step_functions/cfn_state_machine.rb', line 176

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


186
187
188
 
# File 'step_functions/cfn_state_machine.rb', line 186

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


658
659
660
661
 
# File 'step_functions/cfn_state_machine.rb', line 658

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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) 


397
398
399
400
401
402
 
# File 'step_functions/cfn_state_machine.rb', line 397

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