This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html). # Amazon Bedrock **Resource types** + [AWS::Bedrock::Agent](aws-resource-bedrock-agent.md) + [AWS::Bedrock::AgentAlias](aws-resource-bedrock-agentalias.md) + [AWS::Bedrock::ApplicationInferenceProfile](aws-resource-bedrock-applicationinferenceprofile.md) + [AWS::Bedrock::AutomatedReasoningPolicy](aws-resource-bedrock-automatedreasoningpolicy.md) + [AWS::Bedrock::AutomatedReasoningPolicyVersion](aws-resource-bedrock-automatedreasoningpolicyversion.md) + [AWS::Bedrock::Blueprint](aws-resource-bedrock-blueprint.md) + [AWS::Bedrock::DataAutomationLibrary](aws-resource-bedrock-dataautomationlibrary.md) + [AWS::Bedrock::DataAutomationProject](aws-resource-bedrock-dataautomationproject.md) + [AWS::Bedrock::DataSource](aws-resource-bedrock-datasource.md) + [AWS::Bedrock::EnforcedGuardrailConfiguration](aws-resource-bedrock-enforcedguardrailconfiguration.md) + [AWS::Bedrock::Flow](aws-resource-bedrock-flow.md) + [AWS::Bedrock::FlowAlias](aws-resource-bedrock-flowalias.md) + [AWS::Bedrock::FlowVersion](aws-resource-bedrock-flowversion.md) + [AWS::Bedrock::Guardrail](aws-resource-bedrock-guardrail.md) + [AWS::Bedrock::GuardrailVersion](aws-resource-bedrock-guardrailversion.md) + [AWS::Bedrock::IntelligentPromptRouter](aws-resource-bedrock-intelligentpromptrouter.md) + [AWS::Bedrock::KnowledgeBase](aws-resource-bedrock-knowledgebase.md) + [AWS::Bedrock::Prompt](aws-resource-bedrock-prompt.md) + [AWS::Bedrock::PromptVersion](aws-resource-bedrock-promptversion.md) + [AWS::Bedrock::ResourcePolicy](aws-resource-bedrock-resourcepolicy.md) # AWS::Bedrock::Agent Specifies an agent as a resource in a top-level template. Minimally, you must specify the following properties: + AgentName – Specify a name for the agent. + AgentResourceRoleArn – Specify the Amazon Resource Name (ARN) of the service role with permissions to invoke API operations on the agent. For more information, see [Create a service role for Agents for Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-permissions.html). + FoundationModel – Specify the model ID of a foundation model to use when invoking the agent. For more information, see [Supported regions and models for Agents for Amazon Bedrock](https://docs.aws.amazon.com//bedrock/latest/userguide/agents-supported.html). For more information about using agents in Amazon Bedrock, see [Agents for Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/agents.html). See the **Properties** section below for descriptions of both the required and optional properties. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::Bedrock::Agent", "Properties" : { "[ActionGroups](#cfn-bedrock-agent-actiongroups)" : [ AgentActionGroup, ... ], "[AgentCollaboration](#cfn-bedrock-agent-agentcollaboration)" : String, "[AgentCollaborators](#cfn-bedrock-agent-agentcollaborators)" : [ AgentCollaborator, ... ], "[AgentName](#cfn-bedrock-agent-agentname)" : String, "[AgentResourceRoleArn](#cfn-bedrock-agent-agentresourcerolearn)" : String, "[AutoPrepare](#cfn-bedrock-agent-autoprepare)" : Boolean, "[CustomerEncryptionKeyArn](#cfn-bedrock-agent-customerencryptionkeyarn)" : String, "[CustomOrchestration](#cfn-bedrock-agent-customorchestration)" : CustomOrchestration, "[Description](#cfn-bedrock-agent-description)" : String, "[FoundationModel](#cfn-bedrock-agent-foundationmodel)" : String, "[GuardrailConfiguration](#cfn-bedrock-agent-guardrailconfiguration)" : GuardrailConfiguration, "[IdleSessionTTLInSeconds](#cfn-bedrock-agent-idlesessionttlinseconds)" : Number, "[Instruction](#cfn-bedrock-agent-instruction)" : String, "[KnowledgeBases](#cfn-bedrock-agent-knowledgebases)" : [ AgentKnowledgeBase, ... ], "[MemoryConfiguration](#cfn-bedrock-agent-memoryconfiguration)" : MemoryConfiguration, "[OrchestrationType](#cfn-bedrock-agent-orchestrationtype)" : String, "[PromptOverrideConfiguration](#cfn-bedrock-agent-promptoverrideconfiguration)" : PromptOverrideConfiguration, "[SkipResourceInUseCheckOnDelete](#cfn-bedrock-agent-skipresourceinusecheckondelete)" : Boolean, "[Tags](#cfn-bedrock-agent-tags)" : {Key: Value, ...}, "[TestAliasTags](#cfn-bedrock-agent-testaliastags)" : {Key: Value, ...} } } ``` ### YAML ``` Type: AWS::Bedrock::Agent Properties: [ActionGroups](#cfn-bedrock-agent-actiongroups): - AgentActionGroup [AgentCollaboration](#cfn-bedrock-agent-agentcollaboration): String [AgentCollaborators](#cfn-bedrock-agent-agentcollaborators): - AgentCollaborator [AgentName](#cfn-bedrock-agent-agentname): String [AgentResourceRoleArn](#cfn-bedrock-agent-agentresourcerolearn): String [AutoPrepare](#cfn-bedrock-agent-autoprepare): Boolean [CustomerEncryptionKeyArn](#cfn-bedrock-agent-customerencryptionkeyarn): String [CustomOrchestration](#cfn-bedrock-agent-customorchestration): CustomOrchestration [Description](#cfn-bedrock-agent-description): String [FoundationModel](#cfn-bedrock-agent-foundationmodel): String [GuardrailConfiguration](#cfn-bedrock-agent-guardrailconfiguration): GuardrailConfiguration [IdleSessionTTLInSeconds](#cfn-bedrock-agent-idlesessionttlinseconds): Number [Instruction](#cfn-bedrock-agent-instruction): String [KnowledgeBases](#cfn-bedrock-agent-knowledgebases): - AgentKnowledgeBase [MemoryConfiguration](#cfn-bedrock-agent-memoryconfiguration): MemoryConfiguration [OrchestrationType](#cfn-bedrock-agent-orchestrationtype): String [PromptOverrideConfiguration](#cfn-bedrock-agent-promptoverrideconfiguration): PromptOverrideConfiguration [SkipResourceInUseCheckOnDelete](#cfn-bedrock-agent-skipresourceinusecheckondelete): Boolean [Tags](#cfn-bedrock-agent-tags): Key: Value [TestAliasTags](#cfn-bedrock-agent-testaliastags): Key: Value ``` ## Properties `ActionGroups` The action groups that belong to an agent. *Required*: No *Type*: Array of [AgentActionGroup](aws-properties-bedrock-agent-agentactiongroup.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AgentCollaboration` The agent's collaboration settings. *Required*: No *Type*: String *Allowed values*: `DISABLED | SUPERVISOR | SUPERVISOR_ROUTER` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AgentCollaborators` Property description not available. *Required*: No *Type*: Array of [AgentCollaborator](aws-properties-bedrock-agent-agentcollaborator.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AgentName` The name of the agent. *Required*: Yes *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AgentResourceRoleArn` The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent. *Required*: No *Type*: String *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AutoPrepare` Specifies whether to automatically update the `DRAFT` version of the agent after making changes to the agent. The `DRAFT` version can be continually iterated upon during internal development. By default, this value is `false`. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CustomerEncryptionKeyArn` The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the agent. *Required*: No *Type*: String *Pattern*: `^arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CustomOrchestration` Contains custom orchestration configurations for the agent. *Required*: No *Type*: [CustomOrchestration](aws-properties-bedrock-agent-customorchestration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` The description of the agent. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FoundationModel` The foundation model used for orchestration by the agent. *Required*: No *Type*: String *Pattern*: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|([0-9]{12}:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GuardrailConfiguration` Details about the guardrail associated with the agent. *Required*: No *Type*: [GuardrailConfiguration](aws-properties-bedrock-agent-guardrailconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IdleSessionTTLInSeconds` The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent. A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout. *Required*: No *Type*: Number *Minimum*: `60` *Maximum*: `5400` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Instruction` Instructions that tell the agent what it should do and how it should interact with users. *Required*: No *Type*: String *Minimum*: `40` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KnowledgeBases` The knowledge bases associated with the agent. *Required*: No *Type*: Array of [AgentKnowledgeBase](aws-properties-bedrock-agent-agentknowledgebase.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MemoryConfiguration` Contains memory configuration for the agent. *Required*: No *Type*: [MemoryConfiguration](aws-properties-bedrock-agent-memoryconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OrchestrationType` Specifies the orchestration strategy for the agent. *Required*: No *Type*: String *Allowed values*: `DEFAULT | CUSTOM_ORCHESTRATION` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PromptOverrideConfiguration` Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see [Advanced prompts](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html). *Required*: No *Type*: [PromptOverrideConfiguration](aws-properties-bedrock-agent-promptoverrideconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SkipResourceInUseCheckOnDelete` Specifies whether to delete the resource even if it's in use. By default, this value is `false`. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources: + [Tag naming limits and requirements](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions) + [Tagging best practices](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices) *Required*: No *Type*: Object of String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TestAliasTags` Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources: + [Tag naming limits and requirements](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions) + [Tagging best practices](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices) *Required*: No *Type*: Object of String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the agent base ID. For example, `{ "Ref": "myAgent" }` could return the value `"AGENT12345"`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `AgentArn` The Amazon Resource Name (ARN) of the agent. `AgentId` The unique identifier of the agent. `AgentStatus` The status of the agent and whether it is ready for use. The following statuses are possible: + CREATING – The agent is being created. + PREPARING – The agent is being prepared. + PREPARED – The agent is prepared and ready to be invoked. + NOT\$1PREPARED – The agent has been created but not yet prepared. + FAILED – The agent API operation failed. + UPDATING – The agent is being updated. + DELETING – The agent is being deleted. `AgentVersion` The version of the agent. `CreatedAt` The time at which the agent was created. `FailureReasons` Contains reasons that the agent-related API that you invoked failed. `PreparedAt` The time at which the agent was last prepared. `RecommendedActions` Contains recommended actions to take for the agent-related API that you invoked to succeed. `UpdatedAt` The time at which the agent was last updated. ## Examples ### Create an agent The following example creates an agent that orchestrates on the Anthropic Claude v2 foundation model to help customers with IT problems. It contains one action group and one knowledge base. #### YAML ``` AWSTemplateFormatVersion: 2010-09-09 Description: "CFN stack for creating an agent" Resources: ExampleAgentResource: Type: AWS::Bedrock::Agent Properties: AgentName: "Example Agent" AgentResourceRoleArn: "arn:aws:iam::123456789012:role/AmazonBedrockExecutionRoleForAgents_user" FoundationModel: "anthropic.claude-v2" Instruction: "You are an IT agent who solves customer's problems" Description: "Description is here" IdleSessionTTLInSeconds: 900 CustomerEncryptionKeyArn: "arn:aws:kms:us-west-2:123456789012:key/1234abcd-ab12-34cd-56ef-abcdefg123456" ActionGroups: - ActionGroupName: "IT Action" Description: "Testing latest IT Management action" ActionGroupExecutor: Lambda: "arn:aws:lambda:us-west-2:123456789012:function:ItAgentLambda" ApiSchema: S3: S3BucketName: "apischema-s3" S3ObjectKey: "ApiSchema.json" KnowledgeBases: - KnowledgeBaseId: "1234567890" Description: "IT Knowledge Base" KnowledgeBaseState: ENABLED ``` #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Description": "CFN stack for creating an agent", "Resources": { "ExampleAgentResource": { "Type": "AWS::Bedrock::Agent", "Properties": { "AgentName": "Example Agent", "AgentResourceRoleArn": "arn:aws:iam::123456789012:role/AmazonBedrockExecutionRoleForAgents_user", "FoundationModel": "anthropic.claude-v2", "Instruction": "You are an IT agent who solves customer's problems", "Description": "Description is here", "IdleSessionTTLInSeconds": 900, "CustomerEncryptionKeyArn": "arn:aws:kms:us-west-2:123456789012:key/1234abcd-ab12-34cd-56ef-abcdefg123456", "ActionGroups": [ { "ActionGroupName": "IT Action", "Description": "Testing latest IT Management action", "ActionGroupExecutor": { "Lambda": "arn:aws:lambda:us-west-2:123456789012:function:ItAgentLambda" }, "ApiSchema": { "S3": { "S3BucketName": "apischema-s3", "S3ObjectKey": "ApiSchema.json" } } } ], "KnowledgeBases": [ { "KnowledgeBaseId": "1234567890", "Description": "IT Knowledge Base", "KnowledgeBaseState": "ENABLED" } ] } } } } ``` # AWS::Bedrock::Agent ActionGroupExecutor Contains details about the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CustomControl](#cfn-bedrock-agent-actiongroupexecutor-customcontrol)" : String, "[Lambda](#cfn-bedrock-agent-actiongroupexecutor-lambda)" : String } ``` ### YAML ``` [CustomControl](#cfn-bedrock-agent-actiongroupexecutor-customcontrol): String [Lambda](#cfn-bedrock-agent-actiongroupexecutor-lambda): String ``` ## Properties `CustomControl` To return the action group invocation results directly in the `InvokeInlineAgent` response, specify `RETURN_CONTROL`. *Required*: No *Type*: String *Allowed values*: `RETURN_CONTROL` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Lambda` The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action. *Required*: No *Type*: String *Pattern*: `^arn:(aws[a-zA-Z-]*)?:lambda:[a-z0-9-]{1,20}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Agent AgentActionGroup Contains details of the inline agent's action group. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ActionGroupExecutor](#cfn-bedrock-agent-agentactiongroup-actiongroupexecutor)" : ActionGroupExecutor, "[ActionGroupName](#cfn-bedrock-agent-agentactiongroup-actiongroupname)" : String, "[ActionGroupState](#cfn-bedrock-agent-agentactiongroup-actiongroupstate)" : String, "[ApiSchema](#cfn-bedrock-agent-agentactiongroup-apischema)" : APISchema, "[Description](#cfn-bedrock-agent-agentactiongroup-description)" : String, "[FunctionSchema](#cfn-bedrock-agent-agentactiongroup-functionschema)" : FunctionSchema, "[ParentActionGroupSignature](#cfn-bedrock-agent-agentactiongroup-parentactiongroupsignature)" : String, "[SkipResourceInUseCheckOnDelete](#cfn-bedrock-agent-agentactiongroup-skipresourceinusecheckondelete)" : Boolean } ``` ### YAML ``` [ActionGroupExecutor](#cfn-bedrock-agent-agentactiongroup-actiongroupexecutor): ActionGroupExecutor [ActionGroupName](#cfn-bedrock-agent-agentactiongroup-actiongroupname): String [ActionGroupState](#cfn-bedrock-agent-agentactiongroup-actiongroupstate): String [ApiSchema](#cfn-bedrock-agent-agentactiongroup-apischema): APISchema [Description](#cfn-bedrock-agent-agentactiongroup-description): String [FunctionSchema](#cfn-bedrock-agent-agentactiongroup-functionschema): FunctionSchema [ParentActionGroupSignature](#cfn-bedrock-agent-agentactiongroup-parentactiongroupsignature): String [SkipResourceInUseCheckOnDelete](#cfn-bedrock-agent-agentactiongroup-skipresourceinusecheckondelete): Boolean ``` ## Properties `ActionGroupExecutor` The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user. *Required*: No *Type*: [ActionGroupExecutor](aws-properties-bedrock-agent-actiongroupexecutor.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ActionGroupName` The name of the action group. *Required*: Yes *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ActionGroupState` Specifies whether the action group is available for the agent to invoke or not when sending an [InvokeAgent](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) request. *Required*: No *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ApiSchema` Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see [Action group OpenAPI schemas](https://docs.aws.amazon.com//bedrock/latest/userguide/agents-api-schema.html). *Required*: No *Type*: [APISchema](aws-properties-bedrock-agent-apischema.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` A description of the action group. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FunctionSchema` Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema. *Required*: No *Type*: [FunctionSchema](aws-properties-bedrock-agent-functionschema.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ParentActionGroupSignature` If this field is set as `AMAZON.UserInput`, the agent can request the user for additional information when trying to complete a task. The `description`, `apiSchema`, and `actionGroupExecutor` fields must be blank for this action group. During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an [Observation](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html) reprompting the user for more information. *Required*: No *Type*: String *Allowed values*: `AMAZON.UserInput | AMAZON.CodeInterpreter` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SkipResourceInUseCheckOnDelete` Specifies whether to delete the resource even if it's in use. By default, this value is `false`. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Agent AgentCollaborator An agent collaborator. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AgentDescriptor](#cfn-bedrock-agent-agentcollaborator-agentdescriptor)" : AgentDescriptor, "[CollaborationInstruction](#cfn-bedrock-agent-agentcollaborator-collaborationinstruction)" : String, "[CollaboratorName](#cfn-bedrock-agent-agentcollaborator-collaboratorname)" : String, "[RelayConversationHistory](#cfn-bedrock-agent-agentcollaborator-relayconversationhistory)" : String } ``` ### YAML ``` [AgentDescriptor](#cfn-bedrock-agent-agentcollaborator-agentdescriptor): AgentDescriptor [CollaborationInstruction](#cfn-bedrock-agent-agentcollaborator-collaborationinstruction): String [CollaboratorName](#cfn-bedrock-agent-agentcollaborator-collaboratorname): String [RelayConversationHistory](#cfn-bedrock-agent-agentcollaborator-relayconversationhistory): String ``` ## Properties `AgentDescriptor` The collaborator's agent descriptor. *Required*: Yes *Type*: [AgentDescriptor](aws-properties-bedrock-agent-agentdescriptor.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CollaborationInstruction` The collaborator's instructions. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `4000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CollaboratorName` The collaborator's collaborator name. *Required*: Yes *Type*: String *Pattern*: `([0-9a-zA-Z][_-]?){1,100}` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RelayConversationHistory` The collaborator's relay conversation history. *Required*: No *Type*: String *Allowed values*: `TO_COLLABORATOR | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Agent AgentDescriptor An agent descriptor. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AliasArn](#cfn-bedrock-agent-agentdescriptor-aliasarn)" : String } ``` ### YAML ``` [AliasArn](#cfn-bedrock-agent-agentdescriptor-aliasarn): String ``` ## Properties `AliasArn` The agent's alias ARN. *Required*: No *Type*: String *Pattern*: `^arn:(aws[a-zA-Z-]*)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Agent AgentKnowledgeBase Contains details about a knowledge base that is associated with an agent. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Description](#cfn-bedrock-agent-agentknowledgebase-description)" : String, "[KnowledgeBaseId](#cfn-bedrock-agent-agentknowledgebase-knowledgebaseid)" : String, "[KnowledgeBaseState](#cfn-bedrock-agent-agentknowledgebase-knowledgebasestate)" : String } ``` ### YAML ``` [Description](#cfn-bedrock-agent-agentknowledgebase-description): String [KnowledgeBaseId](#cfn-bedrock-agent-agentknowledgebase-knowledgebaseid): String [KnowledgeBaseState](#cfn-bedrock-agent-agentknowledgebase-knowledgebasestate): String ``` ## Properties `Description` The description of the association between the agent and the knowledge base. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KnowledgeBaseId` The unique identifier of the association between the agent and the knowledge base. *Required*: Yes *Type*: String *Pattern*: `^[0-9a-zA-Z]{10}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KnowledgeBaseState` Specifies whether to use the knowledge base or not when sending an [InvokeAgent](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) request. *Required*: No *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Agent APISchema Contains details about the OpenAPI schema for the action group. For more information, see [Action group OpenAPI schemas](https://docs.aws.amazon.com//bedrock/latest/userguide/agents-api-schema.html). You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Payload](#cfn-bedrock-agent-apischema-payload)" : String, "[S3](#cfn-bedrock-agent-apischema-s3)" : S3Identifier } ``` ### YAML ``` [Payload](#cfn-bedrock-agent-apischema-payload): String [S3](#cfn-bedrock-agent-apischema-s3): S3Identifier ``` ## Properties `Payload` The JSON or YAML-formatted payload defining the OpenAPI schema for the action group. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3` Contains details about the S3 object containing the OpenAPI schema for the action group. *Required*: No *Type*: [S3Identifier](aws-properties-bedrock-agent-s3identifier.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Agent CustomOrchestration Contains details of the custom orchestration configured for the agent. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Executor](#cfn-bedrock-agent-customorchestration-executor)" : OrchestrationExecutor } ``` ### YAML ``` [Executor](#cfn-bedrock-agent-customorchestration-executor): OrchestrationExecutor ``` ## Properties `Executor` The structure of the executor invoking the actions in custom orchestration. *Required*: No *Type*: [OrchestrationExecutor](aws-properties-bedrock-agent-orchestrationexecutor.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Agent Function Defines parameters that the agent needs to invoke from the user to complete the function. Corresponds to an action in an action group. This data type is used in the following API operations: + [CreateAgentActionGroup request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_RequestSyntax) + [CreateAgentActionGroup response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_CreateAgentActionGroup.html#API_agent_CreateAgentActionGroup_ResponseSyntax) + [UpdateAgentActionGroup request](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_RequestSyntax) + [UpdateAgentActionGroup response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_UpdateAgentActionGroup.html#API_agent_UpdateAgentActionGroup_ResponseSyntax) + [GetAgentActionGroup response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetAgentActionGroup.html#API_agent_GetAgentActionGroup_ResponseSyntax) ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Description](#cfn-bedrock-agent-function-description)" : String, "[Name](#cfn-bedrock-agent-function-name)" : String, "[Parameters](#cfn-bedrock-agent-function-parameters)" : {Key: Value, ...}, "[RequireConfirmation](#cfn-bedrock-agent-function-requireconfirmation)" : String } ``` ### YAML ``` [Description](#cfn-bedrock-agent-function-description): String [Name](#cfn-bedrock-agent-function-name): String [Parameters](#cfn-bedrock-agent-function-parameters): Key: Value [RequireConfirmation](#cfn-bedrock-agent-function-requireconfirmation): String ``` ## Properties `Description` A description of the function and its purpose. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `1200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` A name for the function. *Required*: Yes *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Parameters` The parameters that the agent elicits from the user to fulfill the function. *Required*: No *Type*: Object of [ParameterDetail](aws-properties-bedrock-agent-parameterdetail.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RequireConfirmation` Contains information if user confirmation is required to invoke the function. *Required*: No *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Agent FunctionSchema Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Functions](#cfn-bedrock-agent-functionschema-functions)" : [ Function, ... ] } ``` ### YAML ``` [Functions](#cfn-bedrock-agent-functionschema-functions): - Function ``` ## Properties `Functions` A list of functions that each define an action in the action group. *Required*: Yes *Type*: Array of [Function](aws-properties-bedrock-agent-function.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Agent GuardrailConfiguration Configuration information for a guardrail that you use with the [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) operation. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[GuardrailIdentifier](#cfn-bedrock-agent-guardrailconfiguration-guardrailidentifier)" : String, "[GuardrailVersion](#cfn-bedrock-agent-guardrailconfiguration-guardrailversion)" : String } ``` ### YAML ``` [GuardrailIdentifier](#cfn-bedrock-agent-guardrailconfiguration-guardrailidentifier): String [GuardrailVersion](#cfn-bedrock-agent-guardrailconfiguration-guardrailversion): String ``` ## Properties `GuardrailIdentifier` The identifier for the guardrail. *Required*: No *Type*: String *Pattern*: `^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GuardrailVersion` The version of the guardrail. *Required*: No *Type*: String *Pattern*: `^(([0-9]{1,8})|(DRAFT))$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Agent InferenceConfiguration Base inference parameters to pass to a model in a call to [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) or [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html). For more information, see [Inference parameters for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html). If you need to pass additional parameters that the model supports, use the `additionalModelRequestFields` request field in the call to `Converse` or `ConverseStream`. For more information, see [Model parameters](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MaximumLength](#cfn-bedrock-agent-inferenceconfiguration-maximumlength)" : Number, "[StopSequences](#cfn-bedrock-agent-inferenceconfiguration-stopsequences)" : [ String, ... ], "[Temperature](#cfn-bedrock-agent-inferenceconfiguration-temperature)" : Number, "[TopK](#cfn-bedrock-agent-inferenceconfiguration-topk)" : Number, "[TopP](#cfn-bedrock-agent-inferenceconfiguration-topp)" : Number } ``` ### YAML ``` [MaximumLength](#cfn-bedrock-agent-inferenceconfiguration-maximumlength): Number [StopSequences](#cfn-bedrock-agent-inferenceconfiguration-stopsequences): - String [Temperature](#cfn-bedrock-agent-inferenceconfiguration-temperature): Number [TopK](#cfn-bedrock-agent-inferenceconfiguration-topk): Number [TopP](#cfn-bedrock-agent-inferenceconfiguration-topp): Number ``` ## Properties `MaximumLength` The maximum number of tokens allowed in the generated response. *Required*: No *Type*: Number *Minimum*: `0` *Maximum*: `131072` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StopSequences` A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response. *Required*: No *Type*: Array of String *Minimum*: `0` *Maximum*: `4` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Temperature` The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options. The default value is the default value for the model that you are using. For more information, see [Inference parameters for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html). *Required*: No *Type*: Number *Minimum*: `0` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TopK` While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for `topK` is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set `topK` to 50, the model selects the next token from among the top 50 most likely choices. *Required*: No *Type*: Number *Minimum*: `0` *Maximum*: `500` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TopP` The percentage of most-likely candidates that the model considers for the next token. For example, if you choose a value of 0.8 for `topP`, the model selects from the top 80% of the probability distribution of tokens that could be next in the sequence. The default value is the default value for the model that you are using. For more information, see [Inference parameters for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html). *Required*: No *Type*: Number *Minimum*: `0` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Agent MemoryConfiguration Details of the memory configuration. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[EnabledMemoryTypes](#cfn-bedrock-agent-memoryconfiguration-enabledmemorytypes)" : [ String, ... ], "[SessionSummaryConfiguration](#cfn-bedrock-agent-memoryconfiguration-sessionsummaryconfiguration)" : SessionSummaryConfiguration, "[StorageDays](#cfn-bedrock-agent-memoryconfiguration-storagedays)" : Number } ``` ### YAML ``` [EnabledMemoryTypes](#cfn-bedrock-agent-memoryconfiguration-enabledmemorytypes): - String [SessionSummaryConfiguration](#cfn-bedrock-agent-memoryconfiguration-sessionsummaryconfiguration): SessionSummaryConfiguration [StorageDays](#cfn-bedrock-agent-memoryconfiguration-storagedays): Number ``` ## Properties `EnabledMemoryTypes` The type of memory that is stored. *Required*: No *Type*: Array of String *Minimum*: `1` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SessionSummaryConfiguration` Contains the configuration for SESSION\$1SUMMARY memory type enabled for the agent. *Required*: No *Type*: [SessionSummaryConfiguration](aws-properties-bedrock-agent-sessionsummaryconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StorageDays` The number of days the agent is configured to retain the conversational context. *Required*: No *Type*: Number *Minimum*: `0` *Maximum*: `365` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Agent OrchestrationExecutor The structure of the executor invoking the actions in custom orchestration. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Lambda](#cfn-bedrock-agent-orchestrationexecutor-lambda)" : String } ``` ### YAML ``` [Lambda](#cfn-bedrock-agent-orchestrationexecutor-lambda): String ``` ## Properties `Lambda` The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action. *Required*: Yes *Type*: String *Pattern*: `^arn:(aws[a-zA-Z-]*)?:lambda:[a-z0-9-]{1,20}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Agent ParameterDetail Contains details about a parameter in a function for an action group. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Description](#cfn-bedrock-agent-parameterdetail-description)" : String, "[Required](#cfn-bedrock-agent-parameterdetail-required)" : Boolean, "[Type](#cfn-bedrock-agent-parameterdetail-type)" : String } ``` ### YAML ``` [Description](#cfn-bedrock-agent-parameterdetail-description): String [Required](#cfn-bedrock-agent-parameterdetail-required): Boolean [Type](#cfn-bedrock-agent-parameterdetail-type): String ``` ## Properties `Description` A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `500` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Required` Whether the parameter is required for the agent to complete the function for action group invocation. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The data type of the parameter. *Required*: Yes *Type*: String *Allowed values*: `string | number | integer | boolean | array` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Agent PromptConfiguration Contains configurations to override a prompt template in one part of an agent sequence. For more information, see [Advanced prompts](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AdditionalModelRequestFields](#cfn-bedrock-agent-promptconfiguration-additionalmodelrequestfields)" : Json, "[BasePromptTemplate](#cfn-bedrock-agent-promptconfiguration-baseprompttemplate)" : String, "[FoundationModel](#cfn-bedrock-agent-promptconfiguration-foundationmodel)" : String, "[InferenceConfiguration](#cfn-bedrock-agent-promptconfiguration-inferenceconfiguration)" : InferenceConfiguration, "[ParserMode](#cfn-bedrock-agent-promptconfiguration-parsermode)" : String, "[PromptCreationMode](#cfn-bedrock-agent-promptconfiguration-promptcreationmode)" : String, "[PromptState](#cfn-bedrock-agent-promptconfiguration-promptstate)" : String, "[PromptType](#cfn-bedrock-agent-promptconfiguration-prompttype)" : String } ``` ### YAML ``` [AdditionalModelRequestFields](#cfn-bedrock-agent-promptconfiguration-additionalmodelrequestfields): Json [BasePromptTemplate](#cfn-bedrock-agent-promptconfiguration-baseprompttemplate): String [FoundationModel](#cfn-bedrock-agent-promptconfiguration-foundationmodel): String [InferenceConfiguration](#cfn-bedrock-agent-promptconfiguration-inferenceconfiguration): InferenceConfiguration [ParserMode](#cfn-bedrock-agent-promptconfiguration-parsermode): String [PromptCreationMode](#cfn-bedrock-agent-promptconfiguration-promptcreationmode): String [PromptState](#cfn-bedrock-agent-promptconfiguration-promptstate): String [PromptType](#cfn-bedrock-agent-promptconfiguration-prompttype): String ``` ## Properties `AdditionalModelRequestFields` If the Converse or ConverseStream operations support the model, `additionalModelRequestFields` contains additional inference parameters, beyond the base set of inference parameters in the `inferenceConfiguration` field. For more information, see [Inference request parameters and response fields for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html). *Required*: No *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BasePromptTemplate` Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see [Prompt template placeholder variables](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html). For more information, see [Configure the prompt templates](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts-configure.html). *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `100000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FoundationModel` The agent's foundation model. *Required*: No *Type*: String *Pattern*: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:(([0-9]{12}:custom-model/[a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}(([:][a-z0-9-]{1,63}){0,2})?/[a-z0-9]{12})|(:foundation-model/([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|([0-9]{12}:(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+))|(([a-z0-9-]{1,63}[.]{1}[a-z0-9-]{1,63}([.]?[a-z0-9-]{1,63})([:][a-z0-9-]{1,63}){0,2}))|(([0-9a-zA-Z][_-]?)+)$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InferenceConfiguration` Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the `promptType`. For more information, see [Inference parameters for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html). *Required*: No *Type*: [InferenceConfiguration](aws-properties-bedrock-agent-inferenceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ParserMode` Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the `promptType`. If you set the field as `OVERRIDDEN`, the `overrideLambda` field in the [PromptOverrideConfiguration](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html) must be specified with the ARN of a Lambda function. *Required*: No *Type*: String *Allowed values*: `DEFAULT | OVERRIDDEN` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PromptCreationMode` Specifies whether to override the default prompt template for this `promptType`. Set this value to `OVERRIDDEN` to use the prompt that you provide in the `basePromptTemplate`. If you leave it as `DEFAULT`, the agent uses a default prompt template. *Required*: No *Type*: String *Allowed values*: `DEFAULT | OVERRIDDEN` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PromptState` Specifies whether to allow the inline agent to carry out the step specified in the `promptType`. If you set this value to `DISABLED`, the agent skips that step. The default state for each `promptType` is as follows. + `PRE_PROCESSING` – `ENABLED` + `ORCHESTRATION` – `ENABLED` + `KNOWLEDGE_BASE_RESPONSE_GENERATION` – `ENABLED` + `POST_PROCESSING` – `DISABLED` *Required*: No *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PromptType` The step in the agent sequence that this prompt configuration applies to. *Required*: No *Type*: String *Allowed values*: `PRE_PROCESSING | ORCHESTRATION | POST_PROCESSING | ROUTING_CLASSIFIER | MEMORY_SUMMARIZATION | KNOWLEDGE_BASE_RESPONSE_GENERATION` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Agent PromptOverrideConfiguration Contains configurations to override prompts in different parts of an agent sequence. For more information, see [Advanced prompts](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[OverrideLambda](#cfn-bedrock-agent-promptoverrideconfiguration-overridelambda)" : String, "[PromptConfigurations](#cfn-bedrock-agent-promptoverrideconfiguration-promptconfigurations)" : [ PromptConfiguration, ... ] } ``` ### YAML ``` [OverrideLambda](#cfn-bedrock-agent-promptoverrideconfiguration-overridelambda): String [PromptConfigurations](#cfn-bedrock-agent-promptoverrideconfiguration-promptconfigurations): - PromptConfiguration ``` ## Properties `OverrideLambda` The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence. If you specify this field, at least one of the `promptConfigurations` must contain a `parserMode` value that is set to `OVERRIDDEN`. For more information, see [Parser Lambda function in Amazon Bedrock Agents](https://docs.aws.amazon.com/bedrock/latest/userguide/lambda-parser.html). *Required*: No *Type*: String *Pattern*: `^arn:(aws[a-zA-Z-]*)?:lambda:[a-z0-9-]{1,20}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PromptConfigurations` Contains configurations to override a prompt template in one part of an agent sequence. For more information, see [Advanced prompts](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html). *Required*: Yes *Type*: Array of [PromptConfiguration](aws-properties-bedrock-agent-promptconfiguration.md) *Maximum*: `10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Agent S3Identifier The identifier information for an Amazon S3 bucket. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[S3BucketName](#cfn-bedrock-agent-s3identifier-s3bucketname)" : String, "[S3ObjectKey](#cfn-bedrock-agent-s3identifier-s3objectkey)" : String } ``` ### YAML ``` [S3BucketName](#cfn-bedrock-agent-s3identifier-s3bucketname): String [S3ObjectKey](#cfn-bedrock-agent-s3identifier-s3objectkey): String ``` ## Properties `S3BucketName` The name of the S3 bucket. *Required*: No *Type*: String *Pattern*: `^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$` *Minimum*: `3` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3ObjectKey` The S3 object key for the S3 resource. *Required*: No *Type*: String *Pattern*: `^[\.\-\!\*\_\'a-zA-Z0-9][\.\-\!\*\_\'\/a-zA-Z0-9]*$` *Minimum*: `1` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Agent SessionSummaryConfiguration Configuration for SESSION\$1SUMMARY memory type enabled for the agent. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MaxRecentSessions](#cfn-bedrock-agent-sessionsummaryconfiguration-maxrecentsessions)" : Number } ``` ### YAML ``` [MaxRecentSessions](#cfn-bedrock-agent-sessionsummaryconfiguration-maxrecentsessions): Number ``` ## Properties `MaxRecentSessions` Maximum number of recent session summaries to include in the agent's prompt context. *Required*: No *Type*: Number *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::AgentAlias Specifies an agent alias as a resource in a top-level template. Minimally, you must specify the following properties: + AgentAliasName – Specify a name for the alias. For more information about creating aliases for an agent in Amazon Bedrock, see [Deploy an Amazon Bedrock agent](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-deploy.html). See the **Properties** section below for descriptions of both the required and optional properties. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::Bedrock::AgentAlias", "Properties" : { "[AgentAliasName](#cfn-bedrock-agentalias-agentaliasname)" : String, "[AgentId](#cfn-bedrock-agentalias-agentid)" : String, "[Description](#cfn-bedrock-agentalias-description)" : String, "[RoutingConfiguration](#cfn-bedrock-agentalias-routingconfiguration)" : [ AgentAliasRoutingConfigurationListItem, ... ], "[Tags](#cfn-bedrock-agentalias-tags)" : {Key: Value, ...} } } ``` ### YAML ``` Type: AWS::Bedrock::AgentAlias Properties: [AgentAliasName](#cfn-bedrock-agentalias-agentaliasname): String [AgentId](#cfn-bedrock-agentalias-agentid): String [Description](#cfn-bedrock-agentalias-description): String [RoutingConfiguration](#cfn-bedrock-agentalias-routingconfiguration): - AgentAliasRoutingConfigurationListItem [Tags](#cfn-bedrock-agentalias-tags): Key: Value ``` ## Properties `AgentAliasName` The name of the alias of the agent. *Required*: Yes *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `AgentId` The unique identifier of the agent. *Required*: Yes *Type*: String *Pattern*: `^[0-9a-zA-Z]{10}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Description` The description of the alias of the agent. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RoutingConfiguration` Contains details about the routing configuration of the alias. *Required*: No *Type*: Array of [AgentAliasRoutingConfigurationListItem](aws-properties-bedrock-agentalias-agentaliasroutingconfigurationlistitem.md) *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources: + [Tag naming limits and requirements](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions) + [Tagging best practices](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices) *Required*: No *Type*: Object of String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the agent ID and the agent alias ID, separated by a pipe (`|`). For example, `{ "Ref": "myAgentAlias" }` could return the value `"AGENT12345|ALIAS12345"`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `AgentAliasArn` The Amazon Resource Name (ARN) of the alias of the agent. `AgentAliasHistoryEvents` Contains details about the history of the alias. `AgentAliasId` The unique identifier of the alias of the agent. `AgentAliasStatus` The status of the alias of the agent and whether it is ready for use. The following statuses are possible: + CREATING – The agent alias is being created. + PREPARED – The agent alias is finished being created or updated and is ready to be invoked. + FAILED – The agent alias API operation failed. + UPDATING – The agent alias is being updated. + DELETING – The agent alias is being deleted. + DISSOCIATED - The agent alias has no version associated with it. `CreatedAt` The time at which the alias of the agent was created. `UpdatedAt` The time at which the alias was last updated. ## Examples ### Create an alias for an agent The following example creates an alias that points to version 1 of an agent. #### YAML ``` AWSTemplateFormatVersion: 2010-09-09 Description: "CFN stack for creating an AgentAlias" Resources: ExampleAgentAliasResource: Type: AWS::Bedrock::AgentAlias Properties: AgentId: "1234567890" AgentAliasName: "TestAlias" Description: "Alias for testing" RoutingConfiguration: - AgentVersion: "1" ``` #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Description": "CFN stack for creating an AgentAlias", "Resources": { "ExampleAgentAliasResource": { "Type": "AWS::Bedrock::AgentAlias", "Properties": { "AgentId": "1234567890", "AgentAliasName": "TestAlias", "Description": "Alias for testing", "RoutingConfiguration": { "AgentVersion": "1" } } } } } ``` # AWS::Bedrock::AgentAlias AgentAliasHistoryEvent Contains details about the history of the alias. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[EndDate](#cfn-bedrock-agentalias-agentaliashistoryevent-enddate)" : String, "[RoutingConfiguration](#cfn-bedrock-agentalias-agentaliashistoryevent-routingconfiguration)" : [ AgentAliasRoutingConfigurationListItem, ... ], "[StartDate](#cfn-bedrock-agentalias-agentaliashistoryevent-startdate)" : String } ``` ### YAML ``` [EndDate](#cfn-bedrock-agentalias-agentaliashistoryevent-enddate): String [RoutingConfiguration](#cfn-bedrock-agentalias-agentaliashistoryevent-routingconfiguration): - AgentAliasRoutingConfigurationListItem [StartDate](#cfn-bedrock-agentalias-agentaliashistoryevent-startdate): String ``` ## Properties `EndDate` The date that the alias stopped being associated to the version in the `routingConfiguration` object *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RoutingConfiguration` Contains details about the version of the agent with which the alias is associated. *Required*: No *Type*: Array of [AgentAliasRoutingConfigurationListItem](aws-properties-bedrock-agentalias-agentaliasroutingconfigurationlistitem.md) *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StartDate` The date that the alias began being associated to the version in the `routingConfiguration` object. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::AgentAlias AgentAliasRoutingConfigurationListItem Contains details about the routing configuration of the alias. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AgentVersion](#cfn-bedrock-agentalias-agentaliasroutingconfigurationlistitem-agentversion)" : String } ``` ### YAML ``` [AgentVersion](#cfn-bedrock-agentalias-agentaliasroutingconfigurationlistitem-agentversion): String ``` ## Properties `AgentVersion` The version of the agent with which the alias is associated. *Required*: Yes *Type*: String *Pattern*: `^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$` *Minimum*: `1` *Maximum*: `5` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::ApplicationInferenceProfile Specifies an inference profile as a resource in a top-level template. Use the `ModelSource` field to specify the inference profile to copy into the resource. For more information about using inference profiles in Amazon Bedrock, see [Improve resilience with cross-region inference ](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html). See the **Properties** section below for descriptions of both the required and optional properties. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::Bedrock::ApplicationInferenceProfile", "Properties" : { "[Description](#cfn-bedrock-applicationinferenceprofile-description)" : String, "[InferenceProfileName](#cfn-bedrock-applicationinferenceprofile-inferenceprofilename)" : String, "[ModelSource](#cfn-bedrock-applicationinferenceprofile-modelsource)" : InferenceProfileModelSource, "[Tags](#cfn-bedrock-applicationinferenceprofile-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::Bedrock::ApplicationInferenceProfile Properties: [Description](#cfn-bedrock-applicationinferenceprofile-description): String [InferenceProfileName](#cfn-bedrock-applicationinferenceprofile-inferenceprofilename): String [ModelSource](#cfn-bedrock-applicationinferenceprofile-modelsource): InferenceProfileModelSource [Tags](#cfn-bedrock-applicationinferenceprofile-tags): - Tag ``` ## Properties `Description` The description of the inference profile. *Required*: No *Type*: String *Pattern*: `^([0-9a-zA-Z:.][ _-]?)+$` *Minimum*: `1` *Maximum*: `200` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `InferenceProfileName` The name of the inference profile. *Required*: Yes *Type*: String *Pattern*: `^([0-9a-zA-Z][ _-]?)+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ModelSource` Contains configurations for the inference profile to copy as the resource. *Required*: No *Type*: [InferenceProfileModelSource](aws-properties-bedrock-applicationinferenceprofile-inferenceprofilemodelsource.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Tags` A list of tags associated with the inference profile. *Required*: No *Type*: Array of [Tag](aws-properties-bedrock-applicationinferenceprofile-tag.md) *Minimum*: `0` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the inference profile ID. For example, `{ "Ref": "myInferenceProfile" }` could return the value `"IP12345678"`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `CreatedAt` The time at which the inference profile was created. `InferenceProfileArn` The Amazon Resource Name (ARN) of the inference profile. `InferenceProfileId` The unique identifier of the inference profile. `InferenceProfileIdentifier` The ID or Amazon Resource Name (ARN) of the inference profile. `Models` A list of information about each model in the inference profile. `Status` The status of the inference profile. `ACTIVE` means that the inference profile is ready to be used. `Type` The type of the inference profile. The following types are possible: + `SYSTEM_DEFINED` – The inference profile is defined by Amazon Bedrock. You can route inference requests across regions with these inference profiles. + `APPLICATION` – The inference profile was created by a user. This type of inference profile can track metrics and costs when invoking the model in it. The inference profile may route requests to one or multiple regions. `UpdatedAt` The time at which the inference profile was last updated. ## Examples ### Create an inference profile The following example creates an inference profile for the Anthropic Claude 3.5 Sonnet model in the US West (Oregon) region: #### YAML ``` AWSTemplateFormatVersion: '2010-09-09' Description: Example Application Inference Profile Resources: ExampleApplicationInferenceProfile: Type: AWS::Bedrock::ApplicationInferenceProfile Properties: ModelSource: CopyFrom: "arn:aws:bedrock:us-west-2::foundation-model/anthropic.claude-3-5-sonnet-20240620-v1:0" InferenceProfileName: Example Application Inference Profile Name Description: Description of ExampleApplicationInferenceProfile ``` #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Description": "Example Application Inference Profile", "Resources": { "ExampleApplicationInferenceProfile": { "Type": "AWS::Bedrock::ApplicationInferenceProfile", "Properties": { "ModelSource": { "CopyFrom": "arn:aws:bedrock:us-west-2::foundation-model/anthropic.claude-3-5-sonnet-20240620-v1:0" }, "InferenceProfileName": "Example Application Inference Profile Name", "Description": "Description of ExampleApplicationInferenceProfile" } } } } ``` # AWS::Bedrock::ApplicationInferenceProfile InferenceProfileModel Contains information about a model. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ModelArn](#cfn-bedrock-applicationinferenceprofile-inferenceprofilemodel-modelarn)" : String } ``` ### YAML ``` [ModelArn](#cfn-bedrock-applicationinferenceprofile-inferenceprofilemodel-modelarn): String ``` ## Properties `ModelArn` The Amazon Resource Name (ARN) of the model. *Required*: No *Type*: String *Pattern*: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::ApplicationInferenceProfile InferenceProfileModelSource Contains information about the model or system-defined inference profile that is the source for an inference profile.. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CopyFrom](#cfn-bedrock-applicationinferenceprofile-inferenceprofilemodelsource-copyfrom)" : String } ``` ### YAML ``` [CopyFrom](#cfn-bedrock-applicationinferenceprofile-inferenceprofilemodelsource-copyfrom): String ``` ## Properties `CopyFrom` The ARN of the model or system-defined inference profile that is the source for the inference profile. *Required*: Yes *Type*: String *Pattern*: `^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|foundation-model)/[a-zA-Z0-9-:.]+$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::ApplicationInferenceProfile Tag A tag associated with a resource. A tag consists of a key and value. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-bedrock-applicationinferenceprofile-tag-key)" : String, "[Value](#cfn-bedrock-applicationinferenceprofile-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-bedrock-applicationinferenceprofile-tag-key): String [Value](#cfn-bedrock-applicationinferenceprofile-tag-value): String ``` ## Properties `Key` The key associated with a tag. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value associated with a tag. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::AutomatedReasoningPolicy Creates an Automated Reasoning policy for Amazon Bedrock Guardrails. Automated Reasoning policies use mathematical techniques to detect hallucinations, suggest corrections, and highlight unstated assumptions in the responses of your GenAI application. To create a policy, you upload a source document that describes the rules that you're encoding. Automated Reasoning extracts important concepts from the source document that will become variables in the policy and infers policy rules. To learn more about creating Automated Reasoning policies, see [Minimize AI hallucinations and deliver up to 99% verification accuracy with Automated Reasoning checks: Now available](https://aws.amazon.com/blogs/aws/minimize-ai-hallucinations-and-deliver-up-to-99-verification-accuracy-with-automated-reasoning-checks-now-available/) in the *AWS News Blog*. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::Bedrock::AutomatedReasoningPolicy", "Properties" : { "[Description](#cfn-bedrock-automatedreasoningpolicy-description)" : String, "[ForceDelete](#cfn-bedrock-automatedreasoningpolicy-forcedelete)" : Boolean, "[KmsKeyId](#cfn-bedrock-automatedreasoningpolicy-kmskeyid)" : String, "[Name](#cfn-bedrock-automatedreasoningpolicy-name)" : String, "[PolicyDefinition](#cfn-bedrock-automatedreasoningpolicy-policydefinition)" : PolicyDefinition, "[Tags](#cfn-bedrock-automatedreasoningpolicy-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::Bedrock::AutomatedReasoningPolicy Properties: [Description](#cfn-bedrock-automatedreasoningpolicy-description): String [ForceDelete](#cfn-bedrock-automatedreasoningpolicy-forcedelete): Boolean [KmsKeyId](#cfn-bedrock-automatedreasoningpolicy-kmskeyid): String [Name](#cfn-bedrock-automatedreasoningpolicy-name): String [PolicyDefinition](#cfn-bedrock-automatedreasoningpolicy-policydefinition): PolicyDefinition [Tags](#cfn-bedrock-automatedreasoningpolicy-tags): - Tag ``` ## Properties `Description` The description of the policy. *Required*: No *Type*: String *Pattern*: `^[\s\S]+$` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ForceDelete` Property description not available. *Required*: No *Type*: Boolean *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `KmsKeyId` Property description not available. *Required*: No *Type*: String *Pattern*: `^(arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:((key/[a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)))|([a-zA-Z0-9-]{36})|(alias/[a-zA-Z0-9-_/]+)$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Name` The name of the policy. *Required*: Yes *Type*: String *Pattern*: `^[0-9a-zA-Z-_ ]+$` *Minimum*: `1` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PolicyDefinition` The complete policy definition generated by the build workflow, containing all rules, variables, and custom types extracted from the source documents. *Required*: No *Type*: [PolicyDefinition](aws-properties-bedrock-automatedreasoningpolicy-policydefinition.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` The tags associated with the Automated Reasoning policy. *Required*: No *Type*: Array of [Tag](aws-properties-bedrock-automatedreasoningpolicy-tag.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref Returns the policy ID. ### Fn::GetAtt Returns the value of an attribute from a resource in the template. #### `CreatedAt` The timestamp when the policy was created. `DefinitionHash` A hash of the policy definition used to identify the version. `KmsKeyArn` Property description not available. `PolicyArn` The Amazon Resource Name (ARN) of the policy. `PolicyId` The unique identifier of the policy. `UpdatedAt` The timestamp when the policy was last updated. `Version` The version of the policy. # AWS::Bedrock::AutomatedReasoningPolicy PolicyDefinition The complete policy definition containing rules, variables, and types. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Rules](#cfn-bedrock-automatedreasoningpolicy-policydefinition-rules)" : [ PolicyDefinitionRule, ... ], "[Types](#cfn-bedrock-automatedreasoningpolicy-policydefinition-types)" : [ PolicyDefinitionType, ... ], "[Variables](#cfn-bedrock-automatedreasoningpolicy-policydefinition-variables)" : [ PolicyDefinitionVariable, ... ], "[Version](#cfn-bedrock-automatedreasoningpolicy-policydefinition-version)" : String } ``` ### YAML ``` [Rules](#cfn-bedrock-automatedreasoningpolicy-policydefinition-rules): - PolicyDefinitionRule [Types](#cfn-bedrock-automatedreasoningpolicy-policydefinition-types): - PolicyDefinitionType [Variables](#cfn-bedrock-automatedreasoningpolicy-policydefinition-variables): - PolicyDefinitionVariable [Version](#cfn-bedrock-automatedreasoningpolicy-policydefinition-version): String ``` ## Properties `Rules` The collection of rules that define the policy logic. *Required*: No *Type*: Array of [PolicyDefinitionRule](aws-properties-bedrock-automatedreasoningpolicy-policydefinitionrule.md) *Maximum*: `500` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Types` The custom types defined within the policy definition. *Required*: No *Type*: Array of [PolicyDefinitionType](aws-properties-bedrock-automatedreasoningpolicy-policydefinitiontype.md) *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Variables` The variables used within the policy definition. *Required*: No *Type*: Array of [PolicyDefinitionVariable](aws-properties-bedrock-automatedreasoningpolicy-policydefinitionvariable.md) *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Version` The version of the policy definition. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::AutomatedReasoningPolicy PolicyDefinitionRule A rule within the policy definition that defines logical constraints. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AlternateExpression](#cfn-bedrock-automatedreasoningpolicy-policydefinitionrule-alternateexpression)" : String, "[Expression](#cfn-bedrock-automatedreasoningpolicy-policydefinitionrule-expression)" : String, "[Id](#cfn-bedrock-automatedreasoningpolicy-policydefinitionrule-id)" : String } ``` ### YAML ``` [AlternateExpression](#cfn-bedrock-automatedreasoningpolicy-policydefinitionrule-alternateexpression): String [Expression](#cfn-bedrock-automatedreasoningpolicy-policydefinitionrule-expression): String [Id](#cfn-bedrock-automatedreasoningpolicy-policydefinitionrule-id): String ``` ## Properties `AlternateExpression` An alternative expression for the policy rule. *Required*: No *Type*: String *Pattern*: `^[\s\S]+$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Expression` The logical expression that defines the rule. *Required*: Yes *Type*: String *Pattern*: `^[\s\S]+$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Id` The unique identifier for the policy definition rule. *Required*: Yes *Type*: String *Pattern*: `^[A-Z][0-9A-Z]{11}$` *Minimum*: `12` *Maximum*: `12` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::AutomatedReasoningPolicy PolicyDefinitionType A custom type definition within the policy. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Description](#cfn-bedrock-automatedreasoningpolicy-policydefinitiontype-description)" : String, "[Name](#cfn-bedrock-automatedreasoningpolicy-policydefinitiontype-name)" : String, "[Values](#cfn-bedrock-automatedreasoningpolicy-policydefinitiontype-values)" : [ PolicyDefinitionTypeValue, ... ] } ``` ### YAML ``` [Description](#cfn-bedrock-automatedreasoningpolicy-policydefinitiontype-description): String [Name](#cfn-bedrock-automatedreasoningpolicy-policydefinitiontype-name): String [Values](#cfn-bedrock-automatedreasoningpolicy-policydefinitiontype-values): - PolicyDefinitionTypeValue ``` ## Properties `Description` A description of the custom type defined in the policy. *Required*: No *Type*: String *Pattern*: `^[\s\S]+$` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of a custom type defined in the policy. *Required*: Yes *Type*: String *Pattern*: `^[A-Za-z][A-Za-z0-9_]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Values` The possible values for a custom type defined in the policy. *Required*: Yes *Type*: Array of [PolicyDefinitionTypeValue](aws-properties-bedrock-automatedreasoningpolicy-policydefinitiontypevalue.md) *Minimum*: `1` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::AutomatedReasoningPolicy PolicyDefinitionTypeValue A value associated with a custom type in the policy definition. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Description](#cfn-bedrock-automatedreasoningpolicy-policydefinitiontypevalue-description)" : String, "[Value](#cfn-bedrock-automatedreasoningpolicy-policydefinitiontypevalue-value)" : String } ``` ### YAML ``` [Description](#cfn-bedrock-automatedreasoningpolicy-policydefinitiontypevalue-description): String [Value](#cfn-bedrock-automatedreasoningpolicy-policydefinitiontypevalue-value): String ``` ## Properties `Description` A description of the policy definition type value. *Required*: No *Type*: String *Pattern*: `^[\s\S]+$` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value associated with a policy definition type. *Required*: Yes *Type*: String *Pattern*: `^[A-Za-z][A-Za-z0-9_]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::AutomatedReasoningPolicy PolicyDefinitionVariable A variable defined within the policy that can be used in rules. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Description](#cfn-bedrock-automatedreasoningpolicy-policydefinitionvariable-description)" : String, "[Name](#cfn-bedrock-automatedreasoningpolicy-policydefinitionvariable-name)" : String, "[Type](#cfn-bedrock-automatedreasoningpolicy-policydefinitionvariable-type)" : String } ``` ### YAML ``` [Description](#cfn-bedrock-automatedreasoningpolicy-policydefinitionvariable-description): String [Name](#cfn-bedrock-automatedreasoningpolicy-policydefinitionvariable-name): String [Type](#cfn-bedrock-automatedreasoningpolicy-policydefinitionvariable-type): String ``` ## Properties `Description` A description of a variable defined in the policy. *Required*: Yes *Type*: String *Pattern*: `^[\s\S]+$` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of a variable defined in the policy. *Required*: Yes *Type*: String *Pattern*: `^[A-Za-z][A-Za-z0-9_]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The data type of a variable defined in the policy. *Required*: Yes *Type*: String *Pattern*: `^[A-Za-z][A-Za-z0-9_]+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::AutomatedReasoningPolicy Tag A tag associated with a resource. A tag consists of a key and value. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-bedrock-automatedreasoningpolicy-tag-key)" : String, "[Value](#cfn-bedrock-automatedreasoningpolicy-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-bedrock-automatedreasoningpolicy-tag-key): String [Value](#cfn-bedrock-automatedreasoningpolicy-tag-value): String ``` ## Properties `Key` The key associated with a tag. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value associated with a tag. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::AutomatedReasoningPolicyVersion Creates a new version of an existing Automated Reasoning policy. This allows you to iterate on your policy rules while maintaining previous versions for rollback or comparison purposes. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::Bedrock::AutomatedReasoningPolicyVersion", "Properties" : { "[LastUpdatedDefinitionHash](#cfn-bedrock-automatedreasoningpolicyversion-lastupdateddefinitionhash)" : String, "[PolicyArn](#cfn-bedrock-automatedreasoningpolicyversion-policyarn)" : String, "[Tags](#cfn-bedrock-automatedreasoningpolicyversion-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::Bedrock::AutomatedReasoningPolicyVersion Properties: [LastUpdatedDefinitionHash](#cfn-bedrock-automatedreasoningpolicyversion-lastupdateddefinitionhash): String [PolicyArn](#cfn-bedrock-automatedreasoningpolicyversion-policyarn): String [Tags](#cfn-bedrock-automatedreasoningpolicyversion-tags): - Tag ``` ## Properties `LastUpdatedDefinitionHash` The hash of the policy definition that was last updated. *Required*: No *Type*: String *Pattern*: `^[0-9a-z]{128}$` *Minimum*: `128` *Maximum*: `128` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `PolicyArn` The Amazon Resource Name (ARN) of the policy. *Required*: Yes *Type*: String *Pattern*: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:automated-reasoning-policy\/[a-z0-9]{12}$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Tags` The tags associated with the Automated Reasoning policy version. *Required*: No *Type*: Array of [Tag](aws-properties-bedrock-automatedreasoningpolicyversion-tag.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Return values ### Ref Returns the policy version ID. ### Fn::GetAtt Returns the value of an attribute from a resource in the template. #### `CreatedAt` The timestamp when the policy version was created. `DefinitionHash` A hash of the policy definition used to identify the version. `Description` The description of the policy version. `Name` The name of the policy version. `PolicyId` The unique identifier of the policy. `UpdatedAt` The timestamp when the policy version was last updated. `Version` The version number of the policy version. # AWS::Bedrock::AutomatedReasoningPolicyVersion Tag A tag associated with a resource. A tag consists of a key and value. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-bedrock-automatedreasoningpolicyversion-tag-key)" : String, "[Value](#cfn-bedrock-automatedreasoningpolicyversion-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-bedrock-automatedreasoningpolicyversion-tag-key): String [Value](#cfn-bedrock-automatedreasoningpolicyversion-tag-value): String ``` ## Properties `Key` The key associated with a tag. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Value` The value associated with a tag. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `0` *Maximum*: `256` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::Blueprint Details about a data automation blueprint. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::Bedrock::Blueprint", "Properties" : { "[BlueprintName](#cfn-bedrock-blueprint-blueprintname)" : String, "[KmsEncryptionContext](#cfn-bedrock-blueprint-kmsencryptioncontext)" : {Key: Value, ...}, "[KmsKeyId](#cfn-bedrock-blueprint-kmskeyid)" : String, "[Schema](#cfn-bedrock-blueprint-schema)" : Json, "[Tags](#cfn-bedrock-blueprint-tags)" : [ Tag, ... ], "[Type](#cfn-bedrock-blueprint-type)" : String } } ``` ### YAML ``` Type: AWS::Bedrock::Blueprint Properties: [BlueprintName](#cfn-bedrock-blueprint-blueprintname): String [KmsEncryptionContext](#cfn-bedrock-blueprint-kmsencryptioncontext): Key: Value [KmsKeyId](#cfn-bedrock-blueprint-kmskeyid): String [Schema](#cfn-bedrock-blueprint-schema): Json [Tags](#cfn-bedrock-blueprint-tags): - Tag [Type](#cfn-bedrock-blueprint-type): String ``` ## Properties `BlueprintName` The blueprint's name. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9-_]+$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `KmsEncryptionContext` Name-value pairs to include as an encryption context. *Required*: No *Type*: Object of String *Pattern*: `^.*$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KmsKeyId` The AWS KMS key to use for encryption. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Schema` The blueprint's schema. *Required*: Yes *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` Property description not available. *Required*: No *Type*: Array of [Tag](aws-properties-bedrock-blueprint-tag.md) *Minimum*: `0` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The blueprint's type. *Required*: Yes *Type*: String *Allowed values*: `DOCUMENT | IMAGE | AUDIO | VIDEO` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Return values ### Ref ### Fn::GetAtt #### `BlueprintArn` The blueprint's ARN. `BlueprintStage` The blueprint's stage. `CreationTime` When the blueprint was created. `LastModifiedTime` When the blueprint was last updated. # AWS::Bedrock::Blueprint Tag A tag associated with a resource. A tag consists of a key and value. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-bedrock-blueprint-tag-key)" : String, "[Value](#cfn-bedrock-blueprint-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-bedrock-blueprint-tag-key): String [Value](#cfn-bedrock-blueprint-tag-value): String ``` ## Properties `Key` The key associated with a tag. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value associated with a tag. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationLibrary A data automation library. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::Bedrock::DataAutomationLibrary", "Properties" : { "[EncryptionConfiguration](#cfn-bedrock-dataautomationlibrary-encryptionconfiguration)" : EncryptionConfiguration, "[LibraryDescription](#cfn-bedrock-dataautomationlibrary-librarydescription)" : String, "[LibraryName](#cfn-bedrock-dataautomationlibrary-libraryname)" : String, "[Tags](#cfn-bedrock-dataautomationlibrary-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::Bedrock::DataAutomationLibrary Properties: [EncryptionConfiguration](#cfn-bedrock-dataautomationlibrary-encryptionconfiguration): EncryptionConfiguration [LibraryDescription](#cfn-bedrock-dataautomationlibrary-librarydescription): String [LibraryName](#cfn-bedrock-dataautomationlibrary-libraryname): String [Tags](#cfn-bedrock-dataautomationlibrary-tags): - Tag ``` ## Properties `EncryptionConfiguration` Encryption settings for an invocation. *Required*: No *Type*: [EncryptionConfiguration](aws-properties-bedrock-dataautomationlibrary-encryptionconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `LibraryDescription` The library's description. *Required*: No *Type*: String *Minimum*: `0` *Maximum*: `300` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LibraryName` The library's name. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9-_]+$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Tags` Property description not available. *Required*: No *Type*: Array of [Tag](aws-properties-bedrock-dataautomationlibrary-tag.md) *Minimum*: `0` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref ### Fn::GetAtt #### `CreationTime` When the library was created. `EntityTypes` The entity types supported by the library. `LibraryArn` The library's ARN. `Status` The library's status. # AWS::Bedrock::DataAutomationLibrary EncryptionConfiguration Encryption settings for an invocation. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[KmsEncryptionContext](#cfn-bedrock-dataautomationlibrary-encryptionconfiguration-kmsencryptioncontext)" : {Key: Value, ...}, "[KmsKeyId](#cfn-bedrock-dataautomationlibrary-encryptionconfiguration-kmskeyid)" : String } ``` ### YAML ``` [KmsEncryptionContext](#cfn-bedrock-dataautomationlibrary-encryptionconfiguration-kmsencryptioncontext): Key: Value [KmsKeyId](#cfn-bedrock-dataautomationlibrary-encryptionconfiguration-kmskeyid): String ``` ## Properties `KmsEncryptionContext` Name-value pairs to include as an encryption context. *Required*: No *Type*: Object of String *Pattern*: `^.*\S.*$` *Minimum*: `1` *Maximum*: `2000` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `KmsKeyId` A KMS key ID to use for encryption. *Required*: Yes *Type*: String *Pattern*: `^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]+$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::DataAutomationLibrary EntityTypeInfo Information about an entity type. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[EntityMetadata](#cfn-bedrock-dataautomationlibrary-entitytypeinfo-entitymetadata)" : String, "[EntityType](#cfn-bedrock-dataautomationlibrary-entitytypeinfo-entitytype)" : String } ``` ### YAML ``` [EntityMetadata](#cfn-bedrock-dataautomationlibrary-entitytypeinfo-entitymetadata): String [EntityType](#cfn-bedrock-dataautomationlibrary-entitytypeinfo-entitytype): String ``` ## Properties `EntityMetadata` Metadata about the entity type. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `EntityType` The entity type. *Required*: Yes *Type*: String *Allowed values*: `VOCABULARY` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationLibrary Tag A tag associated with a resource. A tag consists of a key and value. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-bedrock-dataautomationlibrary-tag-key)" : String, "[Value](#cfn-bedrock-dataautomationlibrary-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-bedrock-dataautomationlibrary-tag-key): String [Value](#cfn-bedrock-dataautomationlibrary-tag-value): String ``` ## Properties `Key` The key associated with a tag. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value associated with a tag. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject A data automation project. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::Bedrock::DataAutomationProject", "Properties" : { "[CustomOutputConfiguration](#cfn-bedrock-dataautomationproject-customoutputconfiguration)" : CustomOutputConfiguration, "[KmsEncryptionContext](#cfn-bedrock-dataautomationproject-kmsencryptioncontext)" : {Key: Value, ...}, "[KmsKeyId](#cfn-bedrock-dataautomationproject-kmskeyid)" : String, "[OverrideConfiguration](#cfn-bedrock-dataautomationproject-overrideconfiguration)" : OverrideConfiguration, "[ProjectDescription](#cfn-bedrock-dataautomationproject-projectdescription)" : String, "[ProjectName](#cfn-bedrock-dataautomationproject-projectname)" : String, "[ProjectType](#cfn-bedrock-dataautomationproject-projecttype)" : String, "[StandardOutputConfiguration](#cfn-bedrock-dataautomationproject-standardoutputconfiguration)" : StandardOutputConfiguration, "[Tags](#cfn-bedrock-dataautomationproject-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::Bedrock::DataAutomationProject Properties: [CustomOutputConfiguration](#cfn-bedrock-dataautomationproject-customoutputconfiguration): CustomOutputConfiguration [KmsEncryptionContext](#cfn-bedrock-dataautomationproject-kmsencryptioncontext): Key: Value [KmsKeyId](#cfn-bedrock-dataautomationproject-kmskeyid): String [OverrideConfiguration](#cfn-bedrock-dataautomationproject-overrideconfiguration): OverrideConfiguration [ProjectDescription](#cfn-bedrock-dataautomationproject-projectdescription): String [ProjectName](#cfn-bedrock-dataautomationproject-projectname): String [ProjectType](#cfn-bedrock-dataautomationproject-projecttype): String [StandardOutputConfiguration](#cfn-bedrock-dataautomationproject-standardoutputconfiguration): StandardOutputConfiguration [Tags](#cfn-bedrock-dataautomationproject-tags): - Tag ``` ## Properties `CustomOutputConfiguration` Blueprints to apply to objects processed by the project. *Required*: No *Type*: [CustomOutputConfiguration](aws-properties-bedrock-dataautomationproject-customoutputconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KmsEncryptionContext` The AWS KMS encryption context to use for encryption. *Required*: No *Type*: Object of String *Pattern*: `^.*$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KmsKeyId` The AWS KMS key to use for encryption. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OverrideConfiguration` Additional settings for the project. *Required*: No *Type*: [OverrideConfiguration](aws-properties-bedrock-dataautomationproject-overrideconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ProjectDescription` The project's description. *Required*: No *Type*: String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ProjectName` The project's name. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9-_]+$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ProjectType` The type of bedrock data automation API that is compatible with this project. *Required*: No *Type*: String *Allowed values*: `ASYNC | SYNC` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `StandardOutputConfiguration` The project's standard output configuration. *Required*: No *Type*: [StandardOutputConfiguration](aws-properties-bedrock-dataautomationproject-standardoutputconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` Property description not available. *Required*: No *Type*: Array of [Tag](aws-properties-bedrock-dataautomationproject-tag.md) *Minimum*: `0` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref ### Fn::GetAtt #### `CreationTime` When the project was created. `LastModifiedTime` When the project was last updated. `ProjectArn` The project's ARN. `ProjectStage` The project's stage. `Status` The project's status. # AWS::Bedrock::DataAutomationProject AudioExtractionCategory Settings for generating data from audio. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[State](#cfn-bedrock-dataautomationproject-audioextractioncategory-state)" : String, "[TypeConfiguration](#cfn-bedrock-dataautomationproject-audioextractioncategory-typeconfiguration)" : AudioExtractionCategoryTypeConfiguration, "[Types](#cfn-bedrock-dataautomationproject-audioextractioncategory-types)" : [ String, ... ] } ``` ### YAML ``` [State](#cfn-bedrock-dataautomationproject-audioextractioncategory-state): String [TypeConfiguration](#cfn-bedrock-dataautomationproject-audioextractioncategory-typeconfiguration): AudioExtractionCategoryTypeConfiguration [Types](#cfn-bedrock-dataautomationproject-audioextractioncategory-types): - String ``` ## Properties `State` Whether generating categorical data from audio is enabled. *Required*: Yes *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TypeConfiguration` This element contains information about extractions from different types. Used to enable speaker and channel labeling for transcripts. *Required*: No *Type*: [AudioExtractionCategoryTypeConfiguration](aws-properties-bedrock-dataautomationproject-audioextractioncategorytypeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Types` The types of data to generate. *Required*: No *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject AudioExtractionCategoryTypeConfiguration Allows configuration of extractions for different types of data, such as transcript and content moderation. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Transcript](#cfn-bedrock-dataautomationproject-audioextractioncategorytypeconfiguration-transcript)" : TranscriptConfiguration } ``` ### YAML ``` [Transcript](#cfn-bedrock-dataautomationproject-audioextractioncategorytypeconfiguration-transcript): TranscriptConfiguration ``` ## Properties `Transcript` This element allows you to configure different extractions for your transcript data, such as speaker and channel labeling. *Required*: No *Type*: [TranscriptConfiguration](aws-properties-bedrock-dataautomationproject-transcriptconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject AudioLanguageConfiguration This allows you to set the input and output language of your audio. The input language can be set to any of the languages supported by Bedrock Data Automation. The output can either be set to english or whatever the dominant language is of the audio, determined by the language spoken for the most seconds. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[GenerativeOutputLanguage](#cfn-bedrock-dataautomationproject-audiolanguageconfiguration-generativeoutputlanguage)" : String, "[IdentifyMultipleLanguages](#cfn-bedrock-dataautomationproject-audiolanguageconfiguration-identifymultiplelanguages)" : Boolean, "[InputLanguages](#cfn-bedrock-dataautomationproject-audiolanguageconfiguration-inputlanguages)" : [ String, ... ] } ``` ### YAML ``` [GenerativeOutputLanguage](#cfn-bedrock-dataautomationproject-audiolanguageconfiguration-generativeoutputlanguage): String [IdentifyMultipleLanguages](#cfn-bedrock-dataautomationproject-audiolanguageconfiguration-identifymultiplelanguages): Boolean [InputLanguages](#cfn-bedrock-dataautomationproject-audiolanguageconfiguration-inputlanguages): - String ``` ## Properties `GenerativeOutputLanguage` The output language of your processing results. This can either be set to `EN` (English) or `DEFAULT` which will output the results in the dominant language of the audio. The dominant language is determined as the language in the audio, spoken the longest in the input audio. *Required*: No *Type*: String *Allowed values*: `DEFAULT | EN` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IdentifyMultipleLanguages` The toggle determining if you want to detect multiple languages from your audio. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputLanguages` The input language of your audio. This can be set to any of the currently supported languages via the language codes. *Required*: No *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject AudioOverrideConfiguration Sets whether your project will process audio or not. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[LanguageConfiguration](#cfn-bedrock-dataautomationproject-audiooverrideconfiguration-languageconfiguration)" : AudioLanguageConfiguration, "[ModalityProcessing](#cfn-bedrock-dataautomationproject-audiooverrideconfiguration-modalityprocessing)" : ModalityProcessingConfiguration, "[SensitiveDataConfiguration](#cfn-bedrock-dataautomationproject-audiooverrideconfiguration-sensitivedataconfiguration)" : SensitiveDataConfiguration } ``` ### YAML ``` [LanguageConfiguration](#cfn-bedrock-dataautomationproject-audiooverrideconfiguration-languageconfiguration): AudioLanguageConfiguration [ModalityProcessing](#cfn-bedrock-dataautomationproject-audiooverrideconfiguration-modalityprocessing): ModalityProcessingConfiguration [SensitiveDataConfiguration](#cfn-bedrock-dataautomationproject-audiooverrideconfiguration-sensitivedataconfiguration): SensitiveDataConfiguration ``` ## Properties `LanguageConfiguration` The output and input language configuration for your audio. *Required*: No *Type*: [AudioLanguageConfiguration](aws-properties-bedrock-dataautomationproject-audiolanguageconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ModalityProcessing` Sets modality processing for audio files. All modalities are enabled by default. *Required*: No *Type*: [ModalityProcessingConfiguration](aws-properties-bedrock-dataautomationproject-modalityprocessingconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SensitiveDataConfiguration` Configuration for sensitive data detection and redaction for audio files. *Required*: No *Type*: [SensitiveDataConfiguration](aws-properties-bedrock-dataautomationproject-sensitivedataconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject AudioStandardExtraction Settings for generating data from audio. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Category](#cfn-bedrock-dataautomationproject-audiostandardextraction-category)" : AudioExtractionCategory } ``` ### YAML ``` [Category](#cfn-bedrock-dataautomationproject-audiostandardextraction-category): AudioExtractionCategory ``` ## Properties `Category` Settings for generating data from audio. *Required*: Yes *Type*: [AudioExtractionCategory](aws-properties-bedrock-dataautomationproject-audioextractioncategory.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject AudioStandardGenerativeField Settings for generating descriptions of audio. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[State](#cfn-bedrock-dataautomationproject-audiostandardgenerativefield-state)" : String, "[Types](#cfn-bedrock-dataautomationproject-audiostandardgenerativefield-types)" : [ String, ... ] } ``` ### YAML ``` [State](#cfn-bedrock-dataautomationproject-audiostandardgenerativefield-state): String [Types](#cfn-bedrock-dataautomationproject-audiostandardgenerativefield-types): - String ``` ## Properties `State` Whether generating descriptions is enabled for audio. *Required*: Yes *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Types` The types of description to generate. *Required*: No *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject AudioStandardOutputConfiguration Output settings for processing audio. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Extraction](#cfn-bedrock-dataautomationproject-audiostandardoutputconfiguration-extraction)" : AudioStandardExtraction, "[GenerativeField](#cfn-bedrock-dataautomationproject-audiostandardoutputconfiguration-generativefield)" : AudioStandardGenerativeField } ``` ### YAML ``` [Extraction](#cfn-bedrock-dataautomationproject-audiostandardoutputconfiguration-extraction): AudioStandardExtraction [GenerativeField](#cfn-bedrock-dataautomationproject-audiostandardoutputconfiguration-generativefield): AudioStandardGenerativeField ``` ## Properties `Extraction` Settings for populating data fields that describe the audio. *Required*: No *Type*: [AudioStandardExtraction](aws-properties-bedrock-dataautomationproject-audiostandardextraction.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GenerativeField` Whether to generate descriptions of the data. *Required*: No *Type*: [AudioStandardGenerativeField](aws-properties-bedrock-dataautomationproject-audiostandardgenerativefield.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject BlueprintItem An abbreviated summary of a blueprint. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BlueprintArn](#cfn-bedrock-dataautomationproject-blueprintitem-blueprintarn)" : String, "[BlueprintStage](#cfn-bedrock-dataautomationproject-blueprintitem-blueprintstage)" : String, "[BlueprintVersion](#cfn-bedrock-dataautomationproject-blueprintitem-blueprintversion)" : String } ``` ### YAML ``` [BlueprintArn](#cfn-bedrock-dataautomationproject-blueprintitem-blueprintarn): String [BlueprintStage](#cfn-bedrock-dataautomationproject-blueprintitem-blueprintstage): String [BlueprintVersion](#cfn-bedrock-dataautomationproject-blueprintitem-blueprintversion): String ``` ## Properties `BlueprintArn` The blueprint's ARN. *Required*: Yes *Type*: String *Pattern*: `^arn:aws(|-cn|-us-gov|-iso|-iso-[a-z]):bedrock:[a-zA-Z0-9-]*:(aws|[0-9]{12}):blueprint/(bedrock-data-automation-public-[a-zA-Z0-9-_]{1,30}|[a-zA-Z0-9-]{12,36})$` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BlueprintStage` The blueprint's stage. *Required*: No *Type*: String *Allowed values*: `DEVELOPMENT | LIVE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BlueprintVersion` The blueprint's version. *Required*: No *Type*: String *Pattern*: `^[0-9]*$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject ChannelLabelingConfiguration Enables or disables channel labeling. Channel labeling, when enabled will assign a number to each audio channel, and indicate which channel is being used in each portion of the transcript. This appears in the response as "ch\$10" for the first channel, and "ch\$11" for the second. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[State](#cfn-bedrock-dataautomationproject-channellabelingconfiguration-state)" : String } ``` ### YAML ``` [State](#cfn-bedrock-dataautomationproject-channellabelingconfiguration-state): String ``` ## Properties `State` State of channel labeling, either enabled or disabled. *Required*: Yes *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject CustomOutputConfiguration Blueprints to apply to objects processed by the project. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Blueprints](#cfn-bedrock-dataautomationproject-customoutputconfiguration-blueprints)" : [ BlueprintItem, ... ] } ``` ### YAML ``` [Blueprints](#cfn-bedrock-dataautomationproject-customoutputconfiguration-blueprints): - BlueprintItem ``` ## Properties `Blueprints` A list of blueprints. *Required*: No *Type*: Array of [BlueprintItem](aws-properties-bedrock-dataautomationproject-blueprintitem.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject DocumentBoundingBox Bounding box settings for documents. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[State](#cfn-bedrock-dataautomationproject-documentboundingbox-state)" : String } ``` ### YAML ``` [State](#cfn-bedrock-dataautomationproject-documentboundingbox-state): String ``` ## Properties `State` Whether bounding boxes are enabled for documents. *Required*: Yes *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject DocumentExtractionGranularity Granularity settings for documents. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Types](#cfn-bedrock-dataautomationproject-documentextractiongranularity-types)" : [ String, ... ] } ``` ### YAML ``` [Types](#cfn-bedrock-dataautomationproject-documentextractiongranularity-types): - String ``` ## Properties `Types` Granularity settings for documents. *Required*: No *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject DocumentOutputAdditionalFileFormat Output settings for additional file formats. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[State](#cfn-bedrock-dataautomationproject-documentoutputadditionalfileformat-state)" : String } ``` ### YAML ``` [State](#cfn-bedrock-dataautomationproject-documentoutputadditionalfileformat-state): String ``` ## Properties `State` Whether additional file formats are enabled for a project. *Required*: Yes *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject DocumentOutputFormat A document output format. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AdditionalFileFormat](#cfn-bedrock-dataautomationproject-documentoutputformat-additionalfileformat)" : DocumentOutputAdditionalFileFormat, "[TextFormat](#cfn-bedrock-dataautomationproject-documentoutputformat-textformat)" : DocumentOutputTextFormat } ``` ### YAML ``` [AdditionalFileFormat](#cfn-bedrock-dataautomationproject-documentoutputformat-additionalfileformat): DocumentOutputAdditionalFileFormat [TextFormat](#cfn-bedrock-dataautomationproject-documentoutputformat-textformat): DocumentOutputTextFormat ``` ## Properties `AdditionalFileFormat` Output settings for additional file formats. *Required*: Yes *Type*: [DocumentOutputAdditionalFileFormat](aws-properties-bedrock-dataautomationproject-documentoutputadditionalfileformat.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TextFormat` An output text format. *Required*: Yes *Type*: [DocumentOutputTextFormat](aws-properties-bedrock-dataautomationproject-documentoutputtextformat.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject DocumentOutputTextFormat An output text format. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Types](#cfn-bedrock-dataautomationproject-documentoutputtextformat-types)" : [ String, ... ] } ``` ### YAML ``` [Types](#cfn-bedrock-dataautomationproject-documentoutputtextformat-types): - String ``` ## Properties `Types` The types of output text to generate. *Required*: No *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject DocumentOverrideConfiguration Additional settings for a project. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ModalityProcessing](#cfn-bedrock-dataautomationproject-documentoverrideconfiguration-modalityprocessing)" : ModalityProcessingConfiguration, "[SensitiveDataConfiguration](#cfn-bedrock-dataautomationproject-documentoverrideconfiguration-sensitivedataconfiguration)" : SensitiveDataConfiguration, "[Splitter](#cfn-bedrock-dataautomationproject-documentoverrideconfiguration-splitter)" : SplitterConfiguration } ``` ### YAML ``` [ModalityProcessing](#cfn-bedrock-dataautomationproject-documentoverrideconfiguration-modalityprocessing): ModalityProcessingConfiguration [SensitiveDataConfiguration](#cfn-bedrock-dataautomationproject-documentoverrideconfiguration-sensitivedataconfiguration): SensitiveDataConfiguration [Splitter](#cfn-bedrock-dataautomationproject-documentoverrideconfiguration-splitter): SplitterConfiguration ``` ## Properties `ModalityProcessing` Sets modality processing for document files. All modalities are enabled by default. *Required*: No *Type*: [ModalityProcessingConfiguration](aws-properties-bedrock-dataautomationproject-modalityprocessingconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SensitiveDataConfiguration` Configuration for sensitive data detection and redaction for document files. *Required*: No *Type*: [SensitiveDataConfiguration](aws-properties-bedrock-dataautomationproject-sensitivedataconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Splitter` Whether document splitter is enabled for a project. *Required*: No *Type*: [SplitterConfiguration](aws-properties-bedrock-dataautomationproject-splitterconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject DocumentStandardExtraction Settings for generating data from documents. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BoundingBox](#cfn-bedrock-dataautomationproject-documentstandardextraction-boundingbox)" : DocumentBoundingBox, "[Granularity](#cfn-bedrock-dataautomationproject-documentstandardextraction-granularity)" : DocumentExtractionGranularity } ``` ### YAML ``` [BoundingBox](#cfn-bedrock-dataautomationproject-documentstandardextraction-boundingbox): DocumentBoundingBox [Granularity](#cfn-bedrock-dataautomationproject-documentstandardextraction-granularity): DocumentExtractionGranularity ``` ## Properties `BoundingBox` Whether to generate bounding boxes. *Required*: Yes *Type*: [DocumentBoundingBox](aws-properties-bedrock-dataautomationproject-documentboundingbox.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Granularity` Which granularities to generate data for. *Required*: Yes *Type*: [DocumentExtractionGranularity](aws-properties-bedrock-dataautomationproject-documentextractiongranularity.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject DocumentStandardGenerativeField Settings for generating descriptions of documents. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[State](#cfn-bedrock-dataautomationproject-documentstandardgenerativefield-state)" : String } ``` ### YAML ``` [State](#cfn-bedrock-dataautomationproject-documentstandardgenerativefield-state): String ``` ## Properties `State` Whether generating descriptions is enabled for documents. *Required*: Yes *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject DocumentStandardOutputConfiguration Output settings for processing documents. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Extraction](#cfn-bedrock-dataautomationproject-documentstandardoutputconfiguration-extraction)" : DocumentStandardExtraction, "[GenerativeField](#cfn-bedrock-dataautomationproject-documentstandardoutputconfiguration-generativefield)" : DocumentStandardGenerativeField, "[OutputFormat](#cfn-bedrock-dataautomationproject-documentstandardoutputconfiguration-outputformat)" : DocumentOutputFormat } ``` ### YAML ``` [Extraction](#cfn-bedrock-dataautomationproject-documentstandardoutputconfiguration-extraction): DocumentStandardExtraction [GenerativeField](#cfn-bedrock-dataautomationproject-documentstandardoutputconfiguration-generativefield): DocumentStandardGenerativeField [OutputFormat](#cfn-bedrock-dataautomationproject-documentstandardoutputconfiguration-outputformat): DocumentOutputFormat ``` ## Properties `Extraction` Settings for populating data fields that describe the document. *Required*: No *Type*: [DocumentStandardExtraction](aws-properties-bedrock-dataautomationproject-documentstandardextraction.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GenerativeField` Whether to generate descriptions. *Required*: No *Type*: [DocumentStandardGenerativeField](aws-properties-bedrock-dataautomationproject-documentstandardgenerativefield.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OutputFormat` The output format to generate. *Required*: No *Type*: [DocumentOutputFormat](aws-properties-bedrock-dataautomationproject-documentoutputformat.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject ImageBoundingBox Bounding box settings for a project. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[State](#cfn-bedrock-dataautomationproject-imageboundingbox-state)" : String } ``` ### YAML ``` [State](#cfn-bedrock-dataautomationproject-imageboundingbox-state): String ``` ## Properties `State` Bounding box settings for a project. *Required*: Yes *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject ImageExtractionCategory Settings for generating categorical data from images. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[State](#cfn-bedrock-dataautomationproject-imageextractioncategory-state)" : String, "[Types](#cfn-bedrock-dataautomationproject-imageextractioncategory-types)" : [ String, ... ] } ``` ### YAML ``` [State](#cfn-bedrock-dataautomationproject-imageextractioncategory-state): String [Types](#cfn-bedrock-dataautomationproject-imageextractioncategory-types): - String ``` ## Properties `State` Whether generating categorical data from images is enabled. *Required*: Yes *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Types` The types of data to generate. *Required*: No *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject ImageOverrideConfiguration Sets whether your project will process images or not. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ModalityProcessing](#cfn-bedrock-dataautomationproject-imageoverrideconfiguration-modalityprocessing)" : ModalityProcessingConfiguration, "[SensitiveDataConfiguration](#cfn-bedrock-dataautomationproject-imageoverrideconfiguration-sensitivedataconfiguration)" : SensitiveDataConfiguration } ``` ### YAML ``` [ModalityProcessing](#cfn-bedrock-dataautomationproject-imageoverrideconfiguration-modalityprocessing): ModalityProcessingConfiguration [SensitiveDataConfiguration](#cfn-bedrock-dataautomationproject-imageoverrideconfiguration-sensitivedataconfiguration): SensitiveDataConfiguration ``` ## Properties `ModalityProcessing` Sets modality processing for image files. All modalities are enabled by default. *Required*: No *Type*: [ModalityProcessingConfiguration](aws-properties-bedrock-dataautomationproject-modalityprocessingconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SensitiveDataConfiguration` Configuration for sensitive data detection and redaction for image files. *Required*: No *Type*: [SensitiveDataConfiguration](aws-properties-bedrock-dataautomationproject-sensitivedataconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject ImageStandardExtraction Settings for generating data from images. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BoundingBox](#cfn-bedrock-dataautomationproject-imagestandardextraction-boundingbox)" : ImageBoundingBox, "[Category](#cfn-bedrock-dataautomationproject-imagestandardextraction-category)" : ImageExtractionCategory } ``` ### YAML ``` [BoundingBox](#cfn-bedrock-dataautomationproject-imagestandardextraction-boundingbox): ImageBoundingBox [Category](#cfn-bedrock-dataautomationproject-imagestandardextraction-category): ImageExtractionCategory ``` ## Properties `BoundingBox` Settings for generating bounding boxes. *Required*: Yes *Type*: [ImageBoundingBox](aws-properties-bedrock-dataautomationproject-imageboundingbox.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Category` Settings for generating categorical data. *Required*: Yes *Type*: [ImageExtractionCategory](aws-properties-bedrock-dataautomationproject-imageextractioncategory.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject ImageStandardGenerativeField Settings for generating descriptions of images. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[State](#cfn-bedrock-dataautomationproject-imagestandardgenerativefield-state)" : String, "[Types](#cfn-bedrock-dataautomationproject-imagestandardgenerativefield-types)" : [ String, ... ] } ``` ### YAML ``` [State](#cfn-bedrock-dataautomationproject-imagestandardgenerativefield-state): String [Types](#cfn-bedrock-dataautomationproject-imagestandardgenerativefield-types): - String ``` ## Properties `State` Whether generating descriptions is enabled for images. *Required*: Yes *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Types` Settings for generating descriptions of images. *Required*: No *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject ImageStandardOutputConfiguration Output settings for processing images. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Extraction](#cfn-bedrock-dataautomationproject-imagestandardoutputconfiguration-extraction)" : ImageStandardExtraction, "[GenerativeField](#cfn-bedrock-dataautomationproject-imagestandardoutputconfiguration-generativefield)" : ImageStandardGenerativeField } ``` ### YAML ``` [Extraction](#cfn-bedrock-dataautomationproject-imagestandardoutputconfiguration-extraction): ImageStandardExtraction [GenerativeField](#cfn-bedrock-dataautomationproject-imagestandardoutputconfiguration-generativefield): ImageStandardGenerativeField ``` ## Properties `Extraction` Settings for populating data fields that describe the image. *Required*: No *Type*: [ImageStandardExtraction](aws-properties-bedrock-dataautomationproject-imagestandardextraction.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GenerativeField` Whether to generate descriptions of the data. *Required*: No *Type*: [ImageStandardGenerativeField](aws-properties-bedrock-dataautomationproject-imagestandardgenerativefield.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject ModalityProcessingConfiguration This element is used to determine if the modality it is associated with is enabled or disabled. All modalities are enabled by default. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[State](#cfn-bedrock-dataautomationproject-modalityprocessingconfiguration-state)" : String } ``` ### YAML ``` [State](#cfn-bedrock-dataautomationproject-modalityprocessingconfiguration-state): String ``` ## Properties `State` Stores the state of the modality for your project, set to either enabled or disabled *Required*: No *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject ModalityRoutingConfiguration This element allows you to set up where JPEG, PNG, MOV, and MP4 files get routed to for processing. JPEG routing applies to both "JPEG" and "JPG" file extensions. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[jpeg](#cfn-bedrock-dataautomationproject-modalityroutingconfiguration-jpeg)" : String, "[mov](#cfn-bedrock-dataautomationproject-modalityroutingconfiguration-mov)" : String, "[mp4](#cfn-bedrock-dataautomationproject-modalityroutingconfiguration-mp4)" : String, "[png](#cfn-bedrock-dataautomationproject-modalityroutingconfiguration-png)" : String } ``` ### YAML ``` [jpeg](#cfn-bedrock-dataautomationproject-modalityroutingconfiguration-jpeg): String [mov](#cfn-bedrock-dataautomationproject-modalityroutingconfiguration-mov): String [mp4](#cfn-bedrock-dataautomationproject-modalityroutingconfiguration-mp4): String [png](#cfn-bedrock-dataautomationproject-modalityroutingconfiguration-png): String ``` ## Properties `jpeg` Sets whether JPEG files are routed to document or image processing. *Required*: No *Type*: String *Allowed values*: `DOCUMENT | IMAGE | VIDEO | AUDIO` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `mov` Sets whether MOV files are routed to audio or video processing. *Required*: No *Type*: String *Allowed values*: `DOCUMENT | IMAGE | VIDEO | AUDIO` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `mp4` Sets whether MP4 files are routed to audio or video processing. *Required*: No *Type*: String *Allowed values*: `DOCUMENT | IMAGE | VIDEO | AUDIO` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `png` Sets whether PNG files are routed to document or image processing. *Required*: No *Type*: String *Allowed values*: `DOCUMENT | IMAGE | VIDEO | AUDIO` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject OverrideConfiguration Additional settings for a project. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Audio](#cfn-bedrock-dataautomationproject-overrideconfiguration-audio)" : AudioOverrideConfiguration, "[Document](#cfn-bedrock-dataautomationproject-overrideconfiguration-document)" : DocumentOverrideConfiguration, "[Image](#cfn-bedrock-dataautomationproject-overrideconfiguration-image)" : ImageOverrideConfiguration, "[ModalityRouting](#cfn-bedrock-dataautomationproject-overrideconfiguration-modalityrouting)" : ModalityRoutingConfiguration, "[Video](#cfn-bedrock-dataautomationproject-overrideconfiguration-video)" : VideoOverrideConfiguration } ``` ### YAML ``` [Audio](#cfn-bedrock-dataautomationproject-overrideconfiguration-audio): AudioOverrideConfiguration [Document](#cfn-bedrock-dataautomationproject-overrideconfiguration-document): DocumentOverrideConfiguration [Image](#cfn-bedrock-dataautomationproject-overrideconfiguration-image): ImageOverrideConfiguration [ModalityRouting](#cfn-bedrock-dataautomationproject-overrideconfiguration-modalityrouting): ModalityRoutingConfiguration [Video](#cfn-bedrock-dataautomationproject-overrideconfiguration-video): VideoOverrideConfiguration ``` ## Properties `Audio` This element declares whether your project will process audio files. *Required*: No *Type*: [AudioOverrideConfiguration](aws-properties-bedrock-dataautomationproject-audiooverrideconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Document` Additional settings for a project. *Required*: No *Type*: [DocumentOverrideConfiguration](aws-properties-bedrock-dataautomationproject-documentoverrideconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Image` This element declares whether your project will process image files. *Required*: No *Type*: [ImageOverrideConfiguration](aws-properties-bedrock-dataautomationproject-imageoverrideconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ModalityRouting` Lets you set which modalities certain file types are processed as. *Required*: No *Type*: [ModalityRoutingConfiguration](aws-properties-bedrock-dataautomationproject-modalityroutingconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Video` This element declares whether your project will process video files. *Required*: No *Type*: [VideoOverrideConfiguration](aws-properties-bedrock-dataautomationproject-videooverrideconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject PIIEntitiesConfiguration Configuration for detecting and redacting Personally Identifiable Information (PII) entities. Specify which PII entity types to detect and the redaction mask mode. If not provided, defaults to ALL entity types with ENTITY\$1TYPE redaction mask mode. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[PiiEntityTypes](#cfn-bedrock-dataautomationproject-piientitiesconfiguration-piientitytypes)" : [ String, ... ], "[RedactionMaskMode](#cfn-bedrock-dataautomationproject-piientitiesconfiguration-redactionmaskmode)" : String } ``` ### YAML ``` [PiiEntityTypes](#cfn-bedrock-dataautomationproject-piientitiesconfiguration-piientitytypes): - String [RedactionMaskMode](#cfn-bedrock-dataautomationproject-piientitiesconfiguration-redactionmaskmode): String ``` ## Properties `PiiEntityTypes` List of PII entity types to detect/redact in the output. Choose from specific entity types (such as ADDRESS, NAME, EMAIL, PHONE, US\$1SOCIAL\$1SECURITY\$1NUMBER) or specify ALL to detect all supported PII types. If not specified, defaults to ALL. *Required*: No *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RedactionMaskMode` Defines how detected PII entities are masked in redacted output files. Set to PII to replace all detected entities with a generic [PII] marker regardless of entity type. Set to ENTITY\$1TYPE to replace each detected entity with its specific type marker (for example, [NAME], [EMAIL], [ADDRESS]). This setting only applies when detectionMode is set to DETECTION\$1AND\$1REDACTION. If not specified, defaults to ENTITY\$1TYPE. *Required*: No *Type*: String *Allowed values*: `PII | ENTITY_TYPE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject SensitiveDataConfiguration Configuration for detecting and redacting sensitive data in content. Use this to control whether sensitive data is detected only or both detected and redacted, specify the scope of detection (standard output, custom output, or both), and configure specific PII entity types to detect along with how they should be masked when redacted. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DetectionMode](#cfn-bedrock-dataautomationproject-sensitivedataconfiguration-detectionmode)" : String, "[DetectionScope](#cfn-bedrock-dataautomationproject-sensitivedataconfiguration-detectionscope)" : [ String, ... ], "[PiiEntitiesConfiguration](#cfn-bedrock-dataautomationproject-sensitivedataconfiguration-piientitiesconfiguration)" : PIIEntitiesConfiguration } ``` ### YAML ``` [DetectionMode](#cfn-bedrock-dataautomationproject-sensitivedataconfiguration-detectionmode): String [DetectionScope](#cfn-bedrock-dataautomationproject-sensitivedataconfiguration-detectionscope): - String [PiiEntitiesConfiguration](#cfn-bedrock-dataautomationproject-sensitivedataconfiguration-piientitiesconfiguration): PIIEntitiesConfiguration ``` ## Properties `DetectionMode` Specifies the mode for handling sensitive data detection. Set to DETECTION to only identify sensitive data without modifying content - this produces one output file per detection scope containing detection information with original unredacted content. Set to DETECTION\$1AND\$1REDACTION to both identify and mask sensitive data - this produces two output files per detection scope: one unredacted file with detection information and one redacted file with masking applied to sensitive content. For example, if detectionScope includes both STANDARD and CUSTOM with DETECTION\$1AND\$1REDACTION mode, four output files will be generated (two for standard output and two for custom output). *Required*: No *Type*: String *Allowed values*: `DETECTION | DETECTION_AND_REDACTION` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DetectionScope` Defines which BDA output types to apply sensitive data detection to. Specify STANDARD to detect sensitive data in standard output, CUSTOM to detect in custom output (blueprint-based extraction), or both to apply detection to both output types. If not specified, defaults to both STANDARD and CUSTOM. The number of output files generated depends on both the detection mode and the scopes selected - each scope specified will produce its own set of output files according to the detection mode configured. *Required*: No *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PiiEntitiesConfiguration` Configuration for detecting and redacting Personally Identifiable Information (PII) entities. *Required*: No *Type*: [PIIEntitiesConfiguration](aws-properties-bedrock-dataautomationproject-piientitiesconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject SpeakerLabelingConfiguration Enables or disables speaker labeling. Speaker labeling, when enabled will assign a number to each speaker, and indicate which speaker is talking in each portion of the transcript. This appears in the response as "spk\$10" for the first speaker, "spk\$11" for the second, and so on for up to 30 speakers. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[State](#cfn-bedrock-dataautomationproject-speakerlabelingconfiguration-state)" : String } ``` ### YAML ``` [State](#cfn-bedrock-dataautomationproject-speakerlabelingconfiguration-state): String ``` ## Properties `State` State of speaker labeling, either enabled or disabled. *Required*: Yes *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject SplitterConfiguration Document splitter settings. If a document is too large to be processed in one pass, the document splitter splits it into smaller documents. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[State](#cfn-bedrock-dataautomationproject-splitterconfiguration-state)" : String } ``` ### YAML ``` [State](#cfn-bedrock-dataautomationproject-splitterconfiguration-state): String ``` ## Properties `State` Whether document splitter is enabled for a project. *Required*: No *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject StandardOutputConfiguration The project's standard output configuration. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Audio](#cfn-bedrock-dataautomationproject-standardoutputconfiguration-audio)" : AudioStandardOutputConfiguration, "[Document](#cfn-bedrock-dataautomationproject-standardoutputconfiguration-document)" : DocumentStandardOutputConfiguration, "[Image](#cfn-bedrock-dataautomationproject-standardoutputconfiguration-image)" : ImageStandardOutputConfiguration, "[Video](#cfn-bedrock-dataautomationproject-standardoutputconfiguration-video)" : VideoStandardOutputConfiguration } ``` ### YAML ``` [Audio](#cfn-bedrock-dataautomationproject-standardoutputconfiguration-audio): AudioStandardOutputConfiguration [Document](#cfn-bedrock-dataautomationproject-standardoutputconfiguration-document): DocumentStandardOutputConfiguration [Image](#cfn-bedrock-dataautomationproject-standardoutputconfiguration-image): ImageStandardOutputConfiguration [Video](#cfn-bedrock-dataautomationproject-standardoutputconfiguration-video): VideoStandardOutputConfiguration ``` ## Properties `Audio` Settings for processing audio. *Required*: No *Type*: [AudioStandardOutputConfiguration](aws-properties-bedrock-dataautomationproject-audiostandardoutputconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Document` Settings for processing documents. *Required*: No *Type*: [DocumentStandardOutputConfiguration](aws-properties-bedrock-dataautomationproject-documentstandardoutputconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Image` Settings for processing images. *Required*: No *Type*: [ImageStandardOutputConfiguration](aws-properties-bedrock-dataautomationproject-imagestandardoutputconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Video` Settings for processing video. *Required*: No *Type*: [VideoStandardOutputConfiguration](aws-properties-bedrock-dataautomationproject-videostandardoutputconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject Tag A tag associated with a resource. A tag consists of a key and value. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-bedrock-dataautomationproject-tag-key)" : String, "[Value](#cfn-bedrock-dataautomationproject-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-bedrock-dataautomationproject-tag-key): String [Value](#cfn-bedrock-dataautomationproject-tag-value): String ``` ## Properties `Key` The key associated with a tag. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value associated with a tag. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject TranscriptConfiguration Configuration for transcript options. This option allows you to enable speaker labeling and channel labeling. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ChannelLabeling](#cfn-bedrock-dataautomationproject-transcriptconfiguration-channellabeling)" : ChannelLabelingConfiguration, "[SpeakerLabeling](#cfn-bedrock-dataautomationproject-transcriptconfiguration-speakerlabeling)" : SpeakerLabelingConfiguration } ``` ### YAML ``` [ChannelLabeling](#cfn-bedrock-dataautomationproject-transcriptconfiguration-channellabeling): ChannelLabelingConfiguration [SpeakerLabeling](#cfn-bedrock-dataautomationproject-transcriptconfiguration-speakerlabeling): SpeakerLabelingConfiguration ``` ## Properties `ChannelLabeling` Enables channel labeling. Each audio channel will be labeled with a number, and the transcript will indicate which channel is being used. *Required*: No *Type*: [ChannelLabelingConfiguration](aws-properties-bedrock-dataautomationproject-channellabelingconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SpeakerLabeling` Enables speaker labeling. Each speaker within a transcript will recieve a number, and the transcript will note which speaker is talking. *Required*: No *Type*: [SpeakerLabelingConfiguration](aws-properties-bedrock-dataautomationproject-speakerlabelingconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject VideoBoundingBox Bounding box settings for video. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[State](#cfn-bedrock-dataautomationproject-videoboundingbox-state)" : String } ``` ### YAML ``` [State](#cfn-bedrock-dataautomationproject-videoboundingbox-state): String ``` ## Properties `State` Whether bounding boxes are enabled for video. *Required*: Yes *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject VideoExtractionCategory Settings for generating categorical data from video. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[State](#cfn-bedrock-dataautomationproject-videoextractioncategory-state)" : String, "[Types](#cfn-bedrock-dataautomationproject-videoextractioncategory-types)" : [ String, ... ] } ``` ### YAML ``` [State](#cfn-bedrock-dataautomationproject-videoextractioncategory-state): String [Types](#cfn-bedrock-dataautomationproject-videoextractioncategory-types): - String ``` ## Properties `State` Whether generating categorical data from video is enabled. *Required*: Yes *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Types` The types of data to generate. *Required*: No *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject VideoOverrideConfiguration Sets whether your project will process videos or not. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ModalityProcessing](#cfn-bedrock-dataautomationproject-videooverrideconfiguration-modalityprocessing)" : ModalityProcessingConfiguration, "[SensitiveDataConfiguration](#cfn-bedrock-dataautomationproject-videooverrideconfiguration-sensitivedataconfiguration)" : SensitiveDataConfiguration } ``` ### YAML ``` [ModalityProcessing](#cfn-bedrock-dataautomationproject-videooverrideconfiguration-modalityprocessing): ModalityProcessingConfiguration [SensitiveDataConfiguration](#cfn-bedrock-dataautomationproject-videooverrideconfiguration-sensitivedataconfiguration): SensitiveDataConfiguration ``` ## Properties `ModalityProcessing` Sets modality processing for video files. All modalities are enabled by default. *Required*: No *Type*: [ModalityProcessingConfiguration](aws-properties-bedrock-dataautomationproject-modalityprocessingconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SensitiveDataConfiguration` Configuration for sensitive data detection and redaction for video files. *Required*: No *Type*: [SensitiveDataConfiguration](aws-properties-bedrock-dataautomationproject-sensitivedataconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject VideoStandardExtraction Settings for generating data from video. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BoundingBox](#cfn-bedrock-dataautomationproject-videostandardextraction-boundingbox)" : VideoBoundingBox, "[Category](#cfn-bedrock-dataautomationproject-videostandardextraction-category)" : VideoExtractionCategory } ``` ### YAML ``` [BoundingBox](#cfn-bedrock-dataautomationproject-videostandardextraction-boundingbox): VideoBoundingBox [Category](#cfn-bedrock-dataautomationproject-videostandardextraction-category): VideoExtractionCategory ``` ## Properties `BoundingBox` Settings for generating bounding boxes. *Required*: Yes *Type*: [VideoBoundingBox](aws-properties-bedrock-dataautomationproject-videoboundingbox.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Category` Settings for generating categorical data. *Required*: Yes *Type*: [VideoExtractionCategory](aws-properties-bedrock-dataautomationproject-videoextractioncategory.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject VideoStandardGenerativeField Settings for generating descriptions of video. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[State](#cfn-bedrock-dataautomationproject-videostandardgenerativefield-state)" : String, "[Types](#cfn-bedrock-dataautomationproject-videostandardgenerativefield-types)" : [ String, ... ] } ``` ### YAML ``` [State](#cfn-bedrock-dataautomationproject-videostandardgenerativefield-state): String [Types](#cfn-bedrock-dataautomationproject-videostandardgenerativefield-types): - String ``` ## Properties `State` Whether generating descriptions is enabled for video. *Required*: Yes *Type*: String *Allowed values*: `ENABLED | DISABLED` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Types` The types of description to generate. *Required*: No *Type*: Array of String *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataAutomationProject VideoStandardOutputConfiguration Output settings for processing video. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Extraction](#cfn-bedrock-dataautomationproject-videostandardoutputconfiguration-extraction)" : VideoStandardExtraction, "[GenerativeField](#cfn-bedrock-dataautomationproject-videostandardoutputconfiguration-generativefield)" : VideoStandardGenerativeField } ``` ### YAML ``` [Extraction](#cfn-bedrock-dataautomationproject-videostandardoutputconfiguration-extraction): VideoStandardExtraction [GenerativeField](#cfn-bedrock-dataautomationproject-videostandardoutputconfiguration-generativefield): VideoStandardGenerativeField ``` ## Properties `Extraction` Settings for populating data fields that describe the video. *Required*: No *Type*: [VideoStandardExtraction](aws-properties-bedrock-dataautomationproject-videostandardextraction.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GenerativeField` Whether to generate descriptions of the video. *Required*: No *Type*: [VideoStandardGenerativeField](aws-properties-bedrock-dataautomationproject-videostandardgenerativefield.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource **Important** Properties with `__Update requires: Replacement__` can result in the creation of a new data source and deletion of the old one. This can happen if you also change the Name of the data source. Specifies a data source as a resource in a top-level template. Minimally, you must specify the following properties: + Name – Specify a name for the data source. + KnowledgeBaseId – Specify the ID of the knowledge base for the data source to belong to. + DataSourceConfiguration – Specify information about the Amazon S3 bucket containing the data source. The following sub-properties are required: + Type – Specify the value `S3`. For more information about setting up data sources in Amazon Bedrock, see [Set up a data source for your knowledge base](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-ds.html). See the **Properties** section below for descriptions of both the required and optional properties. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::Bedrock::DataSource", "Properties" : { "[DataDeletionPolicy](#cfn-bedrock-datasource-datadeletionpolicy)" : String, "[DataSourceConfiguration](#cfn-bedrock-datasource-datasourceconfiguration)" : DataSourceConfiguration, "[Description](#cfn-bedrock-datasource-description)" : String, "[KnowledgeBaseId](#cfn-bedrock-datasource-knowledgebaseid)" : String, "[Name](#cfn-bedrock-datasource-name)" : String, "[ServerSideEncryptionConfiguration](#cfn-bedrock-datasource-serversideencryptionconfiguration)" : ServerSideEncryptionConfiguration, "[VectorIngestionConfiguration](#cfn-bedrock-datasource-vectoringestionconfiguration)" : VectorIngestionConfiguration } } ``` ### YAML ``` Type: AWS::Bedrock::DataSource Properties: [DataDeletionPolicy](#cfn-bedrock-datasource-datadeletionpolicy): String [DataSourceConfiguration](#cfn-bedrock-datasource-datasourceconfiguration): DataSourceConfiguration [Description](#cfn-bedrock-datasource-description): String [KnowledgeBaseId](#cfn-bedrock-datasource-knowledgebaseid): String [Name](#cfn-bedrock-datasource-name): String [ServerSideEncryptionConfiguration](#cfn-bedrock-datasource-serversideencryptionconfiguration): ServerSideEncryptionConfiguration [VectorIngestionConfiguration](#cfn-bedrock-datasource-vectoringestionconfiguration): VectorIngestionConfiguration ``` ## Properties `DataDeletionPolicy` The data deletion policy for the data source. *Required*: No *Type*: String *Allowed values*: `RETAIN | DELETE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DataSourceConfiguration` The connection configuration for the data source. *Required*: Yes *Type*: [DataSourceConfiguration](aws-properties-bedrock-datasource-datasourceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` The description of the data source. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KnowledgeBaseId` The unique identifier of the knowledge base to which the data source belongs. *Required*: Yes *Type*: String *Pattern*: `^[0-9a-zA-Z]{10}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Name` The name of the data source. *Required*: Yes *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ServerSideEncryptionConfiguration` Contains details about the configuration of the server-side encryption. *Required*: No *Type*: [ServerSideEncryptionConfiguration](aws-properties-bedrock-datasource-serversideencryptionconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `VectorIngestionConfiguration` Contains details about how to ingest the documents in the data source. *Required*: No *Type*: [VectorIngestionConfiguration](aws-properties-bedrock-datasource-vectoringestionconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the knowledge base ID and the data source ID, separated by a pipe (`|`). For example, `{ "Ref": "myDataSource" }` could return the value `"KB12345678|DS12345678"`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `CreatedAt` The time at which the data source was created. `DataSourceConfiguration.WebConfiguration.CrawlerConfiguration.UserAgentHeader` Property description not available. `DataSourceId` The unique identifier of the data source. `DataSourceStatus` The status of the data source. The following statuses are possible: + Available – The data source has been created and is ready for ingestion into the knowledge base. + Deleting – The data source is being deleted. `FailureReasons` The detailed reasons on the failure to delete a data source. `UpdatedAt` The time at which the data source was last updated. # AWS::Bedrock::DataSource BedrockDataAutomationConfiguration Contains configurations for using Amazon Bedrock Data Automation as the parser for ingesting your data sources. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ParsingModality](#cfn-bedrock-datasource-bedrockdataautomationconfiguration-parsingmodality)" : String } ``` ### YAML ``` [ParsingModality](#cfn-bedrock-datasource-bedrockdataautomationconfiguration-parsingmodality): String ``` ## Properties `ParsingModality` Specifies whether to enable parsing of multimodal data, including both text and/or images. *Required*: No *Type*: String *Allowed values*: `MULTIMODAL` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::DataSource BedrockFoundationModelConfiguration Settings for a foundation model used to parse documents for a data source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ModelArn](#cfn-bedrock-datasource-bedrockfoundationmodelconfiguration-modelarn)" : String, "[ParsingModality](#cfn-bedrock-datasource-bedrockfoundationmodelconfiguration-parsingmodality)" : String, "[ParsingPrompt](#cfn-bedrock-datasource-bedrockfoundationmodelconfiguration-parsingprompt)" : ParsingPrompt } ``` ### YAML ``` [ModelArn](#cfn-bedrock-datasource-bedrockfoundationmodelconfiguration-modelarn): String [ParsingModality](#cfn-bedrock-datasource-bedrockfoundationmodelconfiguration-parsingmodality): String [ParsingPrompt](#cfn-bedrock-datasource-bedrockfoundationmodelconfiguration-parsingprompt): ParsingPrompt ``` ## Properties `ModelArn` The ARN of the foundation model to use for parsing. *Required*: Yes *Type*: String *Pattern*: `^(arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:(bedrock):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ParsingModality` Specifies whether to enable parsing of multimodal data, including both text and/or images. *Required*: No *Type*: String *Allowed values*: `MULTIMODAL` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ParsingPrompt` Instructions for interpreting the contents of a document. *Required*: No *Type*: [ParsingPrompt](aws-properties-bedrock-datasource-parsingprompt.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::DataSource BedrockFoundationModelContextEnrichmentConfiguration Context enrichment configuration is used to provide additional context to the RAG application using Amazon Bedrock foundation models. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[EnrichmentStrategyConfiguration](#cfn-bedrock-datasource-bedrockfoundationmodelcontextenrichmentconfiguration-enrichmentstrategyconfiguration)" : EnrichmentStrategyConfiguration, "[ModelArn](#cfn-bedrock-datasource-bedrockfoundationmodelcontextenrichmentconfiguration-modelarn)" : String } ``` ### YAML ``` [EnrichmentStrategyConfiguration](#cfn-bedrock-datasource-bedrockfoundationmodelcontextenrichmentconfiguration-enrichmentstrategyconfiguration): EnrichmentStrategyConfiguration [ModelArn](#cfn-bedrock-datasource-bedrockfoundationmodelcontextenrichmentconfiguration-modelarn): String ``` ## Properties `EnrichmentStrategyConfiguration` The enrichment stategy used to provide additional context. For example, Neptune GraphRAG uses Amazon Bedrock foundation models to perform chunk entity extraction. *Required*: Yes *Type*: [EnrichmentStrategyConfiguration](aws-properties-bedrock-datasource-enrichmentstrategyconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ModelArn` The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base. *Required*: Yes *Type*: String *Pattern*: `^(arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:(bedrock):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource ChunkingConfiguration Details about how to chunk the documents in the data source. A *chunk* refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ChunkingStrategy](#cfn-bedrock-datasource-chunkingconfiguration-chunkingstrategy)" : String, "[FixedSizeChunkingConfiguration](#cfn-bedrock-datasource-chunkingconfiguration-fixedsizechunkingconfiguration)" : FixedSizeChunkingConfiguration, "[HierarchicalChunkingConfiguration](#cfn-bedrock-datasource-chunkingconfiguration-hierarchicalchunkingconfiguration)" : HierarchicalChunkingConfiguration, "[SemanticChunkingConfiguration](#cfn-bedrock-datasource-chunkingconfiguration-semanticchunkingconfiguration)" : SemanticChunkingConfiguration } ``` ### YAML ``` [ChunkingStrategy](#cfn-bedrock-datasource-chunkingconfiguration-chunkingstrategy): String [FixedSizeChunkingConfiguration](#cfn-bedrock-datasource-chunkingconfiguration-fixedsizechunkingconfiguration): FixedSizeChunkingConfiguration [HierarchicalChunkingConfiguration](#cfn-bedrock-datasource-chunkingconfiguration-hierarchicalchunkingconfiguration): HierarchicalChunkingConfiguration [SemanticChunkingConfiguration](#cfn-bedrock-datasource-chunkingconfiguration-semanticchunkingconfiguration): SemanticChunkingConfiguration ``` ## Properties `ChunkingStrategy` Knowledge base can split your source data into chunks. A *chunk* refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. You have the following options for chunking your data. If you opt for `NONE`, then you may want to pre-process your files by splitting them up such that each file corresponds to a chunk. + `FIXED_SIZE` – Amazon Bedrock splits your source data into chunks of the approximate size that you set in the `fixedSizeChunkingConfiguration`. + `HIERARCHICAL` – Split documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer. + `SEMANTIC` – Split documents into chunks based on groups of similar content derived with natural language processing. + `NONE` – Amazon Bedrock treats each file as one chunk. If you choose this option, you may want to pre-process your documents by splitting them into separate files. *Required*: Yes *Type*: String *Allowed values*: `FIXED_SIZE | NONE | HIERARCHICAL | SEMANTIC` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `FixedSizeChunkingConfiguration` Configurations for when you choose fixed-size chunking. If you set the `chunkingStrategy` as `NONE`, exclude this field. *Required*: No *Type*: [FixedSizeChunkingConfiguration](aws-properties-bedrock-datasource-fixedsizechunkingconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `HierarchicalChunkingConfiguration` Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer. *Required*: No *Type*: [HierarchicalChunkingConfiguration](aws-properties-bedrock-datasource-hierarchicalchunkingconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `SemanticChunkingConfiguration` Settings for semantic document chunking for a data source. Semantic chunking splits a document into into smaller documents based on groups of similar content derived from the text with natural language processing. *Required*: No *Type*: [SemanticChunkingConfiguration](aws-properties-bedrock-datasource-semanticchunkingconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::DataSource ConfluenceCrawlerConfiguration The configuration of the Confluence content. For example, configuring specific types of Confluence content. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[FilterConfiguration](#cfn-bedrock-datasource-confluencecrawlerconfiguration-filterconfiguration)" : CrawlFilterConfiguration } ``` ### YAML ``` [FilterConfiguration](#cfn-bedrock-datasource-confluencecrawlerconfiguration-filterconfiguration): CrawlFilterConfiguration ``` ## Properties `FilterConfiguration` The configuration of filtering the Confluence content. For example, configuring regular expression patterns to include or exclude certain content. *Required*: No *Type*: [CrawlFilterConfiguration](aws-properties-bedrock-datasource-crawlfilterconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource ConfluenceDataSourceConfiguration The configuration information to connect to Confluence as your data source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CrawlerConfiguration](#cfn-bedrock-datasource-confluencedatasourceconfiguration-crawlerconfiguration)" : ConfluenceCrawlerConfiguration, "[SourceConfiguration](#cfn-bedrock-datasource-confluencedatasourceconfiguration-sourceconfiguration)" : ConfluenceSourceConfiguration } ``` ### YAML ``` [CrawlerConfiguration](#cfn-bedrock-datasource-confluencedatasourceconfiguration-crawlerconfiguration): ConfluenceCrawlerConfiguration [SourceConfiguration](#cfn-bedrock-datasource-confluencedatasourceconfiguration-sourceconfiguration): ConfluenceSourceConfiguration ``` ## Properties `CrawlerConfiguration` The configuration of the Confluence content. For example, configuring specific types of Confluence content. *Required*: No *Type*: [ConfluenceCrawlerConfiguration](aws-properties-bedrock-datasource-confluencecrawlerconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SourceConfiguration` The endpoint information to connect to your Confluence data source. *Required*: Yes *Type*: [ConfluenceSourceConfiguration](aws-properties-bedrock-datasource-confluencesourceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource ConfluenceSourceConfiguration The endpoint information to connect to your Confluence data source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AuthType](#cfn-bedrock-datasource-confluencesourceconfiguration-authtype)" : String, "[CredentialsSecretArn](#cfn-bedrock-datasource-confluencesourceconfiguration-credentialssecretarn)" : String, "[HostType](#cfn-bedrock-datasource-confluencesourceconfiguration-hosttype)" : String, "[HostUrl](#cfn-bedrock-datasource-confluencesourceconfiguration-hosturl)" : String } ``` ### YAML ``` [AuthType](#cfn-bedrock-datasource-confluencesourceconfiguration-authtype): String [CredentialsSecretArn](#cfn-bedrock-datasource-confluencesourceconfiguration-credentialssecretarn): String [HostType](#cfn-bedrock-datasource-confluencesourceconfiguration-hosttype): String [HostUrl](#cfn-bedrock-datasource-confluencesourceconfiguration-hosturl): String ``` ## Properties `AuthType` The supported authentication type to authenticate and connect to your Confluence instance. *Required*: Yes *Type*: String *Allowed values*: `BASIC | OAUTH2_CLIENT_CREDENTIALS` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CredentialsSecretArn` The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your Confluence instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see [Confluence connection configuration](https://docs.aws.amazon.com/bedrock/latest/userguide/confluence-data-source-connector.html#configuration-confluence-connector). *Required*: Yes *Type*: String *Pattern*: `^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `HostType` The supported host type, whether online/cloud or server/on-premises. *Required*: Yes *Type*: String *Allowed values*: `SAAS` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `HostUrl` The Confluence host URL or instance URL. *Required*: Yes *Type*: String *Pattern*: `^https://[A-Za-z0-9][^\s]*$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource ContextEnrichmentConfiguration Context enrichment configuration is used to provide additional context to the RAG application. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BedrockFoundationModelConfiguration](#cfn-bedrock-datasource-contextenrichmentconfiguration-bedrockfoundationmodelconfiguration)" : BedrockFoundationModelContextEnrichmentConfiguration, "[Type](#cfn-bedrock-datasource-contextenrichmentconfiguration-type)" : String } ``` ### YAML ``` [BedrockFoundationModelConfiguration](#cfn-bedrock-datasource-contextenrichmentconfiguration-bedrockfoundationmodelconfiguration): BedrockFoundationModelContextEnrichmentConfiguration [Type](#cfn-bedrock-datasource-contextenrichmentconfiguration-type): String ``` ## Properties `BedrockFoundationModelConfiguration` The configuration of the Amazon Bedrock foundation model used for context enrichment. *Required*: No *Type*: [BedrockFoundationModelContextEnrichmentConfiguration](aws-properties-bedrock-datasource-bedrockfoundationmodelcontextenrichmentconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The method used for context enrichment. It must be Amazon Bedrock foundation models. *Required*: Yes *Type*: String *Allowed values*: `BEDROCK_FOUNDATION_MODEL` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource CrawlFilterConfiguration The configuration of filtering the data source content. For example, configuring regular expression patterns to include or exclude certain content. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[PatternObjectFilter](#cfn-bedrock-datasource-crawlfilterconfiguration-patternobjectfilter)" : PatternObjectFilterConfiguration, "[Type](#cfn-bedrock-datasource-crawlfilterconfiguration-type)" : String } ``` ### YAML ``` [PatternObjectFilter](#cfn-bedrock-datasource-crawlfilterconfiguration-patternobjectfilter): PatternObjectFilterConfiguration [Type](#cfn-bedrock-datasource-crawlfilterconfiguration-type): String ``` ## Properties `PatternObjectFilter` The configuration of filtering certain objects or content types of the data source. *Required*: No *Type*: [PatternObjectFilterConfiguration](aws-properties-bedrock-datasource-patternobjectfilterconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The type of filtering that you want to apply to certain objects or content of the data source. For example, the `PATTERN` type is regular expression patterns you can apply to filter your content. *Required*: Yes *Type*: String *Allowed values*: `PATTERN` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource CustomTransformationConfiguration Settings for customizing steps in the data source content ingestion pipeline. You can configure the data source to process documents with a Lambda function after they are parsed and converted into chunks. When you add a post-chunking transformation, the service stores chunked documents in an S3 bucket and invokes a Lambda function to process them. To process chunked documents with a Lambda function, define an S3 bucket path for input and output objects, and a transformation that specifies the Lambda function to invoke. You can use the Lambda function to customize how chunks are split, and the metadata for each chunk. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IntermediateStorage](#cfn-bedrock-datasource-customtransformationconfiguration-intermediatestorage)" : IntermediateStorage, "[Transformations](#cfn-bedrock-datasource-customtransformationconfiguration-transformations)" : [ Transformation, ... ] } ``` ### YAML ``` [IntermediateStorage](#cfn-bedrock-datasource-customtransformationconfiguration-intermediatestorage): IntermediateStorage [Transformations](#cfn-bedrock-datasource-customtransformationconfiguration-transformations): - Transformation ``` ## Properties `IntermediateStorage` An S3 bucket path for input and output objects. *Required*: Yes *Type*: [IntermediateStorage](aws-properties-bedrock-datasource-intermediatestorage.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Transformations` A Lambda function that processes documents. *Required*: Yes *Type*: Array of [Transformation](aws-properties-bedrock-datasource-transformation.md) *Minimum*: `1` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource DataSourceConfiguration The connection configuration for the data source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ConfluenceConfiguration](#cfn-bedrock-datasource-datasourceconfiguration-confluenceconfiguration)" : ConfluenceDataSourceConfiguration, "[S3Configuration](#cfn-bedrock-datasource-datasourceconfiguration-s3configuration)" : S3DataSourceConfiguration, "[SalesforceConfiguration](#cfn-bedrock-datasource-datasourceconfiguration-salesforceconfiguration)" : SalesforceDataSourceConfiguration, "[SharePointConfiguration](#cfn-bedrock-datasource-datasourceconfiguration-sharepointconfiguration)" : SharePointDataSourceConfiguration, "[Type](#cfn-bedrock-datasource-datasourceconfiguration-type)" : String, "[WebConfiguration](#cfn-bedrock-datasource-datasourceconfiguration-webconfiguration)" : WebDataSourceConfiguration } ``` ### YAML ``` [ConfluenceConfiguration](#cfn-bedrock-datasource-datasourceconfiguration-confluenceconfiguration): ConfluenceDataSourceConfiguration [S3Configuration](#cfn-bedrock-datasource-datasourceconfiguration-s3configuration): S3DataSourceConfiguration [SalesforceConfiguration](#cfn-bedrock-datasource-datasourceconfiguration-salesforceconfiguration): SalesforceDataSourceConfiguration [SharePointConfiguration](#cfn-bedrock-datasource-datasourceconfiguration-sharepointconfiguration): SharePointDataSourceConfiguration [Type](#cfn-bedrock-datasource-datasourceconfiguration-type): String [WebConfiguration](#cfn-bedrock-datasource-datasourceconfiguration-webconfiguration): WebDataSourceConfiguration ``` ## Properties `ConfluenceConfiguration` The configuration information to connect to Confluence as your data source. Confluence data source connector is in preview release and is subject to change. *Required*: No *Type*: [ConfluenceDataSourceConfiguration](aws-properties-bedrock-datasource-confluencedatasourceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `S3Configuration` The configuration information to connect to Amazon S3 as your data source. *Required*: No *Type*: [S3DataSourceConfiguration](aws-properties-bedrock-datasource-s3datasourceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SalesforceConfiguration` The configuration information to connect to Salesforce as your data source. Salesforce data source connector is in preview release and is subject to change. *Required*: No *Type*: [SalesforceDataSourceConfiguration](aws-properties-bedrock-datasource-salesforcedatasourceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SharePointConfiguration` The configuration information to connect to SharePoint as your data source. SharePoint data source connector is in preview release and is subject to change. *Required*: No *Type*: [SharePointDataSourceConfiguration](aws-properties-bedrock-datasource-sharepointdatasourceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The type of data source. *Required*: Yes *Type*: String *Allowed values*: `S3 | CONFLUENCE | SALESFORCE | SHAREPOINT | WEB | CUSTOM | REDSHIFT_METADATA` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `WebConfiguration` The configuration of web URLs to crawl for your data source. You should be authorized to crawl the URLs. Crawling web URLs as your data source is in preview release and is subject to change. *Required*: No *Type*: [WebDataSourceConfiguration](aws-properties-bedrock-datasource-webdatasourceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource EnrichmentStrategyConfiguration The strategy used for performing context enrichment. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Method](#cfn-bedrock-datasource-enrichmentstrategyconfiguration-method)" : String } ``` ### YAML ``` [Method](#cfn-bedrock-datasource-enrichmentstrategyconfiguration-method): String ``` ## Properties `Method` The method used for the context enrichment strategy. *Required*: Yes *Type*: String *Allowed values*: `CHUNK_ENTITY_EXTRACTION` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource FixedSizeChunkingConfiguration Configurations for when you choose fixed-size chunking. If you set the `chunkingStrategy` as `NONE`, exclude this field. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MaxTokens](#cfn-bedrock-datasource-fixedsizechunkingconfiguration-maxtokens)" : Integer, "[OverlapPercentage](#cfn-bedrock-datasource-fixedsizechunkingconfiguration-overlappercentage)" : Integer } ``` ### YAML ``` [MaxTokens](#cfn-bedrock-datasource-fixedsizechunkingconfiguration-maxtokens): Integer [OverlapPercentage](#cfn-bedrock-datasource-fixedsizechunkingconfiguration-overlappercentage): Integer ``` ## Properties `MaxTokens` The maximum number of tokens to include in a chunk. *Required*: Yes *Type*: Integer *Minimum*: `1` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `OverlapPercentage` The percentage of overlap between adjacent chunks of a data source. *Required*: Yes *Type*: Integer *Minimum*: `1` *Maximum*: `99` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::DataSource HierarchicalChunkingConfiguration Settings for hierarchical document chunking for a data source. Hierarchical chunking splits documents into layers of chunks where the first layer contains large chunks, and the second layer contains smaller chunks derived from the first layer. You configure the number of tokens to overlap, or repeat across adjacent chunks. For example, if you set overlap tokens to 60, the last 60 tokens in the first chunk are also included at the beginning of the second chunk. For each layer, you must also configure the maximum number of tokens in a chunk. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[LevelConfigurations](#cfn-bedrock-datasource-hierarchicalchunkingconfiguration-levelconfigurations)" : [ HierarchicalChunkingLevelConfiguration, ... ], "[OverlapTokens](#cfn-bedrock-datasource-hierarchicalchunkingconfiguration-overlaptokens)" : Integer } ``` ### YAML ``` [LevelConfigurations](#cfn-bedrock-datasource-hierarchicalchunkingconfiguration-levelconfigurations): - HierarchicalChunkingLevelConfiguration [OverlapTokens](#cfn-bedrock-datasource-hierarchicalchunkingconfiguration-overlaptokens): Integer ``` ## Properties `LevelConfigurations` Token settings for each layer. *Required*: Yes *Type*: Array of [HierarchicalChunkingLevelConfiguration](aws-properties-bedrock-datasource-hierarchicalchunkinglevelconfiguration.md) *Minimum*: `2` *Maximum*: `2` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `OverlapTokens` The number of tokens to repeat across chunks in the same layer. *Required*: Yes *Type*: Integer *Minimum*: `1` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::DataSource HierarchicalChunkingLevelConfiguration Token settings for a layer in a hierarchical chunking configuration. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MaxTokens](#cfn-bedrock-datasource-hierarchicalchunkinglevelconfiguration-maxtokens)" : Integer } ``` ### YAML ``` [MaxTokens](#cfn-bedrock-datasource-hierarchicalchunkinglevelconfiguration-maxtokens): Integer ``` ## Properties `MaxTokens` The maximum number of tokens that a chunk can contain in this layer. *Required*: Yes *Type*: Integer *Minimum*: `1` *Maximum*: `8192` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::DataSource IntermediateStorage A location for storing content from data sources temporarily as it is processed by custom components in the ingestion pipeline. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[S3Location](#cfn-bedrock-datasource-intermediatestorage-s3location)" : S3Location } ``` ### YAML ``` [S3Location](#cfn-bedrock-datasource-intermediatestorage-s3location): S3Location ``` ## Properties `S3Location` An S3 bucket path. *Required*: Yes *Type*: [S3Location](aws-properties-bedrock-datasource-s3location.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource ParsingConfiguration Settings for parsing document contents. If you exclude this field, the default parser converts the contents of each document into text before splitting it into chunks. Specify the parsing strategy to use in the `parsingStrategy` field and include the relevant configuration, or omit it to use the Amazon Bedrock default parser. For more information, see [Parsing options for your data source](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-advanced-parsing.html). **Note** If you specify `BEDROCK_DATA_AUTOMATION` or `BEDROCK_FOUNDATION_MODEL` and it fails to parse a file, the Amazon Bedrock default parser will be used instead. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BedrockDataAutomationConfiguration](#cfn-bedrock-datasource-parsingconfiguration-bedrockdataautomationconfiguration)" : BedrockDataAutomationConfiguration, "[BedrockFoundationModelConfiguration](#cfn-bedrock-datasource-parsingconfiguration-bedrockfoundationmodelconfiguration)" : BedrockFoundationModelConfiguration, "[ParsingStrategy](#cfn-bedrock-datasource-parsingconfiguration-parsingstrategy)" : String } ``` ### YAML ``` [BedrockDataAutomationConfiguration](#cfn-bedrock-datasource-parsingconfiguration-bedrockdataautomationconfiguration): BedrockDataAutomationConfiguration [BedrockFoundationModelConfiguration](#cfn-bedrock-datasource-parsingconfiguration-bedrockfoundationmodelconfiguration): BedrockFoundationModelConfiguration [ParsingStrategy](#cfn-bedrock-datasource-parsingconfiguration-parsingstrategy): String ``` ## Properties `BedrockDataAutomationConfiguration` If you specify `BEDROCK_DATA_AUTOMATION` as the parsing strategy for ingesting your data source, use this object to modify configurations for using the Amazon Bedrock Data Automation parser. *Required*: No *Type*: [BedrockDataAutomationConfiguration](aws-properties-bedrock-datasource-bedrockdataautomationconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `BedrockFoundationModelConfiguration` If you specify `BEDROCK_FOUNDATION_MODEL` as the parsing strategy for ingesting your data source, use this object to modify configurations for using a foundation model to parse documents. *Required*: No *Type*: [BedrockFoundationModelConfiguration](aws-properties-bedrock-datasource-bedrockfoundationmodelconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ParsingStrategy` The parsing strategy for the data source. *Required*: Yes *Type*: String *Allowed values*: `BEDROCK_FOUNDATION_MODEL | BEDROCK_DATA_AUTOMATION` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::DataSource ParsingPrompt Instructions for interpreting the contents of a document. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ParsingPromptText](#cfn-bedrock-datasource-parsingprompt-parsingprompttext)" : String } ``` ### YAML ``` [ParsingPromptText](#cfn-bedrock-datasource-parsingprompt-parsingprompttext): String ``` ## Properties `ParsingPromptText` Instructions for interpreting the contents of a document. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `10000` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::DataSource PatternObjectFilter The specific filters applied to your data source content. You can filter out or include certain content. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ExclusionFilters](#cfn-bedrock-datasource-patternobjectfilter-exclusionfilters)" : [ String, ... ], "[InclusionFilters](#cfn-bedrock-datasource-patternobjectfilter-inclusionfilters)" : [ String, ... ], "[ObjectType](#cfn-bedrock-datasource-patternobjectfilter-objecttype)" : String } ``` ### YAML ``` [ExclusionFilters](#cfn-bedrock-datasource-patternobjectfilter-exclusionfilters): - String [InclusionFilters](#cfn-bedrock-datasource-patternobjectfilter-inclusionfilters): - String [ObjectType](#cfn-bedrock-datasource-patternobjectfilter-objecttype): String ``` ## Properties `ExclusionFilters` A list of one or more exclusion regular expression patterns to exclude certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled. *Required*: No *Type*: Array of String *Minimum*: `1` *Maximum*: `1000 | 25` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InclusionFilters` A list of one or more inclusion regular expression patterns to include certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled. *Required*: No *Type*: Array of String *Minimum*: `1` *Maximum*: `1000 | 25` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ObjectType` The supported object type or content type of the data source. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource PatternObjectFilterConfiguration The configuration of filtering certain objects or content types of the data source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Filters](#cfn-bedrock-datasource-patternobjectfilterconfiguration-filters)" : [ PatternObjectFilter, ... ] } ``` ### YAML ``` [Filters](#cfn-bedrock-datasource-patternobjectfilterconfiguration-filters): - PatternObjectFilter ``` ## Properties `Filters` The configuration of specific filters applied to your data source content. You can filter out or include certain content. *Required*: Yes *Type*: Array of [PatternObjectFilter](aws-properties-bedrock-datasource-patternobjectfilter.md) *Minimum*: `1` *Maximum*: `25` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource S3DataSourceConfiguration The configuration information to connect to Amazon S3 as your data source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BucketArn](#cfn-bedrock-datasource-s3datasourceconfiguration-bucketarn)" : String, "[BucketOwnerAccountId](#cfn-bedrock-datasource-s3datasourceconfiguration-bucketowneraccountid)" : String, "[InclusionPrefixes](#cfn-bedrock-datasource-s3datasourceconfiguration-inclusionprefixes)" : [ String, ... ] } ``` ### YAML ``` [BucketArn](#cfn-bedrock-datasource-s3datasourceconfiguration-bucketarn): String [BucketOwnerAccountId](#cfn-bedrock-datasource-s3datasourceconfiguration-bucketowneraccountid): String [InclusionPrefixes](#cfn-bedrock-datasource-s3datasourceconfiguration-inclusionprefixes): - String ``` ## Properties `BucketArn` The Amazon Resource Name (ARN) of the S3 bucket that contains your data. *Required*: Yes *Type*: String *Pattern*: `^arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:s3:::[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BucketOwnerAccountId` The account ID for the owner of the S3 bucket. *Required*: No *Type*: String *Pattern*: `^[0-9]{12}$` *Minimum*: `12` *Maximum*: `12` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InclusionPrefixes` A list of S3 prefixes to include certain files or content. This field is an array with a maximum of one item, which can contain a string that has a maximum length of 300 characters. For more information, see [Organizing objects using prefixes](https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-prefixes.html). *Required*: No *Type*: Array of String *Minimum*: `1 | 1` *Maximum*: `300 | 1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource S3Location A storage location in an Amazon S3 bucket. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[URI](#cfn-bedrock-datasource-s3location-uri)" : String } ``` ### YAML ``` [URI](#cfn-bedrock-datasource-s3location-uri): String ``` ## Properties `URI` An object URI starting with `s3://`. *Required*: Yes *Type*: String *Pattern*: `^s3://.{1,128}$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource SalesforceCrawlerConfiguration The configuration of the Salesforce content. For example, configuring specific types of Salesforce content. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[FilterConfiguration](#cfn-bedrock-datasource-salesforcecrawlerconfiguration-filterconfiguration)" : CrawlFilterConfiguration } ``` ### YAML ``` [FilterConfiguration](#cfn-bedrock-datasource-salesforcecrawlerconfiguration-filterconfiguration): CrawlFilterConfiguration ``` ## Properties `FilterConfiguration` The configuration of filtering the Salesforce content. For example, configuring regular expression patterns to include or exclude certain content. *Required*: No *Type*: [CrawlFilterConfiguration](aws-properties-bedrock-datasource-crawlfilterconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource SalesforceDataSourceConfiguration The configuration information to connect to Salesforce as your data source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CrawlerConfiguration](#cfn-bedrock-datasource-salesforcedatasourceconfiguration-crawlerconfiguration)" : SalesforceCrawlerConfiguration, "[SourceConfiguration](#cfn-bedrock-datasource-salesforcedatasourceconfiguration-sourceconfiguration)" : SalesforceSourceConfiguration } ``` ### YAML ``` [CrawlerConfiguration](#cfn-bedrock-datasource-salesforcedatasourceconfiguration-crawlerconfiguration): SalesforceCrawlerConfiguration [SourceConfiguration](#cfn-bedrock-datasource-salesforcedatasourceconfiguration-sourceconfiguration): SalesforceSourceConfiguration ``` ## Properties `CrawlerConfiguration` The configuration of the Salesforce content. For example, configuring specific types of Salesforce content. *Required*: No *Type*: [SalesforceCrawlerConfiguration](aws-properties-bedrock-datasource-salesforcecrawlerconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SourceConfiguration` The endpoint information to connect to your Salesforce data source. *Required*: Yes *Type*: [SalesforceSourceConfiguration](aws-properties-bedrock-datasource-salesforcesourceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource SalesforceSourceConfiguration The endpoint information to connect to your Salesforce data source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AuthType](#cfn-bedrock-datasource-salesforcesourceconfiguration-authtype)" : String, "[CredentialsSecretArn](#cfn-bedrock-datasource-salesforcesourceconfiguration-credentialssecretarn)" : String, "[HostUrl](#cfn-bedrock-datasource-salesforcesourceconfiguration-hosturl)" : String } ``` ### YAML ``` [AuthType](#cfn-bedrock-datasource-salesforcesourceconfiguration-authtype): String [CredentialsSecretArn](#cfn-bedrock-datasource-salesforcesourceconfiguration-credentialssecretarn): String [HostUrl](#cfn-bedrock-datasource-salesforcesourceconfiguration-hosturl): String ``` ## Properties `AuthType` The supported authentication type to authenticate and connect to your Salesforce instance. *Required*: Yes *Type*: String *Allowed values*: `OAUTH2_CLIENT_CREDENTIALS` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CredentialsSecretArn` The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your Salesforce instance URL. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see [Salesforce connection configuration](https://docs.aws.amazon.com/bedrock/latest/userguide/salesforce-data-source-connector.html#configuration-salesforce-connector). *Required*: Yes *Type*: String *Pattern*: `^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `HostUrl` The Salesforce host URL or instance URL. *Required*: Yes *Type*: String *Pattern*: `^https://[A-Za-z0-9][^\s]*$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource SeedUrl The seed or starting point URL. You should be authorized to crawl the URL. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Url](#cfn-bedrock-datasource-seedurl-url)" : String } ``` ### YAML ``` [Url](#cfn-bedrock-datasource-seedurl-url): String ``` ## Properties `Url` A seed or starting point URL. *Required*: Yes *Type*: String *Pattern*: `^https?://[A-Za-z0-9][^\s]*$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource SemanticChunkingConfiguration Settings for semantic document chunking for a data source. Semantic chunking splits a document into into smaller documents based on groups of similar content derived from the text with natural language processing. With semantic chunking, each sentence is compared to the next to determine how similar they are. You specify a threshold in the form of a percentile, where adjacent sentences that are less similar than that percentage of sentence pairs are divided into separate chunks. For example, if you set the threshold to 90, then the 10 percent of sentence pairs that are least similar are split. So if you have 101 sentences, 100 sentence pairs are compared, and the 10 with the least similarity are split, creating 11 chunks. These chunks are further split if they exceed the max token size. You must also specify a buffer size, which determines whether sentences are compared in isolation, or within a moving context window that includes the previous and following sentence. For example, if you set the buffer size to `1`, the embedding for sentence 10 is derived from sentences 9, 10, and 11 combined. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BreakpointPercentileThreshold](#cfn-bedrock-datasource-semanticchunkingconfiguration-breakpointpercentilethreshold)" : Integer, "[BufferSize](#cfn-bedrock-datasource-semanticchunkingconfiguration-buffersize)" : Integer, "[MaxTokens](#cfn-bedrock-datasource-semanticchunkingconfiguration-maxtokens)" : Integer } ``` ### YAML ``` [BreakpointPercentileThreshold](#cfn-bedrock-datasource-semanticchunkingconfiguration-breakpointpercentilethreshold): Integer [BufferSize](#cfn-bedrock-datasource-semanticchunkingconfiguration-buffersize): Integer [MaxTokens](#cfn-bedrock-datasource-semanticchunkingconfiguration-maxtokens): Integer ``` ## Properties `BreakpointPercentileThreshold` The dissimilarity threshold for splitting chunks. *Required*: Yes *Type*: Integer *Minimum*: `50` *Maximum*: `99` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `BufferSize` The buffer size. *Required*: Yes *Type*: Integer *Minimum*: `0` *Maximum*: `1` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `MaxTokens` The maximum number of tokens that a chunk can contain. *Required*: Yes *Type*: Integer *Minimum*: `1` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::DataSource ServerSideEncryptionConfiguration Contains the configuration for server-side encryption. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[KmsKeyArn](#cfn-bedrock-datasource-serversideencryptionconfiguration-kmskeyarn)" : String } ``` ### YAML ``` [KmsKeyArn](#cfn-bedrock-datasource-serversideencryptionconfiguration-kmskeyarn): String ``` ## Properties `KmsKeyArn` The Amazon Resource Name (ARN) of the AWS KMS key used to encrypt the resource. *Required*: No *Type*: String *Pattern*: `^arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource SharePointCrawlerConfiguration The configuration of the SharePoint content. For example, configuring specific types of SharePoint content. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[FilterConfiguration](#cfn-bedrock-datasource-sharepointcrawlerconfiguration-filterconfiguration)" : CrawlFilterConfiguration } ``` ### YAML ``` [FilterConfiguration](#cfn-bedrock-datasource-sharepointcrawlerconfiguration-filterconfiguration): CrawlFilterConfiguration ``` ## Properties `FilterConfiguration` The configuration of filtering the SharePoint content. For example, configuring regular expression patterns to include or exclude certain content. *Required*: No *Type*: [CrawlFilterConfiguration](aws-properties-bedrock-datasource-crawlfilterconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource SharePointDataSourceConfiguration The configuration information to connect to SharePoint as your data source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CrawlerConfiguration](#cfn-bedrock-datasource-sharepointdatasourceconfiguration-crawlerconfiguration)" : SharePointCrawlerConfiguration, "[SourceConfiguration](#cfn-bedrock-datasource-sharepointdatasourceconfiguration-sourceconfiguration)" : SharePointSourceConfiguration } ``` ### YAML ``` [CrawlerConfiguration](#cfn-bedrock-datasource-sharepointdatasourceconfiguration-crawlerconfiguration): SharePointCrawlerConfiguration [SourceConfiguration](#cfn-bedrock-datasource-sharepointdatasourceconfiguration-sourceconfiguration): SharePointSourceConfiguration ``` ## Properties `CrawlerConfiguration` The configuration of the SharePoint content. For example, configuring specific types of SharePoint content. *Required*: No *Type*: [SharePointCrawlerConfiguration](aws-properties-bedrock-datasource-sharepointcrawlerconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SourceConfiguration` The endpoint information to connect to your SharePoint data source. *Required*: Yes *Type*: [SharePointSourceConfiguration](aws-properties-bedrock-datasource-sharepointsourceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource SharePointSourceConfiguration The endpoint information to connect to your SharePoint data source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AuthType](#cfn-bedrock-datasource-sharepointsourceconfiguration-authtype)" : String, "[CredentialsSecretArn](#cfn-bedrock-datasource-sharepointsourceconfiguration-credentialssecretarn)" : String, "[Domain](#cfn-bedrock-datasource-sharepointsourceconfiguration-domain)" : String, "[HostType](#cfn-bedrock-datasource-sharepointsourceconfiguration-hosttype)" : String, "[SiteUrls](#cfn-bedrock-datasource-sharepointsourceconfiguration-siteurls)" : [ String, ... ], "[TenantId](#cfn-bedrock-datasource-sharepointsourceconfiguration-tenantid)" : String } ``` ### YAML ``` [AuthType](#cfn-bedrock-datasource-sharepointsourceconfiguration-authtype): String [CredentialsSecretArn](#cfn-bedrock-datasource-sharepointsourceconfiguration-credentialssecretarn): String [Domain](#cfn-bedrock-datasource-sharepointsourceconfiguration-domain): String [HostType](#cfn-bedrock-datasource-sharepointsourceconfiguration-hosttype): String [SiteUrls](#cfn-bedrock-datasource-sharepointsourceconfiguration-siteurls): - String [TenantId](#cfn-bedrock-datasource-sharepointsourceconfiguration-tenantid): String ``` ## Properties `AuthType` The supported authentication type to authenticate and connect to your SharePoint site/sites. *Required*: Yes *Type*: String *Allowed values*: `OAUTH2_CLIENT_CREDENTIALS | OAUTH2_SHAREPOINT_APP_ONLY_CLIENT_CREDENTIALS` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CredentialsSecretArn` The Amazon Resource Name of an AWS Secrets Manager secret that stores your authentication credentials for your SharePoint site/sites. For more information on the key-value pairs that must be included in your secret, depending on your authentication type, see [SharePoint connection configuration](https://docs.aws.amazon.com/bedrock/latest/userguide/sharepoint-data-source-connector.html#configuration-sharepoint-connector). *Required*: Yes *Type*: String *Pattern*: `^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Domain` The domain of your SharePoint instance or site URL/URLs. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `HostType` The supported host type, whether online/cloud or server/on-premises. *Required*: Yes *Type*: String *Allowed values*: `ONLINE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SiteUrls` A list of one or more SharePoint site URLs. *Required*: Yes *Type*: Array of String *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TenantId` The identifier of your Microsoft 365 tenant. *Required*: No *Type*: String *Pattern*: `^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource Transformation A custom processing step for documents moving through a data source ingestion pipeline. To process documents after they have been converted into chunks, set the step to apply to `POST_CHUNKING`. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[StepToApply](#cfn-bedrock-datasource-transformation-steptoapply)" : String, "[TransformationFunction](#cfn-bedrock-datasource-transformation-transformationfunction)" : TransformationFunction } ``` ### YAML ``` [StepToApply](#cfn-bedrock-datasource-transformation-steptoapply): String [TransformationFunction](#cfn-bedrock-datasource-transformation-transformationfunction): TransformationFunction ``` ## Properties `StepToApply` When the service applies the transformation. *Required*: Yes *Type*: String *Allowed values*: `POST_CHUNKING` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TransformationFunction` A Lambda function that processes documents. *Required*: Yes *Type*: [TransformationFunction](aws-properties-bedrock-datasource-transformationfunction.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource TransformationFunction A Lambda function that processes documents. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[TransformationLambdaConfiguration](#cfn-bedrock-datasource-transformationfunction-transformationlambdaconfiguration)" : TransformationLambdaConfiguration } ``` ### YAML ``` [TransformationLambdaConfiguration](#cfn-bedrock-datasource-transformationfunction-transformationlambdaconfiguration): TransformationLambdaConfiguration ``` ## Properties `TransformationLambdaConfiguration` The Lambda function. *Required*: Yes *Type*: [TransformationLambdaConfiguration](aws-properties-bedrock-datasource-transformationlambdaconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource TransformationLambdaConfiguration A Lambda function that processes documents. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[LambdaArn](#cfn-bedrock-datasource-transformationlambdaconfiguration-lambdaarn)" : String } ``` ### YAML ``` [LambdaArn](#cfn-bedrock-datasource-transformationlambdaconfiguration-lambdaarn): String ``` ## Properties `LambdaArn` The function's ARN identifier. *Required*: Yes *Type*: String *Pattern*: `^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?$` *Minimum*: `0` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource UrlConfiguration The configuration of web URLs that you want to crawl. You should be authorized to crawl the URLs. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SeedUrls](#cfn-bedrock-datasource-urlconfiguration-seedurls)" : [ SeedUrl, ... ] } ``` ### YAML ``` [SeedUrls](#cfn-bedrock-datasource-urlconfiguration-seedurls): - SeedUrl ``` ## Properties `SeedUrls` One or more seed or starting point URLs. *Required*: Yes *Type*: Array of [SeedUrl](aws-properties-bedrock-datasource-seedurl.md) *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource VectorIngestionConfiguration Contains details about how to ingest the documents in a data source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ChunkingConfiguration](#cfn-bedrock-datasource-vectoringestionconfiguration-chunkingconfiguration)" : ChunkingConfiguration, "[ContextEnrichmentConfiguration](#cfn-bedrock-datasource-vectoringestionconfiguration-contextenrichmentconfiguration)" : ContextEnrichmentConfiguration, "[CustomTransformationConfiguration](#cfn-bedrock-datasource-vectoringestionconfiguration-customtransformationconfiguration)" : CustomTransformationConfiguration, "[ParsingConfiguration](#cfn-bedrock-datasource-vectoringestionconfiguration-parsingconfiguration)" : ParsingConfiguration } ``` ### YAML ``` [ChunkingConfiguration](#cfn-bedrock-datasource-vectoringestionconfiguration-chunkingconfiguration): ChunkingConfiguration [ContextEnrichmentConfiguration](#cfn-bedrock-datasource-vectoringestionconfiguration-contextenrichmentconfiguration): ContextEnrichmentConfiguration [CustomTransformationConfiguration](#cfn-bedrock-datasource-vectoringestionconfiguration-customtransformationconfiguration): CustomTransformationConfiguration [ParsingConfiguration](#cfn-bedrock-datasource-vectoringestionconfiguration-parsingconfiguration): ParsingConfiguration ``` ## Properties `ChunkingConfiguration` Details about how to chunk the documents in the data source. A *chunk* refers to an excerpt from a data source that is returned when the knowledge base that it belongs to is queried. *Required*: No *Type*: [ChunkingConfiguration](aws-properties-bedrock-datasource-chunkingconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ContextEnrichmentConfiguration` The context enrichment configuration used for ingestion of the data into the vector store. *Required*: No *Type*: [ContextEnrichmentConfiguration](aws-properties-bedrock-datasource-contextenrichmentconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CustomTransformationConfiguration` A custom document transformer for parsed data source documents. *Required*: No *Type*: [CustomTransformationConfiguration](aws-properties-bedrock-datasource-customtransformationconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ParsingConfiguration` Configurations for a parser to use for parsing documents in your data source. If you exclude this field, the default parser will be used. *Required*: No *Type*: [ParsingConfiguration](aws-properties-bedrock-datasource-parsingconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::DataSource WebCrawlerConfiguration The configuration of web URLs that you want to crawl. You should be authorized to crawl the URLs. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CrawlerLimits](#cfn-bedrock-datasource-webcrawlerconfiguration-crawlerlimits)" : WebCrawlerLimits, "[ExclusionFilters](#cfn-bedrock-datasource-webcrawlerconfiguration-exclusionfilters)" : [ String, ... ], "[InclusionFilters](#cfn-bedrock-datasource-webcrawlerconfiguration-inclusionfilters)" : [ String, ... ], "[Scope](#cfn-bedrock-datasource-webcrawlerconfiguration-scope)" : String, "[UserAgent](#cfn-bedrock-datasource-webcrawlerconfiguration-useragent)" : String, "[UserAgentHeader](#cfn-bedrock-datasource-webcrawlerconfiguration-useragentheader)" : String } ``` ### YAML ``` [CrawlerLimits](#cfn-bedrock-datasource-webcrawlerconfiguration-crawlerlimits): WebCrawlerLimits [ExclusionFilters](#cfn-bedrock-datasource-webcrawlerconfiguration-exclusionfilters): - String [InclusionFilters](#cfn-bedrock-datasource-webcrawlerconfiguration-inclusionfilters): - String [Scope](#cfn-bedrock-datasource-webcrawlerconfiguration-scope): String [UserAgent](#cfn-bedrock-datasource-webcrawlerconfiguration-useragent): String [UserAgentHeader](#cfn-bedrock-datasource-webcrawlerconfiguration-useragentheader): String ``` ## Properties `CrawlerLimits` The configuration of crawl limits for the web URLs. *Required*: No *Type*: [WebCrawlerLimits](aws-properties-bedrock-datasource-webcrawlerlimits.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ExclusionFilters` A list of one or more exclusion regular expression patterns to exclude certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled. *Required*: No *Type*: Array of String *Minimum*: `1` *Maximum*: `1000 | 25` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InclusionFilters` A list of one or more inclusion regular expression patterns to include certain URLs. If you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion filter takes precedence and the web content of the URL isn’t crawled. *Required*: No *Type*: Array of String *Minimum*: `1` *Maximum*: `1000 | 25` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Scope` The scope of what is crawled for your URLs. You can choose to crawl only web pages that belong to the same host or primary domain. For example, only web pages that contain the seed URL "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no other domains. You can choose to include sub domains in addition to the host or primary domain. For example, web pages that contain "aws.amazon.com" can also include sub domain "docs.aws.amazon.com". *Required*: No *Type*: String *Allowed values*: `HOST_ONLY | SUBDOMAINS` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UserAgent` Returns the user agent suffix for your web crawler. *Required*: No *Type*: String *Minimum*: `15` *Maximum*: `40` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `UserAgentHeader` A string used for identifying the crawler or bot when it accesses a web server. The user agent header value consists of the `bedrockbot`, UUID, and a user agent suffix for your crawler (if one is provided). By default, it is set to `bedrockbot_UUID`. You can optionally append a custom suffix to `bedrockbot_UUID` to allowlist a specific user agent permitted to access your source URLs. *Required*: No *Type*: String *Minimum*: `61` *Maximum*: `86` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource WebCrawlerLimits The rate limits for the URLs that you want to crawl. You should be authorized to crawl the URLs. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MaxPages](#cfn-bedrock-datasource-webcrawlerlimits-maxpages)" : Integer, "[RateLimit](#cfn-bedrock-datasource-webcrawlerlimits-ratelimit)" : Integer } ``` ### YAML ``` [MaxPages](#cfn-bedrock-datasource-webcrawlerlimits-maxpages): Integer [RateLimit](#cfn-bedrock-datasource-webcrawlerlimits-ratelimit): Integer ``` ## Properties `MaxPages` The max number of web pages crawled from your source URLs, up to 25,000 pages. If the web pages exceed this limit, the data source sync will fail and no web pages will be ingested. *Required*: No *Type*: Integer *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RateLimit` The max rate at which pages are crawled, up to 300 per minute per host. *Required*: No *Type*: Integer *Minimum*: `1` *Maximum*: `300` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource WebDataSourceConfiguration The configuration details for the web data source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CrawlerConfiguration](#cfn-bedrock-datasource-webdatasourceconfiguration-crawlerconfiguration)" : WebCrawlerConfiguration, "[SourceConfiguration](#cfn-bedrock-datasource-webdatasourceconfiguration-sourceconfiguration)" : WebSourceConfiguration } ``` ### YAML ``` [CrawlerConfiguration](#cfn-bedrock-datasource-webdatasourceconfiguration-crawlerconfiguration): WebCrawlerConfiguration [SourceConfiguration](#cfn-bedrock-datasource-webdatasourceconfiguration-sourceconfiguration): WebSourceConfiguration ``` ## Properties `CrawlerConfiguration` The Web Crawler configuration details for the web data source. *Required*: No *Type*: [WebCrawlerConfiguration](aws-properties-bedrock-datasource-webcrawlerconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SourceConfiguration` The source configuration details for the web data source. *Required*: Yes *Type*: [WebSourceConfiguration](aws-properties-bedrock-datasource-websourceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::DataSource WebSourceConfiguration The configuration of the URL/URLs for the web content that you want to crawl. You should be authorized to crawl the URLs. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[UrlConfiguration](#cfn-bedrock-datasource-websourceconfiguration-urlconfiguration)" : UrlConfiguration } ``` ### YAML ``` [UrlConfiguration](#cfn-bedrock-datasource-websourceconfiguration-urlconfiguration): UrlConfiguration ``` ## Properties `UrlConfiguration` The configuration of the URL/URLs. *Required*: Yes *Type*: [UrlConfiguration](aws-properties-bedrock-datasource-urlconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::EnforcedGuardrailConfiguration Sets the account-level enforced guardrail configuration. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::Bedrock::EnforcedGuardrailConfiguration", "Properties" : { "[GuardrailIdentifier](#cfn-bedrock-enforcedguardrailconfiguration-guardrailidentifier)" : String, "[GuardrailVersion](#cfn-bedrock-enforcedguardrailconfiguration-guardrailversion)" : String, "[ModelEnforcement](#cfn-bedrock-enforcedguardrailconfiguration-modelenforcement)" : ModelEnforcement, "[SelectiveContentGuarding](#cfn-bedrock-enforcedguardrailconfiguration-selectivecontentguarding)" : SelectiveContentGuarding } } ``` ### YAML ``` Type: AWS::Bedrock::EnforcedGuardrailConfiguration Properties: [GuardrailIdentifier](#cfn-bedrock-enforcedguardrailconfiguration-guardrailidentifier): String [GuardrailVersion](#cfn-bedrock-enforcedguardrailconfiguration-guardrailversion): String [ModelEnforcement](#cfn-bedrock-enforcedguardrailconfiguration-modelenforcement): ModelEnforcement [SelectiveContentGuarding](#cfn-bedrock-enforcedguardrailconfiguration-selectivecontentguarding): SelectiveContentGuarding ``` ## Properties `GuardrailIdentifier` Identifier for the guardrail, could be the ID or the ARN. *Required*: Yes *Type*: String *Pattern*: `^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$` *Minimum*: `0` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GuardrailVersion` Numerical guardrail version. *Required*: Yes *Type*: String *Pattern*: `^[1-9][0-9]{0,7}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ModelEnforcement` Model-specific information for the enforced guardrail configuration. *Required*: No *Type*: [ModelEnforcement](aws-properties-bedrock-enforcedguardrailconfiguration-modelenforcement.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SelectiveContentGuarding` Selective content guarding controls for enforced guardrails. *Required*: No *Type*: [SelectiveContentGuarding](aws-properties-bedrock-enforcedguardrailconfiguration-selectivecontentguarding.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref ### Fn::GetAtt #### `ConfigId` Unique ID for the account enforced configuration. `CreatedAt` Timestamp. `CreatedBy` The ARN of the role used to update the configuration. `GuardrailArn` ARN representation for the guardrail. `GuardrailId` Unique ID for the guardrail. `Owner` Configuration owner type. `UpdatedAt` Timestamp. `UpdatedBy` The ARN of the role used to update the configuration. # AWS::Bedrock::EnforcedGuardrailConfiguration ModelEnforcement Model-specific information for the enforced guardrail configuration. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ExcludedModels](#cfn-bedrock-enforcedguardrailconfiguration-modelenforcement-excludedmodels)" : [ String, ... ], "[IncludedModels](#cfn-bedrock-enforcedguardrailconfiguration-modelenforcement-includedmodels)" : [ String, ... ] } ``` ### YAML ``` [ExcludedModels](#cfn-bedrock-enforcedguardrailconfiguration-modelenforcement-excludedmodels): - String [IncludedModels](#cfn-bedrock-enforcedguardrailconfiguration-modelenforcement-includedmodels): - String ``` ## Properties `ExcludedModels` Models to exclude from enforcement of the guardrail. *Required*: Yes *Type*: Array of String *Minimum*: `0` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `IncludedModels` Models to enforce the guardrail on. *Required*: Yes *Type*: Array of String *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::EnforcedGuardrailConfiguration SelectiveContentGuarding Selective content guarding controls for enforced guardrails. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Messages](#cfn-bedrock-enforcedguardrailconfiguration-selectivecontentguarding-messages)" : String, "[System](#cfn-bedrock-enforcedguardrailconfiguration-selectivecontentguarding-system)" : String } ``` ### YAML ``` [Messages](#cfn-bedrock-enforcedguardrailconfiguration-selectivecontentguarding-messages): String [System](#cfn-bedrock-enforcedguardrailconfiguration-selectivecontentguarding-system): String ``` ## Properties `Messages` Selective guarding mode for user messages. *Required*: No *Type*: String *Allowed values*: `SELECTIVE | COMPREHENSIVE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `System` Selective guarding mode for system prompts. *Required*: No *Type*: String *Allowed values*: `SELECTIVE | COMPREHENSIVE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowdefinition.html) in the `Definition` property. + Provide the definition in the `DefinitionString` property as a JSON-formatted string matching the [FlowDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowdefinition.html) property. + Provide an Amazon S3 location in the `DefinitionS3Location` property that matches the [FlowDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowdefinition.html). 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](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-how-it-works.html) and [Create a prompt flow in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-create.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::Bedrock::Flow", "Properties" : { "[CustomerEncryptionKeyArn](#cfn-bedrock-flow-customerencryptionkeyarn)" : String, "[Definition](#cfn-bedrock-flow-definition)" : FlowDefinition, "[DefinitionS3Location](#cfn-bedrock-flow-definitions3location)" : S3Location, "[DefinitionString](#cfn-bedrock-flow-definitionstring)" : String, "[DefinitionSubstitutions](#cfn-bedrock-flow-definitionsubstitutions)" : {Key: Value, ...}, "[Description](#cfn-bedrock-flow-description)" : String, "[ExecutionRoleArn](#cfn-bedrock-flow-executionrolearn)" : String, "[Name](#cfn-bedrock-flow-name)" : String, "[Tags](#cfn-bedrock-flow-tags)" : {Key: Value, ...}, "[TestAliasTags](#cfn-bedrock-flow-testaliastags)" : {Key: Value, ...} } } ``` ### YAML ``` Type: AWS::Bedrock::Flow Properties: [CustomerEncryptionKeyArn](#cfn-bedrock-flow-customerencryptionkeyarn): String [Definition](#cfn-bedrock-flow-definition): FlowDefinition [DefinitionS3Location](#cfn-bedrock-flow-definitions3location): S3Location [DefinitionString](#cfn-bedrock-flow-definitionstring): String [DefinitionSubstitutions](#cfn-bedrock-flow-definitionsubstitutions): Key: Value [Description](#cfn-bedrock-flow-description): String [ExecutionRoleArn](#cfn-bedrock-flow-executionrolearn): String [Name](#cfn-bedrock-flow-name): String [Tags](#cfn-bedrock-flow-tags): Key: Value [TestAliasTags](#cfn-bedrock-flow-testaliastags): Key: Value ``` ## Properties `CustomerEncryptionKeyArn` The Amazon Resource Name (ARN) of the KMS key that the flow is encrypted with. *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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Definition` The definition of the nodes and connections between the nodes in the flow. *Required*: No *Type*: [FlowDefinition](aws-properties-bedrock-flow-flowdefinition.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DefinitionS3Location` The Amazon S3 location of the flow definition. *Required*: No *Type*: [S3Location](aws-properties-bedrock-flow-s3location.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DefinitionString` The definition of the flow as a JSON-formatted string. The string must match the format in [FlowDefinition](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-flowdefinition.html). *Required*: No *Type*: String *Maximum*: `512000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DefinitionSubstitutions` 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,...}`. *Required*: No *Type*: Object *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` A description of the flow. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ExecutionRoleArn` 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](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html) in the Amazon Bedrock User Guide. *Required*: Yes *Type*: String *Pattern*: `^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/(service-role/)?.+$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the flow. *Required*: Yes *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources: + [Tag naming limits and requirements](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions) + [Tagging best practices](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices) *Required*: No *Type*: Object of String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Number (ARN) of the flow. For example, `{ "Ref": "myFlow" }` could return the value `""arn:aws:bedrock:us-east-1:123456789012:flow/FLOW123456""`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### 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](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PrepareFlow.html) 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](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html) request and check the error message in the `validations` field. `UpdatedAt` The time at which the flow was last updated. `Validations` Property description not available. `Version` The latest version of the flow. # AWS::Bedrock::Flow AgentFlowNodeConfiguration Defines an agent node in your flow. You specify the agent to invoke at this point in the flow. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AgentAliasArn](#cfn-bedrock-flow-agentflownodeconfiguration-agentaliasarn)" : String } ``` ### YAML ``` [AgentAliasArn](#cfn-bedrock-flow-agentflownodeconfiguration-agentaliasarn): String ``` ## Properties `AgentAliasArn` The Amazon Resource Name (ARN) of the alias of the agent to invoke. *Required*: Yes *Type*: String *Pattern*: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow ConditionFlowNodeConfiguration Defines a condition node in your flow. You can specify conditions that determine which node comes next in the flow. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Conditions](#cfn-bedrock-flow-conditionflownodeconfiguration-conditions)" : [ FlowCondition, ... ] } ``` ### YAML ``` [Conditions](#cfn-bedrock-flow-conditionflownodeconfiguration-conditions): - FlowCondition ``` ## Properties `Conditions` An array of conditions. Each member contains the name of a condition and an expression that defines the condition. *Required*: Yes *Type*: Array of [FlowCondition](aws-properties-bedrock-flow-flowcondition.md) *Minimum*: `1` *Maximum*: `5` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow FieldForReranking Specifies a field to be used during the reranking process in a Knowledge Base vector search. This structure identifies metadata fields that should be considered when reordering search results to improve relevance. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[FieldName](#cfn-bedrock-flow-fieldforreranking-fieldname)" : String } ``` ### YAML ``` [FieldName](#cfn-bedrock-flow-fieldforreranking-fieldname): String ``` ## Properties `FieldName` The name of the metadata field to be used during the reranking process. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `2000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow FlowCondition Defines a condition in the condition node. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Expression](#cfn-bedrock-flow-flowcondition-expression)" : String, "[Name](#cfn-bedrock-flow-flowcondition-name)" : String } ``` ### YAML ``` [Expression](#cfn-bedrock-flow-flowcondition-expression): String [Name](#cfn-bedrock-flow-flowcondition-name): String ``` ## Properties `Expression` Defines the condition. You must refer to at least one of the inputs in the condition. For more information, expand the Condition node section in [Node types in prompt flows](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-how-it-works.html#flows-nodes). *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` A name for the condition that you can reference. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow FlowConditionalConnectionConfiguration The configuration of a connection between a condition node and another node. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Condition](#cfn-bedrock-flow-flowconditionalconnectionconfiguration-condition)" : String } ``` ### YAML ``` [Condition](#cfn-bedrock-flow-flowconditionalconnectionconfiguration-condition): String ``` ## Properties `Condition` The condition that triggers this connection. For more information about how to write conditions, see the **Condition** node type in the [Node types](https://docs.aws.amazon.com/bedrock/latest/userguide/node-types.html) topic in the Amazon Bedrock User Guide. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow FlowConnection Contains information about a connection between two nodes in the flow. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Configuration](#cfn-bedrock-flow-flowconnection-configuration)" : FlowConnectionConfiguration, "[Name](#cfn-bedrock-flow-flowconnection-name)" : String, "[Source](#cfn-bedrock-flow-flowconnection-source)" : String, "[Target](#cfn-bedrock-flow-flowconnection-target)" : String, "[Type](#cfn-bedrock-flow-flowconnection-type)" : String } ``` ### YAML ``` [Configuration](#cfn-bedrock-flow-flowconnection-configuration): FlowConnectionConfiguration [Name](#cfn-bedrock-flow-flowconnection-name): String [Source](#cfn-bedrock-flow-flowconnection-source): String [Target](#cfn-bedrock-flow-flowconnection-target): String [Type](#cfn-bedrock-flow-flowconnection-type): String ``` ## Properties `Configuration` The configuration of the connection. *Required*: No *Type*: [FlowConnectionConfiguration](aws-properties-bedrock-flow-flowconnectionconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` A name for the connection that you can reference. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Source` The node that the connection starts at. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Target` The node that the connection ends at. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` Whether the source node that the connection begins from is a condition node (`Conditional`) or not (`Data`). *Required*: Yes *Type*: String *Allowed values*: `Data | Conditional` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow FlowConnectionConfiguration The configuration of the connection. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Conditional](#cfn-bedrock-flow-flowconnectionconfiguration-conditional)" : FlowConditionalConnectionConfiguration, "[Data](#cfn-bedrock-flow-flowconnectionconfiguration-data)" : FlowDataConnectionConfiguration } ``` ### YAML ``` [Conditional](#cfn-bedrock-flow-flowconnectionconfiguration-conditional): FlowConditionalConnectionConfiguration [Data](#cfn-bedrock-flow-flowconnectionconfiguration-data): FlowDataConnectionConfiguration ``` ## Properties `Conditional` The configuration of a connection originating from a Condition node. *Required*: No *Type*: [FlowConditionalConnectionConfiguration](aws-properties-bedrock-flow-flowconditionalconnectionconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Data` The configuration of a connection originating from a node that isn't a Condition node. *Required*: No *Type*: [FlowDataConnectionConfiguration](aws-properties-bedrock-flow-flowdataconnectionconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow FlowDataConnectionConfiguration The configuration of a connection originating from a node that isn't a Condition node. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SourceOutput](#cfn-bedrock-flow-flowdataconnectionconfiguration-sourceoutput)" : String, "[TargetInput](#cfn-bedrock-flow-flowdataconnectionconfiguration-targetinput)" : String } ``` ### YAML ``` [SourceOutput](#cfn-bedrock-flow-flowdataconnectionconfiguration-sourceoutput): String [TargetInput](#cfn-bedrock-flow-flowdataconnectionconfiguration-targetinput): String ``` ## Properties `SourceOutput` The name of the output in the source node that the connection begins from. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TargetInput` The name of the input in the target node that the connection ends at. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow FlowDefinition The definition of the nodes and connections between nodes in the flow. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Connections](#cfn-bedrock-flow-flowdefinition-connections)" : [ FlowConnection, ... ], "[Nodes](#cfn-bedrock-flow-flowdefinition-nodes)" : [ FlowNode, ... ] } ``` ### YAML ``` [Connections](#cfn-bedrock-flow-flowdefinition-connections): - FlowConnection [Nodes](#cfn-bedrock-flow-flowdefinition-nodes): - FlowNode ``` ## Properties `Connections` An array of connection definitions in the flow. *Required*: No *Type*: Array of [FlowConnection](aws-properties-bedrock-flow-flowconnection.md) *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Nodes` An array of node definitions in the flow. *Required*: No *Type*: Array of [FlowNode](aws-properties-bedrock-flow-flownode.md) *Maximum*: `40` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow FlowNode Contains configurations about a node in the flow. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Configuration](#cfn-bedrock-flow-flownode-configuration)" : FlowNodeConfiguration, "[Inputs](#cfn-bedrock-flow-flownode-inputs)" : [ FlowNodeInput, ... ], "[Name](#cfn-bedrock-flow-flownode-name)" : String, "[Outputs](#cfn-bedrock-flow-flownode-outputs)" : [ FlowNodeOutput, ... ], "[Type](#cfn-bedrock-flow-flownode-type)" : String } ``` ### YAML ``` [Configuration](#cfn-bedrock-flow-flownode-configuration): FlowNodeConfiguration [Inputs](#cfn-bedrock-flow-flownode-inputs): - FlowNodeInput [Name](#cfn-bedrock-flow-flownode-name): String [Outputs](#cfn-bedrock-flow-flownode-outputs): - FlowNodeOutput [Type](#cfn-bedrock-flow-flownode-type): String ``` ## Properties `Configuration` Contains configurations for the node. *Required*: No *Type*: [FlowNodeConfiguration](aws-properties-bedrock-flow-flownodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Inputs` An array of objects, each of which contains information about an input into the node. *Required*: No *Type*: Array of [FlowNodeInput](aws-properties-bedrock-flow-flownodeinput.md) *Maximum*: `20` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` A name for the node. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Outputs` A list of objects, each of which contains information about an output from the node. *Required*: No *Type*: Array of [FlowNodeOutput](aws-properties-bedrock-flow-flownodeoutput.md) *Maximum*: `5` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The type of node. This value must match the name of the key that you provide in the configuration you provide in the `FlowNodeConfiguration` field. *Required*: Yes *Type*: String *Allowed values*: `Input | Output | KnowledgeBase | Condition | Lex | Prompt | LambdaFunction | Agent | Storage | Retrieval | Iterator | Collector | InlineCode | Loop | LoopInput | LoopController` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow FlowNodeConfiguration Contains configurations for a node in your flow. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Agent](#cfn-bedrock-flow-flownodeconfiguration-agent)" : AgentFlowNodeConfiguration, "[Collector](#cfn-bedrock-flow-flownodeconfiguration-collector)" : Json, "[Condition](#cfn-bedrock-flow-flownodeconfiguration-condition)" : ConditionFlowNodeConfiguration, "[InlineCode](#cfn-bedrock-flow-flownodeconfiguration-inlinecode)" : InlineCodeFlowNodeConfiguration, "[Input](#cfn-bedrock-flow-flownodeconfiguration-input)" : Json, "[Iterator](#cfn-bedrock-flow-flownodeconfiguration-iterator)" : Json, "[KnowledgeBase](#cfn-bedrock-flow-flownodeconfiguration-knowledgebase)" : KnowledgeBaseFlowNodeConfiguration, "[LambdaFunction](#cfn-bedrock-flow-flownodeconfiguration-lambdafunction)" : LambdaFunctionFlowNodeConfiguration, "[Lex](#cfn-bedrock-flow-flownodeconfiguration-lex)" : LexFlowNodeConfiguration, "[Loop](#cfn-bedrock-flow-flownodeconfiguration-loop)" : LoopFlowNodeConfiguration, "[LoopController](#cfn-bedrock-flow-flownodeconfiguration-loopcontroller)" : LoopControllerFlowNodeConfiguration, "[LoopInput](#cfn-bedrock-flow-flownodeconfiguration-loopinput)" : Json, "[Output](#cfn-bedrock-flow-flownodeconfiguration-output)" : Json, "[Prompt](#cfn-bedrock-flow-flownodeconfiguration-prompt)" : PromptFlowNodeConfiguration, "[Retrieval](#cfn-bedrock-flow-flownodeconfiguration-retrieval)" : RetrievalFlowNodeConfiguration, "[Storage](#cfn-bedrock-flow-flownodeconfiguration-storage)" : StorageFlowNodeConfiguration } ``` ### YAML ``` [Agent](#cfn-bedrock-flow-flownodeconfiguration-agent): AgentFlowNodeConfiguration [Collector](#cfn-bedrock-flow-flownodeconfiguration-collector): Json [Condition](#cfn-bedrock-flow-flownodeconfiguration-condition): ConditionFlowNodeConfiguration [InlineCode](#cfn-bedrock-flow-flownodeconfiguration-inlinecode): InlineCodeFlowNodeConfiguration [Input](#cfn-bedrock-flow-flownodeconfiguration-input): Json [Iterator](#cfn-bedrock-flow-flownodeconfiguration-iterator): Json [KnowledgeBase](#cfn-bedrock-flow-flownodeconfiguration-knowledgebase): KnowledgeBaseFlowNodeConfiguration [LambdaFunction](#cfn-bedrock-flow-flownodeconfiguration-lambdafunction): LambdaFunctionFlowNodeConfiguration [Lex](#cfn-bedrock-flow-flownodeconfiguration-lex): LexFlowNodeConfiguration [Loop](#cfn-bedrock-flow-flownodeconfiguration-loop): LoopFlowNodeConfiguration [LoopController](#cfn-bedrock-flow-flownodeconfiguration-loopcontroller): LoopControllerFlowNodeConfiguration [LoopInput](#cfn-bedrock-flow-flownodeconfiguration-loopinput): Json [Output](#cfn-bedrock-flow-flownodeconfiguration-output): Json [Prompt](#cfn-bedrock-flow-flownodeconfiguration-prompt): PromptFlowNodeConfiguration [Retrieval](#cfn-bedrock-flow-flownodeconfiguration-retrieval): RetrievalFlowNodeConfiguration [Storage](#cfn-bedrock-flow-flownodeconfiguration-storage): StorageFlowNodeConfiguration ``` ## Properties `Agent` Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response. *Required*: No *Type*: [AgentFlowNodeConfiguration](aws-properties-bedrock-flow-agentflownodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Collector` Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs. *Required*: No *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Condition` Contains configurations for a condition node in your flow. Defines conditions that lead to different branches of the flow. *Required*: No *Type*: [ConditionFlowNodeConfiguration](aws-properties-bedrock-flow-conditionflownodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InlineCode` Contains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function. *Required*: No *Type*: [InlineCodeFlowNodeConfiguration](aws-properties-bedrock-flow-inlinecodeflownodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Input` Contains configurations for an input flow node in your flow. The first node in the flow. `inputs` can't be specified for this node. *Required*: No *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Iterator` Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output. The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node. *Required*: No *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KnowledgeBase` Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response. *Required*: No *Type*: [KnowledgeBaseFlowNodeConfiguration](aws-properties-bedrock-flow-knowledgebaseflownodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LambdaFunction` Contains configurations for a Lambda function node in your flow. Invokes an AWS Lambda function. *Required*: No *Type*: [LambdaFunctionFlowNodeConfiguration](aws-properties-bedrock-flow-lambdafunctionflownodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Lex` Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output. *Required*: No *Type*: [LexFlowNodeConfiguration](aws-properties-bedrock-flow-lexflownodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Loop` Contains configurations for a DoWhile loop in your flow. *Required*: No *Type*: [LoopFlowNodeConfiguration](aws-properties-bedrock-flow-loopflownodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LoopController` Contains controller node configurations for a DoWhile loop in your flow. *Required*: No *Type*: [LoopControllerFlowNodeConfiguration](aws-properties-bedrock-flow-loopcontrollerflownodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LoopInput` Contains input node configurations for a DoWhile loop in your flow. *Required*: No *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Output` Contains configurations for an output flow node in your flow. The last node in the flow. `outputs` can't be specified for this node. *Required*: No *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Prompt` Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node. *Required*: No *Type*: [PromptFlowNodeConfiguration](aws-properties-bedrock-flow-promptflownodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Retrieval` Contains configurations for a retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output. *Required*: No *Type*: [RetrievalFlowNodeConfiguration](aws-properties-bedrock-flow-retrievalflownodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Storage` Contains configurations for a storage node in your flow. Stores an input in an Amazon S3 location. *Required*: No *Type*: [StorageFlowNodeConfiguration](aws-properties-bedrock-flow-storageflownodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow FlowNodeInput Contains configurations for an input in an Amazon Bedrock Flows node. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Category](#cfn-bedrock-flow-flownodeinput-category)" : String, "[Expression](#cfn-bedrock-flow-flownodeinput-expression)" : String, "[Name](#cfn-bedrock-flow-flownodeinput-name)" : String, "[Type](#cfn-bedrock-flow-flownodeinput-type)" : String } ``` ### YAML ``` [Category](#cfn-bedrock-flow-flownodeinput-category): String [Expression](#cfn-bedrock-flow-flownodeinput-expression): String [Name](#cfn-bedrock-flow-flownodeinput-name): String [Type](#cfn-bedrock-flow-flownodeinput-type): String ``` ## Properties `Category` Specifies how input data flows between iterations in a DoWhile loop. + `LoopCondition` - Controls whether the loop continues by evaluating condition expressions against the input data. Use this category to define the condition that determines if the loop should continue. + `ReturnValueToLoopStart` - Defines data to pass back to the start of the loop's next iteration. Use this category for variables that you want to update for each loop iteration. + `ExitLoop` - Defines the value that's available once the loop ends. Use this category to expose loop results to nodes outside the loop. *Required*: No *Type*: String *Allowed values*: `LoopCondition | ReturnValueToLoopStart | ExitLoop` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Expression` An expression that formats the input for the node. For an explanation of how to create expressions, see [Expressions in Prompt flows in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-expressions.html). *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` Specifies a name for the input that you can reference. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` Specifies the data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown. *Required*: Yes *Type*: String *Allowed values*: `String | Number | Boolean | Object | Array` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow FlowNodeOutput Contains configurations for an output from a node. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-bedrock-flow-flownodeoutput-name)" : String, "[Type](#cfn-bedrock-flow-flownodeoutput-type)" : String } ``` ### YAML ``` [Name](#cfn-bedrock-flow-flownodeoutput-name): String [Type](#cfn-bedrock-flow-flownodeoutput-type): String ``` ## Properties `Name` A name for the output that you can reference. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The data type of the output. If the output doesn't match this type at runtime, a validation error will be thrown. *Required*: Yes *Type*: String *Allowed values*: `String | Number | Boolean | Object | Array` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow FlowValidation Contains information about validation of the flow. This data type is used in the following API operations: + [GetFlow response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html#API_agent_GetFlow_ResponseSyntax) + [GetFlowVersion response](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlowVersion.html#API_agent_GetFlowVersion_ResponseSyntax) ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Message](#cfn-bedrock-flow-flowvalidation-message)" : String } ``` ### YAML ``` [Message](#cfn-bedrock-flow-flowvalidation-message): String ``` ## Properties `Message` A message describing the validation error. *Required*: Yes *Type*: String *Pattern*: `[\s\S]+` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow GuardrailConfiguration Configuration information for a guardrail that you use with the [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) operation. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[GuardrailIdentifier](#cfn-bedrock-flow-guardrailconfiguration-guardrailidentifier)" : String, "[GuardrailVersion](#cfn-bedrock-flow-guardrailconfiguration-guardrailversion)" : String } ``` ### YAML ``` [GuardrailIdentifier](#cfn-bedrock-flow-guardrailconfiguration-guardrailidentifier): String [GuardrailVersion](#cfn-bedrock-flow-guardrailconfiguration-guardrailversion): String ``` ## Properties `GuardrailIdentifier` The identifier for the guardrail. *Required*: No *Type*: String *Pattern*: `^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GuardrailVersion` The version of the guardrail. *Required*: No *Type*: String *Pattern*: `^(([0-9]{1,8})|(DRAFT))$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow InlineCodeFlowNodeConfiguration Contains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Code](#cfn-bedrock-flow-inlinecodeflownodeconfiguration-code)" : String, "[Language](#cfn-bedrock-flow-inlinecodeflownodeconfiguration-language)" : String } ``` ### YAML ``` [Code](#cfn-bedrock-flow-inlinecodeflownodeconfiguration-code): String [Language](#cfn-bedrock-flow-inlinecodeflownodeconfiguration-language): String ``` ## Properties `Code` The code that's executed in your inline code node. The code can access input data from previous nodes in the flow, perform operations on that data, and produce output that can be used by other nodes in your flow. The code must be valid in the programming `language` that you specify. *Required*: Yes *Type*: String *Maximum*: `5000000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Language` The programming language used by your inline code node. The code must be valid in the programming `language` that you specify. Currently, only Python 3 (`Python_3`) is supported. *Required*: Yes *Type*: String *Allowed values*: `Python_3` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow KnowledgeBaseFlowNodeConfiguration Contains configurations for a knowledge base node in a flow. This node takes a query as the input and returns, as the output, the retrieved responses directly (as an array) or a response generated based on the retrieved responses. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[GuardrailConfiguration](#cfn-bedrock-flow-knowledgebaseflownodeconfiguration-guardrailconfiguration)" : GuardrailConfiguration, "[InferenceConfiguration](#cfn-bedrock-flow-knowledgebaseflownodeconfiguration-inferenceconfiguration)" : PromptInferenceConfiguration, "[KnowledgeBaseId](#cfn-bedrock-flow-knowledgebaseflownodeconfiguration-knowledgebaseid)" : String, "[ModelId](#cfn-bedrock-flow-knowledgebaseflownodeconfiguration-modelid)" : String, "[NumberOfResults](#cfn-bedrock-flow-knowledgebaseflownodeconfiguration-numberofresults)" : Number, "[OrchestrationConfiguration](#cfn-bedrock-flow-knowledgebaseflownodeconfiguration-orchestrationconfiguration)" : KnowledgeBaseOrchestrationConfiguration, "[PromptTemplate](#cfn-bedrock-flow-knowledgebaseflownodeconfiguration-prompttemplate)" : KnowledgeBasePromptTemplate, "[RerankingConfiguration](#cfn-bedrock-flow-knowledgebaseflownodeconfiguration-rerankingconfiguration)" : VectorSearchRerankingConfiguration } ``` ### YAML ``` [GuardrailConfiguration](#cfn-bedrock-flow-knowledgebaseflownodeconfiguration-guardrailconfiguration): GuardrailConfiguration [InferenceConfiguration](#cfn-bedrock-flow-knowledgebaseflownodeconfiguration-inferenceconfiguration): PromptInferenceConfiguration [KnowledgeBaseId](#cfn-bedrock-flow-knowledgebaseflownodeconfiguration-knowledgebaseid): String [ModelId](#cfn-bedrock-flow-knowledgebaseflownodeconfiguration-modelid): String [NumberOfResults](#cfn-bedrock-flow-knowledgebaseflownodeconfiguration-numberofresults): Number [OrchestrationConfiguration](#cfn-bedrock-flow-knowledgebaseflownodeconfiguration-orchestrationconfiguration): KnowledgeBaseOrchestrationConfiguration [PromptTemplate](#cfn-bedrock-flow-knowledgebaseflownodeconfiguration-prompttemplate): KnowledgeBasePromptTemplate [RerankingConfiguration](#cfn-bedrock-flow-knowledgebaseflownodeconfiguration-rerankingconfiguration): VectorSearchRerankingConfiguration ``` ## Properties `GuardrailConfiguration` Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration. *Required*: No *Type*: [GuardrailConfiguration](aws-properties-bedrock-flow-guardrailconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InferenceConfiguration` Contains inference configurations for the prompt. *Required*: No *Type*: [PromptInferenceConfiguration](aws-properties-bedrock-flow-promptinferenceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KnowledgeBaseId` The unique identifier of the knowledge base to query. *Required*: Yes *Type*: String *Pattern*: `^[0-9a-zA-Z]+$` *Maximum*: `10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ModelId` The unique identifier of the model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array. *Required*: No *Type*: String *Pattern*: `^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NumberOfResults` The number of results to retrieve from the knowledge base. *Required*: No *Type*: Number *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OrchestrationConfiguration` The configuration for orchestrating the retrieval and generation process in the knowledge base node. *Required*: No *Type*: [KnowledgeBaseOrchestrationConfiguration](aws-properties-bedrock-flow-knowledgebaseorchestrationconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PromptTemplate` A custom prompt template to use with the knowledge base for generating responses. *Required*: No *Type*: [KnowledgeBasePromptTemplate](aws-properties-bedrock-flow-knowledgebaseprompttemplate.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RerankingConfiguration` The configuration for reranking the retrieved results from the knowledge base to improve relevance. *Required*: No *Type*: [VectorSearchRerankingConfiguration](aws-properties-bedrock-flow-vectorsearchrerankingconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow KnowledgeBaseOrchestrationConfiguration Configures how the knowledge base orchestrates the retrieval and generation process, allowing for customization of prompts, inference parameters, and performance settings. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AdditionalModelRequestFields](#cfn-bedrock-flow-knowledgebaseorchestrationconfiguration-additionalmodelrequestfields)" : Json, "[InferenceConfig](#cfn-bedrock-flow-knowledgebaseorchestrationconfiguration-inferenceconfig)" : PromptInferenceConfiguration, "[PerformanceConfig](#cfn-bedrock-flow-knowledgebaseorchestrationconfiguration-performanceconfig)" : PerformanceConfiguration, "[PromptTemplate](#cfn-bedrock-flow-knowledgebaseorchestrationconfiguration-prompttemplate)" : KnowledgeBasePromptTemplate } ``` ### YAML ``` [AdditionalModelRequestFields](#cfn-bedrock-flow-knowledgebaseorchestrationconfiguration-additionalmodelrequestfields): Json [InferenceConfig](#cfn-bedrock-flow-knowledgebaseorchestrationconfiguration-inferenceconfig): PromptInferenceConfiguration [PerformanceConfig](#cfn-bedrock-flow-knowledgebaseorchestrationconfiguration-performanceconfig): PerformanceConfiguration [PromptTemplate](#cfn-bedrock-flow-knowledgebaseorchestrationconfiguration-prompttemplate): KnowledgeBasePromptTemplate ``` ## Properties `AdditionalModelRequestFields` The additional model-specific request parameters as key-value pairs to be included in the request to the foundation model. *Required*: No *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InferenceConfig` Contains inference configurations for the prompt. *Required*: No *Type*: [PromptInferenceConfiguration](aws-properties-bedrock-flow-promptinferenceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PerformanceConfig` The performance configuration options for the knowledge base retrieval and generation process. *Required*: No *Type*: [PerformanceConfiguration](aws-properties-bedrock-flow-performanceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PromptTemplate` A custom prompt template for orchestrating the retrieval and generation process. *Required*: No *Type*: [KnowledgeBasePromptTemplate](aws-properties-bedrock-flow-knowledgebaseprompttemplate.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow KnowledgeBasePromptTemplate Defines a custom prompt template for orchestrating the retrieval and generation process. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[TextPromptTemplate](#cfn-bedrock-flow-knowledgebaseprompttemplate-textprompttemplate)" : String } ``` ### YAML ``` [TextPromptTemplate](#cfn-bedrock-flow-knowledgebaseprompttemplate-textprompttemplate): String ``` ## Properties `TextPromptTemplate` The text of the prompt template. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `100000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow LambdaFunctionFlowNodeConfiguration Contains configurations for a Lambda function node in the flow. You specify the Lambda function to invoke and the inputs into the function. The output is the response that is defined in the Lambda function. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[LambdaArn](#cfn-bedrock-flow-lambdafunctionflownodeconfiguration-lambdaarn)" : String } ``` ### YAML ``` [LambdaArn](#cfn-bedrock-flow-lambdafunctionflownodeconfiguration-lambdaarn): String ``` ## Properties `LambdaArn` The Amazon Resource Name (ARN) of the Lambda function to invoke. *Required*: Yes *Type*: String *Pattern*: `^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow LexFlowNodeConfiguration Contains configurations for a Lex node in the flow. You specify a Amazon Lex bot to invoke. This node takes an utterance as the input and returns as the output the intent identified by the Amazon Lex bot. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BotAliasArn](#cfn-bedrock-flow-lexflownodeconfiguration-botaliasarn)" : String, "[LocaleId](#cfn-bedrock-flow-lexflownodeconfiguration-localeid)" : String } ``` ### YAML ``` [BotAliasArn](#cfn-bedrock-flow-lexflownodeconfiguration-botaliasarn): String [LocaleId](#cfn-bedrock-flow-lexflownodeconfiguration-localeid): String ``` ## Properties `BotAliasArn` The Amazon Resource Name (ARN) of the Amazon Lex bot alias to invoke. *Required*: Yes *Type*: String *Pattern*: `^arn:aws(|-us-gov):lex:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:bot-alias/[0-9a-zA-Z]+/[0-9a-zA-Z]+$` *Maximum*: `78` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LocaleId` The Region to invoke the Amazon Lex bot in. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow LoopControllerFlowNodeConfiguration Contains configurations for the controller node of a DoWhile loop in the flow. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ContinueCondition](#cfn-bedrock-flow-loopcontrollerflownodeconfiguration-continuecondition)" : FlowCondition, "[MaxIterations](#cfn-bedrock-flow-loopcontrollerflownodeconfiguration-maxiterations)" : Number } ``` ### YAML ``` [ContinueCondition](#cfn-bedrock-flow-loopcontrollerflownodeconfiguration-continuecondition): FlowCondition [MaxIterations](#cfn-bedrock-flow-loopcontrollerflownodeconfiguration-maxiterations): Number ``` ## Properties `ContinueCondition` Specifies the condition that determines when the flow exits the DoWhile loop. The loop executes until this condition evaluates to true. *Required*: Yes *Type*: [FlowCondition](aws-properties-bedrock-flow-flowcondition.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MaxIterations` Specifies the maximum number of times the DoWhile loop can iterate before the flow exits the loop. *Required*: No *Type*: Number *Minimum*: `1` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow LoopFlowNodeConfiguration Contains configurations for the nodes of a DoWhile loop in your flow. A DoWhile loop is made up of the following nodes: + `Loop` - The container node that holds the loop's flow definition. This node encompasses the entire loop structure. + `LoopInput` - The entry point node for the loop. This node receives inputs from nodes outside the loop and from previous loop iterations. + Body nodes - The processing nodes that execute within each loop iteration. These can be nodes for handling data in your flow, such as a prompt or Lambda function nodes. Some node types aren't supported inside a DoWhile loop body. For more information, see [LoopIncompatibleNodeTypeFlowValidationDetails](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_LoopIncompatibleNodeTypeFlowValidationDetails.html). + `LoopController` - The node that evaluates whether the loop should continue or exit based on a condition. These nodes work together to create a loop that runs at least once and continues until a specified condition is met or a maximum number of iterations is reached. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Definition](#cfn-bedrock-flow-loopflownodeconfiguration-definition)" : FlowDefinition } ``` ### YAML ``` [Definition](#cfn-bedrock-flow-loopflownodeconfiguration-definition): FlowDefinition ``` ## Properties `Definition` The definition of the DoWhile loop nodes and connections between nodes in the flow. *Required*: Yes *Type*: [FlowDefinition](aws-properties-bedrock-flow-flowdefinition.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow MetadataConfigurationForReranking Configuration for how metadata should be used during the reranking process in Knowledge Base vector searches. This determines which metadata fields are included or excluded when reordering search results. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SelectionMode](#cfn-bedrock-flow-metadataconfigurationforreranking-selectionmode)" : String, "[SelectiveModeConfiguration](#cfn-bedrock-flow-metadataconfigurationforreranking-selectivemodeconfiguration)" : RerankingMetadataSelectiveModeConfiguration } ``` ### YAML ``` [SelectionMode](#cfn-bedrock-flow-metadataconfigurationforreranking-selectionmode): String [SelectiveModeConfiguration](#cfn-bedrock-flow-metadataconfigurationforreranking-selectivemodeconfiguration): RerankingMetadataSelectiveModeConfiguration ``` ## Properties `SelectionMode` The mode for selecting which metadata fields to include in the reranking process. Valid values are ALL (use all available metadata fields) or SELECTIVE (use only specified fields). *Required*: Yes *Type*: String *Allowed values*: `SELECTIVE | ALL` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SelectiveModeConfiguration` Configuration for selective mode, which allows you to explicitly include or exclude specific metadata fields during reranking. This is only used when selectionMode is set to SELECTIVE. *Required*: No *Type*: [RerankingMetadataSelectiveModeConfiguration](aws-properties-bedrock-flow-rerankingmetadataselectivemodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow PerformanceConfiguration Performance settings for a model. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Latency](#cfn-bedrock-flow-performanceconfiguration-latency)" : String } ``` ### YAML ``` [Latency](#cfn-bedrock-flow-performanceconfiguration-latency): String ``` ## Properties `Latency` To use a latency-optimized version of the model, set to `optimized`. *Required*: No *Type*: String *Allowed values*: `standard | optimized` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow PromptFlowNodeConfiguration Contains configurations for a prompt node in the flow. You can use a prompt from Prompt management or you can define one in this node. If the prompt contains variables, the inputs into this node will fill in the variables. The output from this node is the response generated by the model. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[GuardrailConfiguration](#cfn-bedrock-flow-promptflownodeconfiguration-guardrailconfiguration)" : GuardrailConfiguration, "[SourceConfiguration](#cfn-bedrock-flow-promptflownodeconfiguration-sourceconfiguration)" : PromptFlowNodeSourceConfiguration } ``` ### YAML ``` [GuardrailConfiguration](#cfn-bedrock-flow-promptflownodeconfiguration-guardrailconfiguration): GuardrailConfiguration [SourceConfiguration](#cfn-bedrock-flow-promptflownodeconfiguration-sourceconfiguration): PromptFlowNodeSourceConfiguration ``` ## Properties `GuardrailConfiguration` Contains configurations for a guardrail to apply to the prompt in this node and the response generated from it. *Required*: No *Type*: [GuardrailConfiguration](aws-properties-bedrock-flow-guardrailconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SourceConfiguration` Specifies whether the prompt is from Prompt management or defined inline. *Required*: Yes *Type*: [PromptFlowNodeSourceConfiguration](aws-properties-bedrock-flow-promptflownodesourceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow PromptFlowNodeInlineConfiguration Contains configurations for a prompt defined inline in the node. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InferenceConfiguration](#cfn-bedrock-flow-promptflownodeinlineconfiguration-inferenceconfiguration)" : PromptInferenceConfiguration, "[ModelId](#cfn-bedrock-flow-promptflownodeinlineconfiguration-modelid)" : String, "[TemplateConfiguration](#cfn-bedrock-flow-promptflownodeinlineconfiguration-templateconfiguration)" : PromptTemplateConfiguration, "[TemplateType](#cfn-bedrock-flow-promptflownodeinlineconfiguration-templatetype)" : String } ``` ### YAML ``` [InferenceConfiguration](#cfn-bedrock-flow-promptflownodeinlineconfiguration-inferenceconfiguration): PromptInferenceConfiguration [ModelId](#cfn-bedrock-flow-promptflownodeinlineconfiguration-modelid): String [TemplateConfiguration](#cfn-bedrock-flow-promptflownodeinlineconfiguration-templateconfiguration): PromptTemplateConfiguration [TemplateType](#cfn-bedrock-flow-promptflownodeinlineconfiguration-templatetype): String ``` ## Properties `InferenceConfiguration` Contains inference configurations for the prompt. *Required*: No *Type*: [PromptInferenceConfiguration](aws-properties-bedrock-flow-promptinferenceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ModelId` The unique identifier of the model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) to run inference with. *Required*: Yes *Type*: String *Pattern*: `^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TemplateConfiguration` Contains a prompt and variables in the prompt that can be replaced with values at runtime. *Required*: Yes *Type*: [PromptTemplateConfiguration](aws-properties-bedrock-flow-prompttemplateconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TemplateType` The type of prompt template. *Required*: Yes *Type*: String *Allowed values*: `TEXT` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow PromptFlowNodeResourceConfiguration Contains configurations for a prompt from Prompt management to use in a node. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[PromptArn](#cfn-bedrock-flow-promptflownoderesourceconfiguration-promptarn)" : String } ``` ### YAML ``` [PromptArn](#cfn-bedrock-flow-promptflownoderesourceconfiguration-promptarn): String ``` ## Properties `PromptArn` The Amazon Resource Name (ARN) of the prompt from Prompt management. *Required*: Yes *Type*: String *Pattern*: `^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}(?::[0-9]{1,5})?)$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow PromptFlowNodeSourceConfiguration Contains configurations for a prompt and whether it is from Prompt management or defined inline. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Inline](#cfn-bedrock-flow-promptflownodesourceconfiguration-inline)" : PromptFlowNodeInlineConfiguration, "[Resource](#cfn-bedrock-flow-promptflownodesourceconfiguration-resource)" : PromptFlowNodeResourceConfiguration } ``` ### YAML ``` [Inline](#cfn-bedrock-flow-promptflownodesourceconfiguration-inline): PromptFlowNodeInlineConfiguration [Resource](#cfn-bedrock-flow-promptflownodesourceconfiguration-resource): PromptFlowNodeResourceConfiguration ``` ## Properties `Inline` Contains configurations for a prompt that is defined inline *Required*: No *Type*: [PromptFlowNodeInlineConfiguration](aws-properties-bedrock-flow-promptflownodeinlineconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Resource` Contains configurations for a prompt from Prompt management. *Required*: No *Type*: [PromptFlowNodeResourceConfiguration](aws-properties-bedrock-flow-promptflownoderesourceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow PromptInferenceConfiguration Contains inference configurations for the prompt. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Text](#cfn-bedrock-flow-promptinferenceconfiguration-text)" : PromptModelInferenceConfiguration } ``` ### YAML ``` [Text](#cfn-bedrock-flow-promptinferenceconfiguration-text): PromptModelInferenceConfiguration ``` ## Properties `Text` Contains inference configurations for a text prompt. *Required*: Yes *Type*: [PromptModelInferenceConfiguration](aws-properties-bedrock-flow-promptmodelinferenceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow PromptInputVariable Contains information about a variable in the prompt. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-bedrock-flow-promptinputvariable-name)" : String } ``` ### YAML ``` [Name](#cfn-bedrock-flow-promptinputvariable-name): String ``` ## Properties `Name` The name of the variable. *Required*: No *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow PromptModelInferenceConfiguration Contains inference configurations related to model inference for a prompt. For more information, see [Inference parameters](https://docs.aws.amazon.com/bedrock/latest/userguide/inference-parameters.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MaxTokens](#cfn-bedrock-flow-promptmodelinferenceconfiguration-maxtokens)" : Number, "[StopSequences](#cfn-bedrock-flow-promptmodelinferenceconfiguration-stopsequences)" : [ String, ... ], "[Temperature](#cfn-bedrock-flow-promptmodelinferenceconfiguration-temperature)" : Number, "[TopP](#cfn-bedrock-flow-promptmodelinferenceconfiguration-topp)" : Number } ``` ### YAML ``` [MaxTokens](#cfn-bedrock-flow-promptmodelinferenceconfiguration-maxtokens): Number [StopSequences](#cfn-bedrock-flow-promptmodelinferenceconfiguration-stopsequences): - String [Temperature](#cfn-bedrock-flow-promptmodelinferenceconfiguration-temperature): Number [TopP](#cfn-bedrock-flow-promptmodelinferenceconfiguration-topp): Number ``` ## Properties `MaxTokens` The maximum number of tokens to return in the response. *Required*: No *Type*: Number *Minimum*: `0` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StopSequences` A list of strings that define sequences after which the model will stop generating. *Required*: No *Type*: Array of String *Minimum*: `0` *Maximum*: `4` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Temperature` Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs. *Required*: No *Type*: Number *Minimum*: `0` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TopP` The percentage of most-likely candidates that the model considers for the next token. *Required*: No *Type*: Number *Minimum*: `0` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow PromptTemplateConfiguration Contains the message for a prompt. For more information, see [Construct and store reusable prompts with Prompt management in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Text](#cfn-bedrock-flow-prompttemplateconfiguration-text)" : TextPromptTemplateConfiguration } ``` ### YAML ``` [Text](#cfn-bedrock-flow-prompttemplateconfiguration-text): TextPromptTemplateConfiguration ``` ## Properties `Text` Contains configurations for the text in a message for a prompt. *Required*: Yes *Type*: [TextPromptTemplateConfiguration](aws-properties-bedrock-flow-textprompttemplateconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow RerankingMetadataSelectiveModeConfiguration Configuration for selectively including or excluding metadata fields during the reranking process. This allows you to control which metadata attributes are considered when reordering search results. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[FieldsToExclude](#cfn-bedrock-flow-rerankingmetadataselectivemodeconfiguration-fieldstoexclude)" : [ FieldForReranking, ... ], "[FieldsToInclude](#cfn-bedrock-flow-rerankingmetadataselectivemodeconfiguration-fieldstoinclude)" : [ FieldForReranking, ... ] } ``` ### YAML ``` [FieldsToExclude](#cfn-bedrock-flow-rerankingmetadataselectivemodeconfiguration-fieldstoexclude): - FieldForReranking [FieldsToInclude](#cfn-bedrock-flow-rerankingmetadataselectivemodeconfiguration-fieldstoinclude): - FieldForReranking ``` ## Properties `FieldsToExclude` A list of metadata field names to explicitly exclude from the reranking process. All metadata fields except these will be considered when reordering search results. This parameter cannot be used together with fieldsToInclude. *Required*: No *Type*: Array of [FieldForReranking](aws-properties-bedrock-flow-fieldforreranking.md) *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FieldsToInclude` A list of metadata field names to explicitly include in the reranking process. Only these fields will be considered when reordering search results. This parameter cannot be used together with fieldsToExclude. *Required*: No *Type*: Array of [FieldForReranking](aws-properties-bedrock-flow-fieldforreranking.md) *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow RetrievalFlowNodeConfiguration Contains configurations for a Retrieval node in a flow. This node retrieves data from the Amazon S3 location that you specify and returns it as the output. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ServiceConfiguration](#cfn-bedrock-flow-retrievalflownodeconfiguration-serviceconfiguration)" : RetrievalFlowNodeServiceConfiguration } ``` ### YAML ``` [ServiceConfiguration](#cfn-bedrock-flow-retrievalflownodeconfiguration-serviceconfiguration): RetrievalFlowNodeServiceConfiguration ``` ## Properties `ServiceConfiguration` Contains configurations for the service to use for retrieving data to return as the output from the node. *Required*: Yes *Type*: [RetrievalFlowNodeServiceConfiguration](aws-properties-bedrock-flow-retrievalflownodeserviceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow RetrievalFlowNodeS3Configuration Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BucketName](#cfn-bedrock-flow-retrievalflownodes3configuration-bucketname)" : String } ``` ### YAML ``` [BucketName](#cfn-bedrock-flow-retrievalflownodes3configuration-bucketname): String ``` ## Properties `BucketName` The name of the Amazon S3 bucket from which to retrieve data. *Required*: Yes *Type*: String *Pattern*: `^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow RetrievalFlowNodeServiceConfiguration Contains configurations for the service to use for retrieving data to return as the output from the node. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[S3](#cfn-bedrock-flow-retrievalflownodeserviceconfiguration-s3)" : RetrievalFlowNodeS3Configuration } ``` ### YAML ``` [S3](#cfn-bedrock-flow-retrievalflownodeserviceconfiguration-s3): RetrievalFlowNodeS3Configuration ``` ## Properties `S3` Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node. *Required*: No *Type*: [RetrievalFlowNodeS3Configuration](aws-properties-bedrock-flow-retrievalflownodes3configuration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow S3Location The S3 location of the flow definition. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Bucket](#cfn-bedrock-flow-s3location-bucket)" : String, "[Key](#cfn-bedrock-flow-s3location-key)" : String, "[Version](#cfn-bedrock-flow-s3location-version)" : String } ``` ### YAML ``` [Bucket](#cfn-bedrock-flow-s3location-bucket): String [Key](#cfn-bedrock-flow-s3location-key): String [Version](#cfn-bedrock-flow-s3location-version): String ``` ## Properties `Bucket` The S3 bucket containing the flow definition. *Required*: Yes *Type*: String *Pattern*: `^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$` *Minimum*: `3` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Key` The object key for the S3 location containing the definition. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Version` The Amazon S3 location from which to retrieve data for an S3 retrieve node or to which to store data for an S3 storage node. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow StorageFlowNodeConfiguration Contains configurations for a Storage node in a flow. This node stores the input in an Amazon S3 location that you specify. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ServiceConfiguration](#cfn-bedrock-flow-storageflownodeconfiguration-serviceconfiguration)" : StorageFlowNodeServiceConfiguration } ``` ### YAML ``` [ServiceConfiguration](#cfn-bedrock-flow-storageflownodeconfiguration-serviceconfiguration): StorageFlowNodeServiceConfiguration ``` ## Properties `ServiceConfiguration` Contains configurations for the service to use for storing the input into the node. *Required*: Yes *Type*: [StorageFlowNodeServiceConfiguration](aws-properties-bedrock-flow-storageflownodeserviceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow StorageFlowNodeS3Configuration Contains configurations for the Amazon S3 location in which to store the input into the node. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BucketName](#cfn-bedrock-flow-storageflownodes3configuration-bucketname)" : String } ``` ### YAML ``` [BucketName](#cfn-bedrock-flow-storageflownodes3configuration-bucketname): String ``` ## Properties `BucketName` The name of the Amazon S3 bucket in which to store the input into the node. *Required*: Yes *Type*: String *Pattern*: `^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow StorageFlowNodeServiceConfiguration Contains configurations for the service to use for storing the input into the node. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[S3](#cfn-bedrock-flow-storageflownodeserviceconfiguration-s3)" : StorageFlowNodeS3Configuration } ``` ### YAML ``` [S3](#cfn-bedrock-flow-storageflownodeserviceconfiguration-s3): StorageFlowNodeS3Configuration ``` ## Properties `S3` Contains configurations for the Amazon S3 location in which to store the input into the node. *Required*: No *Type*: [StorageFlowNodeS3Configuration](aws-properties-bedrock-flow-storageflownodes3configuration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow TextPromptTemplateConfiguration Contains configurations for a text prompt template. To include a variable, enclose a word in double curly braces as in `{{variable}}`. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InputVariables](#cfn-bedrock-flow-textprompttemplateconfiguration-inputvariables)" : [ PromptInputVariable, ... ], "[Text](#cfn-bedrock-flow-textprompttemplateconfiguration-text)" : String } ``` ### YAML ``` [InputVariables](#cfn-bedrock-flow-textprompttemplateconfiguration-inputvariables): - PromptInputVariable [Text](#cfn-bedrock-flow-textprompttemplateconfiguration-text): String ``` ## Properties `InputVariables` An array of the variables in the prompt template. *Required*: No *Type*: Array of [PromptInputVariable](aws-properties-bedrock-flow-promptinputvariable.md) *Minimum*: `0` *Maximum*: `20` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Text` The message for the prompt. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `200000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow VectorSearchBedrockRerankingConfiguration Configuration for using Amazon Bedrock foundation models to rerank Knowledge Base vector search results. This enables more sophisticated relevance ranking using large language models. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MetadataConfiguration](#cfn-bedrock-flow-vectorsearchbedrockrerankingconfiguration-metadataconfiguration)" : MetadataConfigurationForReranking, "[ModelConfiguration](#cfn-bedrock-flow-vectorsearchbedrockrerankingconfiguration-modelconfiguration)" : VectorSearchBedrockRerankingModelConfiguration, "[NumberOfRerankedResults](#cfn-bedrock-flow-vectorsearchbedrockrerankingconfiguration-numberofrerankedresults)" : Number } ``` ### YAML ``` [MetadataConfiguration](#cfn-bedrock-flow-vectorsearchbedrockrerankingconfiguration-metadataconfiguration): MetadataConfigurationForReranking [ModelConfiguration](#cfn-bedrock-flow-vectorsearchbedrockrerankingconfiguration-modelconfiguration): VectorSearchBedrockRerankingModelConfiguration [NumberOfRerankedResults](#cfn-bedrock-flow-vectorsearchbedrockrerankingconfiguration-numberofrerankedresults): Number ``` ## Properties `MetadataConfiguration` Configuration for how document metadata should be used during the reranking process. This determines which metadata fields are included when reordering search results. *Required*: No *Type*: [MetadataConfigurationForReranking](aws-properties-bedrock-flow-metadataconfigurationforreranking.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ModelConfiguration` Configuration for the Amazon Bedrock foundation model used for reranking. This includes the model ARN and any additional request fields required by the model. *Required*: Yes *Type*: [VectorSearchBedrockRerankingModelConfiguration](aws-properties-bedrock-flow-vectorsearchbedrockrerankingmodelconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NumberOfRerankedResults` The maximum number of results to rerank. This limits how many of the initial vector search results will be processed by the reranking model. A smaller number improves performance but may exclude potentially relevant results. *Required*: No *Type*: Number *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow VectorSearchBedrockRerankingModelConfiguration Configuration for the Amazon Bedrock foundation model used for reranking vector search results. This specifies which model to use and any additional parameters required by the model. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AdditionalModelRequestFields](#cfn-bedrock-flow-vectorsearchbedrockrerankingmodelconfiguration-additionalmodelrequestfields)" : Json, "[ModelArn](#cfn-bedrock-flow-vectorsearchbedrockrerankingmodelconfiguration-modelarn)" : String } ``` ### YAML ``` [AdditionalModelRequestFields](#cfn-bedrock-flow-vectorsearchbedrockrerankingmodelconfiguration-additionalmodelrequestfields): Json [ModelArn](#cfn-bedrock-flow-vectorsearchbedrockrerankingmodelconfiguration-modelarn): String ``` ## Properties `AdditionalModelRequestFields` A list of additional fields to include in the model request during reranking. These fields provide extra context or configuration options specific to the selected foundation model. *Required*: No *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ModelArn` The Amazon Resource Name (ARN) of the foundation model to use for reranking. This model processes the query and search results to determine a more relevant ordering. *Required*: Yes *Type*: String *Pattern*: `^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/(.*))?$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Flow VectorSearchRerankingConfiguration Configuration for reranking vector search results to improve relevance. Reranking applies additional relevance models to reorder the initial vector search results based on more sophisticated criteria. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BedrockRerankingConfiguration](#cfn-bedrock-flow-vectorsearchrerankingconfiguration-bedrockrerankingconfiguration)" : VectorSearchBedrockRerankingConfiguration, "[Type](#cfn-bedrock-flow-vectorsearchrerankingconfiguration-type)" : String } ``` ### YAML ``` [BedrockRerankingConfiguration](#cfn-bedrock-flow-vectorsearchrerankingconfiguration-bedrockrerankingconfiguration): VectorSearchBedrockRerankingConfiguration [Type](#cfn-bedrock-flow-vectorsearchrerankingconfiguration-type): String ``` ## Properties `BedrockRerankingConfiguration` Configuration for using Amazon Bedrock foundation models to rerank search results. This is required when the reranking type is set to BEDROCK. *Required*: No *Type*: [VectorSearchBedrockRerankingConfiguration](aws-properties-bedrock-flow-vectorsearchbedrockrerankingconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The type of reranking to apply to vector search results. Currently, the only supported value is BEDROCK, which uses Amazon Bedrock foundation models for reranking. *Required*: Yes *Type*: String *Allowed values*: `BEDROCK_RERANKING_MODEL` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowAlias Creates an alias of a flow for deployment. For more information, see [Deploy a flow in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::Bedrock::FlowAlias", "Properties" : { "[ConcurrencyConfiguration](#cfn-bedrock-flowalias-concurrencyconfiguration)" : FlowAliasConcurrencyConfiguration, "[Description](#cfn-bedrock-flowalias-description)" : String, "[FlowArn](#cfn-bedrock-flowalias-flowarn)" : String, "[Name](#cfn-bedrock-flowalias-name)" : String, "[RoutingConfiguration](#cfn-bedrock-flowalias-routingconfiguration)" : [ FlowAliasRoutingConfigurationListItem, ... ], "[Tags](#cfn-bedrock-flowalias-tags)" : {Key: Value, ...} } } ``` ### YAML ``` Type: AWS::Bedrock::FlowAlias Properties: [ConcurrencyConfiguration](#cfn-bedrock-flowalias-concurrencyconfiguration): FlowAliasConcurrencyConfiguration [Description](#cfn-bedrock-flowalias-description): String [FlowArn](#cfn-bedrock-flowalias-flowarn): String [Name](#cfn-bedrock-flowalias-name): String [RoutingConfiguration](#cfn-bedrock-flowalias-routingconfiguration): - FlowAliasRoutingConfigurationListItem [Tags](#cfn-bedrock-flowalias-tags): Key: Value ``` ## Properties `ConcurrencyConfiguration` The configuration that specifies how nodes in the flow are executed concurrently. *Required*: No *Type*: [FlowAliasConcurrencyConfiguration](aws-properties-bedrock-flowalias-flowaliasconcurrencyconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` A description of the alias. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FlowArn` The Amazon Resource Name (ARN) of the alias. *Required*: Yes *Type*: String *Pattern*: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}$` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Name` The name of the alias. *Required*: Yes *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RoutingConfiguration` A list of configurations about the versions that the alias maps to. Currently, you can only specify one. *Required*: Yes *Type*: Array of [FlowAliasRoutingConfigurationListItem](aws-properties-bedrock-flowalias-flowaliasroutingconfigurationlistitem.md) *Minimum*: `1` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources: + [Tag naming limits and requirements](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions) + [Tagging best practices](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices) *Required*: No *Type*: Object of String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Number (ARN) of the flow and the Amazon Resource Name (ARN) of its alias, separated by a pipe (`|`). For example, `{ "Ref": "myFlowAlias" }` could return the value `"arn:aws:bedrock:us-east-1:123456789012:flow/FLOW12345|arn:aws:bedrock:us-east-1:123456789012:flow/FLOW12345/alias/ALIAS12345"`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt #### `Arn` The Amazon Resource Name (ARN) of the alias. `CreatedAt` The time at which the alias was created. `FlowId` The unique identifier of the flow. `Id` The unique identifier of the alias of the flow. `UpdatedAt` The time at which the alias was last updated. # AWS::Bedrock::FlowAlias FlowAliasConcurrencyConfiguration Determines how multiple nodes in a flow can run in parallel. Running nodes concurrently can improve your flow's performance. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MaxConcurrency](#cfn-bedrock-flowalias-flowaliasconcurrencyconfiguration-maxconcurrency)" : Number, "[Type](#cfn-bedrock-flowalias-flowaliasconcurrencyconfiguration-type)" : String } ``` ### YAML ``` [MaxConcurrency](#cfn-bedrock-flowalias-flowaliasconcurrencyconfiguration-maxconcurrency): Number [Type](#cfn-bedrock-flowalias-flowaliasconcurrencyconfiguration-type): String ``` ## Properties `MaxConcurrency` The maximum number of nodes that can be executed concurrently in the flow. *Required*: No *Type*: Number *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The type of concurrency to use for parallel node execution. Specify one of the following options: + `Automatic` - Amazon Bedrock determines which nodes can be executed in parallel based on the flow definition and its dependencies. + `Manual` - You specify which nodes can be executed in parallel. *Required*: Yes *Type*: String *Allowed values*: `Automatic | Manual` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowAlias FlowAliasRoutingConfigurationListItem Contains information about a version that the alias maps to. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[FlowVersion](#cfn-bedrock-flowalias-flowaliasroutingconfigurationlistitem-flowversion)" : String } ``` ### YAML ``` [FlowVersion](#cfn-bedrock-flowalias-flowaliasroutingconfigurationlistitem-flowversion): String ``` ## Properties `FlowVersion` The version that the alias maps to. *Required*: No *Type*: String *Pattern*: `^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$` *Minimum*: `1` *Maximum*: `5` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion Creates a version of the flow that you can deploy. For more information, see [Deploy a flow in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-deploy.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::Bedrock::FlowVersion", "Properties" : { "[Description](#cfn-bedrock-flowversion-description)" : String, "[FlowArn](#cfn-bedrock-flowversion-flowarn)" : String } } ``` ### YAML ``` Type: AWS::Bedrock::FlowVersion Properties: [Description](#cfn-bedrock-flowversion-description): String [FlowArn](#cfn-bedrock-flowversion-flowarn): String ``` ## Properties `Description` The description of the flow version. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `200` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `FlowArn` The Amazon Resource Name (ARN) of the flow that the version belongs to. *Required*: Yes *Type*: String *Pattern*: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:flow/[0-9a-zA-Z]{10}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Number (ARN) of the flow the version of the flow, separated by a pipe (`|`). For example, `{ "Ref": "myFlowVersion" }` could return the value `"arn:aws:bedrock:us-east-1:123456789012:flow/FLOW12345|1"`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt #### `CreatedAt` The time at the version was created. `CustomerEncryptionKeyArn` The Amazon Resource Name (ARN) of the KMS key that the flow version is encrypted with. `ExecutionRoleArn` 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](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html) in the Amazon Bedrock User Guide. `FlowId` The unique identifier of the flow. `Name` The name of the flow. `Status` The status of the flow. `Version` The version of the flow. # AWS::Bedrock::FlowVersion AgentFlowNodeConfiguration Defines an agent node in your flow. You specify the agent to invoke at this point in the flow. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AgentAliasArn](#cfn-bedrock-flowversion-agentflownodeconfiguration-agentaliasarn)" : String } ``` ### YAML ``` [AgentAliasArn](#cfn-bedrock-flowversion-agentflownodeconfiguration-agentaliasarn): String ``` ## Properties `AgentAliasArn` The Amazon Resource Name (ARN) of the alias of the agent to invoke. *Required*: Yes *Type*: String *Pattern*: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion ConditionFlowNodeConfiguration Defines a condition node in your flow. You can specify conditions that determine which node comes next in the flow. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Conditions](#cfn-bedrock-flowversion-conditionflownodeconfiguration-conditions)" : [ FlowCondition, ... ] } ``` ### YAML ``` [Conditions](#cfn-bedrock-flowversion-conditionflownodeconfiguration-conditions): - FlowCondition ``` ## Properties `Conditions` An array of conditions. Each member contains the name of a condition and an expression that defines the condition. *Required*: Yes *Type*: Array of [FlowCondition](aws-properties-bedrock-flowversion-flowcondition.md) *Minimum*: `1` *Maximum*: `5` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion FieldForReranking Specifies a field to be used during the reranking process in a Knowledge Base vector search. This structure identifies metadata fields that should be considered when reordering search results to improve relevance. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[FieldName](#cfn-bedrock-flowversion-fieldforreranking-fieldname)" : String } ``` ### YAML ``` [FieldName](#cfn-bedrock-flowversion-fieldforreranking-fieldname): String ``` ## Properties `FieldName` The name of the metadata field to be used during the reranking process. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `2000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion FlowCondition Defines a condition in the condition node. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Expression](#cfn-bedrock-flowversion-flowcondition-expression)" : String, "[Name](#cfn-bedrock-flowversion-flowcondition-name)" : String } ``` ### YAML ``` [Expression](#cfn-bedrock-flowversion-flowcondition-expression): String [Name](#cfn-bedrock-flowversion-flowcondition-name): String ``` ## Properties `Expression` Defines the condition. You must refer to at least one of the inputs in the condition. For more information, expand the Condition node section in [Node types in prompt flows](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-how-it-works.html#flows-nodes). *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` A name for the condition that you can reference. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion FlowConditionalConnectionConfiguration The configuration of a connection between a condition node and another node. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Condition](#cfn-bedrock-flowversion-flowconditionalconnectionconfiguration-condition)" : String } ``` ### YAML ``` [Condition](#cfn-bedrock-flowversion-flowconditionalconnectionconfiguration-condition): String ``` ## Properties `Condition` The condition that triggers this connection. For more information about how to write conditions, see the **Condition** node type in the [Node types](https://docs.aws.amazon.com/bedrock/latest/userguide/node-types.html) topic in the Amazon Bedrock User Guide. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion FlowConnection Contains information about a connection between two nodes in the flow. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Configuration](#cfn-bedrock-flowversion-flowconnection-configuration)" : FlowConnectionConfiguration, "[Name](#cfn-bedrock-flowversion-flowconnection-name)" : String, "[Source](#cfn-bedrock-flowversion-flowconnection-source)" : String, "[Target](#cfn-bedrock-flowversion-flowconnection-target)" : String, "[Type](#cfn-bedrock-flowversion-flowconnection-type)" : String } ``` ### YAML ``` [Configuration](#cfn-bedrock-flowversion-flowconnection-configuration): FlowConnectionConfiguration [Name](#cfn-bedrock-flowversion-flowconnection-name): String [Source](#cfn-bedrock-flowversion-flowconnection-source): String [Target](#cfn-bedrock-flowversion-flowconnection-target): String [Type](#cfn-bedrock-flowversion-flowconnection-type): String ``` ## Properties `Configuration` The configuration of the connection. *Required*: No *Type*: [FlowConnectionConfiguration](aws-properties-bedrock-flowversion-flowconnectionconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` A name for the connection that you can reference. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){1,100}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Source` The node that the connection starts at. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Target` The node that the connection ends at. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` Whether the source node that the connection begins from is a condition node (`Conditional`) or not (`Data`). *Required*: Yes *Type*: String *Allowed values*: `Data | Conditional` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion FlowConnectionConfiguration The configuration of the connection. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Conditional](#cfn-bedrock-flowversion-flowconnectionconfiguration-conditional)" : FlowConditionalConnectionConfiguration, "[Data](#cfn-bedrock-flowversion-flowconnectionconfiguration-data)" : FlowDataConnectionConfiguration } ``` ### YAML ``` [Conditional](#cfn-bedrock-flowversion-flowconnectionconfiguration-conditional): FlowConditionalConnectionConfiguration [Data](#cfn-bedrock-flowversion-flowconnectionconfiguration-data): FlowDataConnectionConfiguration ``` ## Properties `Conditional` The configuration of a connection originating from a Condition node. *Required*: No *Type*: [FlowConditionalConnectionConfiguration](aws-properties-bedrock-flowversion-flowconditionalconnectionconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Data` The configuration of a connection originating from a node that isn't a Condition node. *Required*: No *Type*: [FlowDataConnectionConfiguration](aws-properties-bedrock-flowversion-flowdataconnectionconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion FlowDataConnectionConfiguration The configuration of a connection originating from a node that isn't a Condition node. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SourceOutput](#cfn-bedrock-flowversion-flowdataconnectionconfiguration-sourceoutput)" : String, "[TargetInput](#cfn-bedrock-flowversion-flowdataconnectionconfiguration-targetinput)" : String } ``` ### YAML ``` [SourceOutput](#cfn-bedrock-flowversion-flowdataconnectionconfiguration-sourceoutput): String [TargetInput](#cfn-bedrock-flowversion-flowdataconnectionconfiguration-targetinput): String ``` ## Properties `SourceOutput` The name of the output in the source node that the connection begins from. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TargetInput` The name of the input in the target node that the connection ends at. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion FlowDefinition The definition of the nodes and connections between nodes in the flow. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Connections](#cfn-bedrock-flowversion-flowdefinition-connections)" : [ FlowConnection, ... ], "[Nodes](#cfn-bedrock-flowversion-flowdefinition-nodes)" : [ FlowNode, ... ] } ``` ### YAML ``` [Connections](#cfn-bedrock-flowversion-flowdefinition-connections): - FlowConnection [Nodes](#cfn-bedrock-flowversion-flowdefinition-nodes): - FlowNode ``` ## Properties `Connections` An array of connection definitions in the flow. *Required*: No *Type*: Array of [FlowConnection](aws-properties-bedrock-flowversion-flowconnection.md) *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Nodes` An array of node definitions in the flow. *Required*: No *Type*: Array of [FlowNode](aws-properties-bedrock-flowversion-flownode.md) *Maximum*: `40` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion FlowNode Contains configurations about a node in the flow. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Configuration](#cfn-bedrock-flowversion-flownode-configuration)" : FlowNodeConfiguration, "[Inputs](#cfn-bedrock-flowversion-flownode-inputs)" : [ FlowNodeInput, ... ], "[Name](#cfn-bedrock-flowversion-flownode-name)" : String, "[Outputs](#cfn-bedrock-flowversion-flownode-outputs)" : [ FlowNodeOutput, ... ], "[Type](#cfn-bedrock-flowversion-flownode-type)" : String } ``` ### YAML ``` [Configuration](#cfn-bedrock-flowversion-flownode-configuration): FlowNodeConfiguration [Inputs](#cfn-bedrock-flowversion-flownode-inputs): - FlowNodeInput [Name](#cfn-bedrock-flowversion-flownode-name): String [Outputs](#cfn-bedrock-flowversion-flownode-outputs): - FlowNodeOutput [Type](#cfn-bedrock-flowversion-flownode-type): String ``` ## Properties `Configuration` Contains configurations for the node. *Required*: No *Type*: [FlowNodeConfiguration](aws-properties-bedrock-flowversion-flownodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Inputs` An array of objects, each of which contains information about an input into the node. *Required*: No *Type*: Array of [FlowNodeInput](aws-properties-bedrock-flowversion-flownodeinput.md) *Maximum*: `5` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` A name for the node. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Outputs` A list of objects, each of which contains information about an output from the node. *Required*: No *Type*: Array of [FlowNodeOutput](aws-properties-bedrock-flowversion-flownodeoutput.md) *Maximum*: `5` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The type of node. This value must match the name of the key that you provide in the configuration you provide in the `FlowNodeConfiguration` field. *Required*: Yes *Type*: String *Allowed values*: `Input | Output | KnowledgeBase | Condition | Lex | Prompt | LambdaFunction | Agent | Iterator | Collector | Storage | Retrieval | InlineCode | Loop | LoopInput | LoopController` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion FlowNodeConfiguration Contains configurations for a node in your flow. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Agent](#cfn-bedrock-flowversion-flownodeconfiguration-agent)" : AgentFlowNodeConfiguration, "[Collector](#cfn-bedrock-flowversion-flownodeconfiguration-collector)" : Json, "[Condition](#cfn-bedrock-flowversion-flownodeconfiguration-condition)" : ConditionFlowNodeConfiguration, "[InlineCode](#cfn-bedrock-flowversion-flownodeconfiguration-inlinecode)" : InlineCodeFlowNodeConfiguration, "[Input](#cfn-bedrock-flowversion-flownodeconfiguration-input)" : Json, "[Iterator](#cfn-bedrock-flowversion-flownodeconfiguration-iterator)" : Json, "[KnowledgeBase](#cfn-bedrock-flowversion-flownodeconfiguration-knowledgebase)" : KnowledgeBaseFlowNodeConfiguration, "[LambdaFunction](#cfn-bedrock-flowversion-flownodeconfiguration-lambdafunction)" : LambdaFunctionFlowNodeConfiguration, "[Lex](#cfn-bedrock-flowversion-flownodeconfiguration-lex)" : LexFlowNodeConfiguration, "[Loop](#cfn-bedrock-flowversion-flownodeconfiguration-loop)" : LoopFlowNodeConfiguration, "[LoopController](#cfn-bedrock-flowversion-flownodeconfiguration-loopcontroller)" : LoopControllerFlowNodeConfiguration, "[LoopInput](#cfn-bedrock-flowversion-flownodeconfiguration-loopinput)" : Json, "[Output](#cfn-bedrock-flowversion-flownodeconfiguration-output)" : Json, "[Prompt](#cfn-bedrock-flowversion-flownodeconfiguration-prompt)" : PromptFlowNodeConfiguration, "[Retrieval](#cfn-bedrock-flowversion-flownodeconfiguration-retrieval)" : RetrievalFlowNodeConfiguration, "[Storage](#cfn-bedrock-flowversion-flownodeconfiguration-storage)" : StorageFlowNodeConfiguration } ``` ### YAML ``` [Agent](#cfn-bedrock-flowversion-flownodeconfiguration-agent): AgentFlowNodeConfiguration [Collector](#cfn-bedrock-flowversion-flownodeconfiguration-collector): Json [Condition](#cfn-bedrock-flowversion-flownodeconfiguration-condition): ConditionFlowNodeConfiguration [InlineCode](#cfn-bedrock-flowversion-flownodeconfiguration-inlinecode): InlineCodeFlowNodeConfiguration [Input](#cfn-bedrock-flowversion-flownodeconfiguration-input): Json [Iterator](#cfn-bedrock-flowversion-flownodeconfiguration-iterator): Json [KnowledgeBase](#cfn-bedrock-flowversion-flownodeconfiguration-knowledgebase): KnowledgeBaseFlowNodeConfiguration [LambdaFunction](#cfn-bedrock-flowversion-flownodeconfiguration-lambdafunction): LambdaFunctionFlowNodeConfiguration [Lex](#cfn-bedrock-flowversion-flownodeconfiguration-lex): LexFlowNodeConfiguration [Loop](#cfn-bedrock-flowversion-flownodeconfiguration-loop): LoopFlowNodeConfiguration [LoopController](#cfn-bedrock-flowversion-flownodeconfiguration-loopcontroller): LoopControllerFlowNodeConfiguration [LoopInput](#cfn-bedrock-flowversion-flownodeconfiguration-loopinput): Json [Output](#cfn-bedrock-flowversion-flownodeconfiguration-output): Json [Prompt](#cfn-bedrock-flowversion-flownodeconfiguration-prompt): PromptFlowNodeConfiguration [Retrieval](#cfn-bedrock-flowversion-flownodeconfiguration-retrieval): RetrievalFlowNodeConfiguration [Storage](#cfn-bedrock-flowversion-flownodeconfiguration-storage): StorageFlowNodeConfiguration ``` ## Properties `Agent` Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response. *Required*: No *Type*: [AgentFlowNodeConfiguration](aws-properties-bedrock-flowversion-agentflownodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Collector` Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs. *Required*: No *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Condition` Contains configurations for a condition node in your flow. Defines conditions that lead to different branches of the flow. *Required*: No *Type*: [ConditionFlowNodeConfiguration](aws-properties-bedrock-flowversion-conditionflownodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InlineCode` Contains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function. *Required*: No *Type*: [InlineCodeFlowNodeConfiguration](aws-properties-bedrock-flowversion-inlinecodeflownodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Input` Contains configurations for an input flow node in your flow. The first node in the flow. `inputs` can't be specified for this node. *Required*: No *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Iterator` Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output. The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node. *Required*: No *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KnowledgeBase` Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response. *Required*: No *Type*: [KnowledgeBaseFlowNodeConfiguration](aws-properties-bedrock-flowversion-knowledgebaseflownodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LambdaFunction` Contains configurations for a Lambda function node in your flow. Invokes an AWS Lambda function. *Required*: No *Type*: [LambdaFunctionFlowNodeConfiguration](aws-properties-bedrock-flowversion-lambdafunctionflownodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Lex` Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output. *Required*: No *Type*: [LexFlowNodeConfiguration](aws-properties-bedrock-flowversion-lexflownodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Loop` Contains configurations for a DoWhile loop in your flow. *Required*: No *Type*: [LoopFlowNodeConfiguration](aws-properties-bedrock-flowversion-loopflownodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LoopController` Contains controller node configurations for a DoWhile loop in your flow. *Required*: No *Type*: [LoopControllerFlowNodeConfiguration](aws-properties-bedrock-flowversion-loopcontrollerflownodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LoopInput` Contains input node configurations for a DoWhile loop in your flow. *Required*: No *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Output` Contains configurations for an output flow node in your flow. The last node in the flow. `outputs` can't be specified for this node. *Required*: No *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Prompt` Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node. *Required*: No *Type*: [PromptFlowNodeConfiguration](aws-properties-bedrock-flowversion-promptflownodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Retrieval` Contains configurations for a retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output. *Required*: No *Type*: [RetrievalFlowNodeConfiguration](aws-properties-bedrock-flowversion-retrievalflownodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Storage` Contains configurations for a storage node in your flow. Stores an input in an Amazon S3 location. *Required*: No *Type*: [StorageFlowNodeConfiguration](aws-properties-bedrock-flowversion-storageflownodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion FlowNodeInput Contains configurations for an input in an Amazon Bedrock Flows node. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Expression](#cfn-bedrock-flowversion-flownodeinput-expression)" : String, "[Name](#cfn-bedrock-flowversion-flownodeinput-name)" : String, "[Type](#cfn-bedrock-flowversion-flownodeinput-type)" : String } ``` ### YAML ``` [Expression](#cfn-bedrock-flowversion-flownodeinput-expression): String [Name](#cfn-bedrock-flowversion-flownodeinput-name): String [Type](#cfn-bedrock-flowversion-flownodeinput-type): String ``` ## Properties `Expression` An expression that formats the input for the node. For an explanation of how to create expressions, see [Expressions in Prompt flows in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-expressions.html). *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` Specifies a name for the input that you can reference. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` Specifies the data type of the input. If the input doesn't match this type at runtime, a validation error will be thrown. *Required*: Yes *Type*: String *Allowed values*: `String | Number | Boolean | Object | Array` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion FlowNodeOutput Contains configurations for an output from a node. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-bedrock-flowversion-flownodeoutput-name)" : String, "[Type](#cfn-bedrock-flowversion-flownodeoutput-type)" : String } ``` ### YAML ``` [Name](#cfn-bedrock-flowversion-flownodeoutput-name): String [Type](#cfn-bedrock-flowversion-flownodeoutput-type): String ``` ## Properties `Name` A name for the output that you can reference. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z]([_]?[0-9a-zA-Z]){1,50}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The data type of the output. If the output doesn't match this type at runtime, a validation error will be thrown. *Required*: Yes *Type*: String *Allowed values*: `String | Number | Boolean | Object | Array` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion GuardrailConfiguration Configuration information for a guardrail that you use with the [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) operation. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[GuardrailIdentifier](#cfn-bedrock-flowversion-guardrailconfiguration-guardrailidentifier)" : String, "[GuardrailVersion](#cfn-bedrock-flowversion-guardrailconfiguration-guardrailversion)" : String } ``` ### YAML ``` [GuardrailIdentifier](#cfn-bedrock-flowversion-guardrailconfiguration-guardrailidentifier): String [GuardrailVersion](#cfn-bedrock-flowversion-guardrailconfiguration-guardrailversion): String ``` ## Properties `GuardrailIdentifier` The identifier for the guardrail. *Required*: No *Type*: String *Pattern*: `^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GuardrailVersion` The version of the guardrail. *Required*: No *Type*: String *Pattern*: `^(([0-9]{1,8})|(DRAFT))$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion InlineCodeFlowNodeConfiguration Contains configurations for an inline code node in your flow. Inline code nodes let you write and execute code directly within your flow, enabling data transformations, custom logic, and integrations without needing an external Lambda function. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Code](#cfn-bedrock-flowversion-inlinecodeflownodeconfiguration-code)" : String, "[Language](#cfn-bedrock-flowversion-inlinecodeflownodeconfiguration-language)" : String } ``` ### YAML ``` [Code](#cfn-bedrock-flowversion-inlinecodeflownodeconfiguration-code): String [Language](#cfn-bedrock-flowversion-inlinecodeflownodeconfiguration-language): String ``` ## Properties `Code` The code that's executed in your inline code node. The code can access input data from previous nodes in the flow, perform operations on that data, and produce output that can be used by other nodes in your flow. The code must be valid in the programming `language` that you specify. *Required*: Yes *Type*: String *Maximum*: `5000000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Language` The programming language used by your inline code node. The code must be valid in the programming `language` that you specify. Currently, only Python 3 (`Python_3`) is supported. *Required*: Yes *Type*: String *Allowed values*: `Python_3` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion KnowledgeBaseFlowNodeConfiguration Contains configurations for a knowledge base node in a flow. This node takes a query as the input and returns, as the output, the retrieved responses directly (as an array) or a response generated based on the retrieved responses. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[GuardrailConfiguration](#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-guardrailconfiguration)" : GuardrailConfiguration, "[InferenceConfiguration](#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-inferenceconfiguration)" : PromptInferenceConfiguration, "[KnowledgeBaseId](#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-knowledgebaseid)" : String, "[ModelId](#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-modelid)" : String, "[NumberOfResults](#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-numberofresults)" : Number, "[OrchestrationConfiguration](#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-orchestrationconfiguration)" : KnowledgeBaseOrchestrationConfiguration, "[PromptTemplate](#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-prompttemplate)" : KnowledgeBasePromptTemplate, "[RerankingConfiguration](#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-rerankingconfiguration)" : VectorSearchRerankingConfiguration } ``` ### YAML ``` [GuardrailConfiguration](#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-guardrailconfiguration): GuardrailConfiguration [InferenceConfiguration](#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-inferenceconfiguration): PromptInferenceConfiguration [KnowledgeBaseId](#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-knowledgebaseid): String [ModelId](#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-modelid): String [NumberOfResults](#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-numberofresults): Number [OrchestrationConfiguration](#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-orchestrationconfiguration): KnowledgeBaseOrchestrationConfiguration [PromptTemplate](#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-prompttemplate): KnowledgeBasePromptTemplate [RerankingConfiguration](#cfn-bedrock-flowversion-knowledgebaseflownodeconfiguration-rerankingconfiguration): VectorSearchRerankingConfiguration ``` ## Properties `GuardrailConfiguration` Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration. *Required*: No *Type*: [GuardrailConfiguration](aws-properties-bedrock-flowversion-guardrailconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InferenceConfiguration` Contains inference configurations for the prompt. *Required*: No *Type*: [PromptInferenceConfiguration](aws-properties-bedrock-flowversion-promptinferenceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KnowledgeBaseId` The unique identifier of the knowledge base to query. *Required*: Yes *Type*: String *Pattern*: `^[0-9a-zA-Z]+$` *Maximum*: `10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ModelId` The unique identifier of the model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array. *Required*: No *Type*: String *Pattern*: `^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NumberOfResults` The number of results to retrieve from the knowledge base. *Required*: No *Type*: Number *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OrchestrationConfiguration` The configuration for orchestrating the retrieval and generation process in the knowledge base node. *Required*: No *Type*: [KnowledgeBaseOrchestrationConfiguration](aws-properties-bedrock-flowversion-knowledgebaseorchestrationconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PromptTemplate` A custom prompt template to use with the knowledge base for generating responses. *Required*: No *Type*: [KnowledgeBasePromptTemplate](aws-properties-bedrock-flowversion-knowledgebaseprompttemplate.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RerankingConfiguration` The configuration for reranking the retrieved results from the knowledge base to improve relevance. *Required*: No *Type*: [VectorSearchRerankingConfiguration](aws-properties-bedrock-flowversion-vectorsearchrerankingconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion KnowledgeBaseOrchestrationConfiguration Configures how the knowledge base orchestrates the retrieval and generation process, allowing for customization of prompts, inference parameters, and performance settings. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AdditionalModelRequestFields](#cfn-bedrock-flowversion-knowledgebaseorchestrationconfiguration-additionalmodelrequestfields)" : Json, "[InferenceConfig](#cfn-bedrock-flowversion-knowledgebaseorchestrationconfiguration-inferenceconfig)" : PromptInferenceConfiguration, "[PerformanceConfig](#cfn-bedrock-flowversion-knowledgebaseorchestrationconfiguration-performanceconfig)" : PerformanceConfiguration, "[PromptTemplate](#cfn-bedrock-flowversion-knowledgebaseorchestrationconfiguration-prompttemplate)" : KnowledgeBasePromptTemplate } ``` ### YAML ``` [AdditionalModelRequestFields](#cfn-bedrock-flowversion-knowledgebaseorchestrationconfiguration-additionalmodelrequestfields): Json [InferenceConfig](#cfn-bedrock-flowversion-knowledgebaseorchestrationconfiguration-inferenceconfig): PromptInferenceConfiguration [PerformanceConfig](#cfn-bedrock-flowversion-knowledgebaseorchestrationconfiguration-performanceconfig): PerformanceConfiguration [PromptTemplate](#cfn-bedrock-flowversion-knowledgebaseorchestrationconfiguration-prompttemplate): KnowledgeBasePromptTemplate ``` ## Properties `AdditionalModelRequestFields` The additional model-specific request parameters as key-value pairs to be included in the request to the foundation model. *Required*: No *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InferenceConfig` Contains inference configurations for the prompt. *Required*: No *Type*: [PromptInferenceConfiguration](aws-properties-bedrock-flowversion-promptinferenceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PerformanceConfig` The performance configuration options for the knowledge base retrieval and generation process. *Required*: No *Type*: [PerformanceConfiguration](aws-properties-bedrock-flowversion-performanceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `PromptTemplate` A custom prompt template for orchestrating the retrieval and generation process. *Required*: No *Type*: [KnowledgeBasePromptTemplate](aws-properties-bedrock-flowversion-knowledgebaseprompttemplate.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion KnowledgeBasePromptTemplate Defines a custom prompt template for orchestrating the retrieval and generation process. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[TextPromptTemplate](#cfn-bedrock-flowversion-knowledgebaseprompttemplate-textprompttemplate)" : String } ``` ### YAML ``` [TextPromptTemplate](#cfn-bedrock-flowversion-knowledgebaseprompttemplate-textprompttemplate): String ``` ## Properties `TextPromptTemplate` The text of the prompt template. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `100000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion LambdaFunctionFlowNodeConfiguration Contains configurations for a Lambda function node in the flow. You specify the Lambda function to invoke and the inputs into the function. The output is the response that is defined in the Lambda function. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[LambdaArn](#cfn-bedrock-flowversion-lambdafunctionflownodeconfiguration-lambdaarn)" : String } ``` ### YAML ``` [LambdaArn](#cfn-bedrock-flowversion-lambdafunctionflownodeconfiguration-lambdaarn): String ``` ## Properties `LambdaArn` The Amazon Resource Name (ARN) of the Lambda function to invoke. *Required*: Yes *Type*: String *Pattern*: `^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_\.]+(:(\$LATEST|[a-zA-Z0-9-_]+))?$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion LexFlowNodeConfiguration Contains configurations for a Lex node in the flow. You specify a Amazon Lex bot to invoke. This node takes an utterance as the input and returns as the output the intent identified by the Amazon Lex bot. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BotAliasArn](#cfn-bedrock-flowversion-lexflownodeconfiguration-botaliasarn)" : String, "[LocaleId](#cfn-bedrock-flowversion-lexflownodeconfiguration-localeid)" : String } ``` ### YAML ``` [BotAliasArn](#cfn-bedrock-flowversion-lexflownodeconfiguration-botaliasarn): String [LocaleId](#cfn-bedrock-flowversion-lexflownodeconfiguration-localeid): String ``` ## Properties `BotAliasArn` The Amazon Resource Name (ARN) of the Amazon Lex bot alias to invoke. *Required*: Yes *Type*: String *Pattern*: `^arn:aws(|-us-gov):lex:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:bot-alias/[0-9a-zA-Z]+/[0-9a-zA-Z]+$` *Maximum*: `78` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `LocaleId` The Region to invoke the Amazon Lex bot in. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion LoopControllerFlowNodeConfiguration Contains configurations for the controller node of a DoWhile loop in the flow. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ContinueCondition](#cfn-bedrock-flowversion-loopcontrollerflownodeconfiguration-continuecondition)" : FlowCondition, "[MaxIterations](#cfn-bedrock-flowversion-loopcontrollerflownodeconfiguration-maxiterations)" : Number } ``` ### YAML ``` [ContinueCondition](#cfn-bedrock-flowversion-loopcontrollerflownodeconfiguration-continuecondition): FlowCondition [MaxIterations](#cfn-bedrock-flowversion-loopcontrollerflownodeconfiguration-maxiterations): Number ``` ## Properties `ContinueCondition` Specifies the condition that determines when the flow exits the DoWhile loop. The loop executes until this condition evaluates to true. *Required*: Yes *Type*: [FlowCondition](aws-properties-bedrock-flowversion-flowcondition.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `MaxIterations` Specifies the maximum number of times the DoWhile loop can iterate before the flow exits the loop. *Required*: No *Type*: Number *Minimum*: `1` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion LoopFlowNodeConfiguration Contains configurations for the nodes of a DoWhile loop in your flow. A DoWhile loop is made up of the following nodes: + `Loop` - The container node that holds the loop's flow definition. This node encompasses the entire loop structure. + `LoopInput` - The entry point node for the loop. This node receives inputs from nodes outside the loop and from previous loop iterations. + Body nodes - The processing nodes that execute within each loop iteration. These can be nodes for handling data in your flow, such as a prompt or Lambda function nodes. Some node types aren't supported inside a DoWhile loop body. For more information, see [LoopIncompatibleNodeTypeFlowValidationDetails](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_LoopIncompatibleNodeTypeFlowValidationDetails.html). + `LoopController` - The node that evaluates whether the loop should continue or exit based on a condition. These nodes work together to create a loop that runs at least once and continues until a specified condition is met or a maximum number of iterations is reached. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Definition](#cfn-bedrock-flowversion-loopflownodeconfiguration-definition)" : FlowDefinition } ``` ### YAML ``` [Definition](#cfn-bedrock-flowversion-loopflownodeconfiguration-definition): FlowDefinition ``` ## Properties `Definition` The definition of the DoWhile loop nodes and connections between nodes in the flow. *Required*: Yes *Type*: [FlowDefinition](aws-properties-bedrock-flowversion-flowdefinition.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion MetadataConfigurationForReranking Configuration for how metadata should be used during the reranking process in Knowledge Base vector searches. This determines which metadata fields are included or excluded when reordering search results. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SelectionMode](#cfn-bedrock-flowversion-metadataconfigurationforreranking-selectionmode)" : String, "[SelectiveModeConfiguration](#cfn-bedrock-flowversion-metadataconfigurationforreranking-selectivemodeconfiguration)" : RerankingMetadataSelectiveModeConfiguration } ``` ### YAML ``` [SelectionMode](#cfn-bedrock-flowversion-metadataconfigurationforreranking-selectionmode): String [SelectiveModeConfiguration](#cfn-bedrock-flowversion-metadataconfigurationforreranking-selectivemodeconfiguration): RerankingMetadataSelectiveModeConfiguration ``` ## Properties `SelectionMode` The mode for selecting which metadata fields to include in the reranking process. Valid values are ALL (use all available metadata fields) or SELECTIVE (use only specified fields). *Required*: Yes *Type*: String *Allowed values*: `SELECTIVE | ALL` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SelectiveModeConfiguration` Configuration for selective mode, which allows you to explicitly include or exclude specific metadata fields during reranking. This is only used when selectionMode is set to SELECTIVE. *Required*: No *Type*: [RerankingMetadataSelectiveModeConfiguration](aws-properties-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion PerformanceConfiguration Performance settings for a model. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Latency](#cfn-bedrock-flowversion-performanceconfiguration-latency)" : String } ``` ### YAML ``` [Latency](#cfn-bedrock-flowversion-performanceconfiguration-latency): String ``` ## Properties `Latency` To use a latency-optimized version of the model, set to `optimized`. *Required*: No *Type*: String *Allowed values*: `standard | optimized` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion PromptFlowNodeConfiguration Contains configurations for a prompt node in the flow. You can use a prompt from Prompt management or you can define one in this node. If the prompt contains variables, the inputs into this node will fill in the variables. The output from this node is the response generated by the model. For more information, see [Node types in a flow](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[GuardrailConfiguration](#cfn-bedrock-flowversion-promptflownodeconfiguration-guardrailconfiguration)" : GuardrailConfiguration, "[SourceConfiguration](#cfn-bedrock-flowversion-promptflownodeconfiguration-sourceconfiguration)" : PromptFlowNodeSourceConfiguration } ``` ### YAML ``` [GuardrailConfiguration](#cfn-bedrock-flowversion-promptflownodeconfiguration-guardrailconfiguration): GuardrailConfiguration [SourceConfiguration](#cfn-bedrock-flowversion-promptflownodeconfiguration-sourceconfiguration): PromptFlowNodeSourceConfiguration ``` ## Properties `GuardrailConfiguration` Contains configurations for a guardrail to apply to the prompt in this node and the response generated from it. *Required*: No *Type*: [GuardrailConfiguration](aws-properties-bedrock-flowversion-guardrailconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SourceConfiguration` Specifies whether the prompt is from Prompt management or defined inline. *Required*: Yes *Type*: [PromptFlowNodeSourceConfiguration](aws-properties-bedrock-flowversion-promptflownodesourceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion PromptFlowNodeInlineConfiguration Contains configurations for a prompt defined inline in the node. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InferenceConfiguration](#cfn-bedrock-flowversion-promptflownodeinlineconfiguration-inferenceconfiguration)" : PromptInferenceConfiguration, "[ModelId](#cfn-bedrock-flowversion-promptflownodeinlineconfiguration-modelid)" : String, "[TemplateConfiguration](#cfn-bedrock-flowversion-promptflownodeinlineconfiguration-templateconfiguration)" : PromptTemplateConfiguration, "[TemplateType](#cfn-bedrock-flowversion-promptflownodeinlineconfiguration-templatetype)" : String } ``` ### YAML ``` [InferenceConfiguration](#cfn-bedrock-flowversion-promptflownodeinlineconfiguration-inferenceconfiguration): PromptInferenceConfiguration [ModelId](#cfn-bedrock-flowversion-promptflownodeinlineconfiguration-modelid): String [TemplateConfiguration](#cfn-bedrock-flowversion-promptflownodeinlineconfiguration-templateconfiguration): PromptTemplateConfiguration [TemplateType](#cfn-bedrock-flowversion-promptflownodeinlineconfiguration-templatetype): String ``` ## Properties `InferenceConfiguration` Contains inference configurations for the prompt. *Required*: No *Type*: [PromptInferenceConfiguration](aws-properties-bedrock-flowversion-promptinferenceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ModelId` The unique identifier of the model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) to run inference with. *Required*: Yes *Type*: String *Pattern*: `^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TemplateConfiguration` Contains a prompt and variables in the prompt that can be replaced with values at runtime. *Required*: Yes *Type*: [PromptTemplateConfiguration](aws-properties-bedrock-flowversion-prompttemplateconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TemplateType` The type of prompt template. *Required*: Yes *Type*: String *Allowed values*: `TEXT` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion PromptFlowNodeResourceConfiguration Contains configurations for a prompt from Prompt management to use in a node. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[PromptArn](#cfn-bedrock-flowversion-promptflownoderesourceconfiguration-promptarn)" : String } ``` ### YAML ``` [PromptArn](#cfn-bedrock-flowversion-promptflownoderesourceconfiguration-promptarn): String ``` ## Properties `PromptArn` The Amazon Resource Name (ARN) of the prompt from Prompt management. *Required*: Yes *Type*: String *Pattern*: `^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}(?::[0-9]{1,5})?)$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion PromptFlowNodeSourceConfiguration Contains configurations for a prompt and whether it is from Prompt management or defined inline. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Inline](#cfn-bedrock-flowversion-promptflownodesourceconfiguration-inline)" : PromptFlowNodeInlineConfiguration, "[Resource](#cfn-bedrock-flowversion-promptflownodesourceconfiguration-resource)" : PromptFlowNodeResourceConfiguration } ``` ### YAML ``` [Inline](#cfn-bedrock-flowversion-promptflownodesourceconfiguration-inline): PromptFlowNodeInlineConfiguration [Resource](#cfn-bedrock-flowversion-promptflownodesourceconfiguration-resource): PromptFlowNodeResourceConfiguration ``` ## Properties `Inline` Contains configurations for a prompt that is defined inline *Required*: No *Type*: [PromptFlowNodeInlineConfiguration](aws-properties-bedrock-flowversion-promptflownodeinlineconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Resource` Contains configurations for a prompt from Prompt management. *Required*: No *Type*: [PromptFlowNodeResourceConfiguration](aws-properties-bedrock-flowversion-promptflownoderesourceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion PromptInferenceConfiguration Contains inference configurations for the prompt. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Text](#cfn-bedrock-flowversion-promptinferenceconfiguration-text)" : PromptModelInferenceConfiguration } ``` ### YAML ``` [Text](#cfn-bedrock-flowversion-promptinferenceconfiguration-text): PromptModelInferenceConfiguration ``` ## Properties `Text` Contains inference configurations for a text prompt. *Required*: Yes *Type*: [PromptModelInferenceConfiguration](aws-properties-bedrock-flowversion-promptmodelinferenceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion PromptInputVariable Contains information about a variable in the prompt. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-bedrock-flowversion-promptinputvariable-name)" : String } ``` ### YAML ``` [Name](#cfn-bedrock-flowversion-promptinputvariable-name): String ``` ## Properties `Name` The name of the variable. *Required*: No *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion PromptModelInferenceConfiguration Contains inference configurations related to model inference for a prompt. For more information, see [Inference parameters](https://docs.aws.amazon.com/bedrock/latest/userguide/inference-parameters.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MaxTokens](#cfn-bedrock-flowversion-promptmodelinferenceconfiguration-maxtokens)" : Number, "[StopSequences](#cfn-bedrock-flowversion-promptmodelinferenceconfiguration-stopsequences)" : [ String, ... ], "[Temperature](#cfn-bedrock-flowversion-promptmodelinferenceconfiguration-temperature)" : Number, "[TopP](#cfn-bedrock-flowversion-promptmodelinferenceconfiguration-topp)" : Number } ``` ### YAML ``` [MaxTokens](#cfn-bedrock-flowversion-promptmodelinferenceconfiguration-maxtokens): Number [StopSequences](#cfn-bedrock-flowversion-promptmodelinferenceconfiguration-stopsequences): - String [Temperature](#cfn-bedrock-flowversion-promptmodelinferenceconfiguration-temperature): Number [TopP](#cfn-bedrock-flowversion-promptmodelinferenceconfiguration-topp): Number ``` ## Properties `MaxTokens` The maximum number of tokens to return in the response. *Required*: No *Type*: Number *Minimum*: `0` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StopSequences` A list of strings that define sequences after which the model will stop generating. *Required*: No *Type*: Array of String *Minimum*: `0` *Maximum*: `4` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Temperature` Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs. *Required*: No *Type*: Number *Minimum*: `0` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TopP` The percentage of most-likely candidates that the model considers for the next token. *Required*: No *Type*: Number *Minimum*: `0` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion PromptTemplateConfiguration Contains the message for a prompt. For more information, see [Construct and store reusable prompts with Prompt management in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Text](#cfn-bedrock-flowversion-prompttemplateconfiguration-text)" : TextPromptTemplateConfiguration } ``` ### YAML ``` [Text](#cfn-bedrock-flowversion-prompttemplateconfiguration-text): TextPromptTemplateConfiguration ``` ## Properties `Text` Contains configurations for the text in a message for a prompt. *Required*: Yes *Type*: [TextPromptTemplateConfiguration](aws-properties-bedrock-flowversion-textprompttemplateconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion RerankingMetadataSelectiveModeConfiguration Configuration for selectively including or excluding metadata fields during the reranking process. This allows you to control which metadata attributes are considered when reordering search results. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[FieldsToExclude](#cfn-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration-fieldstoexclude)" : [ FieldForReranking, ... ], "[FieldsToInclude](#cfn-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration-fieldstoinclude)" : [ FieldForReranking, ... ] } ``` ### YAML ``` [FieldsToExclude](#cfn-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration-fieldstoexclude): - FieldForReranking [FieldsToInclude](#cfn-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration-fieldstoinclude): - FieldForReranking ``` ## Properties `FieldsToExclude` A list of metadata field names to explicitly exclude from the reranking process. All metadata fields except these will be considered when reordering search results. This parameter cannot be used together with fieldsToInclude. *Required*: No *Type*: Array of [FieldForReranking](aws-properties-bedrock-flowversion-fieldforreranking.md) *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FieldsToInclude` A list of metadata field names to explicitly include in the reranking process. Only these fields will be considered when reordering search results. This parameter cannot be used together with fieldsToExclude. *Required*: No *Type*: Array of [FieldForReranking](aws-properties-bedrock-flowversion-fieldforreranking.md) *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion RetrievalFlowNodeConfiguration Contains configurations for a Retrieval node in a flow. This node retrieves data from the Amazon S3 location that you specify and returns it as the output. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ServiceConfiguration](#cfn-bedrock-flowversion-retrievalflownodeconfiguration-serviceconfiguration)" : RetrievalFlowNodeServiceConfiguration } ``` ### YAML ``` [ServiceConfiguration](#cfn-bedrock-flowversion-retrievalflownodeconfiguration-serviceconfiguration): RetrievalFlowNodeServiceConfiguration ``` ## Properties `ServiceConfiguration` Contains configurations for the service to use for retrieving data to return as the output from the node. *Required*: Yes *Type*: [RetrievalFlowNodeServiceConfiguration](aws-properties-bedrock-flowversion-retrievalflownodeserviceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion RetrievalFlowNodeS3Configuration Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BucketName](#cfn-bedrock-flowversion-retrievalflownodes3configuration-bucketname)" : String } ``` ### YAML ``` [BucketName](#cfn-bedrock-flowversion-retrievalflownodes3configuration-bucketname): String ``` ## Properties `BucketName` The name of the Amazon S3 bucket from which to retrieve data. *Required*: Yes *Type*: String *Pattern*: `^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion RetrievalFlowNodeServiceConfiguration Contains configurations for the service to use for retrieving data to return as the output from the node. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[S3](#cfn-bedrock-flowversion-retrievalflownodeserviceconfiguration-s3)" : RetrievalFlowNodeS3Configuration } ``` ### YAML ``` [S3](#cfn-bedrock-flowversion-retrievalflownodeserviceconfiguration-s3): RetrievalFlowNodeS3Configuration ``` ## Properties `S3` Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node. *Required*: No *Type*: [RetrievalFlowNodeS3Configuration](aws-properties-bedrock-flowversion-retrievalflownodes3configuration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion StorageFlowNodeConfiguration Contains configurations for a Storage node in a flow. This node stores the input in an Amazon S3 location that you specify. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ServiceConfiguration](#cfn-bedrock-flowversion-storageflownodeconfiguration-serviceconfiguration)" : StorageFlowNodeServiceConfiguration } ``` ### YAML ``` [ServiceConfiguration](#cfn-bedrock-flowversion-storageflownodeconfiguration-serviceconfiguration): StorageFlowNodeServiceConfiguration ``` ## Properties `ServiceConfiguration` Contains configurations for the service to use for storing the input into the node. *Required*: Yes *Type*: [StorageFlowNodeServiceConfiguration](aws-properties-bedrock-flowversion-storageflownodeserviceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion StorageFlowNodeS3Configuration Contains configurations for the Amazon S3 location in which to store the input into the node. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BucketName](#cfn-bedrock-flowversion-storageflownodes3configuration-bucketname)" : String } ``` ### YAML ``` [BucketName](#cfn-bedrock-flowversion-storageflownodes3configuration-bucketname): String ``` ## Properties `BucketName` The name of the Amazon S3 bucket in which to store the input into the node. *Required*: Yes *Type*: String *Pattern*: `^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion StorageFlowNodeServiceConfiguration Contains configurations for the service to use for storing the input into the node. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[S3](#cfn-bedrock-flowversion-storageflownodeserviceconfiguration-s3)" : StorageFlowNodeS3Configuration } ``` ### YAML ``` [S3](#cfn-bedrock-flowversion-storageflownodeserviceconfiguration-s3): StorageFlowNodeS3Configuration ``` ## Properties `S3` Contains configurations for the Amazon S3 location in which to store the input into the node. *Required*: No *Type*: [StorageFlowNodeS3Configuration](aws-properties-bedrock-flowversion-storageflownodes3configuration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion TextPromptTemplateConfiguration Contains configurations for a text prompt template. To include a variable, enclose a word in double curly braces as in `{{variable}}`. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InputVariables](#cfn-bedrock-flowversion-textprompttemplateconfiguration-inputvariables)" : [ PromptInputVariable, ... ], "[Text](#cfn-bedrock-flowversion-textprompttemplateconfiguration-text)" : String } ``` ### YAML ``` [InputVariables](#cfn-bedrock-flowversion-textprompttemplateconfiguration-inputvariables): - PromptInputVariable [Text](#cfn-bedrock-flowversion-textprompttemplateconfiguration-text): String ``` ## Properties `InputVariables` An array of the variables in the prompt template. *Required*: No *Type*: Array of [PromptInputVariable](aws-properties-bedrock-flowversion-promptinputvariable.md) *Minimum*: `0` *Maximum*: `20` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Text` The message for the prompt. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `200000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion VectorSearchBedrockRerankingConfiguration Configuration for using Amazon Bedrock foundation models to rerank Knowledge Base vector search results. This enables more sophisticated relevance ranking using large language models. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MetadataConfiguration](#cfn-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration-metadataconfiguration)" : MetadataConfigurationForReranking, "[ModelConfiguration](#cfn-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration-modelconfiguration)" : VectorSearchBedrockRerankingModelConfiguration, "[NumberOfRerankedResults](#cfn-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration-numberofrerankedresults)" : Number } ``` ### YAML ``` [MetadataConfiguration](#cfn-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration-metadataconfiguration): MetadataConfigurationForReranking [ModelConfiguration](#cfn-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration-modelconfiguration): VectorSearchBedrockRerankingModelConfiguration [NumberOfRerankedResults](#cfn-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration-numberofrerankedresults): Number ``` ## Properties `MetadataConfiguration` Configuration for how document metadata should be used during the reranking process. This determines which metadata fields are included when reordering search results. *Required*: No *Type*: [MetadataConfigurationForReranking](aws-properties-bedrock-flowversion-metadataconfigurationforreranking.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ModelConfiguration` Configuration for the Amazon Bedrock foundation model used for reranking. This includes the model ARN and any additional request fields required by the model. *Required*: Yes *Type*: [VectorSearchBedrockRerankingModelConfiguration](aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingmodelconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `NumberOfRerankedResults` The maximum number of results to rerank. This limits how many of the initial vector search results will be processed by the reranking model. A smaller number improves performance but may exclude potentially relevant results. *Required*: No *Type*: Number *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion VectorSearchBedrockRerankingModelConfiguration Configuration for the Amazon Bedrock foundation model used for reranking vector search results. This specifies which model to use and any additional parameters required by the model. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AdditionalModelRequestFields](#cfn-bedrock-flowversion-vectorsearchbedrockrerankingmodelconfiguration-additionalmodelrequestfields)" : Json, "[ModelArn](#cfn-bedrock-flowversion-vectorsearchbedrockrerankingmodelconfiguration-modelarn)" : String } ``` ### YAML ``` [AdditionalModelRequestFields](#cfn-bedrock-flowversion-vectorsearchbedrockrerankingmodelconfiguration-additionalmodelrequestfields): Json [ModelArn](#cfn-bedrock-flowversion-vectorsearchbedrockrerankingmodelconfiguration-modelarn): String ``` ## Properties `AdditionalModelRequestFields` A list of additional fields to include in the model request during reranking. These fields provide extra context or configuration options specific to the selected foundation model. *Required*: No *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ModelArn` The Amazon Resource Name (ARN) of the foundation model to use for reranking. This model processes the query and search results to determine a more relevant ordering. *Required*: Yes *Type*: String *Pattern*: `^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/(.*))?$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::FlowVersion VectorSearchRerankingConfiguration Configuration for reranking vector search results to improve relevance. Reranking applies additional relevance models to reorder the initial vector search results based on more sophisticated criteria. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BedrockRerankingConfiguration](#cfn-bedrock-flowversion-vectorsearchrerankingconfiguration-bedrockrerankingconfiguration)" : VectorSearchBedrockRerankingConfiguration, "[Type](#cfn-bedrock-flowversion-vectorsearchrerankingconfiguration-type)" : String } ``` ### YAML ``` [BedrockRerankingConfiguration](#cfn-bedrock-flowversion-vectorsearchrerankingconfiguration-bedrockrerankingconfiguration): VectorSearchBedrockRerankingConfiguration [Type](#cfn-bedrock-flowversion-vectorsearchrerankingconfiguration-type): String ``` ## Properties `BedrockRerankingConfiguration` Configuration for using Amazon Bedrock foundation models to rerank search results. This is required when the reranking type is set to BEDROCK. *Required*: No *Type*: [VectorSearchBedrockRerankingConfiguration](aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The type of reranking to apply to vector search results. Currently, the only supported value is BEDROCK, which uses Amazon Bedrock foundation models for reranking. *Required*: Yes *Type*: String *Allowed values*: `BEDROCK_RERANKING_MODEL` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Guardrail Creates a guardrail to detect and filter harmful content in your generative AI application. Amazon Bedrock Guardrails provides the following safeguards (also known as policies) to detect and filter harmful content: + **Content filters** - Detect and filter harmful text or image content in input prompts or model responses. Filtering is done based on detection of certain predefined harmful content categories: Hate, Insults, Sexual, Violence, Misconduct and Prompt Attack. You also can adjust the filter strength for each of these categories. + **Denied topics** - Define a set of topics that are undesirable in the context of your application. The filter will help block them if detected in user queries or model responses. + **Word filters** - Configure filters to help block undesirable words, phrases, and profanity (exact match). Such words can include offensive terms, competitor names, etc. + **Sensitive information filters** - Configure filters to help block or mask sensitive information, such as personally identifiable information (PII), or custom regex in user inputs and model responses. Blocking or masking is done based on probabilistic detection of sensitive information in standard formats in entities such as SSN number, Date of Birth, address, etc. This also allows configuring regular expression based detection of patterns for identifiers. + **Contextual grounding check** - Help detect and filter hallucinations in model responses based on grounding in a source and relevance to the user query. For more information, see [How Amazon Bedrock Guardrails works](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-how.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::Bedrock::Guardrail", "Properties" : { "[AutomatedReasoningPolicyConfig](#cfn-bedrock-guardrail-automatedreasoningpolicyconfig)" : AutomatedReasoningPolicyConfig, "[BlockedInputMessaging](#cfn-bedrock-guardrail-blockedinputmessaging)" : String, "[BlockedOutputsMessaging](#cfn-bedrock-guardrail-blockedoutputsmessaging)" : String, "[ContentPolicyConfig](#cfn-bedrock-guardrail-contentpolicyconfig)" : ContentPolicyConfig, "[ContextualGroundingPolicyConfig](#cfn-bedrock-guardrail-contextualgroundingpolicyconfig)" : ContextualGroundingPolicyConfig, "[CrossRegionConfig](#cfn-bedrock-guardrail-crossregionconfig)" : GuardrailCrossRegionConfig, "[Description](#cfn-bedrock-guardrail-description)" : String, "[KmsKeyArn](#cfn-bedrock-guardrail-kmskeyarn)" : String, "[Name](#cfn-bedrock-guardrail-name)" : String, "[SensitiveInformationPolicyConfig](#cfn-bedrock-guardrail-sensitiveinformationpolicyconfig)" : SensitiveInformationPolicyConfig, "[Tags](#cfn-bedrock-guardrail-tags)" : [ Tag, ... ], "[TopicPolicyConfig](#cfn-bedrock-guardrail-topicpolicyconfig)" : TopicPolicyConfig, "[WordPolicyConfig](#cfn-bedrock-guardrail-wordpolicyconfig)" : WordPolicyConfig } } ``` ### YAML ``` Type: AWS::Bedrock::Guardrail Properties: [AutomatedReasoningPolicyConfig](#cfn-bedrock-guardrail-automatedreasoningpolicyconfig): AutomatedReasoningPolicyConfig [BlockedInputMessaging](#cfn-bedrock-guardrail-blockedinputmessaging): String [BlockedOutputsMessaging](#cfn-bedrock-guardrail-blockedoutputsmessaging): String [ContentPolicyConfig](#cfn-bedrock-guardrail-contentpolicyconfig): ContentPolicyConfig [ContextualGroundingPolicyConfig](#cfn-bedrock-guardrail-contextualgroundingpolicyconfig): ContextualGroundingPolicyConfig [CrossRegionConfig](#cfn-bedrock-guardrail-crossregionconfig): GuardrailCrossRegionConfig [Description](#cfn-bedrock-guardrail-description): String [KmsKeyArn](#cfn-bedrock-guardrail-kmskeyarn): String [Name](#cfn-bedrock-guardrail-name): String [SensitiveInformationPolicyConfig](#cfn-bedrock-guardrail-sensitiveinformationpolicyconfig): SensitiveInformationPolicyConfig [Tags](#cfn-bedrock-guardrail-tags): - Tag [TopicPolicyConfig](#cfn-bedrock-guardrail-topicpolicyconfig): TopicPolicyConfig [WordPolicyConfig](#cfn-bedrock-guardrail-wordpolicyconfig): WordPolicyConfig ``` ## Properties `AutomatedReasoningPolicyConfig` Configuration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails. *Required*: No *Type*: [AutomatedReasoningPolicyConfig](aws-properties-bedrock-guardrail-automatedreasoningpolicyconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BlockedInputMessaging` The message to return when the guardrail blocks a prompt. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `500` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `BlockedOutputsMessaging` The message to return when the guardrail blocks a model response. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `500` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ContentPolicyConfig` The content filter policies to configure for the guardrail. *Required*: No *Type*: [ContentPolicyConfig](aws-properties-bedrock-guardrail-contentpolicyconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ContextualGroundingPolicyConfig` Property description not available. *Required*: No *Type*: [ContextualGroundingPolicyConfig](aws-properties-bedrock-guardrail-contextualgroundingpolicyconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `CrossRegionConfig` The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination AWS Regions where guardrail inference requests can be automatically routed. Using guardrail profiles helps maintain guardrail performance and reliability when demand increases. For more information, see the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html). *Required*: No *Type*: [GuardrailCrossRegionConfig](aws-properties-bedrock-guardrail-guardrailcrossregionconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` A description of the guardrail. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KmsKeyArn` The ARN of the AWS KMS key that you use to encrypt the guardrail. *Required*: No *Type*: String *Pattern*: `^arn:aws(-[^:]+)?:kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the guardrail. *Required*: Yes *Type*: String *Pattern*: `^[0-9a-zA-Z-_]+$` *Minimum*: `1` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `SensitiveInformationPolicyConfig` The sensitive information policy to configure for the guardrail. *Required*: No *Type*: [SensitiveInformationPolicyConfig](aws-properties-bedrock-guardrail-sensitiveinformationpolicyconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` The tags that you want to attach to the guardrail. *Required*: No *Type*: Array of [Tag](aws-properties-bedrock-guardrail-tag.md) *Minimum*: `0` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TopicPolicyConfig` The topic policies to configure for the guardrail. *Required*: No *Type*: [TopicPolicyConfig](aws-properties-bedrock-guardrail-topicpolicyconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `WordPolicyConfig` The word policy you configure for the guardrail. *Required*: No *Type*: [WordPolicyConfig](aws-properties-bedrock-guardrail-wordpolicyconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `CreatedAt` Timestamp. `FailureRecommendations` Appears if the `status` of the guardrail is `FAILED`. A list of recommendations to carry out before retrying the request. `GuardrailArn` The ARN of the guardrail. `GuardrailId` The unique identifier of the guardrail. `Status` The status of the guardrail. `StatusReasons` Appears if the `status` is `FAILED`. A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted. `UpdatedAt` Timestamp. `Version` The version of the guardrail that was created. This value will always be `DRAFT`. # AWS::Bedrock::Guardrail AutomatedReasoningPolicyConfig Configuration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ConfidenceThreshold](#cfn-bedrock-guardrail-automatedreasoningpolicyconfig-confidencethreshold)" : Number, "[Policies](#cfn-bedrock-guardrail-automatedreasoningpolicyconfig-policies)" : [ String, ... ] } ``` ### YAML ``` [ConfidenceThreshold](#cfn-bedrock-guardrail-automatedreasoningpolicyconfig-confidencethreshold): Number [Policies](#cfn-bedrock-guardrail-automatedreasoningpolicyconfig-policies): - String ``` ## Properties `ConfidenceThreshold` The minimum confidence level required for Automated Reasoning policy violations to trigger guardrail actions. Values range from 0.0 to 1.0. *Required*: No *Type*: Number *Minimum*: `0` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Policies` The list of Automated Reasoning policy ARNs that should be applied as part of this guardrail configuration. *Required*: Yes *Type*: Array of String *Minimum*: `15 | 1` *Maximum*: `2048 | 2` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Guardrail ContentFilterConfig Contains filter strengths for harmful content. Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs. + **Hate** – Describes language or a statement that discriminates, criticizes, insults, denounces, or dehumanizes a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin). + **Insults** – Describes language or a statement that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying. + **Sexual** – Describes language or a statement that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex. + **Violence** – Describes language or a statement that includes glorification of or threats to inflict physical pain, hurt, or injury toward a person, group or thing. Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as *Hate* with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as *Hate* with HIGH confidence, *Insults* with LOW confidence, *Sexual* with NONE confidence, and *Violence* with MEDIUM confidence. For more information, see [Guardrails content filters](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-filters.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InputAction](#cfn-bedrock-guardrail-contentfilterconfig-inputaction)" : String, "[InputEnabled](#cfn-bedrock-guardrail-contentfilterconfig-inputenabled)" : Boolean, "[InputModalities](#cfn-bedrock-guardrail-contentfilterconfig-inputmodalities)" : [ String, ... ], "[InputStrength](#cfn-bedrock-guardrail-contentfilterconfig-inputstrength)" : String, "[OutputAction](#cfn-bedrock-guardrail-contentfilterconfig-outputaction)" : String, "[OutputEnabled](#cfn-bedrock-guardrail-contentfilterconfig-outputenabled)" : Boolean, "[OutputModalities](#cfn-bedrock-guardrail-contentfilterconfig-outputmodalities)" : [ String, ... ], "[OutputStrength](#cfn-bedrock-guardrail-contentfilterconfig-outputstrength)" : String, "[Type](#cfn-bedrock-guardrail-contentfilterconfig-type)" : String } ``` ### YAML ``` [InputAction](#cfn-bedrock-guardrail-contentfilterconfig-inputaction): String [InputEnabled](#cfn-bedrock-guardrail-contentfilterconfig-inputenabled): Boolean [InputModalities](#cfn-bedrock-guardrail-contentfilterconfig-inputmodalities): - String [InputStrength](#cfn-bedrock-guardrail-contentfilterconfig-inputstrength): String [OutputAction](#cfn-bedrock-guardrail-contentfilterconfig-outputaction): String [OutputEnabled](#cfn-bedrock-guardrail-contentfilterconfig-outputenabled): Boolean [OutputModalities](#cfn-bedrock-guardrail-contentfilterconfig-outputmodalities): - String [OutputStrength](#cfn-bedrock-guardrail-contentfilterconfig-outputstrength): String [Type](#cfn-bedrock-guardrail-contentfilterconfig-type): String ``` ## Properties `InputAction` Specifies the action to take when harmful content is detected. Supported values include: + `BLOCK` – Block the content and replace it with blocked messaging. + `NONE` – Take no action but return detection information in the trace response. *Required*: No *Type*: String *Allowed values*: `BLOCK | NONE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputEnabled` Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputModalities` The input modalities selected for the guardrail content filter configuration. *Required*: No *Type*: Array of String *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputStrength` The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces. *Required*: Yes *Type*: String *Allowed values*: `NONE | LOW | MEDIUM | HIGH` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OutputAction` Specifies the action to take when harmful content is detected in the output. Supported values include: + `BLOCK` – Block the content and replace it with blocked messaging. + `NONE` – Take no action but return detection information in the trace response. *Required*: No *Type*: String *Allowed values*: `BLOCK | NONE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OutputEnabled` Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OutputModalities` The output modalities selected for the guardrail content filter configuration. *Required*: No *Type*: Array of String *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OutputStrength` The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces. *Required*: Yes *Type*: String *Allowed values*: `NONE | LOW | MEDIUM | HIGH` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The harmful category that the content filter is applied to. *Required*: Yes *Type*: String *Allowed values*: `SEXUAL | VIOLENCE | HATE | INSULTS | MISCONDUCT | PROMPT_ATTACK` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Guardrail ContentFiltersTierConfig The tier that your guardrail uses for content filters. Consider using a tier that balances performance, accuracy, and compatibility with your existing generative AI workflows. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[TierName](#cfn-bedrock-guardrail-contentfilterstierconfig-tiername)" : String } ``` ### YAML ``` [TierName](#cfn-bedrock-guardrail-contentfilterstierconfig-tiername): String ``` ## Properties `TierName` The tier that your guardrail uses for content filters. Valid values include: + `CLASSIC` tier – Provides established guardrails functionality supporting English, French, and Spanish languages. + `STANDARD` tier – Provides a more robust solution than the `CLASSIC` tier and has more comprehensive language support. This tier requires that your guardrail use [cross-Region inference](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html). *Required*: Yes *Type*: String *Allowed values*: `CLASSIC | STANDARD` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Guardrail ContentPolicyConfig Contains details about how to handle harmful content. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ContentFiltersTierConfig](#cfn-bedrock-guardrail-contentpolicyconfig-contentfilterstierconfig)" : ContentFiltersTierConfig, "[FiltersConfig](#cfn-bedrock-guardrail-contentpolicyconfig-filtersconfig)" : [ ContentFilterConfig, ... ] } ``` ### YAML ``` [ContentFiltersTierConfig](#cfn-bedrock-guardrail-contentpolicyconfig-contentfilterstierconfig): ContentFiltersTierConfig [FiltersConfig](#cfn-bedrock-guardrail-contentpolicyconfig-filtersconfig): - ContentFilterConfig ``` ## Properties `ContentFiltersTierConfig` The tier that your guardrail uses for content filters. Consider using a tier that balances performance, accuracy, and compatibility with your existing generative AI workflows. *Required*: No *Type*: [ContentFiltersTierConfig](aws-properties-bedrock-guardrail-contentfilterstierconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `FiltersConfig` Contains the type of the content filter and how strongly it should apply to prompts and model responses. *Required*: Yes *Type*: Array of [ContentFilterConfig](aws-properties-bedrock-guardrail-contentfilterconfig.md) *Minimum*: `1` *Maximum*: `6` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Guardrail ContextualGroundingFilterConfig The filter configuration details for the guardrails contextual grounding filter. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Action](#cfn-bedrock-guardrail-contextualgroundingfilterconfig-action)" : String, "[Enabled](#cfn-bedrock-guardrail-contextualgroundingfilterconfig-enabled)" : Boolean, "[Threshold](#cfn-bedrock-guardrail-contextualgroundingfilterconfig-threshold)" : Number, "[Type](#cfn-bedrock-guardrail-contextualgroundingfilterconfig-type)" : String } ``` ### YAML ``` [Action](#cfn-bedrock-guardrail-contextualgroundingfilterconfig-action): String [Enabled](#cfn-bedrock-guardrail-contextualgroundingfilterconfig-enabled): Boolean [Threshold](#cfn-bedrock-guardrail-contextualgroundingfilterconfig-threshold): Number [Type](#cfn-bedrock-guardrail-contextualgroundingfilterconfig-type): String ``` ## Properties `Action` Specifies the action to take when content fails the contextual grounding evaluation. Supported values include: + `BLOCK` – Block the content and replace it with blocked messaging. + `NONE` – Take no action but return detection information in the trace response. *Required*: No *Type*: String *Allowed values*: `BLOCK | NONE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Enabled` Specifies whether to enable contextual grounding evaluation. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Threshold` The threshold details for the guardrails contextual grounding filter. *Required*: Yes *Type*: Number *Minimum*: `0` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The filter details for the guardrails contextual grounding filter. *Required*: Yes *Type*: String *Allowed values*: `GROUNDING | RELEVANCE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Guardrail ContextualGroundingPolicyConfig The policy configuration details for the guardrails contextual grounding policy. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[FiltersConfig](#cfn-bedrock-guardrail-contextualgroundingpolicyconfig-filtersconfig)" : [ ContextualGroundingFilterConfig, ... ] } ``` ### YAML ``` [FiltersConfig](#cfn-bedrock-guardrail-contextualgroundingpolicyconfig-filtersconfig): - ContextualGroundingFilterConfig ``` ## Properties `FiltersConfig` Property description not available. *Required*: Yes *Type*: Array of [ContextualGroundingFilterConfig](aws-properties-bedrock-guardrail-contextualgroundingfilterconfig.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Guardrail GuardrailCrossRegionConfig The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination AWS Regions where guardrail inference requests can be automatically routed. Using guardrail profiles helps maintain guardrail performance and reliability when demand increases. For more information, see the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[GuardrailProfileArn](#cfn-bedrock-guardrail-guardrailcrossregionconfig-guardrailprofilearn)" : String } ``` ### YAML ``` [GuardrailProfileArn](#cfn-bedrock-guardrail-guardrailcrossregionconfig-guardrailprofilearn): String ``` ## Properties `GuardrailProfileArn` The Amazon Resource Name (ARN) of the guardrail profile that your guardrail is using. Guardrail profile availability depends on your current AWS Region. For more information, see the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region-support.html). *Required*: Yes *Type*: String *Pattern*: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail-profile/[a-z0-9-]+[.]{1}guardrail[.]{1}v[0-9:]+$` *Minimum*: `15` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Guardrail ManagedWordsConfig The managed word list to configure for the guardrail. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InputAction](#cfn-bedrock-guardrail-managedwordsconfig-inputaction)" : String, "[InputEnabled](#cfn-bedrock-guardrail-managedwordsconfig-inputenabled)" : Boolean, "[OutputAction](#cfn-bedrock-guardrail-managedwordsconfig-outputaction)" : String, "[OutputEnabled](#cfn-bedrock-guardrail-managedwordsconfig-outputenabled)" : Boolean, "[Type](#cfn-bedrock-guardrail-managedwordsconfig-type)" : String } ``` ### YAML ``` [InputAction](#cfn-bedrock-guardrail-managedwordsconfig-inputaction): String [InputEnabled](#cfn-bedrock-guardrail-managedwordsconfig-inputenabled): Boolean [OutputAction](#cfn-bedrock-guardrail-managedwordsconfig-outputaction): String [OutputEnabled](#cfn-bedrock-guardrail-managedwordsconfig-outputenabled): Boolean [Type](#cfn-bedrock-guardrail-managedwordsconfig-type): String ``` ## Properties `InputAction` Specifies the action to take when harmful content is detected in the input. Supported values include: + `BLOCK` – Block the content and replace it with blocked messaging. + `NONE` – Take no action but return detection information in the trace response. *Required*: No *Type*: String *Allowed values*: `BLOCK | NONE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputEnabled` Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OutputAction` Specifies the action to take when harmful content is detected in the output. Supported values include: + `BLOCK` – Block the content and replace it with blocked messaging. + `NONE` – Take no action but return detection information in the trace response. *Required*: No *Type*: String *Allowed values*: `BLOCK | NONE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OutputEnabled` Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The managed word type to configure for the guardrail. *Required*: Yes *Type*: String *Allowed values*: `PROFANITY` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Guardrail PiiEntityConfig The PII entity to configure for the guardrail. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Action](#cfn-bedrock-guardrail-piientityconfig-action)" : String, "[InputAction](#cfn-bedrock-guardrail-piientityconfig-inputaction)" : String, "[InputEnabled](#cfn-bedrock-guardrail-piientityconfig-inputenabled)" : Boolean, "[OutputAction](#cfn-bedrock-guardrail-piientityconfig-outputaction)" : String, "[OutputEnabled](#cfn-bedrock-guardrail-piientityconfig-outputenabled)" : Boolean, "[Type](#cfn-bedrock-guardrail-piientityconfig-type)" : String } ``` ### YAML ``` [Action](#cfn-bedrock-guardrail-piientityconfig-action): String [InputAction](#cfn-bedrock-guardrail-piientityconfig-inputaction): String [InputEnabled](#cfn-bedrock-guardrail-piientityconfig-inputenabled): Boolean [OutputAction](#cfn-bedrock-guardrail-piientityconfig-outputaction): String [OutputEnabled](#cfn-bedrock-guardrail-piientityconfig-outputenabled): Boolean [Type](#cfn-bedrock-guardrail-piientityconfig-type): String ``` ## Properties `Action` Configure guardrail action when the PII entity is detected. *Required*: Yes *Type*: String *Allowed values*: `BLOCK | ANONYMIZE | NONE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputAction` Specifies the action to take when harmful content is detected in the input. Supported values include: + `BLOCK` – Block the content and replace it with blocked messaging. + `ANONYMIZE` – Mask the content and replace it with identifier tags. + `NONE` – Take no action but return detection information in the trace response. *Required*: No *Type*: String *Allowed values*: `BLOCK | ANONYMIZE | NONE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputEnabled` Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OutputAction` Specifies the action to take when harmful content is detected in the output. Supported values include: + `BLOCK` – Block the content and replace it with blocked messaging. + `ANONYMIZE` – Mask the content and replace it with identifier tags. + `NONE` – Take no action but return detection information in the trace response. *Required*: No *Type*: String *Allowed values*: `BLOCK | ANONYMIZE | NONE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OutputEnabled` Indicates whether guardrail evaluation is enabled on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` Configure guardrail type when the PII entity is detected. The following PIIs are used to block or mask sensitive information: + **General** + **ADDRESS** A physical address, such as "100 Main Street, Anytown, USA" or "Suite \$112, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. + **AGE** An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guardrails recognizes "40 years" as an age. + **NAME** An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address. + **EMAIL** An email address, such as *marymajor@email.com*. + **PHONE** A phone number. This entity type also includes fax and pager numbers. + **USERNAME** A user name that identifies an account, such as a login name, screen name, nick name, or handle. + **PASSWORD** An alphanumeric string that is used as a password, such as "\$1*very20special\$1pass\$1*". + **DRIVER\$1ID** The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters. + **LICENSE\$1PLATE** A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country. + **VEHICLE\$1IDENTIFICATION\$1NUMBER** A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the *ISO 3779* specification. Each country has specific codes and formats for VINs. + **Finance** + **CREDIT\$1DEBIT\$1CARD\$1CVV** A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. + **CREDIT\$1DEBIT\$1CARD\$1EXPIRY** The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as *month/year* or *MM/YY*. Guardrails recognizes expiration dates such as *01/21*, *01/2021*, and *Jan 2021*. + **CREDIT\$1DEBIT\$1CARD\$1NUMBER** The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present. + **PIN** A four-digit personal identification number (PIN) with which you can access your bank account. + **INTERNATIONAL\$1BANK\$1ACCOUNT\$1NUMBER** An International Bank Account Number has specific formats in each country. For more information, see [www.iban.com/structure](https://www.iban.com/structure). + **SWIFT\$1CODE** A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers. SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office. + **IT** + **IP\$1ADDRESS** An IPv4 address, such as *198.51.100.0*. + **MAC\$1ADDRESS** A *media access control* (MAC) address is a unique identifier assigned to a network interface controller (NIC). + **URL** A web address, such as *www.example.com*. + **AWS\$1ACCESS\$1KEY** A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic AWS requests cryptographically. + **AWS\$1SECRET\$1KEY** A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic AWS requests cryptographically. + **USA specific** + **US\$1BANK\$1ACCOUNT\$1NUMBER** A US bank account number, which is typically 10 to 12 digits long. + **US\$1BANK\$1ROUTING\$1NUMBER** A US bank account routing number. These are typically nine digits long, + **US\$1INDIVIDUAL\$1TAX\$1IDENTIFICATION\$1NUMBER** A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits. + **US\$1PASSPORT\$1NUMBER** A US passport number. Passport numbers range from six to nine alphanumeric characters. + **US\$1SOCIAL\$1SECURITY\$1NUMBER** A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents. + **Canada specific** + **CA\$1HEALTH\$1NUMBER** A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits. + **CA\$1SOCIAL\$1INSURANCE\$1NUMBER** A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits. The SIN is formatted as three groups of three digits, such as *123-456-789*. A SIN can be validated through a simple check-digit process called the [Luhn algorithm](https://www.wikipedia.org/wiki/Luhn_algorithm). + **UK Specific** + **UK\$1NATIONAL\$1HEALTH\$1SERVICE\$1NUMBER** A UK National Health Service Number is a 10-17 digit number, such as *485 777 3456*. The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum. + **UK\$1NATIONAL\$1INSURANCE\$1NUMBER** A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system. The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits. + **UK\$1UNIQUE\$1TAXPAYER\$1REFERENCE\$1NUMBER** A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business. + **Custom** + **Regex filter** - You can use a regular expressions to define patterns for a guardrail to recognize and act upon such as serial number, booking ID etc.. *Required*: Yes *Type*: String *Allowed values*: `ADDRESS | AGE | AWS_ACCESS_KEY | AWS_SECRET_KEY | CA_HEALTH_NUMBER | CA_SOCIAL_INSURANCE_NUMBER | CREDIT_DEBIT_CARD_CVV | CREDIT_DEBIT_CARD_EXPIRY | CREDIT_DEBIT_CARD_NUMBER | DRIVER_ID | EMAIL | INTERNATIONAL_BANK_ACCOUNT_NUMBER | IP_ADDRESS | LICENSE_PLATE | MAC_ADDRESS | NAME | PASSWORD | PHONE | PIN | SWIFT_CODE | UK_NATIONAL_HEALTH_SERVICE_NUMBER | UK_NATIONAL_INSURANCE_NUMBER | UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER | URL | USERNAME | US_BANK_ACCOUNT_NUMBER | US_BANK_ROUTING_NUMBER | US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER | US_PASSPORT_NUMBER | US_SOCIAL_SECURITY_NUMBER | VEHICLE_IDENTIFICATION_NUMBER` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Guardrail RegexConfig The regular expression to configure for the guardrail. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Action](#cfn-bedrock-guardrail-regexconfig-action)" : String, "[Description](#cfn-bedrock-guardrail-regexconfig-description)" : String, "[InputAction](#cfn-bedrock-guardrail-regexconfig-inputaction)" : String, "[InputEnabled](#cfn-bedrock-guardrail-regexconfig-inputenabled)" : Boolean, "[Name](#cfn-bedrock-guardrail-regexconfig-name)" : String, "[OutputAction](#cfn-bedrock-guardrail-regexconfig-outputaction)" : String, "[OutputEnabled](#cfn-bedrock-guardrail-regexconfig-outputenabled)" : Boolean, "[Pattern](#cfn-bedrock-guardrail-regexconfig-pattern)" : String } ``` ### YAML ``` [Action](#cfn-bedrock-guardrail-regexconfig-action): String [Description](#cfn-bedrock-guardrail-regexconfig-description): String [InputAction](#cfn-bedrock-guardrail-regexconfig-inputaction): String [InputEnabled](#cfn-bedrock-guardrail-regexconfig-inputenabled): Boolean [Name](#cfn-bedrock-guardrail-regexconfig-name): String [OutputAction](#cfn-bedrock-guardrail-regexconfig-outputaction): String [OutputEnabled](#cfn-bedrock-guardrail-regexconfig-outputenabled): Boolean [Pattern](#cfn-bedrock-guardrail-regexconfig-pattern): String ``` ## Properties `Action` The guardrail action to configure when matching regular expression is detected. *Required*: Yes *Type*: String *Allowed values*: `BLOCK | ANONYMIZE | NONE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` The description of the regular expression to configure for the guardrail. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputAction` Specifies the action to take when harmful content is detected in the input. Supported values include: + `BLOCK` – Block the content and replace it with blocked messaging. + `NONE` – Take no action but return detection information in the trace response. *Required*: No *Type*: String *Allowed values*: `BLOCK | ANONYMIZE | NONE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputEnabled` Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the regular expression to configure for the guardrail. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OutputAction` Specifies the action to take when harmful content is detected in the output. Supported values include: + `BLOCK` – Block the content and replace it with blocked messaging. + `NONE` – Take no action but return detection information in the trace response. *Required*: No *Type*: String *Allowed values*: `BLOCK | ANONYMIZE | NONE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OutputEnabled` Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Pattern` The regular expression pattern to configure for the guardrail. *Required*: Yes *Type*: String *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Guardrail SensitiveInformationPolicyConfig Contains details about PII entities and regular expressions to configure for the guardrail. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[PiiEntitiesConfig](#cfn-bedrock-guardrail-sensitiveinformationpolicyconfig-piientitiesconfig)" : [ PiiEntityConfig, ... ], "[RegexesConfig](#cfn-bedrock-guardrail-sensitiveinformationpolicyconfig-regexesconfig)" : [ RegexConfig, ... ] } ``` ### YAML ``` [PiiEntitiesConfig](#cfn-bedrock-guardrail-sensitiveinformationpolicyconfig-piientitiesconfig): - PiiEntityConfig [RegexesConfig](#cfn-bedrock-guardrail-sensitiveinformationpolicyconfig-regexesconfig): - RegexConfig ``` ## Properties `PiiEntitiesConfig` A list of PII entities to configure to the guardrail. *Required*: No *Type*: Array of [PiiEntityConfig](aws-properties-bedrock-guardrail-piientityconfig.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RegexesConfig` A list of regular expressions to configure to the guardrail. *Required*: No *Type*: Array of [RegexConfig](aws-properties-bedrock-guardrail-regexconfig.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Guardrail Tag A tag associated with a resource. A tag consists of a key and value. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-bedrock-guardrail-tag-key)" : String, "[Value](#cfn-bedrock-guardrail-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-bedrock-guardrail-tag-key): String [Value](#cfn-bedrock-guardrail-tag-value): String ``` ## Properties `Key` The key associated with a tag. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value associated with a tag. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Guardrail TopicConfig Details about topics for the guardrail to identify and deny. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Definition](#cfn-bedrock-guardrail-topicconfig-definition)" : String, "[Examples](#cfn-bedrock-guardrail-topicconfig-examples)" : [ String, ... ], "[InputAction](#cfn-bedrock-guardrail-topicconfig-inputaction)" : String, "[InputEnabled](#cfn-bedrock-guardrail-topicconfig-inputenabled)" : Boolean, "[Name](#cfn-bedrock-guardrail-topicconfig-name)" : String, "[OutputAction](#cfn-bedrock-guardrail-topicconfig-outputaction)" : String, "[OutputEnabled](#cfn-bedrock-guardrail-topicconfig-outputenabled)" : Boolean, "[Type](#cfn-bedrock-guardrail-topicconfig-type)" : String } ``` ### YAML ``` [Definition](#cfn-bedrock-guardrail-topicconfig-definition): String [Examples](#cfn-bedrock-guardrail-topicconfig-examples): - String [InputAction](#cfn-bedrock-guardrail-topicconfig-inputaction): String [InputEnabled](#cfn-bedrock-guardrail-topicconfig-inputenabled): Boolean [Name](#cfn-bedrock-guardrail-topicconfig-name): String [OutputAction](#cfn-bedrock-guardrail-topicconfig-outputaction): String [OutputEnabled](#cfn-bedrock-guardrail-topicconfig-outputenabled): Boolean [Type](#cfn-bedrock-guardrail-topicconfig-type): String ``` ## Properties `Definition` A definition of the topic to deny. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Examples` A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic. *Required*: No *Type*: Array of String *Maximum*: `100` *Minimum*: `1 | 0` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputAction` Specifies the action to take when harmful content is detected in the input. Supported values include: + `BLOCK` – Block the content and replace it with blocked messaging. + `NONE` – Take no action but return detection information in the trace response. *Required*: No *Type*: String *Allowed values*: `BLOCK | NONE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputEnabled` Specifies whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the topic to deny. *Required*: Yes *Type*: String *Pattern*: `^[0-9a-zA-Z-_ !?.]+$` *Minimum*: `1` *Maximum*: `100` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OutputAction` Specifies the action to take when harmful content is detected in the output. Supported values include: + `BLOCK` – Block the content and replace it with blocked messaging. + `NONE` – Take no action but return detection information in the trace response. *Required*: No *Type*: String *Allowed values*: `BLOCK | NONE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OutputEnabled` Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` Specifies to deny the topic. *Required*: Yes *Type*: String *Allowed values*: `DENY` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Guardrail TopicPolicyConfig Contains details about topics that the guardrail should identify and deny. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[TopicsConfig](#cfn-bedrock-guardrail-topicpolicyconfig-topicsconfig)" : [ TopicConfig, ... ], "[TopicsTierConfig](#cfn-bedrock-guardrail-topicpolicyconfig-topicstierconfig)" : TopicsTierConfig } ``` ### YAML ``` [TopicsConfig](#cfn-bedrock-guardrail-topicpolicyconfig-topicsconfig): - TopicConfig [TopicsTierConfig](#cfn-bedrock-guardrail-topicpolicyconfig-topicstierconfig): TopicsTierConfig ``` ## Properties `TopicsConfig` A list of policies related to topics that the guardrail should deny. *Required*: Yes *Type*: Array of [TopicConfig](aws-properties-bedrock-guardrail-topicconfig.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TopicsTierConfig` The tier that your guardrail uses for denied topic filters. *Required*: No *Type*: [TopicsTierConfig](aws-properties-bedrock-guardrail-topicstierconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Guardrail TopicsTierConfig The tier that your guardrail uses for denied topic filters. Consider using a tier that balances performance, accuracy, and compatibility with your existing generative AI workflows. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[TierName](#cfn-bedrock-guardrail-topicstierconfig-tiername)" : String } ``` ### YAML ``` [TierName](#cfn-bedrock-guardrail-topicstierconfig-tiername): String ``` ## Properties `TierName` The tier that your guardrail uses for denied topic filters. Valid values include: + `CLASSIC` tier – Provides established guardrails functionality supporting English, French, and Spanish languages. + `STANDARD` tier – Provides a more robust solution than the `CLASSIC` tier and has more comprehensive language support. This tier requires that your guardrail use [cross-Region inference](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html). *Required*: Yes *Type*: String *Allowed values*: `CLASSIC | STANDARD` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Guardrail WordConfig A word to configure for the guardrail. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InputAction](#cfn-bedrock-guardrail-wordconfig-inputaction)" : String, "[InputEnabled](#cfn-bedrock-guardrail-wordconfig-inputenabled)" : Boolean, "[OutputAction](#cfn-bedrock-guardrail-wordconfig-outputaction)" : String, "[OutputEnabled](#cfn-bedrock-guardrail-wordconfig-outputenabled)" : Boolean, "[Text](#cfn-bedrock-guardrail-wordconfig-text)" : String } ``` ### YAML ``` [InputAction](#cfn-bedrock-guardrail-wordconfig-inputaction): String [InputEnabled](#cfn-bedrock-guardrail-wordconfig-inputenabled): Boolean [OutputAction](#cfn-bedrock-guardrail-wordconfig-outputaction): String [OutputEnabled](#cfn-bedrock-guardrail-wordconfig-outputenabled): Boolean [Text](#cfn-bedrock-guardrail-wordconfig-text): String ``` ## Properties `InputAction` Specifies the action to take when harmful content is detected in the input. Supported values include: + `BLOCK` – Block the content and replace it with blocked messaging. + `NONE` – Take no action but return detection information in the trace response. *Required*: No *Type*: String *Allowed values*: `BLOCK | NONE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputEnabled` Specifies whether to enable guardrail evaluation on the intput. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OutputAction` Specifies the action to take when harmful content is detected in the output. Supported values include: + `BLOCK` – Block the content and replace it with blocked messaging. + `NONE` – Take no action but return detection information in the trace response. *Required*: No *Type*: String *Allowed values*: `BLOCK | NONE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `OutputEnabled` Specifies whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response. *Required*: No *Type*: Boolean *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Text` Text of the word configured for the guardrail to block. *Required*: Yes *Type*: String *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Guardrail WordPolicyConfig Contains details about the word policy to configured for the guardrail. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ManagedWordListsConfig](#cfn-bedrock-guardrail-wordpolicyconfig-managedwordlistsconfig)" : [ ManagedWordsConfig, ... ], "[WordsConfig](#cfn-bedrock-guardrail-wordpolicyconfig-wordsconfig)" : [ WordConfig, ... ] } ``` ### YAML ``` [ManagedWordListsConfig](#cfn-bedrock-guardrail-wordpolicyconfig-managedwordlistsconfig): - ManagedWordsConfig [WordsConfig](#cfn-bedrock-guardrail-wordpolicyconfig-wordsconfig): - WordConfig ``` ## Properties `ManagedWordListsConfig` A list of managed words to configure for the guardrail. *Required*: No *Type*: Array of [ManagedWordsConfig](aws-properties-bedrock-guardrail-managedwordsconfig.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `WordsConfig` A list of words to configure for the guardrail. *Required*: No *Type*: Array of [WordConfig](aws-properties-bedrock-guardrail-wordconfig.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::GuardrailVersion Creates a version of the guardrail. Use this API to create a snapshot of the guardrail when you are satisfied with a configuration, or to compare the configuration with another version. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::Bedrock::GuardrailVersion", "Properties" : { "[Description](#cfn-bedrock-guardrailversion-description)" : String, "[GuardrailIdentifier](#cfn-bedrock-guardrailversion-guardrailidentifier)" : String } } ``` ### YAML ``` Type: AWS::Bedrock::GuardrailVersion Properties: [Description](#cfn-bedrock-guardrailversion-description): String [GuardrailIdentifier](#cfn-bedrock-guardrailversion-guardrailidentifier): String ``` ## Properties `Description` A description of the guardrail version. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `200` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `GuardrailIdentifier` The unique identifier of the guardrail. This can be an ID or the ARN. *Required*: Yes *Type*: String *Pattern*: `^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the guardrail ID and version, separated by a pipe (`|`) in the format (`guardrail-id|guardrail-version`). For example, `{ "Ref": "myGuardrailVersion" }` would return the value `"3mzzryddufkp|2"`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `GuardrailArn` The ARN of the guardrail. `GuardrailId` The unique identifier of the guardrail. `Version` The version of the guardrail. # AWS::Bedrock::IntelligentPromptRouter Specifies an intelligent prompt router resource for Amazon Bedrock. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::Bedrock::IntelligentPromptRouter", "Properties" : { "[Description](#cfn-bedrock-intelligentpromptrouter-description)" : String, "[FallbackModel](#cfn-bedrock-intelligentpromptrouter-fallbackmodel)" : PromptRouterTargetModel, "[Models](#cfn-bedrock-intelligentpromptrouter-models)" : [ PromptRouterTargetModel, ... ], "[PromptRouterName](#cfn-bedrock-intelligentpromptrouter-promptroutername)" : String, "[RoutingCriteria](#cfn-bedrock-intelligentpromptrouter-routingcriteria)" : RoutingCriteria, "[Tags](#cfn-bedrock-intelligentpromptrouter-tags)" : [ Tag, ... ] } } ``` ### YAML ``` Type: AWS::Bedrock::IntelligentPromptRouter Properties: [Description](#cfn-bedrock-intelligentpromptrouter-description): String [FallbackModel](#cfn-bedrock-intelligentpromptrouter-fallbackmodel): PromptRouterTargetModel [Models](#cfn-bedrock-intelligentpromptrouter-models): - PromptRouterTargetModel [PromptRouterName](#cfn-bedrock-intelligentpromptrouter-promptroutername): String [RoutingCriteria](#cfn-bedrock-intelligentpromptrouter-routingcriteria): RoutingCriteria [Tags](#cfn-bedrock-intelligentpromptrouter-tags): - Tag ``` ## Properties `Description` An optional description of the prompt router to help identify its purpose. *Required*: No *Type*: String *Pattern*: `^([0-9a-zA-Z:.][ _-]?)+$` *Minimum*: `1` *Maximum*: `200` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `FallbackModel` The default model to use when the routing criteria is not met. *Required*: Yes *Type*: [PromptRouterTargetModel](aws-properties-bedrock-intelligentpromptrouter-promptroutertargetmodel.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Models` A list of foundation models that the prompt router can route requests to. At least one model must be specified. *Required*: Yes *Type*: Array of [PromptRouterTargetModel](aws-properties-bedrock-intelligentpromptrouter-promptroutertargetmodel.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `PromptRouterName` The name of the prompt router. The name must be unique within your AWS account in the current region. *Required*: Yes *Type*: String *Pattern*: `^([0-9a-zA-Z][ _-]?)+$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `RoutingCriteria` Routing criteria for a prompt router. *Required*: Yes *Type*: [RoutingCriteria](aws-properties-bedrock-intelligentpromptrouter-routingcriteria.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Tags` An array of key-value pairs to apply to this resource as tags. You can use tags to categorize and manage your AWS resources. *Required*: No *Type*: Array of [Tag](aws-properties-bedrock-intelligentpromptrouter-tag.md) *Minimum*: `0` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the intelligent prompt router information. ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `CreatedAt` Indicates the time that the prompt router was created. `PromptRouterArn` The Amazon Resource Name (ARN) of the prompt router. `Status` The router's status. `Type` The router's type. `UpdatedAt` When the router was updated. # AWS::Bedrock::IntelligentPromptRouter PromptRouterTargetModel The target model for a prompt router. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ModelArn](#cfn-bedrock-intelligentpromptrouter-promptroutertargetmodel-modelarn)" : String } ``` ### YAML ``` [ModelArn](#cfn-bedrock-intelligentpromptrouter-promptroutertargetmodel-modelarn): String ``` ## Properties `ModelArn` The target model's ARN. *Required*: Yes *Type*: String *Pattern*: `(^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}::foundation-model/[a-z0-9-]{1,63}[.]{1}([a-z0-9-]{1,63}[.]){0,2}[a-z0-9-]{1,63}([:][a-z0-9-]{1,63}){0,2})|(^arn:aws(|-us-gov|-cn|-iso|-iso-b):bedrock:(|[0-9a-z-]{0,20}):(|[0-9]{12}):(inference-profile|application-inference-profile)/[a-zA-Z0-9-:.]+)$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::IntelligentPromptRouter RoutingCriteria Routing criteria for a prompt router. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ResponseQualityDifference](#cfn-bedrock-intelligentpromptrouter-routingcriteria-responsequalitydifference)" : Number } ``` ### YAML ``` [ResponseQualityDifference](#cfn-bedrock-intelligentpromptrouter-routingcriteria-responsequalitydifference): Number ``` ## Properties `ResponseQualityDifference` The criteria's response quality difference. *Required*: Yes *Type*: Number *Minimum*: `0` *Maximum*: `100` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::IntelligentPromptRouter Tag An array of key-value pairs to apply to this resource as tags. You can use tags to categorize and manage your AWS resources. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-bedrock-intelligentpromptrouter-tag-key)" : String, "[Value](#cfn-bedrock-intelligentpromptrouter-tag-value)" : String } ``` ### YAML ``` [Key](#cfn-bedrock-intelligentpromptrouter-tag-key): String [Value](#cfn-bedrock-intelligentpromptrouter-tag-value): String ``` ## Properties `Key` The tag's key. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value associated with a tag. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::KnowledgeBase Specifies a knowledge base as a resource in a top-level template. Minimally, you must specify the following properties: + Name – Specify a name for the knowledge base. + RoleArn – Specify the Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base. For more information, see [Create a service role for Knowledge base for Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/kb-permissions.html). + KnowledgeBaseConfiguration – Specify the embeddings configuration of the knowledge base. The following sub-properties are required: + Type – Specify the value `VECTOR`. + StorageConfiguration – Specify information about the vector store in which the data source is stored. The following sub-properties are required: + Type – Specify the vector store service that you are using. **Note** Redis Enterprise Cloud vector stores are currently unsupported in CloudFormation. For more information about using knowledge bases in Amazon Bedrock, see [Knowledge base for Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base.html). See the **Properties** section below for descriptions of both the required and optional properties. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::Bedrock::KnowledgeBase", "Properties" : { "[Description](#cfn-bedrock-knowledgebase-description)" : String, "[KnowledgeBaseConfiguration](#cfn-bedrock-knowledgebase-knowledgebaseconfiguration)" : KnowledgeBaseConfiguration, "[Name](#cfn-bedrock-knowledgebase-name)" : String, "[RoleArn](#cfn-bedrock-knowledgebase-rolearn)" : String, "[StorageConfiguration](#cfn-bedrock-knowledgebase-storageconfiguration)" : StorageConfiguration, "[Tags](#cfn-bedrock-knowledgebase-tags)" : {Key: Value, ...} } } ``` ### YAML ``` Type: AWS::Bedrock::KnowledgeBase Properties: [Description](#cfn-bedrock-knowledgebase-description): String [KnowledgeBaseConfiguration](#cfn-bedrock-knowledgebase-knowledgebaseconfiguration): KnowledgeBaseConfiguration [Name](#cfn-bedrock-knowledgebase-name): String [RoleArn](#cfn-bedrock-knowledgebase-rolearn): String [StorageConfiguration](#cfn-bedrock-knowledgebase-storageconfiguration): StorageConfiguration [Tags](#cfn-bedrock-knowledgebase-tags): Key: Value ``` ## Properties `Description` The description of the knowledge base associated with the inline agent. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `KnowledgeBaseConfiguration` Contains details about the embeddings configuration of the knowledge base. *Required*: Yes *Type*: [KnowledgeBaseConfiguration](aws-properties-bedrock-knowledgebase-knowledgebaseconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the knowledge base. *Required*: Yes *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `RoleArn` The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base. *Required*: Yes *Type*: String *Pattern*: `^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StorageConfiguration` Contains details about the storage configuration of the knowledge base. *Required*: No *Type*: [StorageConfiguration](aws-properties-bedrock-knowledgebase-storageconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Tags` Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources: + [Tag naming limits and requirements](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions) + [Tagging best practices](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices) *Required*: No *Type*: Object of String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the knowledge base ID. For example, `{ "Ref": "myKnowledgeBase" }` could return the value `"KB12345678"`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `CreatedAt` The time the knowledge base was created. `FailureReasons` A list of reasons that the API operation on the knowledge base failed. `KnowledgeBaseArn` The Amazon Resource Name (ARN) of the knowledge base. `KnowledgeBaseId` The unique identifier for a knowledge base associated with the inline agent. `Status` The status of the knowledge base. `UpdatedAt` The time the knowledge base was last updated. ## Examples The following examples provide example templates for creating knowledge bases in different vector stores. **Note** Redis Enterprise Cloud vector stores are currently unsupported in CloudFormation. **Topics** + [Create a knowledge base in an Amazon OpenSearch Serverless vector collection.](#aws-resource-bedrock-knowledgebase--examples--Create_a_knowledge_base_in_an_Amazon_OpenSearch_Serverless_vector_collection.) + [Create a knowledge base in an Amazon Aurora database cluster.](#aws-resource-bedrock-knowledgebase--examples--Create_a_knowledge_base_in_an_Amazon_Aurora_database_cluster.) + [Create a knowledge base in a Pinecone index.](#aws-resource-bedrock-knowledgebase--examples--Create_a_knowledge_base_in_a_Pinecone_index.) ### Create a knowledge base in an Amazon OpenSearch Serverless vector collection. The following example creates a knowledge base in a vector index within an Amazon OpenSearch Serverless vector collection. #### YAML ``` AWSTemplateFormatVersion: "2010-09-09" Description: A sample template for Knowledge base with Amazon Opensearch Serverless vector database. Parameters: KnowledgeBaseName: Type: String Description: The name of the knowledge base. KnowledgeBaseDescription: Type: String Description: The description of the knowledge base. DataSourceName: Type: String Description: The name of the data source. DataSourceDescription: Type: String Description: The description of the data source. Resources: KnowledgeBaseWithAoss: Type: AWS::Bedrock::KnowledgeBase Properties: Name: !Ref KnowledgeBaseName Description: !Ref KnowledgeBaseDescription RoleArn: "arn:aws:iam::123456789012:role/cfn-local-test-role" KnowledgeBaseConfiguration: Type: "VECTOR" VectorKnowledgeBaseConfiguration: EmbeddingModelArn: !Sub "arn:${AWS::Partition}:bedrock:${AWS::Region}::foundation-model/amazon.titan-embed-text-v1" StorageConfiguration: Type: "OPENSEARCH_SERVERLESS" OpensearchServerlessConfiguration: CollectionArn: "arn:aws:aoss:us-west-2:123456789012:collection/abcdefghij1234567890" VectorIndexName: "cfn-test-index" FieldMapping: VectorField: "cfn-test-vector-field" TextField: "text" MetadataField: "metadata" SampleDataSource: Type: AWS::Bedrock::DataSource Properties: KnowledgeBaseId: !Ref KnowledgeBaseWithAoss Name: !Ref DataSourceName Description: !Ref DataSourceDescription DataSourceConfiguration: Type: "S3" S3Configuration: BucketArn: "arn:aws:s3:::kb-test-aws" InclusionPrefixes: ["aws-overview.pdf"] ``` #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Parameters": { "KnowledgeBaseName": { "Description": "The name of the knowledge base.", "Type": "String" }, "KnowledgeBaseDescription": { "Description": "The description of the knowledge base.", "Type": "String" }, "DataSourceName": { "Description": "The name of the data source.", "Type": "String" }, "DataSourceDescription": { "Description": "The description of the data source.", "Type": "String" } }, "Resources": { "KnowledgeBaseWithAoss": { "Type": "AWS::Bedrock::KnowledgeBase", "Properties": { "Name": { "Ref": "KnowledgeBaseName" }, "Description": { "Ref": "KnowledgeBaseDescription" }, "RoleArn": "arn:aws:iam::123456789012:role/cfn-local-test-role", "KnowledgeBaseConfiguration": { "Type": "VECTOR", "VectorKnowledgeBaseConfiguration": { "EmbeddingModelArn": { "Fn::Sub": "arn:${AWS::Partition}:bedrock:${AWS::Region}::foundation-model/amazon.titan-embed-text-v1" } } }, "StorageConfiguration": { "Type": "OPENSEARCH_SERVERLESS", "OpensearchServerlessConfiguration": { "CollectionArn": "arn:aws:aoss:us-west-2:123456789012:collection/abcdefghij1234567890", "VectorIndexName": "cfn-test-index", "FieldMapping": { "VectorField": "cfn-test-vector-field", "TextField": "text", "MetadataField": "metadata" } } } } }, "SampleDataSource": { "Type": "AWS::Bedrock::DataSource", "Properties": { "KnowledgeBaseId": { "Ref": "KnowledgeBaseWithAoss" }, "Name": { "Ref": "DataSourceName" }, "Description": { "Ref": "DataSourceDescription" }, "DataSourceConfiguration": { "Type": "S3", "S3Configuration": { "BucketArn": "arn:aws:s3:::kb-test-aws", "InclusionPrefixes": ["aws-overview.pdf"] } } } } } } ``` ### Create a knowledge base in an Amazon Aurora database cluster. The following example creates a knowledge base in a vector index within an Amazon Aurora database cluster. #### YAML ``` AWSTemplateFormatVersion: "2010-09-09" Description: A sample template for Knowledge base with RDS vector database. Parameters: KnowledgeBaseName: Type: String Description: The name of the knowledge base. KnolwedgeBaseDescription: Type: String Description: The description of the knowledge base. DataSourceName: Type: String Description: The name of the data source. DataSourceDescription: Type: String Description: The description of the data source. Resources: KnowledgeBaseWithRDS: Type: AWS::Bedrock::KnowledgeBase Properties: Name: !Ref KnowledgeBaseName Description: !Ref KnolwedgeBaseDescription RoleArn: "arn:aws:iam::123456789012:role/cfn-local-test-role" KnowledgeBaseConfiguration: Type: "VECTOR" VectorKnowledgeBaseConfiguration: EmbeddingModelArn: !Sub "arn:${AWS::Partition}:bedrock:${AWS::Region}::foundation-model/amazon.titan-embed-text-v1" StorageConfiguration: Type: "RDS" RdsConfiguration: ResourceArn: !Sub "arn:${AWS::Partition}:rds:${AWS::Region}:${AWS::AccountId}:cluster:ct-kb-cluster" CredentialsSecretArn: !Sub "arn:aws:secretsmanager:${AWS::Region}:${AWS::AccountId}:secret:rds!cluster-4f5961a1-ebd5-4887-818f-0f902e945e04-eFxmC6" DatabaseName: "postgres" TableName: "bedrock_integration.bedrock_kb" FieldMapping: VectorField: "embedding" TextField: "chunks" MetadataField: "metadata" PrimaryKeyField: "id" SampleDataSource: Type: AWS::Bedrock::DataSource Properties: KnowledgeBaseId: !Ref KnowledgeBaseWithRDS Name: !Ref DataSourceName Description: !Ref DataSourceDescription DataSourceConfiguration: Type: "S3" S3Configuration: BucketArn: "arn:aws:s3:::kb-test-aws" InclusionPrefixes: ["aws-overview.pdf"] ``` #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Parameters": { "KnowledgeBaseName": { "Description": "The name of the knowledge base.", "Type": "String" }, "KnolwedgeBaseDescription": { "Description": "The description of the knowledge base.", "Type": "String" }, "DataSourceName": { "Description": "The name of the data source.", "Type": "String" }, "DataSourceDescription": { "Description": "The description of the data source.", "Type": "String" } }, "Resources": { "KnowledgeBaseWithRds": { "Type": "AWS::Bedrock::KnowledgeBase", "Properties": { "Name": { "Ref": "KnowledgeBaseName" }, "Description": { "Ref": "KnolwedgeBaseDescription" }, "RoleArn": "arn:aws:iam::123456789012:role/cfn-local-test-role", "KnowledgeBaseConfiguration": { "Type": "VECTOR", "VectorKnowledgeBaseConfiguration": { "EmbeddingModelArn": { "Fn::Sub": "arn:${AWS::Partition}:bedrock:${AWS::Region}::foundation-model/amazon.titan-embed-text-v1" } } }, "StorageConfiguration": { "Type": "RDS", "RdsConfiguration": { "ResourceArn": { "Fn::Sub": "arn:${AWS::Partition}:rds:${AWS::Region}:${AWS::AccountId}:cluster:knowledgebase-cluster" }, "CredentialsSecretArn": { "Fn::Sub": "arn:${AWS::Partition}:secretsmanager:${AWS::Region}:${AWS::AccountId}:secret:rds!cluster-4f5961a1-ebd5-4887-818f-0f902e945e04-eFxmC6" }, "DatabaseName": "postgres", "TableName": "bedrock_integration.bedrock_kb", "FieldMapping": { "VectorField": "vectorKey", "TextField": "text", "MetadataField": "metadata", "PrimaryKeyField": "id" } } } } }, "SampleDataSource": { "Type": "AWS::Bedrock::DataSource", "Properties": { "KnowledgeBaseId": { "Ref": "KnowledgeBaseWithRds" }, "Name": { "Ref": "DataSourceName" }, "Description": { "Ref": "DataSourceDescription" }, "DataSourceConfiguration": { "Type": "S3", "S3Configuration": { "BucketArn": "arn:aws:s3:::kb-test-aws", "InclusionPrefixes": ["aws-overview.pdf"] } } } } } } ``` ### Create a knowledge base in a Pinecone index. The following example creates a knowledge base in a Pinecone index. #### YAML ``` AWSTemplateFormatVersion: "2010-09-09" Description: A sample template for Knowledge base with Pinecone vector database. Parameters: KnowledgeBaseName: Type: String Description: The name of the knowledge base. KnowledgeBaseDescription: Type: String Description: The description of the knowledge base. DataSourceName: Type: String Description: The name of the data source. DataSourceDescription: Type: String Description: The description of the data source. Resources: KnowledgeBaseWithPinecone: Type: AWS::Bedrock::KnowledgeBase Properties: Name: !Ref KnowledgeBaseName Description: !Ref KnowledgeBaseDescription RoleArn: "arn:aws:iam::123456789012:role/cfn-local-test-role" KnowledgeBaseConfiguration: Type: "VECTOR" VectorKnowledgeBaseConfiguration: EmbeddingModelArn: !Sub "arn:${AWS::Partition}:bedrock:${AWS::Region}::foundation-model/amazon.titan-embed-text-v1" StorageConfiguration: Type: "PINECONE" PineconeConfiguration: ConnectionString: "https://xxxx.pinecone.io>" CredentialsSecretArn: "arn:aws:secretsmanager:us-west-2:123456789012:secret:pinecone-secret-abc123" Namespace: "kb-namespace" FieldMapping: TextField: "text" MetadataField: "metadata" SampleDataSource: Type: AWS::Bedrock::DataSource Properties: KnowledgeBaseId: !Ref KnowledgeBaseWithPinecone Name: !Ref DataSourceName Description: !Ref DataSourceDescription DataSourceConfiguration: Type: "S3" S3Configuration: BucketArn: "arn:aws:s3:::kb-test-aws" InclusionPrefixes: ["aws-overview.pdf"] ``` #### JSON ``` { "AWSTemplateFormatVersion": "2010-09-09", "Parameters": { "KnowledgeBaseName": { "Description": "The name of the knowledge base.", "Type": "String" }, "KnowledgeBaseDescription": { "Description": "The description of the knowledge base.", "Type": "String" }, "DataSourceName": { "Description": "The name of the data source.", "Type": "String" }, "DataSourceDescription": { "Description": "The description of the data source.", "Type": "String" } }, "Resources": { "KnowledgeBaseWithPinecone": { "Type": "AWS::Bedrock::KnowledgeBase", "Properties": { "Name": { "Ref": "KnowledgeBaseName" }, "Description": { "Ref": "KnowledgeBaseDescription" }, "RoleArn": "arn:aws:iam::123456789012:role/cfn-local-test-role", "KnowledgeBaseConfiguration": { "Type": "VECTOR", "VectorKnowledgeBaseConfiguration": { "EmbeddingModelArn": { "Fn::Sub": "arn:${AWS::Partition}:bedrock:${AWS::Region}::foundation-model/amazon.titan-embed-text-v1" } } }, "StorageConfiguration": { "Type": "PINECONE", "PineconeConfiguration": { "ConnectionString": "https://xxxx.pinecone.io", "CredentialsSecretArn": "arn:aws:secretsmanager:us-west-2:123456789012:secret:pinecone-secret-abc123", "Namespace": "kb-namespace", "FieldMapping": { "TextField": "text", "MetadataField": "metadata" } } } } }, "SampleDataSource": { "Type": "AWS::Bedrock::DataSource", "Properties": { "KnowledgeBaseId": { "Ref": "KnowledgeBaseWithPinecone" }, "Name": { "Ref": "DataSourceName" }, "Description": { "Ref": "DataSourceDescription" }, "DataSourceConfiguration": { "Type": "S3", "S3Configuration": { "BucketArn": "arn:aws:s3:::kb-test-aws", "InclusionPrefixes": ["aws-overview.pdf"] } } } } } } ``` # AWS::Bedrock::KnowledgeBase AudioConfiguration Configuration settings for processing audio content in multimodal knowledge bases. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SegmentationConfiguration](#cfn-bedrock-knowledgebase-audioconfiguration-segmentationconfiguration)" : AudioSegmentationConfiguration } ``` ### YAML ``` [SegmentationConfiguration](#cfn-bedrock-knowledgebase-audioconfiguration-segmentationconfiguration): AudioSegmentationConfiguration ``` ## Properties `SegmentationConfiguration` Configuration for segmenting audio content during processing. *Required*: Yes *Type*: [AudioSegmentationConfiguration](aws-properties-bedrock-knowledgebase-audiosegmentationconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase AudioSegmentationConfiguration Configuration for segmenting audio content during multimodal knowledge base ingestion. Determines how audio files are divided into chunks for processing. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[FixedLengthDuration](#cfn-bedrock-knowledgebase-audiosegmentationconfiguration-fixedlengthduration)" : Integer } ``` ### YAML ``` [FixedLengthDuration](#cfn-bedrock-knowledgebase-audiosegmentationconfiguration-fixedlengthduration): Integer ``` ## Properties `FixedLengthDuration` The duration in seconds for each audio segment. Audio files will be divided into chunks of this length for processing. *Required*: Yes *Type*: Integer *Minimum*: `1` *Maximum*: `30` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase BedrockEmbeddingModelConfiguration The vector configuration details for the Bedrock embeddings model. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Audio](#cfn-bedrock-knowledgebase-bedrockembeddingmodelconfiguration-audio)" : [ AudioConfiguration, ... ], "[Dimensions](#cfn-bedrock-knowledgebase-bedrockembeddingmodelconfiguration-dimensions)" : Integer, "[EmbeddingDataType](#cfn-bedrock-knowledgebase-bedrockembeddingmodelconfiguration-embeddingdatatype)" : String, "[Video](#cfn-bedrock-knowledgebase-bedrockembeddingmodelconfiguration-video)" : [ VideoConfiguration, ... ] } ``` ### YAML ``` [Audio](#cfn-bedrock-knowledgebase-bedrockembeddingmodelconfiguration-audio): - AudioConfiguration [Dimensions](#cfn-bedrock-knowledgebase-bedrockembeddingmodelconfiguration-dimensions): Integer [EmbeddingDataType](#cfn-bedrock-knowledgebase-bedrockembeddingmodelconfiguration-embeddingdatatype): String [Video](#cfn-bedrock-knowledgebase-bedrockembeddingmodelconfiguration-video): - VideoConfiguration ``` ## Properties `Audio` Configuration settings for processing audio content in multimodal knowledge bases. *Required*: No *Type*: Array of [AudioConfiguration](aws-properties-bedrock-knowledgebase-audioconfiguration.md) *Minimum*: `1` *Maximum*: `1` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Dimensions` The dimensions details for the vector configuration used on the Bedrock embeddings model. *Required*: No *Type*: Integer *Minimum*: `0` *Maximum*: `4096` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EmbeddingDataType` The data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Floating-point (float32) is the default data type, and is supported by most models for vector embeddings. See [Supported embeddings models](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-supported.html) for information on the available models and their vector data types. *Required*: No *Type*: String *Allowed values*: `FLOAT32 | BINARY` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Video` Configuration settings for processing video content in multimodal knowledge bases. *Required*: No *Type*: Array of [VideoConfiguration](aws-properties-bedrock-knowledgebase-videoconfiguration.md) *Minimum*: `1` *Maximum*: `1` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase CuratedQuery Contains configurations for a query, each of which defines information about example queries to help the query engine generate appropriate SQL queries. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[NaturalLanguage](#cfn-bedrock-knowledgebase-curatedquery-naturallanguage)" : String, "[Sql](#cfn-bedrock-knowledgebase-curatedquery-sql)" : String } ``` ### YAML ``` [NaturalLanguage](#cfn-bedrock-knowledgebase-curatedquery-naturallanguage): String [Sql](#cfn-bedrock-knowledgebase-curatedquery-sql): String ``` ## Properties `NaturalLanguage` An example natural language query. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Sql` The SQL equivalent of the natural language query. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `1000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::KnowledgeBase EmbeddingModelConfiguration The configuration details for the embeddings model. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[BedrockEmbeddingModelConfiguration](#cfn-bedrock-knowledgebase-embeddingmodelconfiguration-bedrockembeddingmodelconfiguration)" : BedrockEmbeddingModelConfiguration } ``` ### YAML ``` [BedrockEmbeddingModelConfiguration](#cfn-bedrock-knowledgebase-embeddingmodelconfiguration-bedrockembeddingmodelconfiguration): BedrockEmbeddingModelConfiguration ``` ## Properties `BedrockEmbeddingModelConfiguration` The vector configuration details on the Bedrock embeddings model. *Required*: No *Type*: [BedrockEmbeddingModelConfiguration](aws-properties-bedrock-knowledgebase-bedrockembeddingmodelconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase KendraKnowledgeBaseConfiguration Settings for an Amazon Kendra knowledge base. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[KendraIndexArn](#cfn-bedrock-knowledgebase-kendraknowledgebaseconfiguration-kendraindexarn)" : String } ``` ### YAML ``` [KendraIndexArn](#cfn-bedrock-knowledgebase-kendraknowledgebaseconfiguration-kendraindexarn): String ``` ## Properties `KendraIndexArn` The ARN of the Amazon Kendra index. *Required*: Yes *Type*: String *Pattern*: `^arn:aws(|-cn|-us-gov):kendra:[a-z0-9-]{1,20}:([0-9]{12}|):index/([a-zA-Z0-9][a-zA-Z0-9-]{35}|[a-zA-Z0-9][a-zA-Z0-9-]{35}-[a-zA-Z0-9][a-zA-Z0-9-]{35})$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase KnowledgeBaseConfiguration Configurations to apply to a knowledge base attached to the agent during query. For more information, see [Knowledge base retrieval configurations](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html#session-state-kb). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[KendraKnowledgeBaseConfiguration](#cfn-bedrock-knowledgebase-knowledgebaseconfiguration-kendraknowledgebaseconfiguration)" : KendraKnowledgeBaseConfiguration, "[SqlKnowledgeBaseConfiguration](#cfn-bedrock-knowledgebase-knowledgebaseconfiguration-sqlknowledgebaseconfiguration)" : SqlKnowledgeBaseConfiguration, "[Type](#cfn-bedrock-knowledgebase-knowledgebaseconfiguration-type)" : String, "[VectorKnowledgeBaseConfiguration](#cfn-bedrock-knowledgebase-knowledgebaseconfiguration-vectorknowledgebaseconfiguration)" : VectorKnowledgeBaseConfiguration } ``` ### YAML ``` [KendraKnowledgeBaseConfiguration](#cfn-bedrock-knowledgebase-knowledgebaseconfiguration-kendraknowledgebaseconfiguration): KendraKnowledgeBaseConfiguration [SqlKnowledgeBaseConfiguration](#cfn-bedrock-knowledgebase-knowledgebaseconfiguration-sqlknowledgebaseconfiguration): SqlKnowledgeBaseConfiguration [Type](#cfn-bedrock-knowledgebase-knowledgebaseconfiguration-type): String [VectorKnowledgeBaseConfiguration](#cfn-bedrock-knowledgebase-knowledgebaseconfiguration-vectorknowledgebaseconfiguration): VectorKnowledgeBaseConfiguration ``` ## Properties `KendraKnowledgeBaseConfiguration` Settings for an Amazon Kendra knowledge base. *Required*: No *Type*: [KendraKnowledgeBaseConfiguration](aws-properties-bedrock-knowledgebase-kendraknowledgebaseconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `SqlKnowledgeBaseConfiguration` Specifies configurations for a knowledge base connected to an SQL database. *Required*: No *Type*: [SqlKnowledgeBaseConfiguration](aws-properties-bedrock-knowledgebase-sqlknowledgebaseconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The type of data that the data source is converted into for the knowledge base. *Required*: Yes *Type*: String *Allowed values*: `VECTOR | KENDRA | SQL` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `VectorKnowledgeBaseConfiguration` Contains details about the model that's used to convert the data source into vector embeddings. *Required*: No *Type*: [VectorKnowledgeBaseConfiguration](aws-properties-bedrock-knowledgebase-vectorknowledgebaseconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase MongoDbAtlasConfiguration Contains details about the storage configuration of the knowledge base in MongoDB Atlas. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CollectionName](#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-collectionname)" : String, "[CredentialsSecretArn](#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-credentialssecretarn)" : String, "[DatabaseName](#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-databasename)" : String, "[Endpoint](#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-endpoint)" : String, "[EndpointServiceName](#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-endpointservicename)" : String, "[FieldMapping](#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-fieldmapping)" : MongoDbAtlasFieldMapping, "[TextIndexName](#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-textindexname)" : String, "[VectorIndexName](#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-vectorindexname)" : String } ``` ### YAML ``` [CollectionName](#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-collectionname): String [CredentialsSecretArn](#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-credentialssecretarn): String [DatabaseName](#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-databasename): String [Endpoint](#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-endpoint): String [EndpointServiceName](#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-endpointservicename): String [FieldMapping](#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-fieldmapping): MongoDbAtlasFieldMapping [TextIndexName](#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-textindexname): String [VectorIndexName](#cfn-bedrock-knowledgebase-mongodbatlasconfiguration-vectorindexname): String ``` ## Properties `CollectionName` The collection name of the knowledge base in MongoDB Atlas. *Required*: Yes *Type*: String *Pattern*: `^.*$` *Maximum*: `63` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `CredentialsSecretArn` The Amazon Resource Name (ARN) of the secret that you created in AWS Secrets Manager that contains user credentials for your MongoDB Atlas cluster. *Required*: Yes *Type*: String *Pattern*: `^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `DatabaseName` The database name in your MongoDB Atlas cluster for your knowledge base. *Required*: Yes *Type*: String *Pattern*: `^.*$` *Maximum*: `63` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Endpoint` The endpoint URL of your MongoDB Atlas cluster for your knowledge base. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_-]+\.[a-zA-Z0-9_-]+\.mongodb\.net$` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EndpointServiceName` The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster. *Required*: No *Type*: String *Pattern*: `^(?:arn:aws(?:-us-gov|-cn|-iso|-iso-[a-z])*:.+:.*:\d+:.+/.+$|[a-zA-Z0-9*]+[a-zA-Z0-9._-]*)$` *Maximum*: `255` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `FieldMapping` Contains the names of the fields to which to map information about the vector store. *Required*: Yes *Type*: [MongoDbAtlasFieldMapping](aws-properties-bedrock-knowledgebase-mongodbatlasfieldmapping.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `TextIndexName` The name of the text search index in the MongoDB collection. This is required for using the hybrid search feature. *Required*: No *Type*: String *Pattern*: `^.*$` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `VectorIndexName` The name of the MongoDB Atlas vector search index. *Required*: Yes *Type*: String *Pattern*: `^.*$` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase MongoDbAtlasFieldMapping Contains the names of the fields to which to map information about the vector store. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MetadataField](#cfn-bedrock-knowledgebase-mongodbatlasfieldmapping-metadatafield)" : String, "[TextField](#cfn-bedrock-knowledgebase-mongodbatlasfieldmapping-textfield)" : String, "[VectorField](#cfn-bedrock-knowledgebase-mongodbatlasfieldmapping-vectorfield)" : String } ``` ### YAML ``` [MetadataField](#cfn-bedrock-knowledgebase-mongodbatlasfieldmapping-metadatafield): String [TextField](#cfn-bedrock-knowledgebase-mongodbatlasfieldmapping-textfield): String [VectorField](#cfn-bedrock-knowledgebase-mongodbatlasfieldmapping-vectorfield): String ``` ## Properties `MetadataField` The name of the field in which Amazon Bedrock stores metadata about the vector store. *Required*: Yes *Type*: String *Pattern*: `^.*$` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `TextField` The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose. *Required*: Yes *Type*: String *Pattern*: `^.*$` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `VectorField` The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources. *Required*: Yes *Type*: String *Pattern*: `^.*$` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase NeptuneAnalyticsConfiguration Contains details about the storage configuration of the knowledge base in Amazon Neptune Analytics. For more information, see [Create a vector index in Amazon Neptune Analytics](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-neptune.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[FieldMapping](#cfn-bedrock-knowledgebase-neptuneanalyticsconfiguration-fieldmapping)" : NeptuneAnalyticsFieldMapping, "[GraphArn](#cfn-bedrock-knowledgebase-neptuneanalyticsconfiguration-grapharn)" : String } ``` ### YAML ``` [FieldMapping](#cfn-bedrock-knowledgebase-neptuneanalyticsconfiguration-fieldmapping): NeptuneAnalyticsFieldMapping [GraphArn](#cfn-bedrock-knowledgebase-neptuneanalyticsconfiguration-grapharn): String ``` ## Properties `FieldMapping` Contains the names of the fields to which to map information about the vector store. *Required*: Yes *Type*: [NeptuneAnalyticsFieldMapping](aws-properties-bedrock-knowledgebase-neptuneanalyticsfieldmapping.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `GraphArn` The Amazon Resource Name (ARN) of the Neptune Analytics vector store. *Required*: Yes *Type*: String *Pattern*: `^arn:aws(|-cn|-us-gov):neptune-graph:[a-zA-Z0-9-]*:[0-9]{12}:graph\/g-[a-zA-Z0-9]{10}$` *Minimum*: `1` *Maximum*: `255` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase NeptuneAnalyticsFieldMapping Contains the names of the fields to which to map information about the vector store. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MetadataField](#cfn-bedrock-knowledgebase-neptuneanalyticsfieldmapping-metadatafield)" : String, "[TextField](#cfn-bedrock-knowledgebase-neptuneanalyticsfieldmapping-textfield)" : String } ``` ### YAML ``` [MetadataField](#cfn-bedrock-knowledgebase-neptuneanalyticsfieldmapping-metadatafield): String [TextField](#cfn-bedrock-knowledgebase-neptuneanalyticsfieldmapping-textfield): String ``` ## Properties `MetadataField` The name of the field in which Amazon Bedrock stores metadata about the vector store. *Required*: Yes *Type*: String *Pattern*: `^.*$` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `TextField` The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose. *Required*: Yes *Type*: String *Pattern*: `^.*$` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase OpenSearchManagedClusterConfiguration Contains details about the Managed Cluster configuration of the knowledge base in Amazon OpenSearch Service. For more information, see [Create a vector index in OpenSearch Managed Cluster](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-osm.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DomainArn](#cfn-bedrock-knowledgebase-opensearchmanagedclusterconfiguration-domainarn)" : String, "[DomainEndpoint](#cfn-bedrock-knowledgebase-opensearchmanagedclusterconfiguration-domainendpoint)" : String, "[FieldMapping](#cfn-bedrock-knowledgebase-opensearchmanagedclusterconfiguration-fieldmapping)" : OpenSearchManagedClusterFieldMapping, "[VectorIndexName](#cfn-bedrock-knowledgebase-opensearchmanagedclusterconfiguration-vectorindexname)" : String } ``` ### YAML ``` [DomainArn](#cfn-bedrock-knowledgebase-opensearchmanagedclusterconfiguration-domainarn): String [DomainEndpoint](#cfn-bedrock-knowledgebase-opensearchmanagedclusterconfiguration-domainendpoint): String [FieldMapping](#cfn-bedrock-knowledgebase-opensearchmanagedclusterconfiguration-fieldmapping): OpenSearchManagedClusterFieldMapping [VectorIndexName](#cfn-bedrock-knowledgebase-opensearchmanagedclusterconfiguration-vectorindexname): String ``` ## Properties `DomainArn` The Amazon Resource Name (ARN) of the OpenSearch domain. *Required*: Yes *Type*: String *Pattern*: `^arn:aws(-cn|-us-gov|-eusc|-iso(-[b-f])?)?:es:([a-z]{2,}-){2,}\d:\d{12}:domain/[a-z][a-z0-9-]{3,28}$` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `DomainEndpoint` The endpoint URL the OpenSearch domain. *Required*: Yes *Type*: String *Pattern*: `^https://.*$` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `FieldMapping` Contains the names of the fields to which to map information about the vector store. *Required*: Yes *Type*: [OpenSearchManagedClusterFieldMapping](aws-properties-bedrock-knowledgebase-opensearchmanagedclusterfieldmapping.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `VectorIndexName` The name of the vector store. *Required*: Yes *Type*: String *Pattern*: `^(?![\-_+.])[a-z0-9][a-z0-9\-_\.]*$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase OpenSearchManagedClusterFieldMapping Contains the names of the fields to which to map information about the vector store. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MetadataField](#cfn-bedrock-knowledgebase-opensearchmanagedclusterfieldmapping-metadatafield)" : String, "[TextField](#cfn-bedrock-knowledgebase-opensearchmanagedclusterfieldmapping-textfield)" : String, "[VectorField](#cfn-bedrock-knowledgebase-opensearchmanagedclusterfieldmapping-vectorfield)" : String } ``` ### YAML ``` [MetadataField](#cfn-bedrock-knowledgebase-opensearchmanagedclusterfieldmapping-metadatafield): String [TextField](#cfn-bedrock-knowledgebase-opensearchmanagedclusterfieldmapping-textfield): String [VectorField](#cfn-bedrock-knowledgebase-opensearchmanagedclusterfieldmapping-vectorfield): String ``` ## Properties `MetadataField` The name of the field in which Amazon Bedrock stores metadata about the vector store. *Required*: Yes *Type*: String *Pattern*: `^.*$` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `TextField` The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose. *Required*: Yes *Type*: String *Pattern*: `^.*$` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `VectorField` The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources. *Required*: Yes *Type*: String *Pattern*: `^.*$` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase OpenSearchServerlessConfiguration Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service. For more information, see [Create a vector index in Amazon OpenSearch Service](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-oss.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CollectionArn](#cfn-bedrock-knowledgebase-opensearchserverlessconfiguration-collectionarn)" : String, "[FieldMapping](#cfn-bedrock-knowledgebase-opensearchserverlessconfiguration-fieldmapping)" : OpenSearchServerlessFieldMapping, "[VectorIndexName](#cfn-bedrock-knowledgebase-opensearchserverlessconfiguration-vectorindexname)" : String } ``` ### YAML ``` [CollectionArn](#cfn-bedrock-knowledgebase-opensearchserverlessconfiguration-collectionarn): String [FieldMapping](#cfn-bedrock-knowledgebase-opensearchserverlessconfiguration-fieldmapping): OpenSearchServerlessFieldMapping [VectorIndexName](#cfn-bedrock-knowledgebase-opensearchserverlessconfiguration-vectorindexname): String ``` ## Properties `CollectionArn` The Amazon Resource Name (ARN) of the OpenSearch Service vector store. *Required*: Yes *Type*: String *Pattern*: `^arn:aws(|-cn|-us-gov|-iso):aoss:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:collection/[a-z0-9-]{3,32}$` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `FieldMapping` Contains the names of the fields to which to map information about the vector store. *Required*: Yes *Type*: [OpenSearchServerlessFieldMapping](aws-properties-bedrock-knowledgebase-opensearchserverlessfieldmapping.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `VectorIndexName` The name of the vector store. *Required*: Yes *Type*: String *Pattern*: `^.*$` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase OpenSearchServerlessFieldMapping Contains the names of the fields to which to map information about the vector store. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MetadataField](#cfn-bedrock-knowledgebase-opensearchserverlessfieldmapping-metadatafield)" : String, "[TextField](#cfn-bedrock-knowledgebase-opensearchserverlessfieldmapping-textfield)" : String, "[VectorField](#cfn-bedrock-knowledgebase-opensearchserverlessfieldmapping-vectorfield)" : String } ``` ### YAML ``` [MetadataField](#cfn-bedrock-knowledgebase-opensearchserverlessfieldmapping-metadatafield): String [TextField](#cfn-bedrock-knowledgebase-opensearchserverlessfieldmapping-textfield): String [VectorField](#cfn-bedrock-knowledgebase-opensearchserverlessfieldmapping-vectorfield): String ``` ## Properties `MetadataField` The name of the field in which Amazon Bedrock stores metadata about the vector store. *Required*: Yes *Type*: String *Pattern*: `^.*$` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `TextField` The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose. *Required*: Yes *Type*: String *Pattern*: `^.*$` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `VectorField` The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources. *Required*: Yes *Type*: String *Pattern*: `^.*$` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase PineconeConfiguration Contains details about the storage configuration of the knowledge base in Pinecone. For more information, see [Create a vector index in Pinecone](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-pinecone.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ConnectionString](#cfn-bedrock-knowledgebase-pineconeconfiguration-connectionstring)" : String, "[CredentialsSecretArn](#cfn-bedrock-knowledgebase-pineconeconfiguration-credentialssecretarn)" : String, "[FieldMapping](#cfn-bedrock-knowledgebase-pineconeconfiguration-fieldmapping)" : PineconeFieldMapping, "[Namespace](#cfn-bedrock-knowledgebase-pineconeconfiguration-namespace)" : String } ``` ### YAML ``` [ConnectionString](#cfn-bedrock-knowledgebase-pineconeconfiguration-connectionstring): String [CredentialsSecretArn](#cfn-bedrock-knowledgebase-pineconeconfiguration-credentialssecretarn): String [FieldMapping](#cfn-bedrock-knowledgebase-pineconeconfiguration-fieldmapping): PineconeFieldMapping [Namespace](#cfn-bedrock-knowledgebase-pineconeconfiguration-namespace): String ``` ## Properties `ConnectionString` The endpoint URL for your index management page. *Required*: Yes *Type*: String *Pattern*: `^.*$` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `CredentialsSecretArn` The Amazon Resource Name (ARN) of the secret that you created in AWS Secrets Manager that is linked to your Pinecone API key. *Required*: Yes *Type*: String *Pattern*: `^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `FieldMapping` Contains the names of the fields to which to map information about the vector store. *Required*: Yes *Type*: [PineconeFieldMapping](aws-properties-bedrock-knowledgebase-pineconefieldmapping.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Namespace` The namespace to be used to write new data to your database. *Required*: No *Type*: String *Pattern*: `^.*$` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase PineconeFieldMapping Contains the names of the fields to which to map information about the vector store. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MetadataField](#cfn-bedrock-knowledgebase-pineconefieldmapping-metadatafield)" : String, "[TextField](#cfn-bedrock-knowledgebase-pineconefieldmapping-textfield)" : String } ``` ### YAML ``` [MetadataField](#cfn-bedrock-knowledgebase-pineconefieldmapping-metadatafield): String [TextField](#cfn-bedrock-knowledgebase-pineconefieldmapping-textfield): String ``` ## Properties `MetadataField` The name of the field in which Amazon Bedrock stores metadata about the vector store. *Required*: Yes *Type*: String *Pattern*: `^.*$` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `TextField` The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose. *Required*: Yes *Type*: String *Pattern*: `^.*$` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase QueryGenerationColumn Contains information about a column in the current table for the query engine to consider. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Description](#cfn-bedrock-knowledgebase-querygenerationcolumn-description)" : String, "[Inclusion](#cfn-bedrock-knowledgebase-querygenerationcolumn-inclusion)" : String, "[Name](#cfn-bedrock-knowledgebase-querygenerationcolumn-name)" : String } ``` ### YAML ``` [Description](#cfn-bedrock-knowledgebase-querygenerationcolumn-description): String [Inclusion](#cfn-bedrock-knowledgebase-querygenerationcolumn-inclusion): String [Name](#cfn-bedrock-knowledgebase-querygenerationcolumn-name): String ``` ## Properties `Description` A description of the column that helps the query engine understand the contents of the column. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Inclusion` Specifies whether to include or exclude the column during query generation. If you specify `EXCLUDE`, the column will be ignored. If you specify `INCLUDE`, all other columns in the table will be ignored. *Required*: No *Type*: String *Allowed values*: `INCLUDE | EXCLUDE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the column for which the other fields in this object apply. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `127` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::KnowledgeBase QueryGenerationConfiguration Contains configurations for query generation. For more information, see [Build a knowledge base by connecting to a structured data source](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html) in the Amazon Bedrock User Guide.. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ExecutionTimeoutSeconds](#cfn-bedrock-knowledgebase-querygenerationconfiguration-executiontimeoutseconds)" : Integer, "[GenerationContext](#cfn-bedrock-knowledgebase-querygenerationconfiguration-generationcontext)" : QueryGenerationContext } ``` ### YAML ``` [ExecutionTimeoutSeconds](#cfn-bedrock-knowledgebase-querygenerationconfiguration-executiontimeoutseconds): Integer [GenerationContext](#cfn-bedrock-knowledgebase-querygenerationconfiguration-generationcontext): QueryGenerationContext ``` ## Properties `ExecutionTimeoutSeconds` The time after which query generation will time out. *Required*: No *Type*: Integer *Minimum*: `1` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GenerationContext` Specifies configurations for context to use during query generation. *Required*: No *Type*: [QueryGenerationContext](aws-properties-bedrock-knowledgebase-querygenerationcontext.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::KnowledgeBase QueryGenerationContext >Contains configurations for context to use during query generation. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CuratedQueries](#cfn-bedrock-knowledgebase-querygenerationcontext-curatedqueries)" : [ CuratedQuery, ... ], "[Tables](#cfn-bedrock-knowledgebase-querygenerationcontext-tables)" : [ QueryGenerationTable, ... ] } ``` ### YAML ``` [CuratedQueries](#cfn-bedrock-knowledgebase-querygenerationcontext-curatedqueries): - CuratedQuery [Tables](#cfn-bedrock-knowledgebase-querygenerationcontext-tables): - QueryGenerationTable ``` ## Properties `CuratedQueries` An array of objects, each of which defines information about example queries to help the query engine generate appropriate SQL queries. *Required*: No *Type*: Array of [CuratedQuery](aws-properties-bedrock-knowledgebase-curatedquery.md) *Maximum*: `10` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tables` An array of objects, each of which defines information about a table in the database. *Required*: No *Type*: Array of [QueryGenerationTable](aws-properties-bedrock-knowledgebase-querygenerationtable.md) *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::KnowledgeBase QueryGenerationTable Contains information about a table for the query engine to consider. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Columns](#cfn-bedrock-knowledgebase-querygenerationtable-columns)" : [ QueryGenerationColumn, ... ], "[Description](#cfn-bedrock-knowledgebase-querygenerationtable-description)" : String, "[Inclusion](#cfn-bedrock-knowledgebase-querygenerationtable-inclusion)" : String, "[Name](#cfn-bedrock-knowledgebase-querygenerationtable-name)" : String } ``` ### YAML ``` [Columns](#cfn-bedrock-knowledgebase-querygenerationtable-columns): - QueryGenerationColumn [Description](#cfn-bedrock-knowledgebase-querygenerationtable-description): String [Inclusion](#cfn-bedrock-knowledgebase-querygenerationtable-inclusion): String [Name](#cfn-bedrock-knowledgebase-querygenerationtable-name): String ``` ## Properties `Columns` An array of objects, each of which defines information about a column in the table. *Required*: No *Type*: Array of [QueryGenerationColumn](aws-properties-bedrock-knowledgebase-querygenerationcolumn.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` A description of the table that helps the query engine understand the contents of the table. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Inclusion` Specifies whether to include or exclude the table during query generation. If you specify `EXCLUDE`, the table will be ignored. If you specify `INCLUDE`, all other tables will be ignored. *Required*: No *Type*: String *Allowed values*: `INCLUDE | EXCLUDE` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the table for which the other fields in this object apply. *Required*: Yes *Type*: String *Pattern*: `^.*\..*\..*$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::KnowledgeBase RdsConfiguration Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see [Create a vector index in Amazon RDS](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CredentialsSecretArn](#cfn-bedrock-knowledgebase-rdsconfiguration-credentialssecretarn)" : String, "[DatabaseName](#cfn-bedrock-knowledgebase-rdsconfiguration-databasename)" : String, "[FieldMapping](#cfn-bedrock-knowledgebase-rdsconfiguration-fieldmapping)" : RdsFieldMapping, "[ResourceArn](#cfn-bedrock-knowledgebase-rdsconfiguration-resourcearn)" : String, "[TableName](#cfn-bedrock-knowledgebase-rdsconfiguration-tablename)" : String } ``` ### YAML ``` [CredentialsSecretArn](#cfn-bedrock-knowledgebase-rdsconfiguration-credentialssecretarn): String [DatabaseName](#cfn-bedrock-knowledgebase-rdsconfiguration-databasename): String [FieldMapping](#cfn-bedrock-knowledgebase-rdsconfiguration-fieldmapping): RdsFieldMapping [ResourceArn](#cfn-bedrock-knowledgebase-rdsconfiguration-resourcearn): String [TableName](#cfn-bedrock-knowledgebase-rdsconfiguration-tablename): String ``` ## Properties `CredentialsSecretArn` The Amazon Resource Name (ARN) of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database. *Required*: Yes *Type*: String *Pattern*: `^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `DatabaseName` The name of your Amazon RDS database. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_\-]+$` *Maximum*: `63` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `FieldMapping` Contains the names of the fields to which to map information about the vector store. *Required*: Yes *Type*: [RdsFieldMapping](aws-properties-bedrock-knowledgebase-rdsfieldmapping.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ResourceArn` The Amazon Resource Name (ARN) of the vector store. *Required*: Yes *Type*: String *Pattern*: `^arn:aws(|-cn|-us-gov):rds:[a-zA-Z0-9-]*:[0-9]{12}:cluster:[a-zA-Z0-9-]{1,63}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `TableName` The name of the table in the database. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_\.\-]+$` *Maximum*: `63` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase RdsFieldMapping Contains the names of the fields to which to map information about the vector store. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CustomMetadataField](#cfn-bedrock-knowledgebase-rdsfieldmapping-custommetadatafield)" : String, "[MetadataField](#cfn-bedrock-knowledgebase-rdsfieldmapping-metadatafield)" : String, "[PrimaryKeyField](#cfn-bedrock-knowledgebase-rdsfieldmapping-primarykeyfield)" : String, "[TextField](#cfn-bedrock-knowledgebase-rdsfieldmapping-textfield)" : String, "[VectorField](#cfn-bedrock-knowledgebase-rdsfieldmapping-vectorfield)" : String } ``` ### YAML ``` [CustomMetadataField](#cfn-bedrock-knowledgebase-rdsfieldmapping-custommetadatafield): String [MetadataField](#cfn-bedrock-knowledgebase-rdsfieldmapping-metadatafield): String [PrimaryKeyField](#cfn-bedrock-knowledgebase-rdsfieldmapping-primarykeyfield): String [TextField](#cfn-bedrock-knowledgebase-rdsfieldmapping-textfield): String [VectorField](#cfn-bedrock-knowledgebase-rdsfieldmapping-vectorfield): String ``` ## Properties `CustomMetadataField` Provide a name for the universal metadata field where Amazon Bedrock will store any custom metadata from your data source. *Required*: No *Type*: String *Pattern*: `^[a-zA-Z0-9_\-]+$` *Maximum*: `63` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `MetadataField` The name of the field in which Amazon Bedrock stores metadata about the vector store. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_\-]+$` *Maximum*: `63` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `PrimaryKeyField` The name of the field in which Amazon Bedrock stores the ID for each entry. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_\-]+$` *Maximum*: `63` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `TextField` The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_\-]+$` *Maximum*: `63` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `VectorField` The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9_\-]+$` *Maximum*: `63` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase RedshiftConfiguration Contains configurations for an Amazon Redshift database. For more information, see [Build a knowledge base by connecting to a structured data source](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[QueryEngineConfiguration](#cfn-bedrock-knowledgebase-redshiftconfiguration-queryengineconfiguration)" : RedshiftQueryEngineConfiguration, "[QueryGenerationConfiguration](#cfn-bedrock-knowledgebase-redshiftconfiguration-querygenerationconfiguration)" : QueryGenerationConfiguration, "[StorageConfigurations](#cfn-bedrock-knowledgebase-redshiftconfiguration-storageconfigurations)" : [ RedshiftQueryEngineStorageConfiguration, ... ] } ``` ### YAML ``` [QueryEngineConfiguration](#cfn-bedrock-knowledgebase-redshiftconfiguration-queryengineconfiguration): RedshiftQueryEngineConfiguration [QueryGenerationConfiguration](#cfn-bedrock-knowledgebase-redshiftconfiguration-querygenerationconfiguration): QueryGenerationConfiguration [StorageConfigurations](#cfn-bedrock-knowledgebase-redshiftconfiguration-storageconfigurations): - RedshiftQueryEngineStorageConfiguration ``` ## Properties `QueryEngineConfiguration` Specifies configurations for an Amazon Redshift query engine. *Required*: Yes *Type*: [RedshiftQueryEngineConfiguration](aws-properties-bedrock-knowledgebase-redshiftqueryengineconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `QueryGenerationConfiguration` Specifies configurations for generating queries. *Required*: No *Type*: [QueryGenerationConfiguration](aws-properties-bedrock-knowledgebase-querygenerationconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StorageConfigurations` Specifies configurations for Amazon Redshift database storage. *Required*: Yes *Type*: Array of [RedshiftQueryEngineStorageConfiguration](aws-properties-bedrock-knowledgebase-redshiftqueryenginestorageconfiguration.md) *Minimum*: `1` *Maximum*: `1` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase RedshiftProvisionedAuthConfiguration Contains configurations for authentication to an Amazon Redshift provisioned data warehouse. Specify the type of authentication to use in the `type` field and include the corresponding field. If you specify IAM authentication, you don't need to include another field. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DatabaseUser](#cfn-bedrock-knowledgebase-redshiftprovisionedauthconfiguration-databaseuser)" : String, "[Type](#cfn-bedrock-knowledgebase-redshiftprovisionedauthconfiguration-type)" : String, "[UsernamePasswordSecretArn](#cfn-bedrock-knowledgebase-redshiftprovisionedauthconfiguration-usernamepasswordsecretarn)" : String } ``` ### YAML ``` [DatabaseUser](#cfn-bedrock-knowledgebase-redshiftprovisionedauthconfiguration-databaseuser): String [Type](#cfn-bedrock-knowledgebase-redshiftprovisionedauthconfiguration-type): String [UsernamePasswordSecretArn](#cfn-bedrock-knowledgebase-redshiftprovisionedauthconfiguration-usernamepasswordsecretarn): String ``` ## Properties `DatabaseUser` The database username for authentication to an Amazon Redshift provisioned data warehouse. *Required*: No *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Type` The type of authentication to use. *Required*: Yes *Type*: String *Allowed values*: `IAM | USERNAME_PASSWORD | USERNAME` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `UsernamePasswordSecretArn` The ARN of an Secrets Manager secret for authentication. *Required*: No *Type*: String *Pattern*: `^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase RedshiftProvisionedConfiguration Contains configurations for a provisioned Amazon Redshift query engine. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AuthConfiguration](#cfn-bedrock-knowledgebase-redshiftprovisionedconfiguration-authconfiguration)" : RedshiftProvisionedAuthConfiguration, "[ClusterIdentifier](#cfn-bedrock-knowledgebase-redshiftprovisionedconfiguration-clusteridentifier)" : String } ``` ### YAML ``` [AuthConfiguration](#cfn-bedrock-knowledgebase-redshiftprovisionedconfiguration-authconfiguration): RedshiftProvisionedAuthConfiguration [ClusterIdentifier](#cfn-bedrock-knowledgebase-redshiftprovisionedconfiguration-clusteridentifier): String ``` ## Properties `AuthConfiguration` Specifies configurations for authentication to Amazon Redshift. *Required*: Yes *Type*: [RedshiftProvisionedAuthConfiguration](aws-properties-bedrock-knowledgebase-redshiftprovisionedauthconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ClusterIdentifier` The ID of the Amazon Redshift cluster. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `63` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase RedshiftQueryEngineAwsDataCatalogStorageConfiguration Contains configurations for storage in AWS Glue Data Catalog. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[TableNames](#cfn-bedrock-knowledgebase-redshiftqueryengineawsdatacatalogstorageconfiguration-tablenames)" : [ String, ... ] } ``` ### YAML ``` [TableNames](#cfn-bedrock-knowledgebase-redshiftqueryengineawsdatacatalogstorageconfiguration-tablenames): - String ``` ## Properties `TableNames` A list of names of the tables to use. *Required*: Yes *Type*: Array of String *Minimum*: `1` *Maximum*: `1000` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase RedshiftQueryEngineConfiguration Contains configurations for an Amazon Redshift query engine. Specify the type of query engine in `type` and include the corresponding field. For more information, see [Build a knowledge base by connecting to a structured data source](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ProvisionedConfiguration](#cfn-bedrock-knowledgebase-redshiftqueryengineconfiguration-provisionedconfiguration)" : RedshiftProvisionedConfiguration, "[ServerlessConfiguration](#cfn-bedrock-knowledgebase-redshiftqueryengineconfiguration-serverlessconfiguration)" : RedshiftServerlessConfiguration, "[Type](#cfn-bedrock-knowledgebase-redshiftqueryengineconfiguration-type)" : String } ``` ### YAML ``` [ProvisionedConfiguration](#cfn-bedrock-knowledgebase-redshiftqueryengineconfiguration-provisionedconfiguration): RedshiftProvisionedConfiguration [ServerlessConfiguration](#cfn-bedrock-knowledgebase-redshiftqueryengineconfiguration-serverlessconfiguration): RedshiftServerlessConfiguration [Type](#cfn-bedrock-knowledgebase-redshiftqueryengineconfiguration-type): String ``` ## Properties `ProvisionedConfiguration` Specifies configurations for a provisioned Amazon Redshift query engine. *Required*: No *Type*: [RedshiftProvisionedConfiguration](aws-properties-bedrock-knowledgebase-redshiftprovisionedconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `ServerlessConfiguration` Specifies configurations for a serverless Amazon Redshift query engine. *Required*: No *Type*: [RedshiftServerlessConfiguration](aws-properties-bedrock-knowledgebase-redshiftserverlessconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Type` The type of query engine. *Required*: Yes *Type*: String *Allowed values*: `SERVERLESS | PROVISIONED` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase RedshiftQueryEngineRedshiftStorageConfiguration Contains configurations for storage in Amazon Redshift. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[DatabaseName](#cfn-bedrock-knowledgebase-redshiftqueryengineredshiftstorageconfiguration-databasename)" : String } ``` ### YAML ``` [DatabaseName](#cfn-bedrock-knowledgebase-redshiftqueryengineredshiftstorageconfiguration-databasename): String ``` ## Properties `DatabaseName` The name of the Amazon Redshift database. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `200` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase RedshiftQueryEngineStorageConfiguration Contains configurations for Amazon Redshift data storage. Specify the data storage service to use in the `type` field and include the corresponding field. For more information, see [Build a knowledge base by connecting to a structured data source](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AwsDataCatalogConfiguration](#cfn-bedrock-knowledgebase-redshiftqueryenginestorageconfiguration-awsdatacatalogconfiguration)" : RedshiftQueryEngineAwsDataCatalogStorageConfiguration, "[RedshiftConfiguration](#cfn-bedrock-knowledgebase-redshiftqueryenginestorageconfiguration-redshiftconfiguration)" : RedshiftQueryEngineRedshiftStorageConfiguration, "[Type](#cfn-bedrock-knowledgebase-redshiftqueryenginestorageconfiguration-type)" : String } ``` ### YAML ``` [AwsDataCatalogConfiguration](#cfn-bedrock-knowledgebase-redshiftqueryenginestorageconfiguration-awsdatacatalogconfiguration): RedshiftQueryEngineAwsDataCatalogStorageConfiguration [RedshiftConfiguration](#cfn-bedrock-knowledgebase-redshiftqueryenginestorageconfiguration-redshiftconfiguration): RedshiftQueryEngineRedshiftStorageConfiguration [Type](#cfn-bedrock-knowledgebase-redshiftqueryenginestorageconfiguration-type): String ``` ## Properties `AwsDataCatalogConfiguration` Specifies configurations for storage in AWS Glue Data Catalog. *Required*: No *Type*: [RedshiftQueryEngineAwsDataCatalogStorageConfiguration](aws-properties-bedrock-knowledgebase-redshiftqueryengineawsdatacatalogstorageconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `RedshiftConfiguration` Specifies configurations for storage in Amazon Redshift. *Required*: No *Type*: [RedshiftQueryEngineRedshiftStorageConfiguration](aws-properties-bedrock-knowledgebase-redshiftqueryengineredshiftstorageconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Type` The data storage service to use. *Required*: Yes *Type*: String *Allowed values*: `REDSHIFT | AWS_DATA_CATALOG` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase RedshiftServerlessAuthConfiguration Specifies configurations for authentication to a Redshift Serverless. Specify the type of authentication to use in the `type` field and include the corresponding field. If you specify IAM authentication, you don't need to include another field. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Type](#cfn-bedrock-knowledgebase-redshiftserverlessauthconfiguration-type)" : String, "[UsernamePasswordSecretArn](#cfn-bedrock-knowledgebase-redshiftserverlessauthconfiguration-usernamepasswordsecretarn)" : String } ``` ### YAML ``` [Type](#cfn-bedrock-knowledgebase-redshiftserverlessauthconfiguration-type): String [UsernamePasswordSecretArn](#cfn-bedrock-knowledgebase-redshiftserverlessauthconfiguration-usernamepasswordsecretarn): String ``` ## Properties `Type` The type of authentication to use. *Required*: Yes *Type*: String *Allowed values*: `IAM | USERNAME_PASSWORD` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `UsernamePasswordSecretArn` The ARN of an Secrets Manager secret for authentication. *Required*: No *Type*: String *Pattern*: `^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase RedshiftServerlessConfiguration Contains configurations for authentication to Amazon Redshift Serverless. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AuthConfiguration](#cfn-bedrock-knowledgebase-redshiftserverlessconfiguration-authconfiguration)" : RedshiftServerlessAuthConfiguration, "[WorkgroupArn](#cfn-bedrock-knowledgebase-redshiftserverlessconfiguration-workgrouparn)" : String } ``` ### YAML ``` [AuthConfiguration](#cfn-bedrock-knowledgebase-redshiftserverlessconfiguration-authconfiguration): RedshiftServerlessAuthConfiguration [WorkgroupArn](#cfn-bedrock-knowledgebase-redshiftserverlessconfiguration-workgrouparn): String ``` ## Properties `AuthConfiguration` Specifies configurations for authentication to an Amazon Redshift provisioned data warehouse. *Required*: Yes *Type*: [RedshiftServerlessAuthConfiguration](aws-properties-bedrock-knowledgebase-redshiftserverlessauthconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `WorkgroupArn` The ARN of the Amazon Redshift workgroup. *Required*: Yes *Type*: String *Pattern*: `^(arn:(aws(-[a-z]+)*):redshift-serverless:[a-z]{2}(-gov)?-[a-z]+-\d{1}:\d{12}:workgroup/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase S3Location A storage location in an Amazon S3 bucket. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[URI](#cfn-bedrock-knowledgebase-s3location-uri)" : String } ``` ### YAML ``` [URI](#cfn-bedrock-knowledgebase-s3location-uri): String ``` ## Properties `URI` An object URI starting with `s3://`. *Required*: Yes *Type*: String *Pattern*: `^s3://.{1,128}$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase S3VectorsConfiguration Contains the storage configuration of the knowledge base for S3 vectors. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[IndexArn](#cfn-bedrock-knowledgebase-s3vectorsconfiguration-indexarn)" : String, "[IndexName](#cfn-bedrock-knowledgebase-s3vectorsconfiguration-indexname)" : String, "[VectorBucketArn](#cfn-bedrock-knowledgebase-s3vectorsconfiguration-vectorbucketarn)" : String } ``` ### YAML ``` [IndexArn](#cfn-bedrock-knowledgebase-s3vectorsconfiguration-indexarn): String [IndexName](#cfn-bedrock-knowledgebase-s3vectorsconfiguration-indexname): String [VectorBucketArn](#cfn-bedrock-knowledgebase-s3vectorsconfiguration-vectorbucketarn): String ``` ## Properties `IndexArn` The Amazon Resource Name (ARN) of the vector index used for the knowledge base. This ARN identifies the specific vector index resource within Amazon Bedrock. *Required*: No *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `IndexName` The name of the vector index used for the knowledge base. This name identifies the vector index within the Amazon Bedrock service. *Required*: No *Type*: String *Minimum*: `3` *Maximum*: `63` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `VectorBucketArn` The Amazon Resource Name (ARN) of the S3 bucket where vector embeddings are stored. This bucket contains the vector data used by the knowledge base. *Required*: No *Type*: String *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase SqlKnowledgeBaseConfiguration Contains configurations for a knowledge base connected to an SQL database. Specify the SQL database type in the `type` field and include the corresponding field. For more information, see [Build a knowledge base by connecting to a structured data source](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[RedshiftConfiguration](#cfn-bedrock-knowledgebase-sqlknowledgebaseconfiguration-redshiftconfiguration)" : RedshiftConfiguration, "[Type](#cfn-bedrock-knowledgebase-sqlknowledgebaseconfiguration-type)" : String } ``` ### YAML ``` [RedshiftConfiguration](#cfn-bedrock-knowledgebase-sqlknowledgebaseconfiguration-redshiftconfiguration): RedshiftConfiguration [Type](#cfn-bedrock-knowledgebase-sqlknowledgebaseconfiguration-type): String ``` ## Properties `RedshiftConfiguration` Specifies configurations for a knowledge base connected to an Amazon Redshift database. *Required*: No *Type*: [RedshiftConfiguration](aws-properties-bedrock-knowledgebase-redshiftconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Type` The type of SQL database to connect to the knowledge base. *Required*: Yes *Type*: String *Allowed values*: `REDSHIFT` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase StorageConfiguration Contains the storage configuration of the knowledge base. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MongoDbAtlasConfiguration](#cfn-bedrock-knowledgebase-storageconfiguration-mongodbatlasconfiguration)" : MongoDbAtlasConfiguration, "[NeptuneAnalyticsConfiguration](#cfn-bedrock-knowledgebase-storageconfiguration-neptuneanalyticsconfiguration)" : NeptuneAnalyticsConfiguration, "[OpensearchManagedClusterConfiguration](#cfn-bedrock-knowledgebase-storageconfiguration-opensearchmanagedclusterconfiguration)" : OpenSearchManagedClusterConfiguration, "[OpensearchServerlessConfiguration](#cfn-bedrock-knowledgebase-storageconfiguration-opensearchserverlessconfiguration)" : OpenSearchServerlessConfiguration, "[PineconeConfiguration](#cfn-bedrock-knowledgebase-storageconfiguration-pineconeconfiguration)" : PineconeConfiguration, "[RdsConfiguration](#cfn-bedrock-knowledgebase-storageconfiguration-rdsconfiguration)" : RdsConfiguration, "[S3VectorsConfiguration](#cfn-bedrock-knowledgebase-storageconfiguration-s3vectorsconfiguration)" : S3VectorsConfiguration, "[Type](#cfn-bedrock-knowledgebase-storageconfiguration-type)" : String } ``` ### YAML ``` [MongoDbAtlasConfiguration](#cfn-bedrock-knowledgebase-storageconfiguration-mongodbatlasconfiguration): MongoDbAtlasConfiguration [NeptuneAnalyticsConfiguration](#cfn-bedrock-knowledgebase-storageconfiguration-neptuneanalyticsconfiguration): NeptuneAnalyticsConfiguration [OpensearchManagedClusterConfiguration](#cfn-bedrock-knowledgebase-storageconfiguration-opensearchmanagedclusterconfiguration): OpenSearchManagedClusterConfiguration [OpensearchServerlessConfiguration](#cfn-bedrock-knowledgebase-storageconfiguration-opensearchserverlessconfiguration): OpenSearchServerlessConfiguration [PineconeConfiguration](#cfn-bedrock-knowledgebase-storageconfiguration-pineconeconfiguration): PineconeConfiguration [RdsConfiguration](#cfn-bedrock-knowledgebase-storageconfiguration-rdsconfiguration): RdsConfiguration [S3VectorsConfiguration](#cfn-bedrock-knowledgebase-storageconfiguration-s3vectorsconfiguration): S3VectorsConfiguration [Type](#cfn-bedrock-knowledgebase-storageconfiguration-type): String ``` ## Properties `MongoDbAtlasConfiguration` Contains the storage configuration of the knowledge base in MongoDB Atlas. *Required*: No *Type*: [MongoDbAtlasConfiguration](aws-properties-bedrock-knowledgebase-mongodbatlasconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `NeptuneAnalyticsConfiguration` Contains details about the Neptune Analytics configuration of the knowledge base in Amazon Neptune. For more information, see [Create a vector index in Amazon Neptune Analytics.](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-neptune.html). *Required*: No *Type*: [NeptuneAnalyticsConfiguration](aws-properties-bedrock-knowledgebase-neptuneanalyticsconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `OpensearchManagedClusterConfiguration` Contains details about the storage configuration of the knowledge base in OpenSearch Managed Cluster. For more information, see [Create a vector index in Amazon OpenSearch Service](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-osm.html). *Required*: No *Type*: [OpenSearchManagedClusterConfiguration](aws-properties-bedrock-knowledgebase-opensearchmanagedclusterconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `OpensearchServerlessConfiguration` Contains the storage configuration of the knowledge base in Amazon OpenSearch Service. *Required*: No *Type*: [OpenSearchServerlessConfiguration](aws-properties-bedrock-knowledgebase-opensearchserverlessconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `PineconeConfiguration` Contains the storage configuration of the knowledge base in Pinecone. *Required*: No *Type*: [PineconeConfiguration](aws-properties-bedrock-knowledgebase-pineconeconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `RdsConfiguration` Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see [Create a vector index in Amazon RDS](https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-setup-rds.html). *Required*: No *Type*: [RdsConfiguration](aws-properties-bedrock-knowledgebase-rdsconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `S3VectorsConfiguration` The configuration settings for storing knowledge base data using S3 vectors. This includes vector index information and S3 bucket details for vector storage. *Required*: No *Type*: [S3VectorsConfiguration](aws-properties-bedrock-knowledgebase-s3vectorsconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Type` The vector store service in which the knowledge base is stored. *Required*: Yes *Type*: String *Allowed values*: `OPENSEARCH_SERVERLESS | PINECONE | RDS | MONGO_DB_ATLAS | NEPTUNE_ANALYTICS | S3_VECTORS | OPENSEARCH_MANAGED_CLUSTER` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase SupplementalDataStorageConfiguration Specifies configurations for the storage location of multimedia content (images, audio, and video) extracted from multimodal documents in your data source. This content can be retrieved and returned to the end user with timestamp references for audio and video segments. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SupplementalDataStorageLocations](#cfn-bedrock-knowledgebase-supplementaldatastorageconfiguration-supplementaldatastoragelocations)" : [ SupplementalDataStorageLocation, ... ] } ``` ### YAML ``` [SupplementalDataStorageLocations](#cfn-bedrock-knowledgebase-supplementaldatastorageconfiguration-supplementaldatastoragelocations): - SupplementalDataStorageLocation ``` ## Properties `SupplementalDataStorageLocations` Property description not available. *Required*: Yes *Type*: Array of [SupplementalDataStorageLocation](aws-properties-bedrock-knowledgebase-supplementaldatastoragelocation.md) *Minimum*: `1` *Maximum*: `1` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase SupplementalDataStorageLocation Contains information about a storage location for multimedia content (images, audio, and video) extracted from multimodal documents in your data source. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[S3Location](#cfn-bedrock-knowledgebase-supplementaldatastoragelocation-s3location)" : S3Location, "[SupplementalDataStorageLocationType](#cfn-bedrock-knowledgebase-supplementaldatastoragelocation-supplementaldatastoragelocationtype)" : String } ``` ### YAML ``` [S3Location](#cfn-bedrock-knowledgebase-supplementaldatastoragelocation-s3location): S3Location [SupplementalDataStorageLocationType](#cfn-bedrock-knowledgebase-supplementaldatastoragelocation-supplementaldatastoragelocationtype): String ``` ## Properties `S3Location` Contains information about the Amazon S3 location for the extracted multimedia content. *Required*: No *Type*: [S3Location](aws-properties-bedrock-knowledgebase-s3location.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `SupplementalDataStorageLocationType` Property description not available. *Required*: Yes *Type*: String *Allowed values*: `S3` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase VectorKnowledgeBaseConfiguration Contains details about the model used to create vector embeddings for the knowledge base. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[EmbeddingModelArn](#cfn-bedrock-knowledgebase-vectorknowledgebaseconfiguration-embeddingmodelarn)" : String, "[EmbeddingModelConfiguration](#cfn-bedrock-knowledgebase-vectorknowledgebaseconfiguration-embeddingmodelconfiguration)" : EmbeddingModelConfiguration, "[SupplementalDataStorageConfiguration](#cfn-bedrock-knowledgebase-vectorknowledgebaseconfiguration-supplementaldatastorageconfiguration)" : SupplementalDataStorageConfiguration } ``` ### YAML ``` [EmbeddingModelArn](#cfn-bedrock-knowledgebase-vectorknowledgebaseconfiguration-embeddingmodelarn): String [EmbeddingModelConfiguration](#cfn-bedrock-knowledgebase-vectorknowledgebaseconfiguration-embeddingmodelconfiguration): EmbeddingModelConfiguration [SupplementalDataStorageConfiguration](#cfn-bedrock-knowledgebase-vectorknowledgebaseconfiguration-supplementaldatastorageconfiguration): SupplementalDataStorageConfiguration ``` ## Properties `EmbeddingModelArn` The Amazon Resource Name (ARN) of the model used to create vector embeddings for the knowledge base. *Required*: Yes *Type*: String *Pattern*: `^(arn:aws(-[^:]+)?:[a-z0-9-]+:[a-z0-9-]{1,20}:[0-9]{0,12}:[a-zA-Z0-9-:/._+]+)$` *Minimum*: `20` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `EmbeddingModelConfiguration` The embeddings model configuration details for the vector model used in Knowledge Base. *Required*: No *Type*: [EmbeddingModelConfiguration](aws-properties-bedrock-knowledgebase-embeddingmodelconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `SupplementalDataStorageConfiguration` If you include multimodal data from your data source, use this object to specify configurations for the storage location of the images extracted from your documents. These images can be retrieved and returned to the end user. They can also be used in generation when using [RetrieveAndGenerate](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html). *Required*: No *Type*: [SupplementalDataStorageConfiguration](aws-properties-bedrock-knowledgebase-supplementaldatastorageconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase VideoConfiguration Configuration settings for processing video content in multimodal knowledge bases. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[SegmentationConfiguration](#cfn-bedrock-knowledgebase-videoconfiguration-segmentationconfiguration)" : VideoSegmentationConfiguration } ``` ### YAML ``` [SegmentationConfiguration](#cfn-bedrock-knowledgebase-videoconfiguration-segmentationconfiguration): VideoSegmentationConfiguration ``` ## Properties `SegmentationConfiguration` Configuration for segmenting video content during processing. *Required*: Yes *Type*: [VideoSegmentationConfiguration](aws-properties-bedrock-knowledgebase-videosegmentationconfiguration.md) *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::KnowledgeBase VideoSegmentationConfiguration Configuration for segmenting video content during multimodal knowledge base ingestion. Determines how video files are divided into chunks for processing. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[FixedLengthDuration](#cfn-bedrock-knowledgebase-videosegmentationconfiguration-fixedlengthduration)" : Integer } ``` ### YAML ``` [FixedLengthDuration](#cfn-bedrock-knowledgebase-videosegmentationconfiguration-fixedlengthduration): Integer ``` ## Properties `FixedLengthDuration` The duration in seconds for each video segment. Video files will be divided into chunks of this length for processing. *Required*: Yes *Type*: Integer *Minimum*: `1` *Maximum*: `30` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) # AWS::Bedrock::Prompt Creates a prompt in your prompt library that you can add to a flow. For more information, see [Prompt management in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html), [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html) and [Prompt flows in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::Bedrock::Prompt", "Properties" : { "[CustomerEncryptionKeyArn](#cfn-bedrock-prompt-customerencryptionkeyarn)" : String, "[DefaultVariant](#cfn-bedrock-prompt-defaultvariant)" : String, "[Description](#cfn-bedrock-prompt-description)" : String, "[Name](#cfn-bedrock-prompt-name)" : String, "[Tags](#cfn-bedrock-prompt-tags)" : {Key: Value, ...}, "[Variants](#cfn-bedrock-prompt-variants)" : [ PromptVariant, ... ] } } ``` ### YAML ``` Type: AWS::Bedrock::Prompt Properties: [CustomerEncryptionKeyArn](#cfn-bedrock-prompt-customerencryptionkeyarn): String [DefaultVariant](#cfn-bedrock-prompt-defaultvariant): String [Description](#cfn-bedrock-prompt-description): String [Name](#cfn-bedrock-prompt-name): String [Tags](#cfn-bedrock-prompt-tags): Key: Value [Variants](#cfn-bedrock-prompt-variants): - PromptVariant ``` ## Properties `CustomerEncryptionKeyArn` The Amazon Resource Name (ARN) of the KMS key that the prompt is encrypted with. *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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `DefaultVariant` The name of the default variant for the prompt. This value must match the `name` field in the relevant [PromptVariant](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html) object. *Required*: No *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Description` The description of the prompt. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `200` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the prompt. *Required*: Yes *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tags` Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources: + [Tag naming limits and requirements](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions) + [Tagging best practices](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-best-practices) *Required*: No *Type*: Object of String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `0` *Maximum*: `256` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Variants` A list of objects, each containing details about a variant of the prompt. *Required*: No *Type*: Array of [PromptVariant](aws-properties-bedrock-prompt-promptvariant.md) *Minimum*: `0` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Number (ARN) of the prompt. For example, `{ "Ref": "myPrompt" }` could return the value `"arn:aws:bedrock:us-east-1:123456789012:prompt/PROMPT12345"`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `Arn` The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request). `CreatedAt` The time at which the prompt was created. `Id` The unique identifier of the prompt. `UpdatedAt` The time at which the prompt was last updated. `Version` The version of the prompt that this summary applies to. # AWS::Bedrock::Prompt CachePointBlock Defines a section of content to be cached for reuse in subsequent API calls. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Type](#cfn-bedrock-prompt-cachepointblock-type)" : String } ``` ### YAML ``` [Type](#cfn-bedrock-prompt-cachepointblock-type): String ``` ## Properties `Type` Specifies the type of cache point within the CachePointBlock. *Required*: Yes *Type*: String *Allowed values*: `default` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Prompt ChatPromptTemplateConfiguration Contains configurations to use a prompt in a conversational format. For more information, see [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InputVariables](#cfn-bedrock-prompt-chatprompttemplateconfiguration-inputvariables)" : [ PromptInputVariable, ... ], "[Messages](#cfn-bedrock-prompt-chatprompttemplateconfiguration-messages)" : [ Message, ... ], "[System](#cfn-bedrock-prompt-chatprompttemplateconfiguration-system)" : [ SystemContentBlock, ... ], "[ToolConfiguration](#cfn-bedrock-prompt-chatprompttemplateconfiguration-toolconfiguration)" : ToolConfiguration } ``` ### YAML ``` [InputVariables](#cfn-bedrock-prompt-chatprompttemplateconfiguration-inputvariables): - PromptInputVariable [Messages](#cfn-bedrock-prompt-chatprompttemplateconfiguration-messages): - Message [System](#cfn-bedrock-prompt-chatprompttemplateconfiguration-system): - SystemContentBlock [ToolConfiguration](#cfn-bedrock-prompt-chatprompttemplateconfiguration-toolconfiguration): ToolConfiguration ``` ## Properties `InputVariables` An array of the variables in the prompt template. *Required*: No *Type*: Array of [PromptInputVariable](aws-properties-bedrock-prompt-promptinputvariable.md) *Minimum*: `0` *Maximum*: `20` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Messages` Contains messages in the chat for the prompt. *Required*: Yes *Type*: Array of [Message](aws-properties-bedrock-prompt-message.md) *Minimum*: `0` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `System` Contains system prompts to provide context to the model or to describe how it should behave. *Required*: No *Type*: Array of [SystemContentBlock](aws-properties-bedrock-prompt-systemcontentblock.md) *Minimum*: `0` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ToolConfiguration` Configuration information for the tools that the model can use when generating a response. *Required*: No *Type*: [ToolConfiguration](aws-properties-bedrock-prompt-toolconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Prompt ContentBlock A block of content for a message that you pass to, or receive from, a model with the [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) or [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html) API operations. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CachePoint](#cfn-bedrock-prompt-contentblock-cachepoint)" : CachePointBlock, "[Text](#cfn-bedrock-prompt-contentblock-text)" : String } ``` ### YAML ``` [CachePoint](#cfn-bedrock-prompt-contentblock-cachepoint): CachePointBlock [Text](#cfn-bedrock-prompt-contentblock-text): String ``` ## Properties `CachePoint` CachePoint to include in the message. *Required*: No *Type*: [CachePointBlock](aws-properties-bedrock-prompt-cachepointblock.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Text` Text to include in the message. *Required*: No *Type*: String *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Prompt Message A message input, or returned from, a call to [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) or [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Content](#cfn-bedrock-prompt-message-content)" : [ ContentBlock, ... ], "[Role](#cfn-bedrock-prompt-message-role)" : String } ``` ### YAML ``` [Content](#cfn-bedrock-prompt-message-content): - ContentBlock [Role](#cfn-bedrock-prompt-message-role): String ``` ## Properties `Content` The message content. Note the following restrictions: + You can include up to 20 images. Each image's size, height, and width must be no more than 3.75 MB, 8000 px, and 8000 px, respectively. + You can include up to five documents. Each document's size must be no more than 4.5 MB. + If you include a `ContentBlock` with a `document` field in the array, you must also include a `ContentBlock` with a `text` field. + You can only include images and documents if the `role` is `user`. *Required*: Yes *Type*: Array of [ContentBlock](aws-properties-bedrock-prompt-contentblock.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Role` The role that the message plays in the message. *Required*: Yes *Type*: String *Allowed values*: `user | assistant` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Prompt PromptAgentResource Contains specifications for an Amazon Bedrock agent with which to use the prompt. For more information, see [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html) and [Automate tasks in your application using conversational agents](https://docs.aws.amazon.com/bedrock/latest/userguide/agents.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AgentIdentifier](#cfn-bedrock-prompt-promptagentresource-agentidentifier)" : String } ``` ### YAML ``` [AgentIdentifier](#cfn-bedrock-prompt-promptagentresource-agentidentifier): String ``` ## Properties `AgentIdentifier` The ARN of the agent with which to use the prompt. *Required*: Yes *Type*: String *Pattern*: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Prompt PromptGenAiResource Contains specifications for a generative AI resource with which to use the prompt. For more information, see [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Agent](#cfn-bedrock-prompt-promptgenairesource-agent)" : PromptAgentResource } ``` ### YAML ``` [Agent](#cfn-bedrock-prompt-promptgenairesource-agent): PromptAgentResource ``` ## Properties `Agent` Specifies an Amazon Bedrock agent with which to use the prompt. *Required*: Yes *Type*: [PromptAgentResource](aws-properties-bedrock-prompt-promptagentresource.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Prompt PromptInferenceConfiguration Contains inference configurations for the prompt. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Text](#cfn-bedrock-prompt-promptinferenceconfiguration-text)" : PromptModelInferenceConfiguration } ``` ### YAML ``` [Text](#cfn-bedrock-prompt-promptinferenceconfiguration-text): PromptModelInferenceConfiguration ``` ## Properties `Text` Contains inference configurations for a text prompt. *Required*: Yes *Type*: [PromptModelInferenceConfiguration](aws-properties-bedrock-prompt-promptmodelinferenceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Prompt PromptInputVariable Contains information about a variable in the prompt. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-bedrock-prompt-promptinputvariable-name)" : String } ``` ### YAML ``` [Name](#cfn-bedrock-prompt-promptinputvariable-name): String ``` ## Properties `Name` The name of the variable. *Required*: No *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Prompt PromptMetadataEntry Contains a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-bedrock-prompt-promptmetadataentry-key)" : String, "[Value](#cfn-bedrock-prompt-promptmetadataentry-value)" : String } ``` ### YAML ``` [Key](#cfn-bedrock-prompt-promptmetadataentry-key): String [Value](#cfn-bedrock-prompt-promptmetadataentry-value): String ``` ## Properties `Key` The key of a metadata tag for a prompt variant. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value of a metadata tag for a prompt variant. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `1` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Prompt PromptModelInferenceConfiguration Contains inference configurations related to model inference for a prompt. For more information, see [Inference parameters](https://docs.aws.amazon.com/bedrock/latest/userguide/inference-parameters.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MaxTokens](#cfn-bedrock-prompt-promptmodelinferenceconfiguration-maxtokens)" : Number, "[StopSequences](#cfn-bedrock-prompt-promptmodelinferenceconfiguration-stopsequences)" : [ String, ... ], "[Temperature](#cfn-bedrock-prompt-promptmodelinferenceconfiguration-temperature)" : Number, "[TopP](#cfn-bedrock-prompt-promptmodelinferenceconfiguration-topp)" : Number } ``` ### YAML ``` [MaxTokens](#cfn-bedrock-prompt-promptmodelinferenceconfiguration-maxtokens): Number [StopSequences](#cfn-bedrock-prompt-promptmodelinferenceconfiguration-stopsequences): - String [Temperature](#cfn-bedrock-prompt-promptmodelinferenceconfiguration-temperature): Number [TopP](#cfn-bedrock-prompt-promptmodelinferenceconfiguration-topp): Number ``` ## Properties `MaxTokens` The maximum number of tokens to return in the response. *Required*: No *Type*: Number *Minimum*: `0` *Maximum*: `512000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StopSequences` A list of strings that define sequences after which the model will stop generating. *Required*: No *Type*: Array of String *Minimum*: `0` *Maximum*: `4` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Temperature` Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs. *Required*: No *Type*: Number *Minimum*: `0` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TopP` The percentage of most-likely candidates that the model considers for the next token. *Required*: No *Type*: Number *Minimum*: `0` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Prompt PromptTemplateConfiguration Contains the message for a prompt. For more information, see [Construct and store reusable prompts with Prompt management in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Chat](#cfn-bedrock-prompt-prompttemplateconfiguration-chat)" : ChatPromptTemplateConfiguration, "[Text](#cfn-bedrock-prompt-prompttemplateconfiguration-text)" : TextPromptTemplateConfiguration } ``` ### YAML ``` [Chat](#cfn-bedrock-prompt-prompttemplateconfiguration-chat): ChatPromptTemplateConfiguration [Text](#cfn-bedrock-prompt-prompttemplateconfiguration-text): TextPromptTemplateConfiguration ``` ## Properties `Chat` Contains configurations to use the prompt in a conversational format. *Required*: No *Type*: [ChatPromptTemplateConfiguration](aws-properties-bedrock-prompt-chatprompttemplateconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Text` Contains configurations for the text in a message for a prompt. *Required*: No *Type*: [TextPromptTemplateConfiguration](aws-properties-bedrock-prompt-textprompttemplateconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Prompt PromptVariant Contains details about a variant of the prompt. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AdditionalModelRequestFields](#cfn-bedrock-prompt-promptvariant-additionalmodelrequestfields)" : Json, "[GenAiResource](#cfn-bedrock-prompt-promptvariant-genairesource)" : PromptGenAiResource, "[InferenceConfiguration](#cfn-bedrock-prompt-promptvariant-inferenceconfiguration)" : PromptInferenceConfiguration, "[Metadata](#cfn-bedrock-prompt-promptvariant-metadata)" : [ PromptMetadataEntry, ... ], "[ModelId](#cfn-bedrock-prompt-promptvariant-modelid)" : String, "[Name](#cfn-bedrock-prompt-promptvariant-name)" : String, "[TemplateConfiguration](#cfn-bedrock-prompt-promptvariant-templateconfiguration)" : PromptTemplateConfiguration, "[TemplateType](#cfn-bedrock-prompt-promptvariant-templatetype)" : String } ``` ### YAML ``` [AdditionalModelRequestFields](#cfn-bedrock-prompt-promptvariant-additionalmodelrequestfields): Json [GenAiResource](#cfn-bedrock-prompt-promptvariant-genairesource): PromptGenAiResource [InferenceConfiguration](#cfn-bedrock-prompt-promptvariant-inferenceconfiguration): PromptInferenceConfiguration [Metadata](#cfn-bedrock-prompt-promptvariant-metadata): - PromptMetadataEntry [ModelId](#cfn-bedrock-prompt-promptvariant-modelid): String [Name](#cfn-bedrock-prompt-promptvariant-name): String [TemplateConfiguration](#cfn-bedrock-prompt-promptvariant-templateconfiguration): PromptTemplateConfiguration [TemplateType](#cfn-bedrock-prompt-promptvariant-templatetype): String ``` ## Properties `AdditionalModelRequestFields` Contains model-specific inference configurations that aren't in the `inferenceConfiguration` field. To see model-specific inference parameters, see [Inference request parameters and response fields for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html). *Required*: No *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GenAiResource` Specifies a generative AI resource with which to use the prompt. *Required*: No *Type*: [PromptGenAiResource](aws-properties-bedrock-prompt-promptgenairesource.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InferenceConfiguration` Contains inference configurations for the prompt variant. *Required*: No *Type*: [PromptInferenceConfiguration](aws-properties-bedrock-prompt-promptinferenceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Metadata` An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant. *Required*: No *Type*: Array of [PromptMetadataEntry](aws-properties-bedrock-prompt-promptmetadataentry.md) *Minimum*: `0` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ModelId` The unique identifier of the model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) with which to run inference on the prompt. *Required*: No *Type*: String *Pattern*: `^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the prompt variant. *Required*: Yes *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TemplateConfiguration` Contains configurations for the prompt template. *Required*: Yes *Type*: [PromptTemplateConfiguration](aws-properties-bedrock-prompt-prompttemplateconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TemplateType` The type of prompt template to use. *Required*: Yes *Type*: String *Allowed values*: `TEXT | CHAT` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Prompt SpecificToolChoice The model must request a specific tool. For example, `{"tool" : {"name" : "Your tool name"}}`. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide **Note** This field is only supported by Anthropic Claude 3 models. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-bedrock-prompt-specifictoolchoice-name)" : String } ``` ### YAML ``` [Name](#cfn-bedrock-prompt-specifictoolchoice-name): String ``` ## Properties `Name` The name of the tool that the model must request. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Prompt SystemContentBlock Contains configurations for instructions to provide the model for how to handle input. To learn more, see [Using the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference-call.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CachePoint](#cfn-bedrock-prompt-systemcontentblock-cachepoint)" : CachePointBlock, "[Text](#cfn-bedrock-prompt-systemcontentblock-text)" : String } ``` ### YAML ``` [CachePoint](#cfn-bedrock-prompt-systemcontentblock-cachepoint): CachePointBlock [Text](#cfn-bedrock-prompt-systemcontentblock-text): String ``` ## Properties `CachePoint` CachePoint to include in the system prompt. *Required*: No *Type*: [CachePointBlock](aws-properties-bedrock-prompt-cachepointblock.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Text` A system prompt for the model. *Required*: No *Type*: String *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Prompt TextPromptTemplateConfiguration Contains configurations for a text prompt template. To include a variable, enclose a word in double curly braces as in `{{variable}}`. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CachePoint](#cfn-bedrock-prompt-textprompttemplateconfiguration-cachepoint)" : CachePointBlock, "[InputVariables](#cfn-bedrock-prompt-textprompttemplateconfiguration-inputvariables)" : [ PromptInputVariable, ... ], "[Text](#cfn-bedrock-prompt-textprompttemplateconfiguration-text)" : String, "[TextS3Location](#cfn-bedrock-prompt-textprompttemplateconfiguration-texts3location)" : TextS3Location } ``` ### YAML ``` [CachePoint](#cfn-bedrock-prompt-textprompttemplateconfiguration-cachepoint): CachePointBlock [InputVariables](#cfn-bedrock-prompt-textprompttemplateconfiguration-inputvariables): - PromptInputVariable [Text](#cfn-bedrock-prompt-textprompttemplateconfiguration-text): String [TextS3Location](#cfn-bedrock-prompt-textprompttemplateconfiguration-texts3location): TextS3Location ``` ## Properties `CachePoint` A cache checkpoint within a template configuration. *Required*: No *Type*: [CachePointBlock](aws-properties-bedrock-prompt-cachepointblock.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputVariables` An array of the variables in the prompt template. *Required*: No *Type*: Array of [PromptInputVariable](aws-properties-bedrock-prompt-promptinputvariable.md) *Minimum*: `0` *Maximum*: `20` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Text` The message for the prompt. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `200000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TextS3Location` The Amazon S3location of the prompt text. *Required*: No *Type*: [TextS3Location](aws-properties-bedrock-prompt-texts3location.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Prompt TextS3Location The Amazon S3location of the prompt text. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Bucket](#cfn-bedrock-prompt-texts3location-bucket)" : String, "[Key](#cfn-bedrock-prompt-texts3location-key)" : String, "[Version](#cfn-bedrock-prompt-texts3location-version)" : String } ``` ### YAML ``` [Bucket](#cfn-bedrock-prompt-texts3location-bucket): String [Key](#cfn-bedrock-prompt-texts3location-key): String [Version](#cfn-bedrock-prompt-texts3location-version): String ``` ## Properties `Bucket` The Amazon S3bucket containing the prompt text. *Required*: Yes *Type*: String *Pattern*: `^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$` *Minimum*: `3` *Maximum*: `63` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Key` The object key for the Amazon S3 location. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Version` The version of the Amazon S3location to use. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Prompt Tool Information about a tool that you can use with the Converse API. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CachePoint](#cfn-bedrock-prompt-tool-cachepoint)" : CachePointBlock, "[ToolSpec](#cfn-bedrock-prompt-tool-toolspec)" : ToolSpecification } ``` ### YAML ``` [CachePoint](#cfn-bedrock-prompt-tool-cachepoint): CachePointBlock [ToolSpec](#cfn-bedrock-prompt-tool-toolspec): ToolSpecification ``` ## Properties `CachePoint` CachePoint to include in the tool configuration. *Required*: No *Type*: [CachePointBlock](aws-properties-bedrock-prompt-cachepointblock.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ToolSpec` The specfication for the tool. *Required*: No *Type*: [ToolSpecification](aws-properties-bedrock-prompt-toolspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Prompt ToolChoice Determines which tools the model should request in a call to `Converse` or `ConverseStream`. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Any](#cfn-bedrock-prompt-toolchoice-any)" : Json, "[Auto](#cfn-bedrock-prompt-toolchoice-auto)" : Json, "[Tool](#cfn-bedrock-prompt-toolchoice-tool)" : SpecificToolChoice } ``` ### YAML ``` [Any](#cfn-bedrock-prompt-toolchoice-any): Json [Auto](#cfn-bedrock-prompt-toolchoice-auto): Json [Tool](#cfn-bedrock-prompt-toolchoice-tool): SpecificToolChoice ``` ## Properties `Any` The model must request at least one tool (no text is generated). *Required*: No *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Auto` (Default). The Model automatically decides if a tool should be called or whether to generate text instead. *Required*: No *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tool` The Model must request the specified tool. Only supported by Anthropic Claude 3 and Amazon Nova models. *Required*: No *Type*: [SpecificToolChoice](aws-properties-bedrock-prompt-specifictoolchoice.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Prompt ToolConfiguration Configuration information for the tools that you pass to a model. For more information, see [Tool use (function calling)](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ToolChoice](#cfn-bedrock-prompt-toolconfiguration-toolchoice)" : ToolChoice, "[Tools](#cfn-bedrock-prompt-toolconfiguration-tools)" : [ Tool, ... ] } ``` ### YAML ``` [ToolChoice](#cfn-bedrock-prompt-toolconfiguration-toolchoice): ToolChoice [Tools](#cfn-bedrock-prompt-toolconfiguration-tools): - Tool ``` ## Properties `ToolChoice` If supported by model, forces the model to request a tool. *Required*: No *Type*: [ToolChoice](aws-properties-bedrock-prompt-toolchoice.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tools` An array of tools that you want to pass to a model. *Required*: Yes *Type*: Array of [Tool](aws-properties-bedrock-prompt-tool.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Prompt ToolInputSchema The schema for the tool. The top level schema type must be `object`. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Json](#cfn-bedrock-prompt-toolinputschema-json)" : Json } ``` ### YAML ``` [Json](#cfn-bedrock-prompt-toolinputschema-json): Json ``` ## Properties `Json` The JSON schema for the tool. For more information, see [JSON Schema Reference](https://json-schema.org/understanding-json-schema/reference). *Required*: Yes *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::Prompt ToolSpecification The specification for the tool. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Description](#cfn-bedrock-prompt-toolspecification-description)" : String, "[InputSchema](#cfn-bedrock-prompt-toolspecification-inputschema)" : ToolInputSchema, "[Name](#cfn-bedrock-prompt-toolspecification-name)" : String } ``` ### YAML ``` [Description](#cfn-bedrock-prompt-toolspecification-description): String [InputSchema](#cfn-bedrock-prompt-toolspecification-inputschema): ToolInputSchema [Name](#cfn-bedrock-prompt-toolspecification-name): String ``` ## Properties `Description` The description for the tool. *Required*: No *Type*: String *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputSchema` The input schema for the tool in JSON format. *Required*: Yes *Type*: [ToolInputSchema](aws-properties-bedrock-prompt-toolinputschema.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name for the tool. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::PromptVersion Creates a static snapshot of your prompt that can be deployed to production. For more information, see [Deploy prompts using Prompt management by creating versions](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-deploy.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::Bedrock::PromptVersion", "Properties" : { "[Description](#cfn-bedrock-promptversion-description)" : String, "[PromptArn](#cfn-bedrock-promptversion-promptarn)" : String, "[Tags](#cfn-bedrock-promptversion-tags)" : {Key: Value, ...} } } ``` ### YAML ``` Type: AWS::Bedrock::PromptVersion Properties: [Description](#cfn-bedrock-promptversion-description): String [PromptArn](#cfn-bedrock-promptversion-promptarn): String [Tags](#cfn-bedrock-promptversion-tags): Key: Value ``` ## Properties `Description` The description of the prompt version. *Required*: No *Type*: String *Minimum*: `1` *Maximum*: `200` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `PromptArn` The Amazon Resource Name (ARN) of the version of the prompt. *Required*: Yes *Type*: String *Pattern*: `^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) `Tags` A map of tags attached to the prompt version and their values. *Required*: No *Type*: Object of String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `0` *Maximum*: `256` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Return values ### Ref When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the Amazon Resource Number (ARN) of the prompt version. For example, `{ "Ref": "myPromptVersion" }` could return the value `""arn:aws:bedrock:us-east-1:123456789012:prompt/PROMPT12345:1"`. For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html). ### Fn::GetAtt The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html). #### `Arn` The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request). `CreatedAt` The time at which the prompt was created. `CustomerEncryptionKeyArn` The Amazon Resource Name (ARN) of the KMS key that the prompt version is encrypted with. `DefaultVariant` The name of the default variant for the prompt. This value must match the `name` field in the relevant [PromptVariant](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html) object. `Name` The name of the prompt. `PromptId` The unique identifier of the prompt. `UpdatedAt` The time at which the prompt was last updated. `Variants` A list of objects, each containing details about a variant of the prompt. `Version` The version of the prompt that this summary applies to. # AWS::Bedrock::PromptVersion CachePointBlock Defines a section of content to be cached for reuse in subsequent API calls. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Type](#cfn-bedrock-promptversion-cachepointblock-type)" : String } ``` ### YAML ``` [Type](#cfn-bedrock-promptversion-cachepointblock-type): String ``` ## Properties `Type` Specifies the type of cache point within the CachePointBlock. *Required*: Yes *Type*: String *Allowed values*: `default` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::PromptVersion ChatPromptTemplateConfiguration Contains configurations to use a prompt in a conversational format. For more information, see [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[InputVariables](#cfn-bedrock-promptversion-chatprompttemplateconfiguration-inputvariables)" : [ PromptInputVariable, ... ], "[Messages](#cfn-bedrock-promptversion-chatprompttemplateconfiguration-messages)" : [ Message, ... ], "[System](#cfn-bedrock-promptversion-chatprompttemplateconfiguration-system)" : [ SystemContentBlock, ... ], "[ToolConfiguration](#cfn-bedrock-promptversion-chatprompttemplateconfiguration-toolconfiguration)" : ToolConfiguration } ``` ### YAML ``` [InputVariables](#cfn-bedrock-promptversion-chatprompttemplateconfiguration-inputvariables): - PromptInputVariable [Messages](#cfn-bedrock-promptversion-chatprompttemplateconfiguration-messages): - Message [System](#cfn-bedrock-promptversion-chatprompttemplateconfiguration-system): - SystemContentBlock [ToolConfiguration](#cfn-bedrock-promptversion-chatprompttemplateconfiguration-toolconfiguration): ToolConfiguration ``` ## Properties `InputVariables` An array of the variables in the prompt template. *Required*: No *Type*: Array of [PromptInputVariable](aws-properties-bedrock-promptversion-promptinputvariable.md) *Minimum*: `0` *Maximum*: `20` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Messages` Contains messages in the chat for the prompt. *Required*: Yes *Type*: Array of [Message](aws-properties-bedrock-promptversion-message.md) *Minimum*: `0` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `System` Contains system prompts to provide context to the model or to describe how it should behave. *Required*: No *Type*: Array of [SystemContentBlock](aws-properties-bedrock-promptversion-systemcontentblock.md) *Minimum*: `0` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ToolConfiguration` Configuration information for the tools that the model can use when generating a response. *Required*: No *Type*: [ToolConfiguration](aws-properties-bedrock-promptversion-toolconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::PromptVersion ContentBlock A block of content for a message that you pass to, or receive from, a model with the [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) or [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html) API operations. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CachePoint](#cfn-bedrock-promptversion-contentblock-cachepoint)" : CachePointBlock, "[Text](#cfn-bedrock-promptversion-contentblock-text)" : String } ``` ### YAML ``` [CachePoint](#cfn-bedrock-promptversion-contentblock-cachepoint): CachePointBlock [Text](#cfn-bedrock-promptversion-contentblock-text): String ``` ## Properties `CachePoint` CachePoint to include in the message. *Required*: No *Type*: [CachePointBlock](aws-properties-bedrock-promptversion-cachepointblock.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Text` Text to include in the message. *Required*: No *Type*: String *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::PromptVersion Message A message input, or returned from, a call to [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) or [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Content](#cfn-bedrock-promptversion-message-content)" : [ ContentBlock, ... ], "[Role](#cfn-bedrock-promptversion-message-role)" : String } ``` ### YAML ``` [Content](#cfn-bedrock-promptversion-message-content): - ContentBlock [Role](#cfn-bedrock-promptversion-message-role): String ``` ## Properties `Content` The message content. Note the following restrictions: + You can include up to 20 images. Each image's size, height, and width must be no more than 3.75 MB, 8000 px, and 8000 px, respectively. + You can include up to five documents. Each document's size must be no more than 4.5 MB. + If you include a `ContentBlock` with a `document` field in the array, you must also include a `ContentBlock` with a `text` field. + You can only include images and documents if the `role` is `user`. *Required*: Yes *Type*: Array of [ContentBlock](aws-properties-bedrock-promptversion-contentblock.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Role` The role that the message plays in the message. *Required*: Yes *Type*: String *Allowed values*: `user | assistant` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::PromptVersion PromptAgentResource Contains specifications for an Amazon Bedrock agent with which to use the prompt. For more information, see [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html) and [Automate tasks in your application using conversational agents](https://docs.aws.amazon.com/bedrock/latest/userguide/agents.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AgentIdentifier](#cfn-bedrock-promptversion-promptagentresource-agentidentifier)" : String } ``` ### YAML ``` [AgentIdentifier](#cfn-bedrock-promptversion-promptagentresource-agentidentifier): String ``` ## Properties `AgentIdentifier` The ARN of the agent with which to use the prompt. *Required*: Yes *Type*: String *Pattern*: `^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::PromptVersion PromptGenAiResource Contains specifications for a generative AI resource with which to use the prompt. For more information, see [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Agent](#cfn-bedrock-promptversion-promptgenairesource-agent)" : PromptAgentResource } ``` ### YAML ``` [Agent](#cfn-bedrock-promptversion-promptgenairesource-agent): PromptAgentResource ``` ## Properties `Agent` Specifies an Amazon Bedrock agent with which to use the prompt. *Required*: Yes *Type*: [PromptAgentResource](aws-properties-bedrock-promptversion-promptagentresource.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::PromptVersion PromptInferenceConfiguration Contains inference configurations for the prompt. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Text](#cfn-bedrock-promptversion-promptinferenceconfiguration-text)" : PromptModelInferenceConfiguration } ``` ### YAML ``` [Text](#cfn-bedrock-promptversion-promptinferenceconfiguration-text): PromptModelInferenceConfiguration ``` ## Properties `Text` Contains inference configurations for a text prompt. *Required*: Yes *Type*: [PromptModelInferenceConfiguration](aws-properties-bedrock-promptversion-promptmodelinferenceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::PromptVersion PromptInputVariable Contains information about a variable in the prompt. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-bedrock-promptversion-promptinputvariable-name)" : String } ``` ### YAML ``` [Name](#cfn-bedrock-promptversion-promptinputvariable-name): String ``` ## Properties `Name` The name of the variable. *Required*: No *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::PromptVersion PromptMetadataEntry Contains a key-value pair that defines a metadata tag and value to attach to a prompt variant. For more information, see [Create a prompt using Prompt management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-create.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Key](#cfn-bedrock-promptversion-promptmetadataentry-key)" : String, "[Value](#cfn-bedrock-promptversion-promptmetadataentry-value)" : String } ``` ### YAML ``` [Key](#cfn-bedrock-promptversion-promptmetadataentry-key): String [Value](#cfn-bedrock-promptversion-promptmetadataentry-value): String ``` ## Properties `Key` The key of a metadata tag for a prompt variant. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `1` *Maximum*: `128` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Value` The value of a metadata tag for a prompt variant. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z0-9\s._:/=+@-]*$` *Minimum*: `1` *Maximum*: `1024` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::PromptVersion PromptModelInferenceConfiguration Contains inference configurations related to model inference for a prompt. For more information, see [Inference parameters](https://docs.aws.amazon.com/bedrock/latest/userguide/inference-parameters.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[MaxTokens](#cfn-bedrock-promptversion-promptmodelinferenceconfiguration-maxtokens)" : Number, "[StopSequences](#cfn-bedrock-promptversion-promptmodelinferenceconfiguration-stopsequences)" : [ String, ... ], "[Temperature](#cfn-bedrock-promptversion-promptmodelinferenceconfiguration-temperature)" : Number, "[TopP](#cfn-bedrock-promptversion-promptmodelinferenceconfiguration-topp)" : Number } ``` ### YAML ``` [MaxTokens](#cfn-bedrock-promptversion-promptmodelinferenceconfiguration-maxtokens): Number [StopSequences](#cfn-bedrock-promptversion-promptmodelinferenceconfiguration-stopsequences): - String [Temperature](#cfn-bedrock-promptversion-promptmodelinferenceconfiguration-temperature): Number [TopP](#cfn-bedrock-promptversion-promptmodelinferenceconfiguration-topp): Number ``` ## Properties `MaxTokens` The maximum number of tokens to return in the response. *Required*: No *Type*: Number *Minimum*: `0` *Maximum*: `4096` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `StopSequences` A list of strings that define sequences after which the model will stop generating. *Required*: No *Type*: Array of String *Minimum*: `0` *Maximum*: `4` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Temperature` Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs. *Required*: No *Type*: Number *Minimum*: `0` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TopP` The percentage of most-likely candidates that the model considers for the next token. *Required*: No *Type*: Number *Minimum*: `0` *Maximum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::PromptVersion PromptTemplateConfiguration Contains the message for a prompt. For more information, see [Construct and store reusable prompts with Prompt management in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Chat](#cfn-bedrock-promptversion-prompttemplateconfiguration-chat)" : ChatPromptTemplateConfiguration, "[Text](#cfn-bedrock-promptversion-prompttemplateconfiguration-text)" : TextPromptTemplateConfiguration } ``` ### YAML ``` [Chat](#cfn-bedrock-promptversion-prompttemplateconfiguration-chat): ChatPromptTemplateConfiguration [Text](#cfn-bedrock-promptversion-prompttemplateconfiguration-text): TextPromptTemplateConfiguration ``` ## Properties `Chat` Contains configurations to use the prompt in a conversational format. *Required*: No *Type*: [ChatPromptTemplateConfiguration](aws-properties-bedrock-promptversion-chatprompttemplateconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Text` Contains configurations for the text in a message for a prompt. *Required*: No *Type*: [TextPromptTemplateConfiguration](aws-properties-bedrock-promptversion-textprompttemplateconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::PromptVersion PromptVariant Contains details about a variant of the prompt. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[AdditionalModelRequestFields](#cfn-bedrock-promptversion-promptvariant-additionalmodelrequestfields)" : Json, "[GenAiResource](#cfn-bedrock-promptversion-promptvariant-genairesource)" : PromptGenAiResource, "[InferenceConfiguration](#cfn-bedrock-promptversion-promptvariant-inferenceconfiguration)" : PromptInferenceConfiguration, "[Metadata](#cfn-bedrock-promptversion-promptvariant-metadata)" : [ PromptMetadataEntry, ... ], "[ModelId](#cfn-bedrock-promptversion-promptvariant-modelid)" : String, "[Name](#cfn-bedrock-promptversion-promptvariant-name)" : String, "[TemplateConfiguration](#cfn-bedrock-promptversion-promptvariant-templateconfiguration)" : PromptTemplateConfiguration, "[TemplateType](#cfn-bedrock-promptversion-promptvariant-templatetype)" : String } ``` ### YAML ``` [AdditionalModelRequestFields](#cfn-bedrock-promptversion-promptvariant-additionalmodelrequestfields): Json [GenAiResource](#cfn-bedrock-promptversion-promptvariant-genairesource): PromptGenAiResource [InferenceConfiguration](#cfn-bedrock-promptversion-promptvariant-inferenceconfiguration): PromptInferenceConfiguration [Metadata](#cfn-bedrock-promptversion-promptvariant-metadata): - PromptMetadataEntry [ModelId](#cfn-bedrock-promptversion-promptvariant-modelid): String [Name](#cfn-bedrock-promptversion-promptvariant-name): String [TemplateConfiguration](#cfn-bedrock-promptversion-promptvariant-templateconfiguration): PromptTemplateConfiguration [TemplateType](#cfn-bedrock-promptversion-promptvariant-templatetype): String ``` ## Properties `AdditionalModelRequestFields` Contains model-specific inference configurations that aren't in the `inferenceConfiguration` field. To see model-specific inference parameters, see [Inference request parameters and response fields for foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html). *Required*: No *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `GenAiResource` Specifies a generative AI resource with which to use the prompt. *Required*: No *Type*: [PromptGenAiResource](aws-properties-bedrock-promptversion-promptgenairesource.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InferenceConfiguration` Contains inference configurations for the prompt variant. *Required*: No *Type*: [PromptInferenceConfiguration](aws-properties-bedrock-promptversion-promptinferenceconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Metadata` An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant. *Required*: No *Type*: Array of [PromptMetadataEntry](aws-properties-bedrock-promptversion-promptmetadataentry.md) *Minimum*: `0` *Maximum*: `50` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ModelId` The unique identifier of the model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) with which to run inference on the prompt. *Required*: No *Type*: String *Pattern*: `^(arn:aws(-[^:]{1,12})?:(bedrock|sagemaker):[a-z0-9-]{1,20}:([0-9]{12})?:([a-z-]+/)?)?([a-zA-Z0-9.-]{1,63}){0,2}(([:][a-z0-9-]{1,63}){0,2})?(/[a-z0-9]{1,12})?$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name of the prompt variant. *Required*: Yes *Type*: String *Pattern*: `^([0-9a-zA-Z][_-]?){1,100}$` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TemplateConfiguration` Contains configurations for the prompt template. *Required*: Yes *Type*: [PromptTemplateConfiguration](aws-properties-bedrock-promptversion-prompttemplateconfiguration.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `TemplateType` The type of prompt template to use. *Required*: Yes *Type*: String *Allowed values*: `TEXT | CHAT` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::PromptVersion SpecificToolChoice The model must request a specific tool. For example, `{"tool" : {"name" : "Your tool name"}}`. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide **Note** This field is only supported by Anthropic Claude 3 models. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Name](#cfn-bedrock-promptversion-specifictoolchoice-name)" : String } ``` ### YAML ``` [Name](#cfn-bedrock-promptversion-specifictoolchoice-name): String ``` ## Properties `Name` The name of the tool that the model must request. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::PromptVersion SystemContentBlock Contains configurations for instructions to provide the model for how to handle input. To learn more, see [Using the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference-call.html). ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CachePoint](#cfn-bedrock-promptversion-systemcontentblock-cachepoint)" : CachePointBlock, "[Text](#cfn-bedrock-promptversion-systemcontentblock-text)" : String } ``` ### YAML ``` [CachePoint](#cfn-bedrock-promptversion-systemcontentblock-cachepoint): CachePointBlock [Text](#cfn-bedrock-promptversion-systemcontentblock-text): String ``` ## Properties `CachePoint` CachePoint to include in the system prompt. *Required*: No *Type*: [CachePointBlock](aws-properties-bedrock-promptversion-cachepointblock.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Text` A system prompt for the model. *Required*: No *Type*: String *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::PromptVersion TextPromptTemplateConfiguration Contains configurations for a text prompt template. To include a variable, enclose a word in double curly braces as in `{{variable}}`. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CachePoint](#cfn-bedrock-promptversion-textprompttemplateconfiguration-cachepoint)" : CachePointBlock, "[InputVariables](#cfn-bedrock-promptversion-textprompttemplateconfiguration-inputvariables)" : [ PromptInputVariable, ... ], "[Text](#cfn-bedrock-promptversion-textprompttemplateconfiguration-text)" : String } ``` ### YAML ``` [CachePoint](#cfn-bedrock-promptversion-textprompttemplateconfiguration-cachepoint): CachePointBlock [InputVariables](#cfn-bedrock-promptversion-textprompttemplateconfiguration-inputvariables): - PromptInputVariable [Text](#cfn-bedrock-promptversion-textprompttemplateconfiguration-text): String ``` ## Properties `CachePoint` A cache checkpoint within a template configuration. *Required*: No *Type*: [CachePointBlock](aws-properties-bedrock-promptversion-cachepointblock.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputVariables` An array of the variables in the prompt template. *Required*: No *Type*: Array of [PromptInputVariable](aws-properties-bedrock-promptversion-promptinputvariable.md) *Minimum*: `0` *Maximum*: `20` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Text` The message for the prompt. *Required*: Yes *Type*: String *Minimum*: `1` *Maximum*: `200000` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::PromptVersion Tool Information about a tool that you can use with the Converse API. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[CachePoint](#cfn-bedrock-promptversion-tool-cachepoint)" : CachePointBlock, "[ToolSpec](#cfn-bedrock-promptversion-tool-toolspec)" : ToolSpecification } ``` ### YAML ``` [CachePoint](#cfn-bedrock-promptversion-tool-cachepoint): CachePointBlock [ToolSpec](#cfn-bedrock-promptversion-tool-toolspec): ToolSpecification ``` ## Properties `CachePoint` CachePoint to include in the tool configuration. *Required*: No *Type*: [CachePointBlock](aws-properties-bedrock-promptversion-cachepointblock.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ToolSpec` The specfication for the tool. *Required*: No *Type*: [ToolSpecification](aws-properties-bedrock-promptversion-toolspecification.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::PromptVersion ToolChoice Determines which tools the model should request in a call to `Converse` or `ConverseStream`. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Any](#cfn-bedrock-promptversion-toolchoice-any)" : Json, "[Auto](#cfn-bedrock-promptversion-toolchoice-auto)" : Json, "[Tool](#cfn-bedrock-promptversion-toolchoice-tool)" : SpecificToolChoice } ``` ### YAML ``` [Any](#cfn-bedrock-promptversion-toolchoice-any): Json [Auto](#cfn-bedrock-promptversion-toolchoice-auto): Json [Tool](#cfn-bedrock-promptversion-toolchoice-tool): SpecificToolChoice ``` ## Properties `Any` The model must request at least one tool (no text is generated). *Required*: No *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Auto` (Default). The Model automatically decides if a tool should be called or whether to generate text instead. *Required*: No *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tool` The Model must request the specified tool. Only supported by Anthropic Claude 3 and Amazon Nova models. *Required*: No *Type*: [SpecificToolChoice](aws-properties-bedrock-promptversion-specifictoolchoice.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::PromptVersion ToolConfiguration Configuration information for the tools that you pass to a model. For more information, see [Tool use (function calling)](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[ToolChoice](#cfn-bedrock-promptversion-toolconfiguration-toolchoice)" : ToolChoice, "[Tools](#cfn-bedrock-promptversion-toolconfiguration-tools)" : [ Tool, ... ] } ``` ### YAML ``` [ToolChoice](#cfn-bedrock-promptversion-toolconfiguration-toolchoice): ToolChoice [Tools](#cfn-bedrock-promptversion-toolconfiguration-tools): - Tool ``` ## Properties `ToolChoice` If supported by model, forces the model to request a tool. *Required*: No *Type*: [ToolChoice](aws-properties-bedrock-promptversion-toolchoice.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Tools` An array of tools that you want to pass to a model. *Required*: Yes *Type*: Array of [Tool](aws-properties-bedrock-promptversion-tool.md) *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::PromptVersion ToolInputSchema The schema for the tool. The top level schema type must be `object`. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Json](#cfn-bedrock-promptversion-toolinputschema-json)" : Json } ``` ### YAML ``` [Json](#cfn-bedrock-promptversion-toolinputschema-json): Json ``` ## Properties `Json` The JSON schema for the tool. For more information, see [JSON Schema Reference](https://json-schema.org/understanding-json-schema/reference). *Required*: Yes *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::PromptVersion ToolSpecification The specification for the tool. For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "[Description](#cfn-bedrock-promptversion-toolspecification-description)" : String, "[InputSchema](#cfn-bedrock-promptversion-toolspecification-inputschema)" : ToolInputSchema, "[Name](#cfn-bedrock-promptversion-toolspecification-name)" : String } ``` ### YAML ``` [Description](#cfn-bedrock-promptversion-toolspecification-description): String [InputSchema](#cfn-bedrock-promptversion-toolspecification-inputschema): ToolInputSchema [Name](#cfn-bedrock-promptversion-toolspecification-name): String ``` ## Properties `Description` The description for the tool. *Required*: No *Type*: String *Minimum*: `1` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `InputSchema` The input schema for the tool in JSON format. *Required*: Yes *Type*: [ToolInputSchema](aws-properties-bedrock-promptversion-toolinputschema.md) *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `Name` The name for the tool. *Required*: Yes *Type*: String *Pattern*: `^[a-zA-Z][a-zA-Z0-9_]*$` *Minimum*: `1` *Maximum*: `64` *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) # AWS::Bedrock::ResourcePolicy Adds a resource policy for a Bedrock resource. ## Syntax To declare this entity in your CloudFormation template, use the following syntax: ### JSON ``` { "Type" : "AWS::Bedrock::ResourcePolicy", "Properties" : { "[PolicyDocument](#cfn-bedrock-resourcepolicy-policydocument)" : Json, "[ResourceArn](#cfn-bedrock-resourcepolicy-resourcearn)" : String } } ``` ### YAML ``` Type: AWS::Bedrock::ResourcePolicy Properties: [PolicyDocument](#cfn-bedrock-resourcepolicy-policydocument): Json [ResourceArn](#cfn-bedrock-resourcepolicy-resourcearn): String ``` ## Properties `PolicyDocument` The JSON string representing the Bedrock resource policy. *Required*: Yes *Type*: Json *Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt) `ResourceArn` The ARN of the Bedrock resource to which this resource policy applies. *Required*: Yes *Type*: String *Pattern*: `^arn:aws(-[a-z]+)*:bedrock:[a-z0-9-]+:[0-9]{12}:(guardrail|guardrail-profile)/[a-z0-9]+$` *Minimum*: `1` *Maximum*: `2048` *Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) ## Return values ### Ref