Package software.amazon.awscdk.services.bedrock

Interface CfnFlowVersion.FlowDefinitionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlowVersion.FlowDefinitionProperty.Jsii$Proxy

Enclosing class:

CfnFlowVersion

@Stability(Stable)
public static interface CfnFlowVersion.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 collector;
 Object input;
 Object iterator;
 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())
                         .input(input)
                         .iterator(iterator)
                         .knowledgeBase(KnowledgeBaseFlowNodeConfigurationProperty.builder()
                                 .knowledgeBaseId("knowledgeBaseId")
                                 // the properties below are optional
                                 .guardrailConfiguration(GuardrailConfigurationProperty.builder()
                                         .guardrailIdentifier("guardrailIdentifier")
                                         .guardrailVersion("guardrailVersion")
                                         .build())
                                 .modelId("modelId")
                                 .build())
                         .lambdaFunction(LambdaFunctionFlowNodeConfigurationProperty.builder()
                                 .lambdaArn("lambdaArn")
                                 .build())
                         .lex(LexFlowNodeConfigurationProperty.builder()
                                 .botAliasArn("botAliasArn")
                                 .localeId("localeId")
                                 .build())
                         .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")
                         .build()))
                 .outputs(List.of(FlowNodeOutputProperty.builder()
                         .name("name")
                         .type("type")
                         .build()))
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowdefinition.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFlowVersion.FlowDefinitionProperty.Builder	A builder for CfnFlowVersion.FlowDefinitionProperty
static final class	CfnFlowVersion.FlowDefinitionProperty.Jsii$Proxy	An implementation for CfnFlowVersion.FlowDefinitionProperty

Method Summary

Modifier and Type	Method	Description
static CfnFlowVersion.FlowDefinitionProperty.Builder	builder()
default Object	getConnections()	An array of connection definitions in the flow.
default Object	getNodes()	An array of node definitions in the flow.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConnections

@Stability(Stable)
@Nullable
default Object getConnections()

An array of connection definitions in the flow.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowdefinition.html#cfn-bedrock-flowversion-flowdefinition-connections

getNodes

@Stability(Stable)
@Nullable
default Object getNodes()

An array of node definitions in the flow.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-flowdefinition.html#cfn-bedrock-flowversion-flowdefinition-nodes

builder

@Stability(Stable)
static CfnFlowVersion.FlowDefinitionProperty.Builder builder()

Returns:

a CfnFlowVersion.FlowDefinitionProperty.Builder of CfnFlowVersion.FlowDefinitionProperty