Interface CfnFlow.FlowDefinitionProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnFlow.FlowDefinitionProperty.Jsii$Proxy
- Enclosing class:
CfnFlow
@Stability(Stable)
public static interface CfnFlow.FlowDefinitionProperty
extends software.amazon.jsii.JsiiSerializable
The definition of the nodes and connections between nodes in the flow.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.bedrock.*;
Object additionalModelRequestFields;
Object collector;
FlowDefinitionProperty flowDefinitionProperty_;
Object input;
Object iterator;
Object loopInput;
Object output;
FlowDefinitionProperty flowDefinitionProperty = FlowDefinitionProperty.builder()
.connections(List.of(FlowConnectionProperty.builder()
.name("name")
.source("source")
.target("target")
.type("type")
// the properties below are optional
.configuration(FlowConnectionConfigurationProperty.builder()
.conditional(FlowConditionalConnectionConfigurationProperty.builder()
.condition("condition")
.build())
.data(FlowDataConnectionConfigurationProperty.builder()
.sourceOutput("sourceOutput")
.targetInput("targetInput")
.build())
.build())
.build()))
.nodes(List.of(FlowNodeProperty.builder()
.name("name")
.type("type")
// the properties below are optional
.configuration(FlowNodeConfigurationProperty.builder()
.agent(AgentFlowNodeConfigurationProperty.builder()
.agentAliasArn("agentAliasArn")
.build())
.collector(collector)
.condition(ConditionFlowNodeConfigurationProperty.builder()
.conditions(List.of(FlowConditionProperty.builder()
.name("name")
// the properties below are optional
.expression("expression")
.build()))
.build())
.inlineCode(InlineCodeFlowNodeConfigurationProperty.builder()
.code("code")
.language("language")
.build())
.input(input)
.iterator(iterator)
.knowledgeBase(KnowledgeBaseFlowNodeConfigurationProperty.builder()
.knowledgeBaseId("knowledgeBaseId")
// the properties below are optional
.guardrailConfiguration(GuardrailConfigurationProperty.builder()
.guardrailIdentifier("guardrailIdentifier")
.guardrailVersion("guardrailVersion")
.build())
.inferenceConfiguration(PromptInferenceConfigurationProperty.builder()
.text(PromptModelInferenceConfigurationProperty.builder()
.maxTokens(123)
.stopSequences(List.of("stopSequences"))
.temperature(123)
.topP(123)
.build())
.build())
.modelId("modelId")
.numberOfResults(123)
.orchestrationConfiguration(KnowledgeBaseOrchestrationConfigurationProperty.builder()
.additionalModelRequestFields(additionalModelRequestFields)
.inferenceConfig(PromptInferenceConfigurationProperty.builder()
.text(PromptModelInferenceConfigurationProperty.builder()
.maxTokens(123)
.stopSequences(List.of("stopSequences"))
.temperature(123)
.topP(123)
.build())
.build())
.performanceConfig(PerformanceConfigurationProperty.builder()
.latency("latency")
.build())
.promptTemplate(KnowledgeBasePromptTemplateProperty.builder()
.textPromptTemplate("textPromptTemplate")
.build())
.build())
.promptTemplate(KnowledgeBasePromptTemplateProperty.builder()
.textPromptTemplate("textPromptTemplate")
.build())
.rerankingConfiguration(VectorSearchRerankingConfigurationProperty.builder()
.type("type")
// the properties below are optional
.bedrockRerankingConfiguration(VectorSearchBedrockRerankingConfigurationProperty.builder()
.modelConfiguration(VectorSearchBedrockRerankingModelConfigurationProperty.builder()
.modelArn("modelArn")
// the properties below are optional
.additionalModelRequestFields(additionalModelRequestFields)
.build())
// the properties below are optional
.metadataConfiguration(MetadataConfigurationForRerankingProperty.builder()
.selectionMode("selectionMode")
// the properties below are optional
.selectiveModeConfiguration(RerankingMetadataSelectiveModeConfigurationProperty.builder()
.fieldsToExclude(List.of(FieldForRerankingProperty.builder()
.fieldName("fieldName")
.build()))
.fieldsToInclude(List.of(FieldForRerankingProperty.builder()
.fieldName("fieldName")
.build()))
.build())
.build())
.numberOfRerankedResults(123)
.build())
.build())
.build())
.lambdaFunction(LambdaFunctionFlowNodeConfigurationProperty.builder()
.lambdaArn("lambdaArn")
.build())
.lex(LexFlowNodeConfigurationProperty.builder()
.botAliasArn("botAliasArn")
.localeId("localeId")
.build())
.loop(LoopFlowNodeConfigurationProperty.builder()
.definition(flowDefinitionProperty_)
.build())
.loopController(LoopControllerFlowNodeConfigurationProperty.builder()
.continueCondition(FlowConditionProperty.builder()
.name("name")
// the properties below are optional
.expression("expression")
.build())
// the properties below are optional
.maxIterations(123)
.build())
.loopInput(loopInput)
.output(output)
.prompt(PromptFlowNodeConfigurationProperty.builder()
.sourceConfiguration(PromptFlowNodeSourceConfigurationProperty.builder()
.inline(PromptFlowNodeInlineConfigurationProperty.builder()
.modelId("modelId")
.templateConfiguration(PromptTemplateConfigurationProperty.builder()
.text(TextPromptTemplateConfigurationProperty.builder()
.text("text")
// the properties below are optional
.inputVariables(List.of(PromptInputVariableProperty.builder()
.name("name")
.build()))
.build())
.build())
.templateType("templateType")
// the properties below are optional
.inferenceConfiguration(PromptInferenceConfigurationProperty.builder()
.text(PromptModelInferenceConfigurationProperty.builder()
.maxTokens(123)
.stopSequences(List.of("stopSequences"))
.temperature(123)
.topP(123)
.build())
.build())
.build())
.resource(PromptFlowNodeResourceConfigurationProperty.builder()
.promptArn("promptArn")
.build())
.build())
// the properties below are optional
.guardrailConfiguration(GuardrailConfigurationProperty.builder()
.guardrailIdentifier("guardrailIdentifier")
.guardrailVersion("guardrailVersion")
.build())
.build())
.retrieval(RetrievalFlowNodeConfigurationProperty.builder()
.serviceConfiguration(RetrievalFlowNodeServiceConfigurationProperty.builder()
.s3(RetrievalFlowNodeS3ConfigurationProperty.builder()
.bucketName("bucketName")
.build())
.build())
.build())
.storage(StorageFlowNodeConfigurationProperty.builder()
.serviceConfiguration(StorageFlowNodeServiceConfigurationProperty.builder()
.s3(StorageFlowNodeS3ConfigurationProperty.builder()
.bucketName("bucketName")
.build())
.build())
.build())
.build())
.inputs(List.of(FlowNodeInputProperty.builder()
.expression("expression")
.name("name")
.type("type")
// the properties below are optional
.category("category")
.build()))
.outputs(List.of(FlowNodeOutputProperty.builder()
.name("name")
.type("type")
.build()))
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnFlow.FlowDefinitionPropertystatic final classAn implementation forCfnFlow.FlowDefinitionProperty -
Method Summary
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getConnections
An array of connection definitions in the flow.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnFlow.FlowConnectionProperty>- See Also:
-
getNodes
An array of node definitions in the flow.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnFlow.FlowNodeProperty>- See Also:
-
builder
-