Package software.amazon.awscdk.services.bedrock

Interface CfnFlowProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlowProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-25T14:21:11.129Z")
@Stability(Stable)
public interface CfnFlowProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnFlow.

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;
 CfnFlowProps cfnFlowProps = CfnFlowProps.builder()
         .executionRoleArn("executionRoleArn")
         .name("name")
         // the properties below are optional
         .customerEncryptionKeyArn("customerEncryptionKeyArn")
         .definition(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
                                         .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)
                                                                         .topK(123)
                                                                         .topP(123)
                                                                         .build())
                                                                 .build())
                                                         .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()
                                 .expression("expression")
                                 .name("name")
                                 .type("type")
                                 .build()))
                         .outputs(List.of(FlowNodeOutputProperty.builder()
                                 .name("name")
                                 .type("type")
                                 .build()))
                         .build()))
                 .build())
         .definitionS3Location(S3LocationProperty.builder()
                 .bucket("bucket")
                 .key("key")
                 // the properties below are optional
                 .version("version")
                 .build())
         .definitionString("definitionString")
         .definitionSubstitutions(Map.of(
                 "definitionSubstitutionsKey", "definitionSubstitutions"))
         .description("description")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .testAliasTags(Map.of(
                 "testAliasTagsKey", "testAliasTags"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFlowProps.Builder	builder()
default String	getCustomerEncryptionKeyArn()	The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.
default Object	getDefinition()	The definition of the nodes and connections between the nodes in the flow.
default Object	getDefinitionS3Location()	The Amazon S3 location of the flow definition.
default String	getDefinitionString()	The definition of the flow as a JSON-formatted string.
default Object	getDefinitionSubstitutions()	A map that specifies the mappings for placeholder variables in the prompt flow definition.
default String	getDescription()	A description of the flow.
String	getExecutionRoleArn()	The Amazon Resource Name (ARN) of the service role with permissions to create a flow.
String	getName()	The name of the flow.
default Map<String,String>	getTags()	Metadata that you can assign to a resource as key-value pairs.
default Object	getTestAliasTags()	A map of tag keys and values.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExecutionRoleArn

@Stability(Stable)
@NotNull
String getExecutionRoleArn()

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.

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the flow.

See Also:

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

getCustomerEncryptionKeyArn

@Stability(Stable)
@Nullable
default String getCustomerEncryptionKeyArn()

The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.

See Also:

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

getDefinition

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

The definition of the nodes and connections between the nodes in the flow.

See Also:

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

getDefinitionS3Location

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

The Amazon S3 location of the flow definition.

See Also:

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

getDefinitionString

@Stability(Stable)
@Nullable
default String getDefinitionString()

The definition of the flow as a JSON-formatted string.

The string must match the format in FlowDefinition .

See Also:

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

getDefinitionSubstitutions

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

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,...} .

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the flow.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.

• Tag naming limits and requirements
• Tagging best practices

See Also:

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

getTestAliasTags

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

A map of tag keys and values.

See Also:

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

builder

@Stability(Stable)
static CfnFlowProps.Builder builder()

Returns:

a CfnFlowProps.Builder of CfnFlowProps