interface CfnFlowProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.aws_bedrock.CfnFlowProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsbedrock#CfnFlowProps |
 Java | software.amazon.awscdk.services.bedrock.CfnFlowProps |
 Python | aws_cdk.aws_bedrock.CfnFlowProps |
 TypeScript | aws-cdk-lib » aws_bedrock » CfnFlowProps |
Properties for defining a CfnFlow.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flow.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrock as bedrock } from 'aws-cdk-lib';
declare const collector: any;
declare const input: any;
declare const iterator: any;
declare const output: any;
const cfnFlowProps: bedrock.CfnFlowProps = {
executionRoleArn: 'executionRoleArn',
name: 'name',
// the properties below are optional
customerEncryptionKeyArn: 'customerEncryptionKeyArn',
definition: {
connections: [{
name: 'name',
source: 'source',
target: 'target',
type: 'type',
// the properties below are optional
configuration: {
conditional: {
condition: 'condition',
},
data: {
sourceOutput: 'sourceOutput',
targetInput: 'targetInput',
},
},
}],
nodes: [{
name: 'name',
type: 'type',
// the properties below are optional
configuration: {
agent: {
agentAliasArn: 'agentAliasArn',
},
collector: collector,
condition: {
conditions: [{
name: 'name',
// the properties below are optional
expression: 'expression',
}],
},
input: input,
iterator: iterator,
knowledgeBase: {
knowledgeBaseId: 'knowledgeBaseId',
// the properties below are optional
guardrailConfiguration: {
guardrailIdentifier: 'guardrailIdentifier',
guardrailVersion: 'guardrailVersion',
},
modelId: 'modelId',
},
lambdaFunction: {
lambdaArn: 'lambdaArn',
},
lex: {
botAliasArn: 'botAliasArn',
localeId: 'localeId',
},
output: output,
prompt: {
sourceConfiguration: {
inline: {
modelId: 'modelId',
templateConfiguration: {
text: {
text: 'text',
// the properties below are optional
inputVariables: [{
name: 'name',
}],
},
},
templateType: 'templateType',
// the properties below are optional
inferenceConfiguration: {
text: {
maxTokens: 123,
stopSequences: ['stopSequences'],
temperature: 123,
topP: 123,
},
},
},
resource: {
promptArn: 'promptArn',
},
},
// the properties below are optional
guardrailConfiguration: {
guardrailIdentifier: 'guardrailIdentifier',
guardrailVersion: 'guardrailVersion',
},
},
retrieval: {
serviceConfiguration: {
s3: {
bucketName: 'bucketName',
},
},
},
storage: {
serviceConfiguration: {
s3: {
bucketName: 'bucketName',
},
},
},
},
inputs: [{
expression: 'expression',
name: 'name',
type: 'type',
}],
outputs: [{
name: 'name',
type: 'type',
}],
}],
},
definitionS3Location: {
bucket: 'bucket',
key: 'key',
// the properties below are optional
version: 'version',
},
definitionString: 'definitionString',
definitionSubstitutions: {
definitionSubstitutionsKey: 'definitionSubstitutions',
},
description: 'description',
tags: {
tagsKey: 'tags',
},
testAliasTags: {
testAliasTagsKey: 'testAliasTags',
},
};
Properties
| Name | Type | Description |
|---|---|---|
| execution | string | The Amazon Resource Name (ARN) of the service role with permissions to create a flow. |
| name | string | The name of the flow. |
| customer | string | The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with. |
| definition? | IResolvable | Flow | The definition of the nodes and connections between the nodes in the flow. |
| definition | IResolvable | S3 | The Amazon S3 location of the flow definition. |
| definition | string | The definition of the flow as a JSON-formatted string. |
| definition | IResolvable | { [string]: string | number | boolean | IResolvable } | A map that specifies the mappings for placeholder variables in the prompt flow definition. |
| description? | string | A description of the flow. |
| tags? | { [string]: string } | Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:. |
| test | IResolvable | { [string]: string } | A map of tag keys and values. |
executionRoleArn
Type:
string
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.
name
Type:
string
The name of the flow.
customerEncryptionKeyArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.
definition?
Type:
IResolvable | Flow
(optional)
The definition of the nodes and connections between the nodes in the flow.
definitionS3Location?
Type:
IResolvable | S3
(optional)
The Amazon S3 location of the flow definition.
definitionString?
Type:
string
(optional)
The definition of the flow as a JSON-formatted string.
The string must match the format in FlowDefinition .
definitionSubstitutions?
Type:
IResolvable | { [string]: string | number | boolean | IResolvable }
(optional)
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,...} .
description?
Type:
string
(optional)
A description of the flow.
tags?
Type:
{ [string]: string }
(optional)
Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.
testAliasTags?
Type:
IResolvable | { [string]: string }
(optional)
A map of tag keys and values.