@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-bedrock-agent.d.ts

@@ -1,4 +1,16 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html}
+ */
 export type BedrockAgent = ResourceDefinitionWithAttributes<"AWS::Bedrock::Agent", BedrockAgentProps, BedrockAgentAttribs>;
 /**
  * Specifies an agent as a resource in a top-level template. Minimally, you must specify the following properties:
@@ -10,37 +22,45 @@ export type BedrockAgent = ResourceDefinitionWithAttributes<"AWS::Bedrock::Agent
  * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html}
  */
 export type BedrockAgentProps = {
     /**
      * The action groups that belong to an agent.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-actiongroups}
      */
     ActionGroups?: AgentActionGroup[] | undefined;
     /**
      * The agent's collaboration settings.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-agentcollaboration}
      */
     AgentCollaboration?: AgentCollaboration | undefined;
     /**
      * List of Agent Collaborators
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-agentcollaborators}
      */
     AgentCollaborators?: AgentCollaborator[] | undefined;
     /**
      * The name of the agent.
      * @pattern ^([0-9a-zA-Z][_-]?){1,100}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-agentname}
      */
     AgentName: string;
     /**
      * The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-agentresourcerolearn}
      */
     AgentResourceRoleArn?: string | undefined;
     /**
      * 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` .
      * @default false
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-autoprepare}
      */
     AutoPrepare?: boolean | undefined;
     /**
      * Contains custom orchestration configurations for the agent.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-customorchestration}
      */
     CustomOrchestration?: CustomOrchestration | undefined;
     /**
@@ -48,20 +68,24 @@ export type BedrockAgentProps = {
      * @minLength 1
      * @maxLength 2048
      * @pattern ^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-customerencryptionkeyarn}
      */
     CustomerEncryptionKeyArn?: string | undefined;
     /**
      * The description of the agent.
      * @minLength 1
      * @maxLength 200
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-description}
      */
     Description?: string | undefined;
     /**
      * The foundation model used for orchestration by the agent.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-foundationmodel}
      */
     FoundationModel?: string | undefined;
     /**
      * Details about the guardrail associated with the agent.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-guardrailconfiguration}
      */
     GuardrailConfiguration?: GuardrailConfiguration | undefined;
     /**
@@ -70,32 +94,39 @@ export type BedrockAgentProps = {
      * 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.
      * @min 60
      * @max 3600
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-idlesessionttlinseconds}
      */
     IdleSessionTTLInSeconds?: number | undefined;
     /**
      * Instructions that tell the agent what it should do and how it should interact with users.
      * @minLength 40
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-instruction}
      */
     Instruction?: string | undefined;
     /**
      * The knowledge bases associated with the agent.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-knowledgebases}
      */
     KnowledgeBases?: AgentKnowledgeBase[] | undefined;
     /**
      * Contains memory configuration for the agent.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-memoryconfiguration}
      */
     MemoryConfiguration?: MemoryConfiguration | undefined;
     /**
      * Specifies the orchestration strategy for the agent.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-orchestrationtype}
      */
     OrchestrationType?: OrchestrationType | undefined;
     /**
      * 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) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-promptoverrideconfiguration}
      */
     PromptOverrideConfiguration?: PromptOverrideConfiguration | undefined;
     /**
      * Specifies whether to delete the resource even if it's in use. By default, this value is `false` .
      * @default false
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-skipresourceinusecheckondelete}
      */
     SkipResourceInUseCheckOnDelete?: boolean | undefined;
     /**
@@ -103,6 +134,7 @@ export type BedrockAgentProps = {
      *
      * - [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)
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-tags}
      */
     Tags?: Record<string, string> | undefined;
     /**
@@ -110,19 +142,25 @@ export type BedrockAgentProps = {
      *
      * - [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)
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-testaliastags}
      */
     TestAliasTags?: Record<string, string> | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#aws-resource-bedrock-agent-return-values}
+ */
 export type BedrockAgentAttribs = {
     /**
      * The Amazon Resource Name (ARN) of the agent.
      * @maxLength 2048
      * @pattern ^arn:aws(|-cn|-us-gov):bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent/[0-9a-zA-Z]{10}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-agentarn}
      */
     AgentArn: string;
     /**
      * The unique identifier of the agent.
      * @pattern ^[0-9a-zA-Z]{10}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-agentid}
      */
     AgentId: string;
     /**
@@ -135,6 +173,7 @@ export type BedrockAgentAttribs = {
      * - FAILED – The agent API operation failed.
      * - UPDATING – The agent is being updated.
      * - DELETING – The agent is being deleted.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-agentstatus}
      */
     AgentStatus: AgentStatus;
     /**
@@ -142,34 +181,41 @@ export type BedrockAgentAttribs = {
      * @minLength 5
      * @maxLength 5
      * @pattern ^DRAFT$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-agentversion}
      */
     AgentVersion: string;
     /**
      * The time at which the agent was created.
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-createdat}
      */
     CreatedAt: string;
     /**
      * Contains reasons that the agent-related API that you invoked failed.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-failurereasons}
      */
     FailureReasons: string[];
     /**
      * The time at which the agent was last prepared.
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-preparedat}
      */
     PreparedAt: string;
     /**
      * Contains recommended actions to take for the agent-related API that you invoked to succeed.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-recommendedactions}
      */
     RecommendedActions: string[];
     /**
      * The time at which the agent was last updated.
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-updatedat}
      */
     UpdatedAt: string;
 };
 /**
  * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-apischema.html}
  */
 export type APISchema = {
     S3: S3Identifier;
@@ -181,6 +227,7 @@ export type APISchema = {
 };
 /**
  * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-actiongroupexecutor.html}
  */
 export type ActionGroupExecutor = {
     /**
@@ -194,65 +241,79 @@ export type ActionGroupExecutor = {
 };
 /**
  * Action Group Signature for a BuiltIn Action
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-actiongroupsignature.html}
  */
 export type ActionGroupSignature = "AMAZON.UserInput" | "AMAZON.CodeInterpreter";
 /**
  * State of the action group
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-actiongroupstate.html}
  */
 export type ActionGroupState = "ENABLED" | "DISABLED";
 /**
  * Contains details of the inline agent's action group.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html}
  */
 export type AgentActionGroup = {
     /**
      * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-actiongroupexecutor}
      */
     ActionGroupExecutor?: ActionGroupExecutor | undefined;
     /**
      * The name of the action group.
      * @pattern ^([0-9a-zA-Z][_-]?){1,100}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-actiongroupname}
      */
     ActionGroupName: string;
     /**
      * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-actiongroupstate}
      */
     ActionGroupState?: ActionGroupState | undefined;
     /**
      * 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) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-apischema}
      */
     ApiSchema?: APISchema | undefined;
     /**
      * A description of the action group.
      * @minLength 1
      * @maxLength 200
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-description}
      */
     Description?: string | undefined;
     /**
      * Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-functionschema}
      */
     FunctionSchema?: FunctionSchema | undefined;
     /**
      * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-parentactiongroupsignature}
      */
     ParentActionGroupSignature?: ActionGroupSignature | undefined;
     /**
      * Specifies whether to delete the resource even if it's in use. By default, this value is `false` .
      * @default false
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentactiongroup.html#cfn-bedrock-agent-agentactiongroup-skipresourceinusecheckondelete}
      */
     SkipResourceInUseCheckOnDelete?: boolean | undefined;
 };
 /**
  * Agent collaboration state
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentcollaboration.html}
  */
 export type AgentCollaboration = "DISABLED" | "SUPERVISOR" | "SUPERVISOR_ROUTER";
 /**
  * An agent collaborator.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentcollaborator.html}
  */
 export type AgentCollaborator = {
     /**
      * The collaborator's agent descriptor.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentcollaborator.html#cfn-bedrock-agent-agentcollaborator-agentdescriptor}
      */
     AgentDescriptor: {
         /**
@@ -263,55 +324,67 @@ export type AgentCollaborator = {
     };
     /**
      * The collaborator's instructions.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentcollaborator.html#cfn-bedrock-agent-agentcollaborator-collaborationinstruction}
      */
     CollaborationInstruction: string;
     /**
      * The collaborator's collaborator name.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentcollaborator.html#cfn-bedrock-agent-agentcollaborator-collaboratorname}
      */
     CollaboratorName: string;
     /**
      * The collaborator's relay conversation history.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentcollaborator.html#cfn-bedrock-agent-agentcollaborator-relayconversationhistory}
      */
     RelayConversationHistory?: RelayConversationHistory | undefined;
 };
 /**
  * Contains details about a knowledge base that is associated with an agent.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentknowledgebase.html}
  */
 export type AgentKnowledgeBase = {
     /**
      * The description of the association between the agent and the knowledge base.
      * @minLength 1
      * @maxLength 200
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentknowledgebase.html#cfn-bedrock-agent-agentknowledgebase-description}
      */
     Description: string;
     /**
      * The unique identifier of the association between the agent and the knowledge base.
      * @pattern ^[0-9a-zA-Z]{10}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentknowledgebase.html#cfn-bedrock-agent-agentknowledgebase-knowledgebaseid}
      */
     KnowledgeBaseId: string;
     /**
      * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentknowledgebase.html#cfn-bedrock-agent-agentknowledgebase-knowledgebasestate}
      */
     KnowledgeBaseState?: KnowledgeBaseState | undefined;
 };
 /**
  * Schema Type for Action APIs.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentstatus.html}
  */
 export type AgentStatus = "CREATING" | "PREPARING" | "PREPARED" | "NOT_PREPARED" | "DELETING" | "FAILED" | "VERSIONING" | "UPDATING";
 /**
  * Creation Mode for Prompt Configuration.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-creationmode.html}
  */
 export type CreationMode = "DEFAULT" | "OVERRIDDEN";
 /**
  * Custom control of action execution
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-customcontrolmethod.html}
  */
 export type CustomControlMethod = "RETURN_CONTROL";
 /**
  * Contains details of the custom orchestration configured for the agent.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-customorchestration.html}
  */
 export type CustomOrchestration = {
     /**
      * The structure of the executor invoking the actions in custom orchestration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-customorchestration.html#cfn-bedrock-agent-customorchestration-executor}
      */
     Executor?: OrchestrationExecutor | undefined;
 };
@@ -325,50 +398,60 @@ export type CustomOrchestration = {
  * - [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)
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-function.html}
  */
 export type Function = {
     /**
      * A description of the function and its purpose.
      * @minLength 1
      * @maxLength 1200
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-function.html#cfn-bedrock-agent-function-description}
      */
     Description?: string | undefined;
     /**
      * A name for the function.
      * @pattern ^([0-9a-zA-Z][_-]?){1,100}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-function.html#cfn-bedrock-agent-function-name}
      */
     Name: string;
     /**
      * The parameters that the agent elicits from the user to fulfill the function.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-function.html#cfn-bedrock-agent-function-parameters}
      */
     Parameters?: Record<string, ParameterDetail> | undefined;
     /**
      * Contains information if user confirmation is required to invoke the function.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-function.html#cfn-bedrock-agent-function-requireconfirmation}
      */
     RequireConfirmation?: RequireConfirmation | undefined;
 };
 /**
  * Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-functionschema.html}
  */
 export type FunctionSchema = {
     /**
      * A list of functions that each define an action in the action group.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-functionschema.html#cfn-bedrock-agent-functionschema-functions}
      */
     Functions: Function[];
 };
 /**
  * Configuration information for a guardrail that you use with the [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) operation.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-guardrailconfiguration.html}
  */
 export type GuardrailConfiguration = {
     /**
      * The identifier for the guardrail.
      * @maxLength 2048
      * @pattern ^(([a-z0-9]+)|(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:guardrail/[a-z0-9]+))$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-guardrailconfiguration.html#cfn-bedrock-agent-guardrailconfiguration-guardrailidentifier}
      */
     GuardrailIdentifier?: string | undefined;
     /**
      * The version of the guardrail.
      * @pattern ^(([0-9]{1,8})|(DRAFT))$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-guardrailconfiguration.html#cfn-bedrock-agent-guardrailconfiguration-guardrailversion}
      */
     GuardrailVersion?: string | undefined;
 };
@@ -376,16 +459,19 @@ export type GuardrailConfiguration = {
  * 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) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-inferenceconfiguration.html}
  */
 export type InferenceConfiguration = {
     /**
      * The maximum number of tokens allowed in the generated response.
      * @min 0
      * @max 4096
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-inferenceconfiguration.html#cfn-bedrock-agent-inferenceconfiguration-maximumlength}
      */
     MaximumLength?: number | undefined;
     /**
      * A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-inferenceconfiguration.html#cfn-bedrock-agent-inferenceconfiguration-stopsequences}
      */
     StopSequences?: string[] | undefined;
     /**
@@ -394,12 +480,14 @@ export type InferenceConfiguration = {
      * 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) .
      * @min 0
      * @max 1
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-inferenceconfiguration.html#cfn-bedrock-agent-inferenceconfiguration-temperature}
      */
     Temperature?: number | undefined;
     /**
      * 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.
      * @min 0
      * @max 500
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-inferenceconfiguration.html#cfn-bedrock-agent-inferenceconfiguration-topk}
      */
     TopK?: number | undefined;
     /**
@@ -408,98 +496,119 @@ export type InferenceConfiguration = {
      * 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) .
      * @min 0
      * @max 1
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-inferenceconfiguration.html#cfn-bedrock-agent-inferenceconfiguration-topp}
      */
     TopP?: number | undefined;
 };
 /**
  * State of the knowledge base; whether it is enabled or disabled
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-knowledgebasestate.html}
  */
 export type KnowledgeBaseState = "ENABLED" | "DISABLED";
 /**
  * Details of the memory configuration.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-memoryconfiguration.html}
  */
 export type MemoryConfiguration = {
     /**
      * The type of memory that is stored.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-memoryconfiguration.html#cfn-bedrock-agent-memoryconfiguration-enabledmemorytypes}
      */
     EnabledMemoryTypes?: MemoryType[] | undefined;
     /**
      * Contains the configuration for SESSION_SUMMARY memory type enabled for the agent.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-memoryconfiguration.html#cfn-bedrock-agent-memoryconfiguration-sessionsummaryconfiguration}
      */
     SessionSummaryConfiguration?: SessionSummaryConfiguration | undefined;
     /**
      * The number of days the agent is configured to retain the conversational context.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-memoryconfiguration.html#cfn-bedrock-agent-memoryconfiguration-storagedays}
      */
     StorageDays?: number | undefined;
 };
 /**
  * Memory type
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-memorytype.html}
  */
 export type MemoryType = "SESSION_SUMMARY";
 /**
  * The structure of the executor invoking the actions in custom orchestration.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-orchestrationexecutor.html}
  */
 export type OrchestrationExecutor = {
     /**
      * The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action.
      * @maxLength 2048
      * @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-_]+))?$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-orchestrationexecutor.html#cfn-bedrock-agent-orchestrationexecutor-lambda}
      */
     Lambda: string;
 };
 /**
  * Types of orchestration strategy for agents
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-orchestrationtype.html}
  */
 export type OrchestrationType = "DEFAULT" | "CUSTOM_ORCHESTRATION";
 /**
  * Contains details about a parameter in a function for an action group.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-parameterdetail.html}
  */
 export type ParameterDetail = {
     /**
      * A description of the parameter. Helps the foundation model determine how to elicit the parameters from the user.
      * @minLength 1
      * @maxLength 500
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-parameterdetail.html#cfn-bedrock-agent-parameterdetail-description}
      */
     Description?: string | undefined;
     /**
      * Whether the parameter is required for the agent to complete the function for action group invocation.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-parameterdetail.html#cfn-bedrock-agent-parameterdetail-required}
      */
     Required?: boolean | undefined;
     /**
      * The data type of the parameter.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-parameterdetail.html#cfn-bedrock-agent-parameterdetail-type}
      */
     Type: Type;
 };
 /**
  * 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) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptconfiguration.html}
  */
 export type PromptConfiguration = {
     /**
      * 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) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptconfiguration.html#cfn-bedrock-agent-promptconfiguration-additionalmodelrequestfields}
      */
     AdditionalModelRequestFields?: Record<string, unknown> | undefined;
     /**
      * 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) .
      * @minLength 1
      * @maxLength 100000
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptconfiguration.html#cfn-bedrock-agent-promptconfiguration-baseprompttemplate}
      */
     BasePromptTemplate?: string | undefined;
     /**
      * The agent's foundation model.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptconfiguration.html#cfn-bedrock-agent-promptconfiguration-foundationmodel}
      */
     FoundationModel?: string | undefined;
     /**
      * 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) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptconfiguration.html#cfn-bedrock-agent-promptconfiguration-inferenceconfiguration}
      */
     InferenceConfiguration?: InferenceConfiguration | undefined;
     /**
      * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptconfiguration.html#cfn-bedrock-agent-promptconfiguration-parsermode}
      */
     ParserMode?: CreationMode | undefined;
     /**
      * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptconfiguration.html#cfn-bedrock-agent-promptconfiguration-promptcreationmode}
      */
     PromptCreationMode?: CreationMode | undefined;
     /**
@@ -509,46 +618,56 @@ export type PromptConfiguration = {
      * - `ORCHESTRATION` – `ENABLED`
      * - `KNOWLEDGE_BASE_RESPONSE_GENERATION` – `ENABLED`
      * - `POST_PROCESSING` – `DISABLED`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptconfiguration.html#cfn-bedrock-agent-promptconfiguration-promptstate}
      */
     PromptState?: PromptState | undefined;
     /**
      * The step in the agent sequence that this prompt configuration applies to.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptconfiguration.html#cfn-bedrock-agent-promptconfiguration-prompttype}
      */
     PromptType?: PromptType | undefined;
 };
 /**
  * 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) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptoverrideconfiguration.html}
  */
 export type PromptOverrideConfiguration = {
     /**
      * 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) .
      * @maxLength 2048
      * @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-_]+))?$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptoverrideconfiguration.html#cfn-bedrock-agent-promptoverrideconfiguration-overridelambda}
      */
     OverrideLambda?: string | undefined;
     /**
      * 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) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptoverrideconfiguration.html#cfn-bedrock-agent-promptoverrideconfiguration-promptconfigurations}
      */
     PromptConfigurations: PromptConfiguration[];
 };
 /**
  * Prompt State.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-promptstate.html}
  */
 export type PromptState = "ENABLED" | "DISABLED";
 /**
  * Prompt Type.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-prompttype.html}
  */
 export type PromptType = "PRE_PROCESSING" | "ORCHESTRATION" | "POST_PROCESSING" | "ROUTING_CLASSIFIER" | "MEMORY_SUMMARIZATION" | "KNOWLEDGE_BASE_RESPONSE_GENERATION";
 /**
  * Relay conversation history state
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-relayconversationhistory.html}
  */
 export type RelayConversationHistory = "TO_COLLABORATOR" | "DISABLED";
 /**
  * ENUM to check if action requires user confirmation
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-requireconfirmation.html}
  */
 export type RequireConfirmation = "ENABLED" | "DISABLED";
 /**
  * The identifier information for an Amazon S3 bucket.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-s3identifier.html}
  */
 export type S3Identifier = {
     /**
@@ -556,6 +675,7 @@ export type S3Identifier = {
      * @minLength 3
      * @maxLength 63
      * @pattern ^[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-s3identifier.html#cfn-bedrock-agent-s3identifier-s3bucketname}
      */
     S3BucketName?: string | undefined;
     /**
@@ -563,20 +683,24 @@ export type S3Identifier = {
      * @minLength 1
      * @maxLength 1024
      * @pattern ^[\.\-\!\*\_\'\(\)a-zA-Z0-9][\.\-\!\*\_\'\(\)\/a-zA-Z0-9]*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-s3identifier.html#cfn-bedrock-agent-s3identifier-s3objectkey}
      */
     S3ObjectKey?: string | undefined;
 };
 /**
  * Configuration for SESSION_SUMMARY memory type enabled for the agent.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-sessionsummaryconfiguration.html}
  */
 export type SessionSummaryConfiguration = {
     /**
      * Maximum number of recent session summaries to include in the agent's prompt context.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-sessionsummaryconfiguration.html#cfn-bedrock-agent-sessionsummaryconfiguration-maxrecentsessions}
      */
     MaxRecentSessions?: number | undefined;
 };
 /**
  * Parameter Type
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-type.html}
  */
 export type Type = "string" | "number" | "integer" | "boolean" | "array";
 //# sourceMappingURL=aws-bedrock-agent.d.ts.map