Class: AWSCDK::Bedrock::CfnFlowProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
bedrock/cfn_flow_props.rb

Overview

Properties for defining a CfnFlow.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(execution_role_arn:, name:, customer_encryption_key_arn: nil, definition: nil, definition_s3_location: nil, definition_string: nil, definition_substitutions: nil, description: nil, tags: nil, test_alias_tags: nil) ⇒ CfnFlowProps

Returns a new instance of CfnFlowProps.

Parameters:

  • execution_role_arn (String) —

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

  • name (String) —

    The name of the flow.

  • customer_encryption_key_arn (String, nil) (defaults to: nil) —

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

  • definition (AWSCDK::IResolvable, AWSCDK::Bedrock::CfnFlow::FlowDefinitionProperty, nil) (defaults to: nil) —

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

  • definition_s3_location (AWSCDK::IResolvable, AWSCDK::Bedrock::CfnFlow::S3LocationProperty, nil) (defaults to: nil) —

    The Amazon S3 location of the flow definition.

  • definition_string (String, nil) (defaults to: nil) —

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

  • definition_substitutions (AWSCDK::IResolvable, Hash{String => String, Numeric, Boolean, AWSCDK::IResolvable}, nil) (defaults to: nil) —

    A map that specifies the mappings for placeholder variables in the prompt flow definition.

  • description (String, nil) (defaults to: nil) —

    A description of the flow.

  • tags (Hash{String => String}, nil) (defaults to: nil) —

    Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.

  • test_alias_tags (AWSCDK::IResolvable, Hash{String => String}, nil) (defaults to: nil) —

    A map of tag keys and values.



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'bedrock/cfn_flow_props.rb', line 19

def initialize(execution_role_arn:, name:, customer_encryption_key_arn: nil, definition: nil, definition_s3_location: nil, definition_string: nil, definition_substitutions: nil, description: nil, tags: nil, test_alias_tags: nil)
  @execution_role_arn = execution_role_arn
  Jsii::Type.check_type(@execution_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "executionRoleArn")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @customer_encryption_key_arn = customer_encryption_key_arn
  Jsii::Type.check_type(@customer_encryption_key_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customerEncryptionKeyArn") unless @customer_encryption_key_arn.nil?
  @definition = definition.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnFlow::FlowDefinitionProperty.new(**definition.transform_keys(&:to_sym)) : definition
  Jsii::Type.check_type(@definition, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbkZsb3cuRmxvd0RlZmluaXRpb25Qcm9wZXJ0eSJ9XX19")), "definition") unless @definition.nil?
  @definition_s3_location = definition_s3_location.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnFlow::S3LocationProperty.new(**definition_s3_location.transform_keys(&:to_sym)) : definition_s3_location
  Jsii::Type.check_type(@definition_s3_location, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbkZsb3cuUzNMb2NhdGlvblByb3BlcnR5In1dfX0=")), "definitionS3Location") unless @definition_s3_location.nil?
  @definition_string = definition_string
  Jsii::Type.check_type(@definition_string, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "definitionString") unless @definition_string.nil?
  @definition_substitutions = definition_substitutions
  Jsii::Type.check_type(@definition_substitutions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7InByaW1pdGl2ZSI6InN0cmluZyJ9LHsicHJpbWl0aXZlIjoibnVtYmVyIn0seyJwcmltaXRpdmUiOiJib29sZWFuIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5JUmVzb2x2YWJsZSJ9XX19LCJraW5kIjoibWFwIn19XX19")), "definitionSubstitutions") unless @definition_substitutions.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
  @test_alias_tags = test_alias_tags
  Jsii::Type.check_type(@test_alias_tags, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "testAliasTags") unless @test_alias_tags.nil?
end

Instance Attribute Details

#customer_encryption_key_arn ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



58
59
60
 
# File 'bedrock/cfn_flow_props.rb', line 58

def customer_encryption_key_arn
  @customer_encryption_key_arn
end

#definition ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



63
64
65
 
# File 'bedrock/cfn_flow_props.rb', line 63

def definition
  @definition
end

#definition_s3_location ⇒ AWSCDK::IResolvable, ... (readonly)

The Amazon S3 location of the flow definition.

Returns:

See Also:



68
69
70
 
# File 'bedrock/cfn_flow_props.rb', line 68

def definition_s3_location
  @definition_s3_location
end

#definition_string ⇒ String? (readonly)

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

The string must match the format in FlowDefinition .

Returns:

  • (String, nil)

See Also:



75
76
77
 
# File 'bedrock/cfn_flow_props.rb', line 75

def definition_string
  @definition_string
end

#definition_substitutions ⇒ AWSCDK::IResolvable, ... (readonly)

A map that specifies the mappings for placeholder variables in the prompt flow definition.

This enables the customer to inject values obtained at runtime. Variables can be template parameter names, resource logical IDs, resource attributes, or a variable in a key-value map. Only supported with the DefinitionString and DefinitionS3Location fields.

Substitutions must follow the syntax: ${key_name} or ${variable_1,variable_2,...} .

Returns:

See Also:



84
85
86
 
# File 'bedrock/cfn_flow_props.rb', line 84

def definition_substitutions
  @definition_substitutions
end

#description ⇒ String? (readonly)

A description of the flow.

Returns:

  • (String, nil)

See Also:



89
90
91
 
# File 'bedrock/cfn_flow_props.rb', line 89

def description
  @description
end

#execution_role_arn ⇒ String (readonly)

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

For more information, see Create a service row for flows in the Amazon Bedrock User Guide.

Returns:

  • (String)

See Also:



48
49
50
 
# File 'bedrock/cfn_flow_props.rb', line 48

def execution_role_arn
  @execution_role_arn
end

#name ⇒ String (readonly)

The name of the flow.

Returns:

  • (String)

See Also:



53
54
55
 
# File 'bedrock/cfn_flow_props.rb', line 53

def name
  @name
end

#tags ⇒ Hash{String => String}? (readonly)

Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.

Returns:

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

See Also:



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

def tags
  @tags
end

#test_alias_tags ⇒ AWSCDK::IResolvable, ... (readonly)

A map of tag keys and values.

Returns:

See Also:



102
103
104
 
# File 'bedrock/cfn_flow_props.rb', line 102

def test_alias_tags
  @test_alias_tags
end

Class Method Details

.jsii_properties ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'bedrock/cfn_flow_props.rb', line 104

def self.jsii_properties
  {
    :execution_role_arn => "executionRoleArn",
    :name => "name",
    :customer_encryption_key_arn => "customerEncryptionKeyArn",
    :definition => "definition",
    :definition_s3_location => "definitionS3Location",
    :definition_string => "definitionString",
    :definition_substitutions => "definitionSubstitutions",
    :description => "description",
    :tags => "tags",
    :test_alias_tags => "testAliasTags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'bedrock/cfn_flow_props.rb', line 119

def to_jsii
  result = {}
  result.merge!({
    "executionRoleArn" => @execution_role_arn,
    "name" => @name,
    "customerEncryptionKeyArn" => @customer_encryption_key_arn,
    "definition" => @definition,
    "definitionS3Location" => @definition_s3_location,
    "definitionString" => @definition_string,
    "definitionSubstitutions" => @definition_substitutions,
    "description" => @description,
    "tags" => @tags,
    "testAliasTags" => @test_alias_tags,
  })
  result.compact
end