Class: AWSCDK::MWAAServerless::CfnWorkflow

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSMwaaserverless::IWorkflowRef
Defined in:
mwaa_serverless/cfn_workflow.rb

Overview

Resource Type definition for AWS::MWAAServerless::Workflow resource.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnWorkflow

Create a new AWS::MWAAServerless::Workflow.

Parameters:

  • scope (Constructs::Construct)

    Scope in which this resource is defined.

  • id (String)

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

  • props (AWSCDK::MWAAServerless::CfnWorkflowProps)

    Resource properties.



18
19
20
21
22
23
24
# File 'mwaa_serverless/cfn_workflow.rb', line 18

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

Class Method Details

.arn_for_workflow(resource) ⇒ String

Parameters:

Returns:

  • (String)


85
86
87
88
# File 'mwaa_serverless/cfn_workflow.rb', line 85

def self.arn_for_workflow(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19td2Fhc2VydmVybGVzcy5JV29ya2Zsb3dSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_mwaaserverless.CfnWorkflow", "arnForWorkflow", [resource])
end

.CFN_RESOURCE_TYPE_NAMEString

The CloudFormation resource type name for this resource class.

Returns:

  • (String)


192
193
194
# File 'mwaa_serverless/cfn_workflow.rb', line 192

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

.is_cfn_workflow(x) ⇒ Boolean

Checks whether the given object is a CfnWorkflow.

Parameters:

  • x (Object)

Returns:

  • (Boolean)


94
95
96
97
# File 'mwaa_serverless/cfn_workflow.rb', line 94

def self.is_cfn_workflow(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_mwaaserverless.CfnWorkflow", "isCfnWorkflow", [x])
end

.jsii_overridable_methodsObject



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
79
80
81
# File 'mwaa_serverless/cfn_workflow.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 },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_modified_at => { kind: :property, name: "attrModifiedAt", is_optional: false },
    :attr_schedule_configuration => { kind: :property, name: "attrScheduleConfiguration", is_optional: false },
    :attr_workflow_arn => { kind: :property, name: "attrWorkflowArn", is_optional: false },
    :attr_workflow_status => { kind: :property, name: "attrWorkflowStatus", is_optional: false },
    :attr_workflow_version => { kind: :property, name: "attrWorkflowVersion", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :workflow_ref => { kind: :property, name: "workflowRef", is_optional: false },
    :definition_s3_location => { kind: :property, name: "definitionS3Location", is_optional: false },
    :role_arn => { kind: :property, name: "roleArn", is_optional: false },
    :description => { kind: :property, name: "description", is_optional: true },
    :encryption_configuration => { kind: :property, name: "encryptionConfiguration", is_optional: true },
    :logging_configuration => { kind: :property, name: "loggingConfiguration", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :network_configuration => { kind: :property, name: "networkConfiguration", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :trigger_mode => { kind: :property, name: "triggerMode", 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.



372
373
374
375
# File 'mwaa_serverless/cfn_workflow.rb', line 372

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:



384
385
386
387
# File 'mwaa_serverless/cfn_workflow.rb', line 384

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:



394
395
396
397
# File 'mwaa_serverless/cfn_workflow.rb', line 394

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.



405
406
407
408
409
# File 'mwaa_serverless/cfn_workflow.rb', line 405

def (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.


462
463
464
465
466
# File 'mwaa_serverless/cfn_workflow.rb', line 462

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.



472
473
474
475
# File 'mwaa_serverless/cfn_workflow.rb', line 472

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.



484
485
486
487
488
# File 'mwaa_serverless/cfn_workflow.rb', line 484

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:



497
498
499
500
# File 'mwaa_serverless/cfn_workflow.rb', line 497

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:



519
520
521
522
523
524
# File 'mwaa_serverless/cfn_workflow.rb', line 519

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_created_atString

Returns:

  • (String)


197
198
199
# File 'mwaa_serverless/cfn_workflow.rb', line 197

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_modified_atString

Returns:

  • (String)


202
203
204
# File 'mwaa_serverless/cfn_workflow.rb', line 202

def attr_modified_at()
  jsii_get_property("attrModifiedAt")
end

#attr_schedule_configurationAWSCDK::IResolvable

Returns:



207
208
209
# File 'mwaa_serverless/cfn_workflow.rb', line 207

def attr_schedule_configuration()
  jsii_get_property("attrScheduleConfiguration")
end

#attr_workflow_arnString

Returns:

  • (String)


212
213
214
# File 'mwaa_serverless/cfn_workflow.rb', line 212

def attr_workflow_arn()
  jsii_get_property("attrWorkflowArn")
end

#attr_workflow_statusString

Returns:

  • (String)


217
218
219
# File 'mwaa_serverless/cfn_workflow.rb', line 217

def attr_workflow_status()
  jsii_get_property("attrWorkflowStatus")
end

#attr_workflow_versionString

Returns:

  • (String)


222
223
224
# File 'mwaa_serverless/cfn_workflow.rb', line 222

def attr_workflow_version()
  jsii_get_property("attrWorkflowVersion")
end

#cdk_tag_managerAWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



229
230
231
# File 'mwaa_serverless/cfn_workflow.rb', line 229

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_optionsAWSCDK::ICfnResourceOptions

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



145
146
147
# File 'mwaa_serverless/cfn_workflow.rb', line 145

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_propertiesHash{String => Object}

Returns:

  • (Hash{String => Object})


150
151
152
# File 'mwaa_serverless/cfn_workflow.rb', line 150

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil)


528
529
530
531
# File 'mwaa_serverless/cfn_workflow.rb', line 528

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_namesHash{String => String}

Returns:

  • (Hash{String => String})


155
156
157
# File 'mwaa_serverless/cfn_workflow.rb', line 155

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_typeString

AWS resource type.

Returns:

  • (String)


162
163
164
# File 'mwaa_serverless/cfn_workflow.rb', line 162

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stackArray<String>

Returns:

  • (Array<String>)


107
108
109
# File 'mwaa_serverless/cfn_workflow.rb', line 107

def creation_stack()
  jsii_get_property("creationStack")
end

#definition_s3_locationAWSCDK::IResolvable, AWSCDK::MWAAServerless::CfnWorkflow::S3LocationProperty



241
242
243
# File 'mwaa_serverless/cfn_workflow.rb', line 241

def definition_s3_location()
  jsii_get_property("definitionS3Location")
end

#definition_s3_location=(value) ⇒ Object



245
246
247
248
249
# File 'mwaa_serverless/cfn_workflow.rb', line 245

def definition_s3_location=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MWAAServerless::CfnWorkflow::S3LocationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19td2Fhc2VydmVybGVzcy5DZm5Xb3JrZmxvdy5TM0xvY2F0aW9uUHJvcGVydHkifV19fQ==")), "definitionS3Location")
  jsii_set_property("definitionS3Location", value)
end

#descriptionString?

Returns:

  • (String, nil)


262
263
264
# File 'mwaa_serverless/cfn_workflow.rb', line 262

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object



266
267
268
269
# File 'mwaa_serverless/cfn_workflow.rb', line 266

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

#encryption_configurationAWSCDK::IResolvable, ...



272
273
274
# File 'mwaa_serverless/cfn_workflow.rb', line 272

def encryption_configuration()
  jsii_get_property("encryptionConfiguration")
end

#encryption_configuration=(value) ⇒ Object



276
277
278
279
280
# File 'mwaa_serverless/cfn_workflow.rb', line 276

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

#envAWSCDK::Interfaces::ResourceEnvironment



167
168
169
# File 'mwaa_serverless/cfn_workflow.rb', line 167

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:



541
542
543
544
545
# File 'mwaa_serverless/cfn_workflow.rb', line 541

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.



552
553
554
555
# File 'mwaa_serverless/cfn_workflow.rb', line 552

def (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:



622
623
624
625
# File 'mwaa_serverless/cfn_workflow.rb', line 622

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

#logging_configurationAWSCDK::IResolvable, ...



283
284
285
# File 'mwaa_serverless/cfn_workflow.rb', line 283

def logging_configuration()
  jsii_get_property("loggingConfiguration")
end

#logging_configuration=(value) ⇒ Object



287
288
289
290
291
# File 'mwaa_serverless/cfn_workflow.rb', line 287

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

#logical_idString

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)


119
120
121
# File 'mwaa_serverless/cfn_workflow.rb', line 119

def logical_id()
  jsii_get_property("logicalId")
end

#nameString?

Returns:

  • (String, nil)


294
295
296
# File 'mwaa_serverless/cfn_workflow.rb', line 294

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object



298
299
300
301
# File 'mwaa_serverless/cfn_workflow.rb', line 298

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

#network_configurationAWSCDK::IResolvable, ...



304
305
306
# File 'mwaa_serverless/cfn_workflow.rb', line 304

def network_configuration()
  jsii_get_property("networkConfiguration")
end

#network_configuration=(value) ⇒ Object



308
309
310
311
312
# File 'mwaa_serverless/cfn_workflow.rb', line 308

def network_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MWAAServerless::CfnWorkflow::NetworkConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19td2Fhc2VydmVybGVzcy5DZm5Xb3JrZmxvdy5OZXR3b3JrQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "networkConfiguration") unless value.nil?
  jsii_set_property("networkConfiguration", value)
end

#nodeConstructs::Node

The tree node.

Returns:

  • (Constructs::Node)


102
103
104
# File 'mwaa_serverless/cfn_workflow.rb', line 102

def node()
  jsii_get_property("node")
end

#obtain_dependenciesArray<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:



563
564
565
# File 'mwaa_serverless/cfn_workflow.rb', line 563

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

#obtain_resource_dependenciesArray<AWSCDK::CfnResource>

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

Returns:



570
571
572
# File 'mwaa_serverless/cfn_workflow.rb', line 570

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.



363
364
365
366
# File 'mwaa_serverless/cfn_workflow.rb', line 363

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

#refString

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)


138
139
140
# File 'mwaa_serverless/cfn_workflow.rb', line 138

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:



581
582
583
584
# File 'mwaa_serverless/cfn_workflow.rb', line 581

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


588
589
590
591
# File 'mwaa_serverless/cfn_workflow.rb', line 588

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:



598
599
600
601
602
# File 'mwaa_serverless/cfn_workflow.rb', line 598

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_arnString

Returns:

  • (String)


252
253
254
# File 'mwaa_serverless/cfn_workflow.rb', line 252

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object



256
257
258
259
# File 'mwaa_serverless/cfn_workflow.rb', line 256

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

#should_synthesizeBoolean

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.



607
608
609
# File 'mwaa_serverless/cfn_workflow.rb', line 607

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

#stackAWSCDK::Stack

The stack in which this element is defined.

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

Returns:



128
129
130
# File 'mwaa_serverless/cfn_workflow.rb', line 128

def stack()
  jsii_get_property("stack")
end

#tagsHash{String => String}?

A map of key-value pairs to be applied as tags.

Returns:

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


317
318
319
# File 'mwaa_serverless/cfn_workflow.rb', line 317

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object



321
322
323
324
# File 'mwaa_serverless/cfn_workflow.rb', line 321

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

#to_stringString

Returns a string representation of this construct.

Returns:

  • (String)

    a string representation of this resource



339
340
341
# File 'mwaa_serverless/cfn_workflow.rb', line 339

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

#trigger_modeString?

Returns:

  • (String, nil)


327
328
329
# File 'mwaa_serverless/cfn_workflow.rb', line 327

def trigger_mode()
  jsii_get_property("triggerMode")
end

#trigger_mode=(value) ⇒ Object



331
332
333
334
# File 'mwaa_serverless/cfn_workflow.rb', line 331

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

#updated_properitesHash{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})


175
176
177
# File 'mwaa_serverless/cfn_workflow.rb', line 175

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_propertiesHash{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})


185
186
187
# File 'mwaa_serverless/cfn_workflow.rb', line 185

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object)


613
614
615
616
# File 'mwaa_serverless/cfn_workflow.rb', line 613

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)


352
353
354
355
356
357
# File 'mwaa_serverless/cfn_workflow.rb', line 352

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

#workflow_refAWSCDK::Interfaces::AWSMwaaserverless::WorkflowReference

A reference to a Workflow resource.



236
237
238
# File 'mwaa_serverless/cfn_workflow.rb', line 236

def workflow_ref()
  jsii_get_property("workflowRef")
end