Class: AWSCDK::SAM::CfnStateMachine

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

Overview

https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/sam-resource-statemachine.html.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnStateMachine

Create a new AWS::Serverless::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::SAM::CfnStateMachineProps, nil) (defaults to: nil) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'sam/cfn_state_machine.rb', line 18

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

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


182
183
184
 
# File 'sam/cfn_state_machine.rb', line 182

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_sam.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) 


84
85
86
87
 
# File 'sam/cfn_state_machine.rb', line 84

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_sam.CfnStateMachine", "isCfnStateMachine", [x])
end

.jsii_overridable_methods ⇒ Object 



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

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 },
    :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 },
    :definition_substitutions => { kind: :property, name: "definitionSubstitutions", is_optional: true },
    :definition_uri => { kind: :property, name: "definitionUri", is_optional: true },
    :events => { kind: :property, name: "events", is_optional: true },
    :logging => { kind: :property, name: "logging", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :permissions_boundaries => { kind: :property, name: "permissionsBoundaries", is_optional: true },
    :policies => { kind: :property, name: "policies", is_optional: true },
    :role => { kind: :property, name: "role", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :tracing => { kind: :property, name: "tracing", is_optional: true },
    :type => { kind: :property, name: "type", 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

.REQUIRED_TRANSFORM ⇒ String

The Transform a template must use in order to use this resource.

Returns:

  • (String) 


189
190
191
 
# File 'sam/cfn_state_machine.rb', line 189

def self.REQUIRED_TRANSFORM()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_sam.CfnStateMachine", "REQUIRED_TRANSFORM")
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.



367
368
369
370
 
# File 'sam/cfn_state_machine.rb', line 367

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:



379
380
381
382
 
# File 'sam/cfn_state_machine.rb', line 379

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:



389
390
391
392
 
# File 'sam/cfn_state_machine.rb', line 389

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:



400
401
402
403
404
 
# File 'sam/cfn_state_machine.rb', line 400

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.


457
458
459
460
461
 
# File 'sam/cfn_state_machine.rb', line 457

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.



467
468
469
470
 
# File 'sam/cfn_state_machine.rb', line 467

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.



479
480
481
482
483
 
# File 'sam/cfn_state_machine.rb', line 479

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:



492
493
494
495
 
# File 'sam/cfn_state_machine.rb', line 492

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:



514
515
516
517
518
519
 
# File 'sam/cfn_state_machine.rb', line 514

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



135
136
137
 
# File 'sam/cfn_state_machine.rb', line 135

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


140
141
142
 
# File 'sam/cfn_state_machine.rb', line 140

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


523
524
525
526
 
# File 'sam/cfn_state_machine.rb', line 523

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}) 


145
146
147
 
# File 'sam/cfn_state_machine.rb', line 145

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


152
153
154
 
# File 'sam/cfn_state_machine.rb', line 152

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


97
98
99
 
# File 'sam/cfn_state_machine.rb', line 97

def creation_stack()
  jsii_get_property("creationStack")
end

#definition ⇒ Object

Returns:

  • (Object) 


208
209
210
 
# File 'sam/cfn_state_machine.rb', line 208

def definition()
  jsii_get_property("definition")
end

#definition=(value) ⇒ Object 



212
213
214
215
 
# File 'sam/cfn_state_machine.rb', line 212

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

#definition_substitutions ⇒ AWSCDK::IResolvable, ...

Returns:



218
219
220
 
# File 'sam/cfn_state_machine.rb', line 218

def definition_substitutions()
  jsii_get_property("definitionSubstitutions")
end

#definition_substitutions=(value) ⇒ Object 



222
223
224
225
 
# File 'sam/cfn_state_machine.rb', line 222

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

#definition_uri ⇒ String, ...

Returns:



228
229
230
 
# File 'sam/cfn_state_machine.rb', line 228

def definition_uri()
  jsii_get_property("definitionUri")
end

#definition_uri=(value) ⇒ Object 



232
233
234
235
236
 
# File 'sam/cfn_state_machine.rb', line 232

def definition_uri=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SAM::CfnStateMachine::S3LocationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5JUmVzb2x2YWJsZSJ9LHsiZnFuIjoiYXdzLWNkay1saWIuYXdzX3NhbS5DZm5TdGF0ZU1hY2hpbmUuUzNMb2NhdGlvblByb3BlcnR5In1dfX0=")), "definitionUri") unless value.nil?
  jsii_set_property("definitionUri", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



157
158
159
 
# File 'sam/cfn_state_machine.rb', line 157

def env()
  jsii_get_property("env")
end

#events ⇒ AWSCDK::IResolvable, ...

Returns:



239
240
241
 
# File 'sam/cfn_state_machine.rb', line 239

def events()
  jsii_get_property("events")
end

#events=(value) ⇒ Object 



243
244
245
246
 
# File 'sam/cfn_state_machine.rb', line 243

def events=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FtLkNmblN0YXRlTWFjaGluZS5FdmVudFNvdXJjZVByb3BlcnR5In1dfX0sImtpbmQiOiJtYXAifX1dfX0=")), "events") unless value.nil?
  jsii_set_property("events", value)
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:



536
537
538
539
540
 
# File 'sam/cfn_state_machine.rb', line 536

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:



547
548
549
550
 
# File 'sam/cfn_state_machine.rb', line 547

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:



617
618
619
620
 
# File 'sam/cfn_state_machine.rb', line 617

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

#logging ⇒ AWSCDK::IResolvable, ...

Returns:



249
250
251
 
# File 'sam/cfn_state_machine.rb', line 249

def logging()
  jsii_get_property("logging")
end

#logging=(value) ⇒ Object 



253
254
255
256
257
 
# File 'sam/cfn_state_machine.rb', line 253

def logging=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SAM::CfnStateMachine::LoggingConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuU3RhdGVNYWNoaW5lLkxvZ2dpbmdDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "logging") unless value.nil?
  jsii_set_property("logging", 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) 


109
110
111
 
# File 'sam/cfn_state_machine.rb', line 109

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String?

Returns:

  • (String, nil) 


260
261
262
 
# File 'sam/cfn_state_machine.rb', line 260

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



264
265
266
267
 
# File 'sam/cfn_state_machine.rb', line 264

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


92
93
94
 
# File 'sam/cfn_state_machine.rb', line 92

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:



558
559
560
 
# File 'sam/cfn_state_machine.rb', line 558

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:



565
566
567
 
# File 'sam/cfn_state_machine.rb', line 565

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.



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

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

#permissions_boundaries ⇒ String?

Returns:

  • (String, nil) 


270
271
272
 
# File 'sam/cfn_state_machine.rb', line 270

def permissions_boundaries()
  jsii_get_property("permissionsBoundaries")
end

#permissions_boundaries=(value) ⇒ Object 



274
275
276
277
 
# File 'sam/cfn_state_machine.rb', line 274

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

#policies ⇒ String, ...

Returns:



280
281
282
 
# File 'sam/cfn_state_machine.rb', line 280

def policies()
  jsii_get_property("policies")
end

#policies=(value) ⇒ Object 



284
285
286
287
288
 
# File 'sam/cfn_state_machine.rb', line 284

def policies=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SAM::CfnStateMachine::IAMPolicyDocumentProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5JUmVzb2x2YWJsZSJ9LHsiZnFuIjoiYXdzLWNkay1saWIuYXdzX3NhbS5DZm5TdGF0ZU1hY2hpbmUuSUFNUG9saWN5RG9jdW1lbnRQcm9wZXJ0eSJ9LHsiY29sbGVjdGlvbiI6eyJlbGVtZW50dHlwZSI6eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5JUmVzb2x2YWJsZSJ9LHsiZnFuIjoiYXdzLWNkay1saWIuYXdzX3NhbS5DZm5TdGF0ZU1hY2hpbmUuSUFNUG9saWN5RG9jdW1lbnRQcm9wZXJ0eSJ9LHsiZnFuIjoiYXdzLWNkay1saWIuYXdzX3NhbS5DZm5TdGF0ZU1hY2hpbmUuU0FNUG9saWN5VGVtcGxhdGVQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "policies") unless value.nil?
  jsii_set_property("policies", value)
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) 


