@propulsionworks/cloudformation 0.1.0 → 0.1.2

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

@@ -1,7 +1,12 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html}
+ */
 export type BedrockPrompt = ResourceDefinitionWithAttributes<"AWS::Bedrock::Prompt", BedrockPromptProps, BedrockPromptAttribs>;
 /**
  * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html}
  */
 export type BedrockPromptProps = {
     /**
@@ -9,22 +14,26 @@ export type BedrockPromptProps = {
      * @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-prompt.html#cfn-bedrock-prompt-customerencryptionkeyarn}
      */
     CustomerEncryptionKeyArn?: string | undefined;
     /**
      * 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.
      * @pattern ^([0-9a-zA-Z][_-]?){1,100}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-defaultvariant}
      */
     DefaultVariant?: string | undefined;
     /**
      * The description of the prompt.
      * @minLength 1
      * @maxLength 200
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-description}
      */
     Description?: string | undefined;
     /**
      * The name of the prompt.
      * @pattern ^([0-9a-zA-Z][_-]?){1,100}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-name}
      */
     Name: string;
     /**
@@ -32,34 +41,43 @@ export type BedrockPromptProps = {
      *
      * - [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-prompt.html#cfn-bedrock-prompt-tags}
      */
     Tags?: Record<string, string> | undefined;
     /**
      * A list of objects, each containing details about a variant of the prompt.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-variants}
      */
     Variants?: PromptVariant[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#aws-resource-bedrock-prompt-return-values}
+ */
 export type BedrockPromptAttribs = {
     /**
      * The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).
      * @minLength 1
      * @maxLength 2048
      * @pattern ^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-arn}
      */
     Arn: string;
     /**
      * The time at which the prompt was created.
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-createdat}
      */
     CreatedAt: string;
     /**
      * The unique identifier of the prompt.
      * @pattern ^[0-9a-zA-Z]{10}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-id}
      */
     Id: string;
     /**
      * The time at which the prompt was last updated.
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-updatedat}
      */
     UpdatedAt: string;
     /**
@@ -67,45 +85,55 @@ export type BedrockPromptAttribs = {
      * @minLength 5
      * @maxLength 5
      * @pattern ^DRAFT$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-prompt.html#cfn-bedrock-prompt-version}
      */
     Version: string;
 };
 /**
  * Defines a section of content to be cached for reuse in subsequent API calls.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-cachepointblock.html}
  */
 export type CachePointBlock = {
     /**
      * Specifies the type of cache point within the CachePointBlock.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-cachepointblock.html#cfn-bedrock-prompt-cachepointblock-type}
      */
     Type: CachePointType;
 };
 /**
  * CachePoint types for CachePointBlock
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-cachepointtype.html}
  */
 export type CachePointType = "default";
 /**
  * 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) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-chatprompttemplateconfiguration.html}
  */
 export type ChatPromptTemplateConfiguration = {
     /**
      * An array of the variables in the prompt template.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-chatprompttemplateconfiguration.html#cfn-bedrock-prompt-chatprompttemplateconfiguration-inputvariables}
      */
     InputVariables?: PromptInputVariable[] | undefined;
     /**
      * Contains messages in the chat for the prompt.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-chatprompttemplateconfiguration.html#cfn-bedrock-prompt-chatprompttemplateconfiguration-messages}
      */
     Messages: Message[];
     /**
      * Contains system prompts to provide context to the model or to describe how it should behave.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-chatprompttemplateconfiguration.html#cfn-bedrock-prompt-chatprompttemplateconfiguration-system}
      */
     System?: SystemContentBlock[] | undefined;
     /**
      * Configuration information for the tools that the model can use when generating a response.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-chatprompttemplateconfiguration.html#cfn-bedrock-prompt-chatprompttemplateconfiguration-toolconfiguration}
      */
     ToolConfiguration?: ToolConfiguration | undefined;
 };
 /**
  * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-contentblock.html}
  */
 export type ContentBlock = {
     /**
@@ -118,10 +146,12 @@ export type ContentBlock = {
 };
 /**
  * Conversation roles for the chat prompt
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-conversationrole.html}
  */
 export type ConversationRole = "user" | "assistant";
 /**
  * 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) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-message.html}
  */
 export type Message = {
     /**
@@ -131,88 +161,105 @@ export type Message = {
      * - 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` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-message.html#cfn-bedrock-prompt-message-content}
      */
     Content: ContentBlock[];
     /**
      * The role that the message plays in the message.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-message.html#cfn-bedrock-prompt-message-role}
      */
     Role: ConversationRole;
 };
 /**
  * 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) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptagentresource.html}
  */
 export type PromptAgentResource = {
     /**
      * The ARN of the agent with which to use the prompt.
      * @maxLength 2048
      * @pattern ^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:agent-alias/[0-9a-zA-Z]{10}/[0-9a-zA-Z]{10}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptagentresource.html#cfn-bedrock-prompt-promptagentresource-agentidentifier}
      */
     AgentIdentifier: string;
 };
 /**
  * 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) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptgenairesource.html}
  */
 export type PromptGenAiResource = {
     Agent: PromptAgentResource;
 };
 /**
  * Contains inference configurations for the prompt.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptinferenceconfiguration.html}
  */
 export type PromptInferenceConfiguration = {
     Text: PromptModelInferenceConfiguration;
 };
 /**
  * Contains information about a variable in the prompt.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptinputvariable.html}
  */
 export type PromptInputVariable = {
     /**
      * The name of the variable.
      * @pattern ^([0-9a-zA-Z][_-]?){1,100}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptinputvariable.html#cfn-bedrock-prompt-promptinputvariable-name}
      */
     Name?: string | undefined;
 };
 /**
  * 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) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptmetadataentry.html}
  */
 export type PromptMetadataEntry = {
     /**
      * The key of a metadata tag for a prompt variant.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptmetadataentry.html#cfn-bedrock-prompt-promptmetadataentry-key}
      */
     Key: string;
     /**
      * The value of a metadata tag for a prompt variant.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptmetadataentry.html#cfn-bedrock-prompt-promptmetadataentry-value}
      */
     Value: string;
 };
 /**
  * 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) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptmodelinferenceconfiguration.html}
  */
 export type PromptModelInferenceConfiguration = {
     /**
      * The maximum number of tokens to return in the response.
      * @min 0
-     * @max 4096
+     * @max 512000
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptmodelinferenceconfiguration.html#cfn-bedrock-prompt-promptmodelinferenceconfiguration-maxtokens}
      */
     MaxTokens?: number | undefined;
     /**
      * A list of strings that define sequences after which the model will stop generating.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptmodelinferenceconfiguration.html#cfn-bedrock-prompt-promptmodelinferenceconfiguration-stopsequences}
      */
     StopSequences?: string[] | undefined;
     /**
      * Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
      * @min 0
      * @max 1
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptmodelinferenceconfiguration.html#cfn-bedrock-prompt-promptmodelinferenceconfiguration-temperature}
      */
     Temperature?: number | undefined;
     /**
      * The percentage of most-likely candidates that the model considers for the next token.
      * @min 0
      * @max 1
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptmodelinferenceconfiguration.html#cfn-bedrock-prompt-promptmodelinferenceconfiguration-topp}
      */
     TopP?: number | undefined;
 };
 /**
  * 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) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-prompttemplateconfiguration.html}
  */
 export type PromptTemplateConfiguration = {
     Text: TextPromptTemplateConfiguration;
@@ -221,26 +268,32 @@ export type PromptTemplateConfiguration = {
 };
 /**
  * Prompt template type
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-prompttemplatetype.html}
  */
 export type PromptTemplateType = "TEXT" | "CHAT";
 /**
  * Contains details about a variant of the prompt.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html}
  */
 export type PromptVariant = {
     /**
      * 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) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html#cfn-bedrock-prompt-promptvariant-additionalmodelrequestfields}
      */
     AdditionalModelRequestFields?: Record<string, unknown> | undefined;
     /**
      * Specifies a generative AI resource with which to use the prompt.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html#cfn-bedrock-prompt-promptvariant-genairesource}
      */
     GenAiResource?: PromptGenAiResource | undefined;
     /**
      * Contains inference configurations for the prompt variant.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html#cfn-bedrock-prompt-promptvariant-inferenceconfiguration}
      */
     InferenceConfiguration?: PromptInferenceConfiguration | undefined;
     /**
      * An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html#cfn-bedrock-prompt-promptvariant-metadata}
      */
     Metadata?: PromptMetadataEntry[] | undefined;
     /**
@@ -248,19 +301,23 @@ export type PromptVariant = {
      * @minLength 1
      * @maxLength 2048
      * @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})?$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html#cfn-bedrock-prompt-promptvariant-modelid}
      */
     ModelId?: string | undefined;
     /**
      * The name of the prompt variant.
      * @pattern ^([0-9a-zA-Z][_-]?){1,100}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html#cfn-bedrock-prompt-promptvariant-name}
      */
     Name: string;
     /**
      * Contains configurations for the prompt template.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html#cfn-bedrock-prompt-promptvariant-templateconfiguration}
      */
     TemplateConfiguration: PromptTemplateConfiguration;
     /**
      * The type of prompt template to use.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html#cfn-bedrock-prompt-promptvariant-templatetype}
      */
     TemplateType: PromptTemplateType;
 };
@@ -268,6 +325,7 @@ export type PromptVariant = {
  * 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
  *
  * > This field is only supported by Anthropic Claude 3 models.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-specifictoolchoice.html}
  */
 export type SpecificToolChoice = {
     /**
@@ -275,11 +333,13 @@ export type SpecificToolChoice = {
      * @minLength 1
      * @maxLength 64
      * @pattern ^[a-zA-Z][a-zA-Z0-9_]*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-specifictoolchoice.html#cfn-bedrock-prompt-specifictoolchoice-name}
      */
     Name: string;
 };
 /**
  * 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) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-systemcontentblock.html}
  */
 export type SystemContentBlock = {
     /**
@@ -292,29 +352,35 @@ export type SystemContentBlock = {
 };
 /**
  * Contains configurations for a text prompt template. To include a variable, enclose a word in double curly braces as in `{{variable}}` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-textprompttemplateconfiguration.html}
  */
 export type TextPromptTemplateConfiguration = {
     /**
      * A cache checkpoint within a template configuration.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-textprompttemplateconfiguration.html#cfn-bedrock-prompt-textprompttemplateconfiguration-cachepoint}
      */
     CachePoint?: CachePointBlock | undefined;
     /**
      * An array of the variables in the prompt template.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-textprompttemplateconfiguration.html#cfn-bedrock-prompt-textprompttemplateconfiguration-inputvariables}
      */
     InputVariables?: PromptInputVariable[] | undefined;
     /**
      * The message for the prompt.
      * @minLength 1
      * @maxLength 200000
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-textprompttemplateconfiguration.html#cfn-bedrock-prompt-textprompttemplateconfiguration-text}
      */
     Text?: string | undefined;
     /**
      * The Amazon S3 location of the prompt text.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-textprompttemplateconfiguration.html#cfn-bedrock-prompt-textprompttemplateconfiguration-texts3location}
      */
     TextS3Location?: TextS3Location | undefined;
 };
 /**
  * The Amazon S3 location of the prompt text.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-texts3location.html}
  */
 export type TextS3Location = {
     /**
@@ -322,23 +388,27 @@ export type TextS3Location = {
      * @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-prompt-texts3location.html#cfn-bedrock-prompt-texts3location-bucket}
      */
     Bucket: string;
     /**
      * The object key for the Amazon S3 location.
      * @minLength 1
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-texts3location.html#cfn-bedrock-prompt-texts3location-key}
      */
     Key: string;
     /**
      * The version of the Amazon S3 location to use.
      * @minLength 1
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-texts3location.html#cfn-bedrock-prompt-texts3location-version}
      */
     Version?: string | undefined;
 };
 /**
  * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-tool.html}
  */
 export type Tool = {
     ToolSpec: ToolSpecification;
@@ -347,6 +417,7 @@ export type Tool = {
 };
 /**
  * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolchoice.html}
  */
 export type ToolChoice = {
     Auto: Record<string, unknown>;
@@ -357,34 +428,41 @@ export type ToolChoice = {
 };
 /**
  * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolconfiguration.html}
  */
 export type ToolConfiguration = {
     /**
      * If supported by model, forces the model to request a tool.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolconfiguration.html#cfn-bedrock-prompt-toolconfiguration-toolchoice}
      */
     ToolChoice?: ToolChoice | undefined;
     /**
      * An array of tools that you want to pass to a model.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolconfiguration.html#cfn-bedrock-prompt-toolconfiguration-tools}
      */
     Tools: Tool[];
 };
 /**
  * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolinputschema.html}
  */
 export type ToolInputSchema = {
     Json: Record<string, unknown>;
 };
 /**
  * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolspecification.html}
  */
 export type ToolSpecification = {
     /**
      * The description for the tool.
      * @minLength 1
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolspecification.html#cfn-bedrock-prompt-toolspecification-description}
      */
     Description?: string | undefined;
     /**
      * The input schema for the tool in JSON format.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolspecification.html#cfn-bedrock-prompt-toolspecification-inputschema}
      */
     InputSchema: ToolInputSchema;
     /**
@@ -392,6 +470,7 @@ export type ToolSpecification = {
      * @minLength 1
      * @maxLength 64
      * @pattern ^[a-zA-Z][a-zA-Z0-9_]*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolspecification.html#cfn-bedrock-prompt-toolspecification-name}
      */
     Name: string;
 };

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

@@ -1,13 +1,19 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html}
+ */
 export type BedrockPromptVersion = ResourceDefinitionWithAttributes<"AWS::Bedrock::PromptVersion", BedrockPromptVersionProps, BedrockPromptVersionAttribs>;
 /**
  * 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.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html}
  */
 export type BedrockPromptVersionProps = {
     /**
      * The description of the prompt version.
      * @minLength 1
      * @maxLength 200
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html#cfn-bedrock-promptversion-description}
      */
     Description?: string | undefined;
     /**
@@ -15,24 +21,31 @@ export type BedrockPromptVersionProps = {
      * @minLength 1
      * @maxLength 2048
      * @pattern ^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10})$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html#cfn-bedrock-promptversion-promptarn}
      */
     PromptArn: string;
     /**
      * A map of tags attached to the prompt version and their values.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html#cfn-bedrock-promptversion-tags}
      */
     Tags?: Record<string, string> | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html#aws-resource-bedrock-promptversion-return-values}
+ */
 export type BedrockPromptVersionAttribs = {
     /**
      * The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).
      * @minLength 1
      * @maxLength 2048
      * @pattern ^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]{1,20}:[0-9]{12}:prompt/[0-9a-zA-Z]{10}:[0-9]{1,20})$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html#cfn-bedrock-promptversion-arn}
      */
     Arn: string;
     /**
      * The time at which the prompt was created.
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html#cfn-bedrock-promptversion-createdat}
      */
     CreatedAt: string;
     /**
@@ -40,26 +53,31 @@ export type BedrockPromptVersionAttribs = {
      * @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-promptversion.html#cfn-bedrock-promptversion-customerencryptionkeyarn}
      */
     CustomerEncryptionKeyArn: string;
     /**
      * 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.
      * @pattern ^([0-9a-zA-Z][_-]?){1,100}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html#cfn-bedrock-promptversion-defaultvariant}
      */
     DefaultVariant: string;
     /**
      * The name of the prompt.
      * @pattern ^([0-9a-zA-Z][_-]?){1,100}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html#cfn-bedrock-promptversion-name}
      */
     Name: string;
     /**
      * The unique identifier of the prompt.
      * @pattern ^[0-9a-zA-Z]{10}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html#cfn-bedrock-promptversion-promptid}
      */
     PromptId: string;
     /**
      * The time at which the prompt was last updated.
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html#cfn-bedrock-promptversion-updatedat}
      */
     UpdatedAt: string;
     /**
@@ -67,6 +85,7 @@ export type BedrockPromptVersionAttribs = {
      * @minLength 1
      * @maxLength 5
      * @pattern ^(DRAFT|[0-9]{0,4}[1-9][0-9]{0,4})$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-promptversion.html#cfn-bedrock-promptversion-version}
      */
     Version: string;
 };