AWS::Bedrock::Flow - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Bedrock::Flow

Creates a prompt flow that you can use to send an input through various steps to yield an output. Configure nodes, each of which corresponds to a step of the flow, and create connections between the nodes to create paths to different outputs. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Bedrock::Flow",
  "Properties" : {
      "CustomerEncryptionKeyArn" : String,
      "Definition" : FlowDefinition,
      "DefinitionS3Location" : S3Location,
      "DefinitionString" : String,
      "DefinitionSubstitutions" : {Key: Value, ...},
      "Description" : String,
      "ExecutionRoleArn" : String,
      "Name" : String,
      "Tags" : {Key: Value, ...},
      "TestAliasTags" : {Key: Value, ...}
    }
}

YAML

Type: AWS::Bedrock::Flow
Properties:
  CustomerEncryptionKeyArn: String
  Definition: 
    FlowDefinition
  DefinitionS3Location: 
    S3Location
  DefinitionString: 
    String
  DefinitionSubstitutions: 
    Key: Value
  Description: String
  ExecutionRoleArn: String
  Name: String
  Tags: 
    Key: Value
  TestAliasTags: 
    Key: Value

Properties

CustomerEncryptionKeyArn

Property description not available.

Required: No

Type: String

Pattern: ^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$

Minimum: 1

Maximum: 2048

Update requires: No interruption

Definition

Property description not available.

Required: No

Type: FlowDefinition

Update requires: No interruption

DefinitionS3Location

An Amazon S3 location.

Required: No

Type: S3Location

Update requires: No interruption

DefinitionString

Property description not available.

Required: No

Type: String

Maximum: 512000

Update requires: No interruption

DefinitionSubstitutions

Property description not available.

Required: No

Type: Object

Update requires: No interruption

Description

A description of the flow.

Required: No

Type: String

Minimum: 1

Maximum: 200

Update requires: No interruption

ExecutionRoleArn

Property description not available.

Required: Yes

Type: String

Pattern: ^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+$

Maximum: 2048

Update requires: No interruption

Name

The name of the flow.

Required: Yes

Type: String

Pattern: ^([0-9a-zA-Z][_-]?){1,100}$

Update requires: No interruption

Tags

Property description not available.

Required: No

Type: Object of String

Pattern: ^[a-zA-Z0-9\s._:/=+@-]*$

Minimum: 0

Maximum: 256

Update requires: No interruption

TestAliasTags

Property description not available.

Required: No

Type: Object of String

Pattern: ^[a-zA-Z0-9\s._:/=+@-]*$

Minimum: 0

Maximum: 256

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the flow.

CreatedAt

The time at which the flow was created.

Id

The unique identifier of the flow.

Status

The status of the flow. The following statuses are possible:

  • NotPrepared – The flow has been created or updated, but hasn't been prepared. If you just created the flow, you can't test it. If you updated the flow, the DRAFT version won't contain the latest changes for testing. Send a PrepareFlow request to package the latest changes into the DRAFT version.

  • Preparing – The flow is being prepared so that the DRAFT version contains the latest changes for testing.

  • Prepared – The flow is prepared and the DRAFT version contains the latest changes for testing.

  • Failed – The last API operation that you invoked on the flow failed. Send a GetFlow request and check the error message in the validations field.

UpdatedAt

The time at which the flow was last updated.

Version

The latest version of the flow.