2.233.0

interface CfnFlowMixinProps

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins.CfnFlowMixinProps
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsbedrock/mixins#CfnFlowMixinProps
Javasoftware.amazon.awscdk.mixins.preview.services.bedrock.mixins.CfnFlowMixinProps
Pythonaws_cdk.mixins_preview.aws_bedrock.mixins.CfnFlowMixinProps
TypeScript @aws-cdk/mixins-preview » aws_bedrock » mixins » CfnFlowMixinProps

Properties for CfnFlowPropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as bedrock_mixins } from '@aws-cdk/mixins-preview/aws-bedrock';

declare const additionalModelRequestFields: any;
declare const collector: any;
declare const flowDefinitionProperty_: bedrock_mixins.CfnFlowPropsMixin.FlowDefinitionProperty;
declare const input: any;
declare const iterator: any;
declare const loopInput: any;
declare const output: any;
const cfnFlowMixinProps: bedrock_mixins.CfnFlowMixinProps = {
  customerEncryptionKeyArn: 'customerEncryptionKeyArn',
  definition: {
    connections: [{
      configuration: {
        conditional: {
          condition: 'condition',
        },
        data: {
          sourceOutput: 'sourceOutput',
          targetInput: 'targetInput',
        },
      },
      name: 'name',
      source: 'source',
      target: 'target',
      type: 'type',
    }],
    nodes: [{
      configuration: {
        agent: {
          agentAliasArn: 'agentAliasArn',
        },
        collector: collector,
        condition: {
          conditions: [{
            expression: 'expression',
            name: 'name',
          }],
        },
        inlineCode: {
          code: 'code',
          language: 'language',
        },
        input: input,
        iterator: iterator,
        knowledgeBase: {
          guardrailConfiguration: {
            guardrailIdentifier: 'guardrailIdentifier',
            guardrailVersion: 'guardrailVersion',
          },
          inferenceConfiguration: {
            text: {
              maxTokens: 123,
              stopSequences: ['stopSequences'],
              temperature: 123,
              topP: 123,
            },
          },
          knowledgeBaseId: 'knowledgeBaseId',
          modelId: 'modelId',
          numberOfResults: 123,
          orchestrationConfiguration: {
            additionalModelRequestFields: additionalModelRequestFields,
            inferenceConfig: {
              text: {
                maxTokens: 123,
                stopSequences: ['stopSequences'],
                temperature: 123,
                topP: 123,
              },
            },
            performanceConfig: {
              latency: 'latency',
            },
            promptTemplate: {
              textPromptTemplate: 'textPromptTemplate',
            },
          },
          promptTemplate: {
            textPromptTemplate: 'textPromptTemplate',
          },
          rerankingConfiguration: {
            bedrockRerankingConfiguration: {
              metadataConfiguration: {
                selectionMode: 'selectionMode',
                selectiveModeConfiguration: {
                  fieldsToExclude: [{
                    fieldName: 'fieldName',
                  }],
                  fieldsToInclude: [{
                    fieldName: 'fieldName',
                  }],
                },
              },
              modelConfiguration: {
                additionalModelRequestFields: additionalModelRequestFields,
                modelArn: 'modelArn',
              },
              numberOfRerankedResults: 123,
            },
            type: 'type',
          },
        },
        lambdaFunction: {
          lambdaArn: 'lambdaArn',
        },
        lex: {
          botAliasArn: 'botAliasArn',
          localeId: 'localeId',
        },
        loop: {
          definition: flowDefinitionProperty_,
        },
        loopController: {
          continueCondition: {
            expression: 'expression',
            name: 'name',
          },
          maxIterations: 123,
        },
        loopInput: loopInput,
        output: output,
        prompt: {
          guardrailConfiguration: {
            guardrailIdentifier: 'guardrailIdentifier',
            guardrailVersion: 'guardrailVersion',
          },
          sourceConfiguration: {
            inline: {
              inferenceConfiguration: {
                text: {
                  maxTokens: 123,
                  stopSequences: ['stopSequences'],
                  temperature: 123,
                  topP: 123,
                },
              },
              modelId: 'modelId',
              templateConfiguration: {
                text: {
                  inputVariables: [{
                    name: 'name',
                  }],
                  text: 'text',
                },
              },
              templateType: 'templateType',
            },
            resource: {
              promptArn: 'promptArn',
            },
          },
        },
        retrieval: {
          serviceConfiguration: {
            s3: {
              bucketName: 'bucketName',
            },
          },
        },
        storage: {
          serviceConfiguration: {
            s3: {
              bucketName: 'bucketName',
            },
          },
        },
      },
      inputs: [{
        category: 'category',
        expression: 'expression',
        name: 'name',
        type: 'type',
      }],
      name: 'name',
      outputs: [{
        name: 'name',
        type: 'type',
      }],
      type: 'type',
    }],
  },
  definitionS3Location: {
    bucket: 'bucket',
    key: 'key',
    version: 'version',
  },
  definitionString: 'definitionString',
  definitionSubstitutions: {
    definitionSubstitutionsKey: 'definitionSubstitutions',
  },
  description: 'description',
  executionRoleArn: 'executionRoleArn',
  name: 'name',
  tags: {
    tagsKey: 'tags',
  },
  testAliasTags: {
    testAliasTagsKey: 'testAliasTags',
  },
};

Properties

NameTypeDescription
customerEncryptionKeyArn?stringThe Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with.
definition?IResolvable | FlowDefinitionPropertyThe definition of the nodes and connections between the nodes in the flow.
definitionS3Location?IResolvable | S3LocationPropertyThe Amazon S3 location of the flow definition.
definitionString?stringThe definition of the flow as a JSON-formatted string.
definitionSubstitutions?IResolvable | { [string]: string | number | boolean | IResolvable }A map that specifies the mappings for placeholder variables in the prompt flow definition.
description?stringA description of the flow.
executionRoleArn?stringThe Amazon Resource Name (ARN) of the service role with permissions to create a flow.
name?stringThe name of the flow.
tags?{ [string]: string }Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.
testAliasTags?{ [string]: string } | IResolvableA map of tag keys and values.

customerEncryptionKeyArn?

Type: string (optional)

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

definition?

Type: IResolvable | FlowDefinitionProperty (optional)

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

definitionS3Location?

Type: IResolvable | S3LocationProperty (optional)

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

definitionString?

Type: string (optional)

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

definitionSubstitutions?

Type: IResolvable | { [string]: string | number | boolean | IResolvable } (optional)

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

description?

Type: string (optional)

A description of the flow.

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

executionRoleArn?

Type: string (optional)

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

name?

Type: string (optional)

The name of the flow.

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

tags?

Type: { [string]: string } (optional)

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

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

testAliasTags?

Type: { [string]: string } | IResolvable (optional)

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

← PreviousNext →