128
129
130
 
# File 'sam/cfn_state_machine.rb', line 128

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:



576
577
578
579
 
# File 'sam/cfn_state_machine.rb', line 576

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}) 


583
584
585
586
 
# File 'sam/cfn_state_machine.rb', line 583

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:



593
594
595
596
597
 
# File 'sam/cfn_state_machine.rb', line 593

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 ⇒ String?

Returns:

  • (String, nil) 


291
292
293
 
# File 'sam/cfn_state_machine.rb', line 291

def role()
  jsii_get_property("role")
end

#role=(value) ⇒ Object 



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

def role=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "role") unless value.nil?
  jsii_set_property("role", 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.



602
603
604
 
# File 'sam/cfn_state_machine.rb', line 602

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:



118
119
120
 
# File 'sam/cfn_state_machine.rb', line 118

def stack()
  jsii_get_property("stack")
end

#state_machine_ref ⇒ AWSCDK::Interfaces::AWSSAM::StateMachineReference

A reference to a StateMachine resource.

Returns:



196
197
198
 
# File 'sam/cfn_state_machine.rb', line 196

def state_machine_ref()
  jsii_get_property("stateMachineRef")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



203
204
205
 
# File 'sam/cfn_state_machine.rb', line 203

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Hash{String => String}?

Returns:

  • (Hash{String => String}, nil) 


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

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



305
306
307
308
 
# File 'sam/cfn_state_machine.rb', line 305

def tags_raw=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "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



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

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

#tracing ⇒ AWSCDK::IResolvable, ...

Returns:



311
312
313
 
# File 'sam/cfn_state_machine.rb', line 311

def tracing()
  jsii_get_property("tracing")
end

#tracing=(value) ⇒ Object 



315
316
317
318
319
 
# File 'sam/cfn_state_machine.rb', line 315

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

#type ⇒ String?

Returns:

  • (String, nil) 


322
323
324
 
# File 'sam/cfn_state_machine.rb', line 322

def type()
  jsii_get_property("type")
end

#type=(value) ⇒ Object 



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

def type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless value.nil?
  jsii_set_property("type", 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}) 


165
166
167
 
# File 'sam/cfn_state_machine.rb', line 165

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}) 


175
176
177
 
# File 'sam/cfn_state_machine.rb', line 175

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


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

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) 


347
348
349
350
351
352
 
# File 'sam/cfn_state_machine.rb', line 347

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