Class: AWSCDK::Bedrock::CfnFlow

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSBedrock::IFlowRef
Defined in:
bedrock/cfn_flow.rb

Overview

Creates a prompt flow that you can use to send an input through various steps to yield an output.

You define a flow by configuring nodes, each of which corresponds to a step of the flow, and creating connections between the nodes to create paths to different outputs. You can define the flow in one of the following ways:

  • Define a FlowDefinition in the Definition property.
  • Provide the definition in the DefinitionString property as a JSON-formatted string matching the FlowDefinition property.
  • Provide an Amazon S3 location in the DefinitionS3Location property that matches the FlowDefinition .

If you use the DefinitionString or DefinitionS3Location property, you can use the DefinitionSubstitutions property to define key-value pairs to replace at runtime.

For more information, see How it works and Create a prompt flow in Amazon Bedrock in the Amazon Bedrock User Guide.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnFlow

Create a new AWS::Bedrock::Flow.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::Bedrock::CfnFlowProps) —

    Resource properties.



28
29
30
31
32
33
34
 
# File 'bedrock/cfn_flow.rb', line 28

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

Class Method Details

.arn_for_flow(resource) ⇒ String

Parameters:

Returns:

  • (String) 


97
98
99
100
 
# File 'bedrock/cfn_flow.rb', line 97

