Interface ICfnFlowProps
Properties for defining a CfnFlow.
Namespace: Amazon.CDK.AwsBedrock
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnFlowPropsSyntax (vb)
Public Interface ICfnFlowPropsRemarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flow.html
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Aws_bedrock;
var collector;
var input;
var iterator;
var output;
var cfnFlowProps = new CfnFlowProps {
ExecutionRoleArn = "executionRoleArn",
Name = "name",
// the properties below are optional
CustomerEncryptionKeyArn = "customerEncryptionKeyArn",
Definition = new FlowDefinitionProperty {
Connections = new [] { new FlowConnectionProperty {
Name = "name",
Source = "source",
Target = "target",
Type = "type",
// the properties below are optional
Configuration = new FlowConnectionConfigurationProperty {
Conditional = new FlowConditionalConnectionConfigurationProperty {
Condition = "condition"
},
Data = new FlowDataConnectionConfigurationProperty {
SourceOutput = "sourceOutput",
TargetInput = "targetInput"
}
}
} },
Nodes = new [] { new FlowNodeProperty {
Name = "name",
Type = "type",
// the properties below are optional
Configuration = new FlowNodeConfigurationProperty {
Agent = new AgentFlowNodeConfigurationProperty {
AgentAliasArn = "agentAliasArn"
},
Collector = collector,
Condition = new ConditionFlowNodeConfigurationProperty {
Conditions = new [] { new FlowConditionProperty {
Name = "name",
// the properties below are optional
Expression = "expression"
} }
},
Input = input,
Iterator = iterator,
KnowledgeBase = new KnowledgeBaseFlowNodeConfigurationProperty {
KnowledgeBaseId = "knowledgeBaseId",
// the properties below are optional
GuardrailConfiguration = new GuardrailConfigurationProperty {
GuardrailIdentifier = "guardrailIdentifier",
GuardrailVersion = "guardrailVersion"
},
ModelId = "modelId"
},
LambdaFunction = new LambdaFunctionFlowNodeConfigurationProperty {
LambdaArn = "lambdaArn"
},
Lex = new LexFlowNodeConfigurationProperty {
BotAliasArn = "botAliasArn",
LocaleId = "localeId"
},
Output = output,
Prompt = new PromptFlowNodeConfigurationProperty {
SourceConfiguration = new PromptFlowNodeSourceConfigurationProperty {
Inline = new PromptFlowNodeInlineConfigurationProperty {
ModelId = "modelId",
TemplateConfiguration = new PromptTemplateConfigurationProperty {
Text = new TextPromptTemplateConfigurationProperty {
Text = "text",
// the properties below are optional
InputVariables = new [] { new PromptInputVariableProperty {
Name = "name"
} }
}
},
TemplateType = "templateType",
// the properties below are optional
InferenceConfiguration = new PromptInferenceConfigurationProperty {
Text = new PromptModelInferenceConfigurationProperty {
MaxTokens = 123,
StopSequences = new [] { "stopSequences" },
Temperature = 123,
TopP = 123
}
}
},
Resource = new PromptFlowNodeResourceConfigurationProperty {
PromptArn = "promptArn"
}
},
// the properties below are optional
GuardrailConfiguration = new GuardrailConfigurationProperty {
GuardrailIdentifier = "guardrailIdentifier",
GuardrailVersion = "guardrailVersion"
}
},
Retrieval = new RetrievalFlowNodeConfigurationProperty {
ServiceConfiguration = new RetrievalFlowNodeServiceConfigurationProperty {
S3 = new RetrievalFlowNodeS3ConfigurationProperty {
BucketName = "bucketName"
}
}
},
Storage = new StorageFlowNodeConfigurationProperty {
ServiceConfiguration = new StorageFlowNodeServiceConfigurationProperty {
S3 = new StorageFlowNodeS3ConfigurationProperty {
BucketName = "bucketName"
}
}
}
},
Inputs = new [] { new FlowNodeInputProperty {
Expression = "expression",
Name = "name",
Type = "type"
} },
Outputs = new [] { new FlowNodeOutputProperty {
Name = "name",
Type = "type"
} }
} }
},
DefinitionS3Location = new S3LocationProperty {
Bucket = "bucket",
Key = "key",
// the properties below are optional
Version = "version"
},
DefinitionString = "definitionString",
DefinitionSubstitutions = new Dictionary<string, object> {
{ "definitionSubstitutionsKey", "definitionSubstitutions" }
},
Description = "description",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
TestAliasTags = new Dictionary<string, string> {
{ "testAliasTagsKey", "testAliasTags" }
}
};Synopsis
Properties
| Customer |
The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with. |
| Definition | The definition of the nodes and connections between the nodes in the flow. |
| Definition |
The Amazon S3 location of the flow definition. |
| Definition |
The definition of the flow as a JSON-formatted string. |
| Definition |
A map that specifies the mappings for placeholder variables in the prompt flow definition. |
| Description | A description of the flow. |
| Execution |
The Amazon Resource Name (ARN) of the service role with permissions to create a flow. |
| Name | The name of the flow. |
| Tags | Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:. |
| Test |
A map of tag keys and values. |
Properties
CustomerEncryptionKeyArn
The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.
virtual string CustomerEncryptionKeyArn { get; }Property Value
System.
Remarks
Definition
The definition of the nodes and connections between the nodes in the flow.
virtual object Definition { get; }Property Value
System.
Remarks
DefinitionS3Location
The Amazon S3 location of the flow definition.
virtual object DefinitionS3Location { get; }Property Value
System.
Remarks
DefinitionString
The definition of the flow as a JSON-formatted string.
virtual string DefinitionString { get; }Property Value
System.
Remarks
The string must match the format in FlowDefinition .
DefinitionSubstitutions
A map that specifies the mappings for placeholder variables in the prompt flow definition.
virtual object DefinitionSubstitutions { get; }Property Value
System.
Remarks
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
A description of the flow.
virtual string Description { get; }Property Value
System.
Remarks
ExecutionRoleArn
The Amazon Resource Name (ARN) of the service role with permissions to create a flow.
string ExecutionRoleArn { get; }Property Value
System.
Remarks
For more information, see Create a service row for flows in the Amazon Bedrock User Guide.
Name
The name of the flow.
string Name { get; }Property Value
System.
Remarks
Tags
Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.
virtual IDictionary<string, string> Tags { get; }Property Value
System.
Remarks
TestAliasTags
A map of tag keys and values.
virtual object TestAliasTags { get; }Property Value
System.