Package software.amazon.awscdk.cfnpropertymixins.services.bedrock

Class CfnFlowPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.bedrock.CfnFlowPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:56.512Z")
@Stability(Stable)
public class CfnFlowPropsMixin
extends Mixin
implements software.constructs.IMixin

Creates a prompt flow that you can use to send an input through various steps to yield an output.

You define a flow by configuring nodes, each of which corresponds to a step of the flow, and creating connections between the nodes to create paths to different outputs. You can define the flow in one of the following ways:

• Define a FlowDefinition in the Definition property.
• Provide the definition in the DefinitionString property as a JSON-formatted string matching the FlowDefinition property.
• Provide an Amazon S3 location in the DefinitionS3Location property that matches the FlowDefinition .

If you use the DefinitionString or DefinitionS3Location property, you can use the DefinitionSubstitutions property to define key-value pairs to replace at runtime.

For more information, see How it works and Create a prompt flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.bedrock.*;
 import software.amazon.awscdk.*;
 Object additionalModelRequestFields;
 Object collector;
 FlowDefinitionProperty flowDefinitionProperty_;
 Object input;
 Object iterator;
 Object loopInput;
 IMergeStrategy mergeStrategy;
 Object output;
 CfnFlowPropsMixin cfnFlowPropsMixin = CfnFlowPropsMixin.Builder.create(CfnFlowMixinProps.builder()
         .customerEncryptionKeyArn("customerEncryptionKeyArn")
         .definition(FlowDefinitionProperty.builder()
                 .connections(List.of(FlowConnectionProperty.builder()
                         .configuration(FlowConnectionConfigurationProperty.builder()
                                 .conditional(FlowConditionalConnectionConfigurationProperty.builder()
                                         .condition("condition")
                                         .build())
                                 .data(FlowDataConnectionConfigurationProperty.builder()
                                         .sourceOutput("sourceOutput")
                                         .targetInput("targetInput")
                                         .build())
                                 .build())
                         .name("name")
                         .source("source")
                         .target("target")
                         .type("type")
                         .build()))
                 .nodes(List.of(FlowNodeProperty.builder()
                         .configuration(FlowNodeConfigurationProperty.builder()
                                 .agent(AgentFlowNodeConfigurationProperty.builder()
                                         .agentAliasArn("agentAliasArn")
                                         .build())
                                 .collector(collector)
                                 .condition(ConditionFlowNodeConfigurationProperty.builder()
                                         .conditions(List.of(FlowConditionProperty.builder()
                                                 .expression("expression")
                                                 .name("name")
                                                 .build()))
                                         .build())
                                 .inlineCode(InlineCodeFlowNodeConfigurationProperty.builder()
                                         .code("code")
                                         .language("language")
                                         .build())
                                 .input(input)
                                 .iterator(iterator)
                                 .knowledgeBase(KnowledgeBaseFlowNodeConfigurationProperty.builder()
                                         .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())
                                         .knowledgeBaseId("knowledgeBaseId")
                                         .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()
                                                 .bedrockRerankingConfiguration(VectorSearchBedrockRerankingConfigurationProperty.builder()
                                                         .metadataConfiguration(MetadataConfigurationForRerankingProperty.builder()
                                                                 .selectionMode("selectionMode")
                                                                 .selectiveModeConfiguration(RerankingMetadataSelectiveModeConfigurationProperty.builder()
                                                                         .fieldsToExclude(List.of(FieldForRerankingProperty.builder()
                                                                                 .fieldName("fieldName")
                                                                                 .build()))
                                                                         .fieldsToInclude(List.of(FieldForRerankingProperty.builder()
                                                                                 .fieldName("fieldName")
                                                                                 .build()))
                                                                         .build())
                                                                 .build())
                                                         .modelConfiguration(VectorSearchBedrockRerankingModelConfigurationProperty.builder()
                                                                 .additionalModelRequestFields(additionalModelRequestFields)
                                                                 .modelArn("modelArn")
                                                                 .build())
                                                         .numberOfRerankedResults(123)
                                                         .build())
                                                 .type("type")
                                                 .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()
                                                 .expression("expression")
                                                 .name("name")
                                                 .build())
                                         .maxIterations(123)
                                         .build())
                                 .loopInput(loopInput)
                                 .output(output)
                                 .prompt(PromptFlowNodeConfigurationProperty.builder()
                                         .guardrailConfiguration(GuardrailConfigurationProperty.builder()
                                                 .guardrailIdentifier("guardrailIdentifier")
                                                 .guardrailVersion("guardrailVersion")
                                                 .build())
                                         .sourceConfiguration(PromptFlowNodeSourceConfigurationProperty.builder()
                                                 .inline(PromptFlowNodeInlineConfigurationProperty.builder()
                                                         .inferenceConfiguration(PromptInferenceConfigurationProperty.builder()
                                                                 .text(PromptModelInferenceConfigurationProperty.builder()
                                                                         .maxTokens(123)
                                                                         .stopSequences(List.of("stopSequences"))
                                                                         .temperature(123)
                                                                         .topP(123)
                                                                         .build())
                                                                 .build())
                                                         .modelId("modelId")
                                                         .templateConfiguration(PromptTemplateConfigurationProperty.builder()
                                                                 .text(TextPromptTemplateConfigurationProperty.builder()
                                                                         .inputVariables(List.of(PromptInputVariableProperty.builder()
                                                                                 .name("name")
                                                                                 .build()))
                                                                         .text("text")
                                                                         .build())
                                                                 .build())
                                                         .templateType("templateType")
                                                         .build())
                                                 .resource(PromptFlowNodeResourceConfigurationProperty.builder()
                                                         .promptArn("promptArn")
                                                         .build())
                                                 .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()
                                 .category("category")
                                 .expression("expression")
                                 .name("name")
                                 .type("type")
                                 .build()))
                         .name("name")
                         .outputs(List.of(FlowNodeOutputProperty.builder()
                                 .name("name")
                                 .type("type")
                                 .build()))
                         .type("type")
                         .build()))
                 .build())
         .definitionS3Location(S3LocationProperty.builder()
                 .bucket("bucket")
                 .key("key")
                 .version("version")
                 .build())
         .definitionString("definitionString")
         .definitionSubstitutions(Map.of(
                 "definitionSubstitutionsKey", "definitionSubstitutions"))
         .description("description")
         .executionRoleArn("executionRoleArn")
         .name("name")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .testAliasTags(Map.of(
                 "testAliasTagsKey", "testAliasTags"))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-flow.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnFlowPropsMixin.AgentFlowNodeConfigurationProperty	Defines an agent node in your flow.