def self.arn_for_flow(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19iZWRyb2NrLklGbG93UmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrock.CfnFlow", "arnForFlow", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


204
205
206
 
# File 'bedrock/cfn_flow.rb', line 204

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

.is_cfn_flow(x) ⇒ Boolean

Checks whether the given object is a CfnFlow.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


106
107
108
109
 
# File 'bedrock/cfn_flow.rb', line 106

def self.is_cfn_flow(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrock.CfnFlow", "isCfnFlow", [x])
end

.jsii_overridable_methods ⇒ Object 



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
83
84
85
86
87
88
89
90
91
92
93
 
# File 'bedrock/cfn_flow.rb', line 36

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_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_updated_at => { kind: :property, name: "attrUpdatedAt", is_optional: false },
    :attr_validations => { kind: :property, name: "attrValidations", is_optional: false },
    :attr_version => { kind: :property, name: "attrVersion", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :flow_ref => { kind: :property, name: "flowRef", is_optional: false },
    :execution_role_arn => { kind: :property, name: "executionRoleArn", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :customer_encryption_key_arn => { kind: :property, name: "customerEncryptionKeyArn", is_optional: true },
    :definition => { kind: :property, name: "definition", is_optional: true },
    :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 },
    :description => { kind: :property, name: "description", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :test_alias_tags => { kind: :property, name: "testAliasTags", 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.



436
437
438
439
 
# File 'bedrock/cfn_flow.rb', line 436

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:



448
449
450
451
 
# File 'bedrock/cfn_flow.rb', line 448

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:



458
459
460
461
 
# File 'bedrock/cfn_flow.rb', line 458

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:



469
470
471
472
473
 
# File 'bedrock/cfn_flow.rb', line 469

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.


526
527
528
529
530
 
# File 'bedrock/cfn_flow.rb', line 526

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.



536
537
538
539
 
# File 'bedrock/cfn_flow.rb', line 536

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.



548
549
550
551
552
 
# File 'bedrock/cfn_flow.rb', line 548

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:



561
562
563
564
 
# File 'bedrock/cfn_flow.rb', line 561

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:



583
584
585
586
587
588
 
# File 'bedrock/cfn_flow.rb', line 583

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

The Amazon Resource Name (ARN) of the flow.

Returns:

  • (String) 


211
212
213
 
# File 'bedrock/cfn_flow.rb', line 211

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_created_at ⇒ String

The time at which the flow was created.

Returns:

  • (String) 


218
219
220
 
# File 'bedrock/cfn_flow.rb', line 218

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_id ⇒ String

The unique identifier of the flow.

Returns:

  • (String) 


225
226
227
 
# File 'bedrock/cfn_flow.rb', line 225

def attr_id()
  jsii_get_property("attrId")
end

#attr_status ⇒ String

The status of the flow. The following statuses are possible:.

  • NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.
  • Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.
  • Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.
  • Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.

Returns:

  • (String) 


237
238
239
 
# File 'bedrock/cfn_flow.rb', line 237

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_updated_at ⇒ String

The time at which the flow was last updated.

Returns:

  • (String) 


244
245
246
 
# File 'bedrock/cfn_flow.rb', line 244

def attr_updated_at()
  jsii_get_property("attrUpdatedAt")
end

#attr_validations ⇒ AWSCDK::IResolvable

List of flow validations.

Returns:



251
252
253
 
# File 'bedrock/cfn_flow.rb', line 251

def attr_validations()
  jsii_get_property("attrValidations")
end

#attr_version ⇒ String

The latest version of the flow.

Returns:

  • (String) 


258
259
260
 
# File 'bedrock/cfn_flow.rb', line 258

def attr_version()
  jsii_get_property("attrVersion")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



265
266
267
 
# File 'bedrock/cfn_flow.rb', line 265

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



157
158
159
 
# File 'bedrock/cfn_flow.rb', line 157

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


162
163
164
 
# File 'bedrock/cfn_flow.rb', line 162

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


592
593
594
595
 
# File 'bedrock/cfn_flow.rb', line 592

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


167
168
169
 
# File 'bedrock/cfn_flow.rb', line 167

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


174
175
176
 
# File 'bedrock/cfn_flow.rb', line 174

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


119
120
121
 
# File 'bedrock/cfn_flow.rb', line 119

def creation_stack()
  jsii_get_property("creationStack")
end

#customer_encryption_key_arn ⇒ String?

The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.

Returns:

  • (String, nil) 


303
304
305
 
# File 'bedrock/cfn_flow.rb', line 303

def customer_encryption_key_arn()
  jsii_get_property("customerEncryptionKeyArn")
end

#customer_encryption_key_arn=(value) ⇒ Object 



307
308
309
310
 
# File 'bedrock/cfn_flow.rb', line 307

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

#definition ⇒ AWSCDK::IResolvable, ...

The definition of the nodes and connections between the nodes in the flow.

Returns:



315
316
317
 
# File 'bedrock/cfn_flow.rb', line 315

def definition()
  jsii_get_property("definition")
end

#definition=(value) ⇒ Object 



319
320
321
322
323
 
# File 'bedrock/cfn_flow.rb', line 319

def definition=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnFlow::FlowDefinitionProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbkZsb3cuRmxvd0RlZmluaXRpb25Qcm9wZXJ0eSJ9XX19")), "definition") unless value.nil?
  jsii_set_property("definition", value)
end

#definition_s3_location ⇒ AWSCDK::IResolvable, ...

The Amazon S3 location of the flow definition.

Returns:



328
329
330
 
# File 'bedrock/cfn_flow.rb', line 328

def definition_s3_location()
  jsii_get_property("definitionS3Location")
end

#definition_s3_location=(value) ⇒ Object 



332
333
334
335
336
 
# File 'bedrock/cfn_flow.rb', line 332

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

#definition_string ⇒ String?

The definition of the flow as a JSON-formatted string.

Returns:

  • (String, nil) 


341
342
343
 
# File 'bedrock/cfn_flow.rb', line 341

def definition_string()
  jsii_get_property("definitionString")
end

#definition_string=(value) ⇒ Object 



345
346
347
348
 
# File 'bedrock/cfn_flow.rb', line 345

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 that specifies the mappings for placeholder variables in the prompt flow definition.

Returns:



353
354
355
 
# File 'bedrock/cfn_flow.rb', line 353

def definition_substitutions()
  jsii_get_property("definitionSubstitutions")
end

#definition_substitutions=(value) ⇒ Object 



357
358
359
360
 
# File 'bedrock/cfn_flow.rb', line 357

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

#description ⇒ String?

A description of the flow.

Returns:

  • (String, nil) 


365
366
367
 
# File 'bedrock/cfn_flow.rb', line 365

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



369
370
371
372
 
# File 'bedrock/cfn_flow.rb', line 369

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



179
180
181
 
# File 'bedrock/cfn_flow.rb', line 179

def env()
  jsii_get_property("env")
end

#execution_role_arn ⇒ String

The Amazon Resource Name (ARN) of the service role with permissions to create a flow.

Returns:

  • (String) 


279
280
281
 
# File 'bedrock/cfn_flow.rb', line 279

def execution_role_arn()
  jsii_get_property("executionRoleArn")
end

#execution_role_arn=(value) ⇒ Object 



283
284
285
286
 
# File 'bedrock/cfn_flow.rb', line 283

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

#flow_ref ⇒ AWSCDK::Interfaces::AWSBedrock::FlowReference

A reference to a Flow resource.

Returns:



272
273
274
 
# File 'bedrock/cfn_flow.rb', line 272

def flow_ref()
  jsii_get_property("flowRef")
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:



605
606
607
608
609
 
# File 'bedrock/cfn_flow.rb', line 605

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:



616
617
618
619
 
# File 'bedrock/cfn_flow.rb', line 616

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:



686
687
688
689
 
# File 'bedrock/cfn_flow.rb', line 686

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


131
132
133
 
# File 'bedrock/cfn_flow.rb', line 131

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The name of the flow.

Returns:

  • (String) 


291
292
293
 
# File 'bedrock/cfn_flow.rb', line 291

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



295
296
297
298
 
# File 'bedrock/cfn_flow.rb', line 295

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


114
115
116
 
# File 'bedrock/cfn_flow.rb', line 114

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:



627
628
629
 
# File 'bedrock/cfn_flow.rb', line 627

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:



634
635
636
 
# File 'bedrock/cfn_flow.rb', line 634

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.



427
428
429
430
 
# File 'bedrock/cfn_flow.rb', line 427

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) 


150
151
152
 
# File 'bedrock/cfn_flow.rb', line 150

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:



645
646
647
648
 
# File 'bedrock/cfn_flow.rb', line 645

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


652
653
654
655
 
# File 'bedrock/cfn_flow.rb', line 652

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:



662
663
664
665
666
 
# File 'bedrock/cfn_flow.rb', line 662

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

#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.



671
672
673
 
# File 'bedrock/cfn_flow.rb', line 671

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:



140
141
142
 
# File 'bedrock/cfn_flow.rb', line 140

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Hash{String => String}?

Metadata that you can assign to a resource as key-value pairs.

For more information, see the following resources:.

Returns:

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


379
380
381
 
# File 'bedrock/cfn_flow.rb', line 379

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



383
384
385
386
 
# File 'bedrock/cfn_flow.rb', line 383

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

#test_alias_tags ⇒ AWSCDK::IResolvable, ...

A map of tag keys and values.

Returns:



391
392
393
 
# File 'bedrock/cfn_flow.rb', line 391

def test_alias_tags()
  jsii_get_property("testAliasTags")
end

#test_alias_tags=(value) ⇒ Object 



395
396
397
398
 
# File 'bedrock/cfn_flow.rb', line 395

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



403
404
405
 
# File 'bedrock/cfn_flow.rb', line 403

def to_string()
  jsii_call_method("toString", [])
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}) 


187
188
189
 
# File 'bedrock/cfn_flow.rb', line 187

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


197
198
199
 
# File 'bedrock/cfn_flow.rb', line 197

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


677
678
679
680
 
# File 'bedrock/cfn_flow.rb', line 677

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) 


416
417
418
419
420
421
 
# File 'bedrock/cfn_flow.rb', line 416

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