static final class	CfnFlowPropsMixin.Builder	A fluent builder for CfnFlowPropsMixin.
static interface	CfnFlowPropsMixin.ConditionFlowNodeConfigurationProperty	Defines a condition node in your flow.
static interface	CfnFlowPropsMixin.FieldForRerankingProperty	Specifies a field to be used during the reranking process in a Knowledge Base vector search.
static interface	CfnFlowPropsMixin.FlowConditionalConnectionConfigurationProperty	The configuration of a connection between a condition node and another node.
static interface	CfnFlowPropsMixin.FlowConditionProperty	Defines a condition in the condition node.
static interface	CfnFlowPropsMixin.FlowConnectionConfigurationProperty	The configuration of the connection.
static interface	CfnFlowPropsMixin.FlowConnectionProperty	Contains information about a connection between two nodes in the flow.
static interface	CfnFlowPropsMixin.FlowDataConnectionConfigurationProperty	The configuration of a connection originating from a node that isn't a Condition node.
static interface	CfnFlowPropsMixin.FlowDefinitionProperty	The definition of the nodes and connections between nodes in the flow.
static interface	CfnFlowPropsMixin.FlowNodeConfigurationProperty	Contains configurations for a node in your flow.
static interface	CfnFlowPropsMixin.FlowNodeInputProperty	Contains configurations for an input in an Amazon Bedrock Flows node.
static interface	CfnFlowPropsMixin.FlowNodeOutputProperty	Contains configurations for an output from a node.
static interface	CfnFlowPropsMixin.FlowNodeProperty	Contains configurations about a node in the flow.
static interface	CfnFlowPropsMixin.FlowValidationProperty	Contains information about validation of the flow.
static interface	CfnFlowPropsMixin.GuardrailConfigurationProperty	Configuration information for a guardrail that you use with the Converse operation.
static interface	CfnFlowPropsMixin.InlineCodeFlowNodeConfigurationProperty	Contains configurations for an inline code node in your flow.
static interface	CfnFlowPropsMixin.KnowledgeBaseFlowNodeConfigurationProperty	Contains configurations for a knowledge base node in a flow.
static interface	CfnFlowPropsMixin.KnowledgeBaseOrchestrationConfigurationProperty	Configures how the knowledge base orchestrates the retrieval and generation process, allowing for customization of prompts, inference parameters, and performance settings.
static interface	CfnFlowPropsMixin.KnowledgeBasePromptTemplateProperty	Defines a custom prompt template for orchestrating the retrieval and generation process.
static interface	CfnFlowPropsMixin.LambdaFunctionFlowNodeConfigurationProperty	Contains configurations for a Lambda function node in the flow.
static interface	CfnFlowPropsMixin.LexFlowNodeConfigurationProperty	Contains configurations for a Lex node in the flow.
static interface	CfnFlowPropsMixin.LoopControllerFlowNodeConfigurationProperty	Contains configurations for the controller node of a DoWhile loop in the flow.
static interface	CfnFlowPropsMixin.LoopFlowNodeConfigurationProperty	Contains configurations for the nodes of a DoWhile loop in your flow.
static interface	CfnFlowPropsMixin.MetadataConfigurationForRerankingProperty	Configuration for how metadata should be used during the reranking process in Knowledge Base vector searches.
static interface	CfnFlowPropsMixin.PerformanceConfigurationProperty	Performance settings for a model.
static interface	CfnFlowPropsMixin.PromptFlowNodeConfigurationProperty	Contains configurations for a prompt node in the flow.
static interface	CfnFlowPropsMixin.PromptFlowNodeInlineConfigurationProperty	Contains configurations for a prompt defined inline in the node.
static interface	CfnFlowPropsMixin.PromptFlowNodeResourceConfigurationProperty	Contains configurations for a prompt from Prompt management to use in a node.
static interface	CfnFlowPropsMixin.PromptFlowNodeSourceConfigurationProperty	Contains configurations for a prompt and whether it is from Prompt management or defined inline.
static interface	CfnFlowPropsMixin.PromptInferenceConfigurationProperty	Contains inference configurations for the prompt.
static interface	CfnFlowPropsMixin.PromptInputVariableProperty	Contains information about a variable in the prompt.
static interface	CfnFlowPropsMixin.PromptModelInferenceConfigurationProperty	Contains inference configurations related to model inference for a prompt.
static interface	CfnFlowPropsMixin.PromptTemplateConfigurationProperty	Contains the message for a prompt.
static interface	CfnFlowPropsMixin.RerankingMetadataSelectiveModeConfigurationProperty	Configuration for selectively including or excluding metadata fields during the reranking process.
static interface	CfnFlowPropsMixin.RetrievalFlowNodeConfigurationProperty	Contains configurations for a Retrieval node in a flow.
static interface	CfnFlowPropsMixin.RetrievalFlowNodeS3ConfigurationProperty	Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node.
static interface	CfnFlowPropsMixin.RetrievalFlowNodeServiceConfigurationProperty	Contains configurations for the service to use for retrieving data to return as the output from the node.
static interface	CfnFlowPropsMixin.S3LocationProperty	The S3 location of the flow definition.
static interface	CfnFlowPropsMixin.StorageFlowNodeConfigurationProperty	Contains configurations for a Storage node in a flow.
static interface	CfnFlowPropsMixin.StorageFlowNodeS3ConfigurationProperty	Contains configurations for the Amazon S3 location in which to store the input into the node.
static interface	CfnFlowPropsMixin.StorageFlowNodeServiceConfigurationProperty	Contains configurations for the service to use for storing the input into the node.
static interface	CfnFlowPropsMixin.TextPromptTemplateConfigurationProperty	Contains configurations for a text prompt template.
static interface	CfnFlowPropsMixin.VectorSearchBedrockRerankingConfigurationProperty	Configuration for using Amazon Bedrock foundation models to rerank Knowledge Base vector search results.
static interface	CfnFlowPropsMixin.VectorSearchBedrockRerankingModelConfigurationProperty	Configuration for the Amazon Bedrock foundation model used for reranking vector search results.
static interface	CfnFlowPropsMixin.VectorSearchRerankingConfigurationProperty	Configuration for reranking vector search results to improve relevance.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnFlowPropsMixin(CfnFlowMixinProps props)	Create a mixin to apply properties to AWS::Bedrock::Flow.
	CfnFlowPropsMixin(CfnFlowMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::Bedrock::Flow.
protected	CfnFlowPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnFlowPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnFlowMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnFlowPropsMixin

protected CfnFlowPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnFlowPropsMixin

protected CfnFlowPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnFlowPropsMixin

@Stability(Stable)
public CfnFlowPropsMixin(@NotNull
 CfnFlowMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::Bedrock::Flow.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnFlowPropsMixin

@Stability(Stable)
public CfnFlowPropsMixin(@NotNull
 CfnFlowMixinProps props)

Create a mixin to apply properties to AWS::Bedrock::Flow.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnFlowMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()