Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. bedrock
  6. AgentPrompt
Viewing docs for AWS v7.50.0
published on Thursday, Oct 8, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.bedrock.AgentPrompt

aws logo aws logo
Viewing docs for AWS v7.50.0
published on Thursday, Oct 8, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Resource for managing an AWS Bedrock Agents Prompt.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.bedrock.AgentPrompt("example", {
    name: "MyPrompt",
    description: "My prompt description.",
});

    import pulumi
import pulumi_aws as aws

example = aws.bedrock.AgentPrompt("example",
    name="MyPrompt",
    description="My prompt description.")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/bedrock"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bedrock.NewAgentPrompt(ctx, "example", &bedrock.AgentPromptArgs{
			Name:        pulumi.String("MyPrompt"),
			Description: pulumi.String("My prompt description."),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Bedrock.AgentPrompt("example", new()
    {
        Name = "MyPrompt",
        Description = "My prompt description.",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.bedrock.AgentPrompt;
import com.pulumi.aws.bedrock.AgentPromptArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new AgentPrompt("example", AgentPromptArgs.builder()
            .name("MyPrompt")
            .description("My prompt description.")
            .build());

    }
}

    resources:
  example:
    type: aws:bedrock:AgentPrompt
    properties:
      name: MyPrompt
      description: My prompt description.

    pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_bedrock_agentprompt" "example" {
  name        = "MyPrompt"
  description = "My prompt description."
}

    With Variants

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.bedrock.AgentPrompt("example", {
    variants: [{
        inferenceConfiguration: {
            text: {
                temperature: 0.8,
            },
        },
        templateConfiguration: {
            text: {
                inputVariables: [
                    {
                        name: "genre",
                    },
                    {
                        name: "number",
                    },
                ],
                text: "Make me a {{genre}} playlist consisting of the following number of songs: {{number}}.",
            },
        },
        name: "Variant1",
        modelId: "amazon.titan-text-express-v1",
        templateType: "TEXT",
    }],
    name: "MakePlaylist",
    description: "My first prompt.",
    defaultVariant: "Variant1",
});

    import pulumi
import pulumi_aws as aws

example = aws.bedrock.AgentPrompt("example",
    variants=[{
        "inference_configuration": {
            "text": {
                "temperature": 0.8,
            },
        },
        "template_configuration": {
            "text": {
                "input_variables": [
                    {
                        "name": "genre",
                    },
                    {
                        "name": "number",
                    },
                ],
                "text": "Make me a {{genre}} playlist consisting of the following number of songs: {{number}}.",
            },
        },
        "name": "Variant1",
        "model_id": "amazon.titan-text-express-v1",
        "template_type": "TEXT",
    }],
    name="MakePlaylist",
    description="My first prompt.",
    default_variant="Variant1")

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/bedrock"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bedrock.NewAgentPrompt(ctx, "example", &bedrock.AgentPromptArgs{
			Variants: bedrock.AgentPromptVariantArray{
				&bedrock.AgentPromptVariantArgs{
					InferenceConfiguration: &bedrock.AgentPromptVariantInferenceConfigurationArgs{
						Text: &bedrock.AgentPromptVariantInferenceConfigurationTextArgs{
							Temperature: pulumi.Float64(0.8),
						},
					},
					TemplateConfiguration: &bedrock.AgentPromptVariantTemplateConfigurationArgs{
						Text: &bedrock.AgentPromptVariantTemplateConfigurationTextArgs{
							InputVariables: bedrock.AgentPromptVariantTemplateConfigurationTextInputVariableArray{
								&bedrock.AgentPromptVariantTemplateConfigurationTextInputVariableArgs{
									Name: pulumi.String("genre"),
								},
								&bedrock.AgentPromptVariantTemplateConfigurationTextInputVariableArgs{
									Name: pulumi.String("number"),
								},
							},
							Text: pulumi.String("Make me a {{genre}} playlist consisting of the following number of songs: {{number}}."),
						},
					},
					Name:         pulumi.String("Variant1"),
					ModelId:      pulumi.String("amazon.titan-text-express-v1"),
					TemplateType: pulumi.String("TEXT"),
				},
			},
			Name:           pulumi.String("MakePlaylist"),
			Description:    pulumi.String("My first prompt."),
			DefaultVariant: pulumi.String("Variant1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Bedrock.AgentPrompt("example", new()
    {
        Variants = new[]
        {
            new Aws.Bedrock.Inputs.AgentPromptVariantArgs
            {
                InferenceConfiguration = new Aws.Bedrock.Inputs.AgentPromptVariantInferenceConfigurationArgs
                {
                    Text = new Aws.Bedrock.Inputs.AgentPromptVariantInferenceConfigurationTextArgs
                    {
                        Temperature = 0.8,
                    },
                },
                TemplateConfiguration = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationArgs
                {
                    Text = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationTextArgs
                    {
                        InputVariables = new[]
                        {
                            new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationTextInputVariableArgs
                            {
                                Name = "genre",
                            },
                            new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationTextInputVariableArgs
                            {
                                Name = "number",
                            },
                        },
                        Text = "Make me a {{genre}} playlist consisting of the following number of songs: {{number}}.",
                    },
                },
                Name = "Variant1",
                ModelId = "amazon.titan-text-express-v1",
                TemplateType = "TEXT",
            },
        },
        Name = "MakePlaylist",
        Description = "My first prompt.",
        DefaultVariant = "Variant1",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.bedrock.AgentPrompt;
import com.pulumi.aws.bedrock.AgentPromptArgs;
import com.pulumi.aws.bedrock.inputs.AgentPromptVariantArgs;
import com.pulumi.aws.bedrock.inputs.AgentPromptVariantInferenceConfigurationArgs;
import com.pulumi.aws.bedrock.inputs.AgentPromptVariantInferenceConfigurationTextArgs;
import com.pulumi.aws.bedrock.inputs.AgentPromptVariantTemplateConfigurationArgs;
import com.pulumi.aws.bedrock.inputs.AgentPromptVariantTemplateConfigurationTextArgs;
import com.pulumi.aws.bedrock.inputs.AgentPromptVariantTemplateConfigurationTextInputVariableArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new AgentPrompt("example", AgentPromptArgs.builder()
            .variants(AgentPromptVariantArgs.builder()
                .inferenceConfiguration(AgentPromptVariantInferenceConfigurationArgs.builder()
                    .text(AgentPromptVariantInferenceConfigurationTextArgs.builder()
                        .temperature(0.8)
                        .build())
                    .build())
                .templateConfiguration(AgentPromptVariantTemplateConfigurationArgs.builder()
                    .text(AgentPromptVariantTemplateConfigurationTextArgs.builder()
                        .inputVariables(                        
                            AgentPromptVariantTemplateConfigurationTextInputVariableArgs.builder()
                                .name("genre")
                                .build(),
                            AgentPromptVariantTemplateConfigurationTextInputVariableArgs.builder()
                                .name("number")
                                .build())
                        .text("Make me a {{genre}} playlist consisting of the following number of songs: {{number}}.")
                        .build())
                    .build())
                .name("Variant1")
                .modelId("amazon.titan-text-express-v1")
                .templateType("TEXT")
                .build())
            .name("MakePlaylist")
            .description("My first prompt.")
            .defaultVariant("Variant1")
            .build());

    }
}

    resources:
  example:
    type: aws:bedrock:AgentPrompt
    properties:
      variants:
        - inferenceConfiguration:
            text:
              temperature: 0.8
          templateConfiguration:
            text:
              inputVariables:
                - name: genre
                - name: number
              text: 'Make me a {{genre}} playlist consisting of the following number of songs: {{number}}.'
          name: Variant1
          modelId: amazon.titan-text-express-v1
          templateType: TEXT
      name: MakePlaylist
      description: My first prompt.
      defaultVariant: Variant1

    pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_bedrock_agentprompt" "example" {
  variants {
    inference_configuration = {
      text = {
        temperature = 0.8
      }
    }
    template_configuration = {
      text = {
        input_variables = [{
          "name" = "genre"
          }, {
          "name" = "number"
        }]
        text = "Make me a {{genre}} playlist consisting of the following number of songs: {{number}}."
      }
    }
    name          = "Variant1"
    model_id      = "amazon.titan-text-express-v1"
    template_type = "TEXT"
  }
  name            = "MakePlaylist"
  description     = "My first prompt."
  default_variant = "Variant1"
}

    Create AgentPrompt Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AgentPrompt(name: string, args?: AgentPromptArgs, opts?: CustomResourceOptions);
    @overload
def AgentPrompt(resource_name: str,
                args: Optional[AgentPromptArgs] = None,
                opts: Optional[ResourceOptions] = None)

@overload
def AgentPrompt(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                customer_encryption_key_arn: Optional[str] = None,
                default_variant: Optional[str] = None,
                description: Optional[str] = None,
                name: Optional[str] = None,
                region: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                variants: Optional[Sequence[AgentPromptVariantArgs]] = None)
    func NewAgentPrompt(ctx *Context, name string, args *AgentPromptArgs, opts ...ResourceOption) (*AgentPrompt, error)
    public AgentPrompt(string name, AgentPromptArgs? args = null, CustomResourceOptions? opts = null)
    public AgentPrompt(String name, AgentPromptArgs args)
public AgentPrompt(String name, AgentPromptArgs args, CustomResourceOptions options)

    type: aws:bedrock:AgentPrompt
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "aws_bedrock_agent_prompt" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args AgentPromptArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AgentPromptArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AgentPromptArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AgentPromptArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AgentPromptArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var agentPromptResource = new Aws.Bedrock.AgentPrompt("agentPromptResource", new()
{
    CustomerEncryptionKeyArn = "string",
    DefaultVariant = "string",
    Description = "string",
    Name = "string",
    Region = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Variants = new[]
    {
        new Aws.Bedrock.Inputs.AgentPromptVariantArgs
        {
            Name = "string",
            TemplateType = "string",
            AdditionalModelRequestFields = "string",
            GenAiResource = new Aws.Bedrock.Inputs.AgentPromptVariantGenAiResourceArgs
            {
                Agent = new Aws.Bedrock.Inputs.AgentPromptVariantGenAiResourceAgentArgs
                {
                    AgentIdentifier = "string",
                },
            },
            InferenceConfiguration = new Aws.Bedrock.Inputs.AgentPromptVariantInferenceConfigurationArgs
            {
                Text = new Aws.Bedrock.Inputs.AgentPromptVariantInferenceConfigurationTextArgs
                {
                    MaxTokens = 0,
                    StopSequences = new[]
                    {
                        "string",
                    },
                    Temperature = 0.0,
                    TopP = 0.0,
                },
            },
            Metadatas = new[]
            {
                new Aws.Bedrock.Inputs.AgentPromptVariantMetadataArgs
                {
                    Key = "string",
                    Value = "string",
                },
            },
            ModelId = "string",
            TemplateConfiguration = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationArgs
            {
                Chat = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatArgs
                {
                    Messages = new[]
                    {
                        new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatMessageArgs
                        {
                            Role = "string",
                            Content = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatMessageContentArgs
                            {
                                CachePoint = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatMessageContentCachePointArgs
                                {
                                    Type = "string",
                                },
                                Text = "string",
                            },
                        },
                    },
                    InputVariables = new[]
                    {
                        new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatInputVariableArgs
                        {
                            Name = "string",
                        },
                    },
                    Systems = new[]
                    {
                        new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatSystemArgs
                        {
                            CachePoint = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatSystemCachePointArgs
                            {
                                Type = "string",
                            },
                            Text = "string",
                        },
                    },
                    ToolConfiguration = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatToolConfigurationArgs
                    {
                        ToolChoice = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceArgs
                        {
                            Any = null,
                            Auto = null,
                            Tool = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceToolArgs
                            {
                                Name = "string",
                            },
                        },
                        Tools = new[]
                        {
                            new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolArgs
                            {
                                CachePoint = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolCachePointArgs
                                {
                                    Type = "string",
                                },
                                ToolSpec = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpecArgs
                                {
                                    Name = "string",
                                    Description = "string",
                                    InputSchema = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpecInputSchemaArgs
                                    {
                                        Json = "string",
                                    },
                                },
                            },
                        },
                    },
                },
                Text = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationTextArgs
                {
                    Text = "string",
                    CachePoint = new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationTextCachePointArgs
                    {
                        Type = "string",
                    },
                    InputVariables = new[]
                    {
                        new Aws.Bedrock.Inputs.AgentPromptVariantTemplateConfigurationTextInputVariableArgs
                        {
                            Name = "string",
                        },
                    },
                },
            },
        },
    },
});

    example, err := bedrock.NewAgentPrompt(ctx, "agentPromptResource", &bedrock.AgentPromptArgs{
	CustomerEncryptionKeyArn: pulumi.String("string"),
	DefaultVariant:           pulumi.String("string"),
	Description:              pulumi.String("string"),
	Name:                     pulumi.String("string"),
	Region:                   pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Variants: bedrock.AgentPromptVariantArray{
		&bedrock.AgentPromptVariantArgs{
			Name:                         pulumi.String("string"),
			TemplateType:                 pulumi.String("string"),
			AdditionalModelRequestFields: pulumi.String("string"),
			GenAiResource: &bedrock.AgentPromptVariantGenAiResourceArgs{
				Agent: &bedrock.AgentPromptVariantGenAiResourceAgentArgs{
					AgentIdentifier: pulumi.String("string"),
				},
			},
			InferenceConfiguration: &bedrock.AgentPromptVariantInferenceConfigurationArgs{
				Text: &bedrock.AgentPromptVariantInferenceConfigurationTextArgs{
					MaxTokens: pulumi.Int(0),
					StopSequences: pulumi.StringArray{
						pulumi.String("string"),
					},
					Temperature: pulumi.Float64(0),
					TopP:        pulumi.Float64(0),
				},
			},
			Metadatas: bedrock.AgentPromptVariantMetadataArray{
				&bedrock.AgentPromptVariantMetadataArgs{
					Key:   pulumi.String("string"),
					Value: pulumi.String("string"),
				},
			},
			ModelId: pulumi.String("string"),
			TemplateConfiguration: &bedrock.AgentPromptVariantTemplateConfigurationArgs{
				Chat: &bedrock.AgentPromptVariantTemplateConfigurationChatArgs{
					Messages: bedrock.AgentPromptVariantTemplateConfigurationChatMessageArray{
						&bedrock.AgentPromptVariantTemplateConfigurationChatMessageArgs{
							Role: pulumi.String("string"),
							Content: &bedrock.AgentPromptVariantTemplateConfigurationChatMessageContentArgs{
								CachePoint: &bedrock.AgentPromptVariantTemplateConfigurationChatMessageContentCachePointArgs{
									Type: pulumi.String("string"),
								},
								Text: pulumi.String("string"),
							},
						},
					},
					InputVariables: bedrock.AgentPromptVariantTemplateConfigurationChatInputVariableArray{
						&bedrock.AgentPromptVariantTemplateConfigurationChatInputVariableArgs{
							Name: pulumi.String("string"),
						},
					},
					Systems: bedrock.AgentPromptVariantTemplateConfigurationChatSystemArray{
						&bedrock.AgentPromptVariantTemplateConfigurationChatSystemArgs{
							CachePoint: &bedrock.AgentPromptVariantTemplateConfigurationChatSystemCachePointArgs{
								Type: pulumi.String("string"),
							},
							Text: pulumi.String("string"),
						},
					},
					ToolConfiguration: &bedrock.AgentPromptVariantTemplateConfigurationChatToolConfigurationArgs{
						ToolChoice: &bedrock.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceArgs{
							Any:  &bedrock.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceAnyArgs{},
							Auto: &bedrock.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceAutoArgs{},
							Tool: &bedrock.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceToolArgs{
								Name: pulumi.String("string"),
							},
						},
						Tools: bedrock.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolArray{
							&bedrock.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolArgs{
								CachePoint: &bedrock.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolCachePointArgs{
									Type: pulumi.String("string"),
								},
								ToolSpec: &bedrock.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpecArgs{
									Name:        pulumi.String("string"),
									Description: pulumi.String("string"),
									InputSchema: &bedrock.AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpecInputSchemaArgs{
										Json: pulumi.String("string"),
									},
								},
							},
						},
					},
				},
				Text: &bedrock.AgentPromptVariantTemplateConfigurationTextArgs{
					Text: pulumi.String("string"),
					CachePoint: &bedrock.AgentPromptVariantTemplateConfigurationTextCachePointArgs{
						Type: pulumi.String("string"),
					},
					InputVariables: bedrock.AgentPromptVariantTemplateConfigurationTextInputVariableArray{
						&bedrock.AgentPromptVariantTemplateConfigurationTextInputVariableArgs{
							Name: pulumi.String("string"),
						},
					},
				},
			},
		},
	},
})

    resource "aws_bedrock_agent_prompt" "agentPromptResource" {
  lifecycle {
    create_before_destroy = true
  }
  customer_encryption_key_arn = "string"
  default_variant             = "string"
  description                 = "string"
  name                        = "string"
  region                      = "string"
  tags = {
    "string" = "string"
  }
  variants {
    name                            = "string"
    template_type                   = "string"
    additional_model_request_fields = "string"
    gen_ai_resource = {
      agent = {
        agent_identifier = "string"
      }
    }
    inference_configuration = {
      text = {
        max_tokens     = 0
        stop_sequences = ["string"]
        temperature    = 0
        top_p          = 0
      }
    }
    metadatas {
      key   = "string"
      value = "string"
    }
    model_id = "string"
    template_configuration = {
      chat = {
        messages = [{
          role = "string"
          content = {
            cache_point = {
              type = "string"
            }
            text = "string"
          }
        }]
        input_variables = [{
          name = "string"
        }]
        systems = [{
          cache_point = {
            type = "string"
          }
          text = "string"
        }]
        tool_configuration = {
          tool_choice = {
            any  = {}
            auto = {}
            tool = {
              name = "string"
            }
          }
          tools = [{
            cache_point = {
              type = "string"
            }
            tool_spec = {
              name        = "string"
              description = "string"
              input_schema = {
                json = "string"
              }
            }
          }]
        }
      }
      text = {
        text = "string"
        cache_point = {
          type = "string"
        }
        input_variables = [{
          name = "string"
        }]
      }
    }
  }
}

    var agentPromptResource = new AgentPrompt("agentPromptResource", AgentPromptArgs.builder()
    .customerEncryptionKeyArn("string")
    .defaultVariant("string")
    .description("string")
    .name("string")
    .region("string")
    .tags(Map.of("string", "string"))
    .variants(AgentPromptVariantArgs.builder()
        .name("string")
        .templateType("string")
        .additionalModelRequestFields("string")
        .genAiResource(AgentPromptVariantGenAiResourceArgs.builder()
            .agent(AgentPromptVariantGenAiResourceAgentArgs.builder()
                .agentIdentifier("string")
                .build())
            .build())
        .inferenceConfiguration(AgentPromptVariantInferenceConfigurationArgs.builder()
            .text(AgentPromptVariantInferenceConfigurationTextArgs.builder()
                .maxTokens(0)
                .stopSequences("string")
                .temperature(0.0)
                .topP(0.0)
                .build())
            .build())
        .metadatas(AgentPromptVariantMetadataArgs.builder()
            .key("string")
            .value("string")
            .build())
        .modelId("string")
        .templateConfiguration(AgentPromptVariantTemplateConfigurationArgs.builder()
            .chat(AgentPromptVariantTemplateConfigurationChatArgs.builder()
                .messages(AgentPromptVariantTemplateConfigurationChatMessageArgs.builder()
                    .role("string")
                    .content(AgentPromptVariantTemplateConfigurationChatMessageContentArgs.builder()
                        .cachePoint(AgentPromptVariantTemplateConfigurationChatMessageContentCachePointArgs.builder()
                            .type("string")
                            .build())
                        .text("string")
                        .build())
                    .build())
                .inputVariables(AgentPromptVariantTemplateConfigurationChatInputVariableArgs.builder()
                    .name("string")
                    .build())
                .systems(AgentPromptVariantTemplateConfigurationChatSystemArgs.builder()
                    .cachePoint(AgentPromptVariantTemplateConfigurationChatSystemCachePointArgs.builder()
                        .type("string")
                        .build())
                    .text("string")
                    .build())
                .toolConfiguration(AgentPromptVariantTemplateConfigurationChatToolConfigurationArgs.builder()
                    .toolChoice(AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceArgs.builder()
                        .any(AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceAnyArgs.builder()
                            .build())
                        .auto(AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceAutoArgs.builder()
                            .build())
                        .tool(AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceToolArgs.builder()
                            .name("string")
                            .build())
                        .build())
                    .tools(AgentPromptVariantTemplateConfigurationChatToolConfigurationToolArgs.builder()
                        .cachePoint(AgentPromptVariantTemplateConfigurationChatToolConfigurationToolCachePointArgs.builder()
                            .type("string")
                            .build())
                        .toolSpec(AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpecArgs.builder()
                            .name("string")
                            .description("string")
                            .inputSchema(AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpecInputSchemaArgs.builder()
                                .json("string")
                                .build())
                            .build())
                        .build())
                    .build())
                .build())
            .text(AgentPromptVariantTemplateConfigurationTextArgs.builder()
                .text("string")
                .cachePoint(AgentPromptVariantTemplateConfigurationTextCachePointArgs.builder()
                    .type("string")
                    .build())
                .inputVariables(AgentPromptVariantTemplateConfigurationTextInputVariableArgs.builder()
                    .name("string")
                    .build())
                .build())
            .build())
        .build())
    .build());

    agent_prompt_resource = aws.bedrock.AgentPrompt("agentPromptResource",
    customer_encryption_key_arn="string",
    default_variant="string",
    description="string",
    name="string",
    region="string",
    tags={
        "string": "string",
    },
    variants=[{
        "name": "string",
        "template_type": "string",
        "additional_model_request_fields": "string",
        "gen_ai_resource": {
            "agent": {
                "agent_identifier": "string",
            },
        },
        "inference_configuration": {
            "text": {
                "max_tokens": 0,
                "stop_sequences": ["string"],
                "temperature": float(0),
                "top_p": float(0),
            },
        },
        "metadatas": [{
            "key": "string",
            "value": "string",
        }],
        "model_id": "string",
        "template_configuration": {
            "chat": {
                "messages": [{
                    "role": "string",
                    "content": {
                        "cache_point": {
                            "type": "string",
                        },
                        "text": "string",
                    },
                }],
                "input_variables": [{
                    "name": "string",
                }],
                "systems": [{
                    "cache_point": {
                        "type": "string",
                    },
                    "text": "string",
                }],
                "tool_configuration": {
                    "tool_choice": {
                        "any": {},
                        "auto": {},
                        "tool": {
                            "name": "string",
                        },
                    },
                    "tools": [{
                        "cache_point": {
                            "type": "string",
                        },
                        "tool_spec": {
                            "name": "string",
                            "description": "string",
                            "input_schema": {
                                "json": "string",
                            },
                        },
                    }],
                },
            },
            "text": {
                "text": "string",
                "cache_point": {
                    "type": "string",
                },
                "input_variables": [{
                    "name": "string",
                }],
            },
        },
    }])

    const agentPromptResource = new aws.bedrock.AgentPrompt("agentPromptResource", {
    customerEncryptionKeyArn: "string",
    defaultVariant: "string",
    description: "string",
    name: "string",
    region: "string",
    tags: {
        string: "string",
    },
    variants: [{
        name: "string",
        templateType: "string",
        additionalModelRequestFields: "string",
        genAiResource: {
            agent: {
                agentIdentifier: "string",
            },
        },
        inferenceConfiguration: {
            text: {
                maxTokens: 0,
                stopSequences: ["string"],
                temperature: 0,
                topP: 0,
            },
        },
        metadatas: [{
            key: "string",
            value: "string",
        }],
        modelId: "string",
        templateConfiguration: {
            chat: {
                messages: [{
                    role: "string",
                    content: {
                        cachePoint: {
                            type: "string",
                        },
                        text: "string",
                    },
                }],
                inputVariables: [{
                    name: "string",
                }],
                systems: [{
                    cachePoint: {
                        type: "string",
                    },
                    text: "string",
                }],
                toolConfiguration: {
                    toolChoice: {
                        any: {},
                        auto: {},
                        tool: {
                            name: "string",
                        },
                    },
                    tools: [{
                        cachePoint: {
                            type: "string",
                        },
                        toolSpec: {
                            name: "string",
                            description: "string",
                            inputSchema: {
                                json: "string",
                            },
                        },
                    }],
                },
            },
            text: {
                text: "string",
                cachePoint: {
                    type: "string",
                },
                inputVariables: [{
                    name: "string",
                }],
            },
        },
    }],
});

    type: aws:bedrock:AgentPrompt
properties:
    customerEncryptionKeyArn: string
    defaultVariant: string
    description: string
    name: string
    region: string
    tags:
        string: string
    variants:
        - additionalModelRequestFields: string
          genAiResource:
            agent:
                agentIdentifier: string
          inferenceConfiguration:
            text:
                maxTokens: 0
                stopSequences:
                    - string
                temperature: 0
                topP: 0
          metadatas:
            - key: string
              value: string
          modelId: string
          name: string
          templateConfiguration:
            chat:
                inputVariables:
                    - name: string
                messages:
                    - content:
                        cachePoint:
                            type: string
                        text: string
                      role: string
                systems:
                    - cachePoint:
                        type: string
                      text: string
                toolConfiguration:
                    toolChoice:
                        any: {}
                        auto: {}
                        tool:
                            name: string
                    tools:
                        - cachePoint:
                            type: string
                          toolSpec:
                            description: string
                            inputSchema:
                                json: string
                            name: string
            text:
                cachePoint:
                    type: string
                inputVariables:
                    - name: string
                text: string
          templateType: string

    AgentPrompt Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The AgentPrompt resource accepts the following input properties:

    CustomerEncryptionKeyArn string
    ARN of the KMS key that you encrypted the prompt with.
    DefaultVariant string
    Name of the default variant for your prompt.
    Description string
    Description of the prompt.
    Name string

    Name of the prompt.

    The following arguments are optional:

    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Variants List<AgentPromptVariant>
    List of objects, each containing details about a variant of the prompt. See variant Block for more information.
    CustomerEncryptionKeyArn string
    ARN of the KMS key that you encrypted the prompt with.
    DefaultVariant string
    Name of the default variant for your prompt.
    Description string
    Description of the prompt.
    Name string

    Name of the prompt.

    The following arguments are optional:

    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Variants []AgentPromptVariantArgs
    List of objects, each containing details about a variant of the prompt. See variant Block for more information.
    customer_encryption_key_arn string
    ARN of the KMS key that you encrypted the prompt with.
    default_variant string
    Name of the default variant for your prompt.
    description string
    Description of the prompt.
    name string

    Name of the prompt.

    The following arguments are optional:

    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags map(string)
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    variants list(object)
    List of objects, each containing details about a variant of the prompt. See variant Block for more information.
    customerEncryptionKeyArn String
    ARN of the KMS key that you encrypted the prompt with.
    defaultVariant String
    Name of the default variant for your prompt.
    description String
    Description of the prompt.
    name String

    Name of the prompt.

    The following arguments are optional:

    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    variants List<AgentPromptVariant>
    List of objects, each containing details about a variant of the prompt. See variant Block for more information.
    customerEncryptionKeyArn string
    ARN of the KMS key that you encrypted the prompt with.
    defaultVariant string
    Name of the default variant for your prompt.
    description string
    Description of the prompt.
    name string

    Name of the prompt.

    The following arguments are optional:

    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    variants AgentPromptVariant[]
    List of objects, each containing details about a variant of the prompt. See variant Block for more information.
    customer_encryption_key_arn str
    ARN of the KMS key that you encrypted the prompt with.
    default_variant str
    Name of the default variant for your prompt.
    description str
    Description of the prompt.
    name str

    Name of the prompt.

    The following arguments are optional:

    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    variants Sequence[AgentPromptVariantArgs]
    List of objects, each containing details about a variant of the prompt. See variant Block for more information.
    customerEncryptionKeyArn String
    ARN of the KMS key that you encrypted the prompt with.
    defaultVariant String
    Name of the default variant for your prompt.
    description String
    Description of the prompt.
    name String

    Name of the prompt.

    The following arguments are optional:

    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    variants List<Property Map>
    List of objects, each containing details about a variant of the prompt. See variant Block for more information.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AgentPrompt resource produces the following output properties:

    Arn string
    ARN of the prompt.
    CreatedAt string
    Time at which the prompt was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    UpdatedAt string
    Time at which the prompt was last updated.
    Version string
    Version of the prompt. When you create a prompt, the version created is the DRAFT version.
    Arn string
    ARN of the prompt.
    CreatedAt string
    Time at which the prompt was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    UpdatedAt string
    Time at which the prompt was last updated.
    Version string
    Version of the prompt. When you create a prompt, the version created is the DRAFT version.
    arn string
    ARN of the prompt.
    created_at string
    Time at which the prompt was created.
    id string
    The provider-assigned unique ID for this managed resource.
    tags_all map(string)
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    updated_at string
    Time at which the prompt was last updated.
    version string
    Version of the prompt. When you create a prompt, the version created is the DRAFT version.
    arn String
    ARN of the prompt.
    createdAt String
    Time at which the prompt was created.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    updatedAt String
    Time at which the prompt was last updated.
    version String
    Version of the prompt. When you create a prompt, the version created is the DRAFT version.
    arn string
    ARN of the prompt.
    createdAt string
    Time at which the prompt was created.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    updatedAt string
    Time at which the prompt was last updated.
    version string
    Version of the prompt. When you create a prompt, the version created is the DRAFT version.
    arn str
    ARN of the prompt.
    created_at str
    Time at which the prompt was created.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    updated_at str
    Time at which the prompt was last updated.
    version str
    Version of the prompt. When you create a prompt, the version created is the DRAFT version.
    arn String
    ARN of the prompt.
    createdAt String
    Time at which the prompt was created.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    updatedAt String
    Time at which the prompt was last updated.
    version String
    Version of the prompt. When you create a prompt, the version created is the DRAFT version.

    Look up Existing AgentPrompt Resource

    Get an existing AgentPrompt resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AgentPromptState, opts?: CustomResourceOptions): AgentPrompt
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        created_at: Optional[str] = None,
        customer_encryption_key_arn: Optional[str] = None,
        default_variant: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        updated_at: Optional[str] = None,
        variants: Optional[Sequence[AgentPromptVariantArgs]] = None,
        version: Optional[str] = None) -> AgentPrompt
    func GetAgentPrompt(ctx *Context, name string, id IDInput, state *AgentPromptState, opts ...ResourceOption) (*AgentPrompt, error)
    public static AgentPrompt Get(string name, Input<string> id, AgentPromptState? state, CustomResourceOptions? opts = null)
    public static AgentPrompt get(String name, Output<String> id, AgentPromptState state, CustomResourceOptions options)
    resources:  _:    type: aws:bedrock:AgentPrompt    get:      id: ${id}
    import {
  to = aws_bedrock_agent_prompt.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN of the prompt.
    CreatedAt string
    Time at which the prompt was created.
    CustomerEncryptionKeyArn string
    ARN of the KMS key that you encrypted the prompt with.
    DefaultVariant string
    Name of the default variant for your prompt.
    Description string
    Description of the prompt.
    Name string

    Name of the prompt.

    The following arguments are optional:

    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    UpdatedAt string
    Time at which the prompt was last updated.
    Variants List<AgentPromptVariant>
    List of objects, each containing details about a variant of the prompt. See variant Block for more information.
    Version string
    Version of the prompt. When you create a prompt, the version created is the DRAFT version.
    Arn string
    ARN of the prompt.
    CreatedAt string
    Time at which the prompt was created.
    CustomerEncryptionKeyArn string
    ARN of the KMS key that you encrypted the prompt with.
    DefaultVariant string
    Name of the default variant for your prompt.
    Description string
    Description of the prompt.
    Name string

    Name of the prompt.

    The following arguments are optional:

    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    UpdatedAt string
    Time at which the prompt was last updated.
    Variants []AgentPromptVariantArgs
    List of objects, each containing details about a variant of the prompt. See variant Block for more information.
    Version string
    Version of the prompt. When you create a prompt, the version created is the DRAFT version.
    arn string
    ARN of the prompt.
    created_at string
    Time at which the prompt was created.
    customer_encryption_key_arn string
    ARN of the KMS key that you encrypted the prompt with.
    default_variant string
    Name of the default variant for your prompt.
    description string
    Description of the prompt.
    name string

    Name of the prompt.

    The following arguments are optional:

    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags map(string)
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all map(string)
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    updated_at string
    Time at which the prompt was last updated.
    variants list(object)
    List of objects, each containing details about a variant of the prompt. See variant Block for more information.
    version string
    Version of the prompt. When you create a prompt, the version created is the DRAFT version.
    arn String
    ARN of the prompt.
    createdAt String
    Time at which the prompt was created.
    customerEncryptionKeyArn String
    ARN of the KMS key that you encrypted the prompt with.
    defaultVariant String
    Name of the default variant for your prompt.
    description String
    Description of the prompt.
    name String

    Name of the prompt.

    The following arguments are optional:

    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    updatedAt String
    Time at which the prompt was last updated.
    variants List<AgentPromptVariant>
    List of objects, each containing details about a variant of the prompt. See variant Block for more information.
    version String
    Version of the prompt. When you create a prompt, the version created is the DRAFT version.
    arn string
    ARN of the prompt.
    createdAt string
    Time at which the prompt was created.
    customerEncryptionKeyArn string
    ARN of the KMS key that you encrypted the prompt with.
    defaultVariant string
    Name of the default variant for your prompt.
    description string
    Description of the prompt.
    name string

    Name of the prompt.

    The following arguments are optional:

    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    updatedAt string
    Time at which the prompt was last updated.
    variants AgentPromptVariant[]
    List of objects, each containing details about a variant of the prompt. See variant Block for more information.
    version string
    Version of the prompt. When you create a prompt, the version created is the DRAFT version.
    arn str
    ARN of the prompt.
    created_at str
    Time at which the prompt was created.
    customer_encryption_key_arn str
    ARN of the KMS key that you encrypted the prompt with.
    default_variant str
    Name of the default variant for your prompt.
    description str
    Description of the prompt.
    name str

    Name of the prompt.

    The following arguments are optional:

    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    updated_at str
    Time at which the prompt was last updated.
    variants Sequence[AgentPromptVariantArgs]
    List of objects, each containing details about a variant of the prompt. See variant Block for more information.
    version str
    Version of the prompt. When you create a prompt, the version created is the DRAFT version.
    arn String
    ARN of the prompt.
    createdAt String
    Time at which the prompt was created.
    customerEncryptionKeyArn String
    ARN of the KMS key that you encrypted the prompt with.
    defaultVariant String
    Name of the default variant for your prompt.
    description String
    Description of the prompt.
    name String

    Name of the prompt.

    The following arguments are optional:

    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    updatedAt String
    Time at which the prompt was last updated.
    variants List<Property Map>
    List of objects, each containing details about a variant of the prompt. See variant Block for more information.
    version String
    Version of the prompt. When you create a prompt, the version created is the DRAFT version.

    Supporting Types

    AgentPromptVariant, AgentPromptVariantArgs

    Name string
    Name of the tool.
    TemplateType string
    Type of prompt template to use. Valid values: CHAT, TEXT.
    AdditionalModelRequestFields string
    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.
    GenAiResource AgentPromptVariantGenAiResource
    Generative AI resource with which to use the prompt. If this is not supplied, then a modelId must be defined. See genAiResource Block for more information.
    InferenceConfiguration AgentPromptVariantInferenceConfiguration
    Inference configurations for the prompt variant. See inferenceConfiguration Block for more information.
    Metadatas List<AgentPromptVariantMetadata>
    List of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant. See metadata Block for more information.
    ModelId string
    Unique identifier of the model or inference profile with which to run inference on the prompt. If this is not supplied, then a genAiResource must be defined.
    TemplateConfiguration AgentPromptVariantTemplateConfiguration
    Configurations for the prompt template. See templateConfiguration Block for more information.
    Name string
    Name of the tool.
    TemplateType string
    Type of prompt template to use. Valid values: CHAT, TEXT.
    AdditionalModelRequestFields string
    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.
    GenAiResource AgentPromptVariantGenAiResource
    Generative AI resource with which to use the prompt. If this is not supplied, then a modelId must be defined. See genAiResource Block for more information.
    InferenceConfiguration AgentPromptVariantInferenceConfiguration
    Inference configurations for the prompt variant. See inferenceConfiguration Block for more information.
    Metadatas []AgentPromptVariantMetadata
    List of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant. See metadata Block for more information.
    ModelId string
    Unique identifier of the model or inference profile with which to run inference on the prompt. If this is not supplied, then a genAiResource must be defined.
    TemplateConfiguration AgentPromptVariantTemplateConfiguration
    Configurations for the prompt template. See templateConfiguration Block for more information.
    name string
    Name of the tool.
    template_type string
    Type of prompt template to use. Valid values: CHAT, TEXT.
    additional_model_request_fields string
    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.
    gen_ai_resource object
    Generative AI resource with which to use the prompt. If this is not supplied, then a modelId must be defined. See genAiResource Block for more information.
    inference_configuration object
    Inference configurations for the prompt variant. See inferenceConfiguration Block for more information.
    metadatas list(object)
    List of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant. See metadata Block for more information.
    model_id string
    Unique identifier of the model or inference profile with which to run inference on the prompt. If this is not supplied, then a genAiResource must be defined.
    template_configuration object
    Configurations for the prompt template. See templateConfiguration Block for more information.
    name String
    Name of the tool.
    templateType String
    Type of prompt template to use. Valid values: CHAT, TEXT.
    additionalModelRequestFields String
    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.
    genAiResource AgentPromptVariantGenAiResource
    Generative AI resource with which to use the prompt. If this is not supplied, then a modelId must be defined. See genAiResource Block for more information.
    inferenceConfiguration AgentPromptVariantInferenceConfiguration
    Inference configurations for the prompt variant. See inferenceConfiguration Block for more information.
    metadatas List<AgentPromptVariantMetadata>
    List of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant. See metadata Block for more information.
    modelId String
    Unique identifier of the model or inference profile with which to run inference on the prompt. If this is not supplied, then a genAiResource must be defined.
    templateConfiguration AgentPromptVariantTemplateConfiguration
    Configurations for the prompt template. See templateConfiguration Block for more information.
    name string
    Name of the tool.
    templateType string
    Type of prompt template to use. Valid values: CHAT, TEXT.
    additionalModelRequestFields string
    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.
    genAiResource AgentPromptVariantGenAiResource
    Generative AI resource with which to use the prompt. If this is not supplied, then a modelId must be defined. See genAiResource Block for more information.
    inferenceConfiguration AgentPromptVariantInferenceConfiguration
    Inference configurations for the prompt variant. See inferenceConfiguration Block for more information.
    metadatas AgentPromptVariantMetadata[]
    List of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant. See metadata Block for more information.
    modelId string
    Unique identifier of the model or inference profile with which to run inference on the prompt. If this is not supplied, then a genAiResource must be defined.
    templateConfiguration AgentPromptVariantTemplateConfiguration
    Configurations for the prompt template. See templateConfiguration Block for more information.
    name str
    Name of the tool.
    template_type str
    Type of prompt template to use. Valid values: CHAT, TEXT.
    additional_model_request_fields str
    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.
    gen_ai_resource AgentPromptVariantGenAiResource
    Generative AI resource with which to use the prompt. If this is not supplied, then a modelId must be defined. See genAiResource Block for more information.
    inference_configuration AgentPromptVariantInferenceConfiguration
    Inference configurations for the prompt variant. See inferenceConfiguration Block for more information.
    metadatas Sequence[AgentPromptVariantMetadata]
    List of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant. See metadata Block for more information.
    model_id str
    Unique identifier of the model or inference profile with which to run inference on the prompt. If this is not supplied, then a genAiResource must be defined.
    template_configuration AgentPromptVariantTemplateConfiguration
    Configurations for the prompt template. See templateConfiguration Block for more information.
    name String
    Name of the tool.
    templateType String
    Type of prompt template to use. Valid values: CHAT, TEXT.
    additionalModelRequestFields String
    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.
    genAiResource Property Map
    Generative AI resource with which to use the prompt. If this is not supplied, then a modelId must be defined. See genAiResource Block for more information.
    inferenceConfiguration Property Map
    Inference configurations for the prompt variant. See inferenceConfiguration Block for more information.
    metadatas List<Property Map>
    List of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant. See metadata Block for more information.
    modelId String
    Unique identifier of the model or inference profile with which to run inference on the prompt. If this is not supplied, then a genAiResource must be defined.
    templateConfiguration Property Map
    Configurations for the prompt template. See templateConfiguration Block for more information.

    AgentPromptVariantGenAiResource, AgentPromptVariantGenAiResourceArgs

    Agent AgentPromptVariantGenAiResourceAgent
    Amazon Bedrock agent with which to use the prompt. See agent Block for more information.
    Agent AgentPromptVariantGenAiResourceAgent
    Amazon Bedrock agent with which to use the prompt. See agent Block for more information.
    agent object
    Amazon Bedrock agent with which to use the prompt. See agent Block for more information.
    agent AgentPromptVariantGenAiResourceAgent
    Amazon Bedrock agent with which to use the prompt. See agent Block for more information.
    agent AgentPromptVariantGenAiResourceAgent
    Amazon Bedrock agent with which to use the prompt. See agent Block for more information.
    agent AgentPromptVariantGenAiResourceAgent
    Amazon Bedrock agent with which to use the prompt. See agent Block for more information.
    agent Property Map
    Amazon Bedrock agent with which to use the prompt. See agent Block for more information.

    AgentPromptVariantGenAiResourceAgent, AgentPromptVariantGenAiResourceAgentArgs

    AgentIdentifier string
    ARN of the agent with which to use the prompt.
    AgentIdentifier string
    ARN of the agent with which to use the prompt.
    agent_identifier string
    ARN of the agent with which to use the prompt.
    agentIdentifier String
    ARN of the agent with which to use the prompt.
    agentIdentifier string
    ARN of the agent with which to use the prompt.
    agent_identifier str
    ARN of the agent with which to use the prompt.
    agentIdentifier String
    ARN of the agent with which to use the prompt.

    AgentPromptVariantInferenceConfiguration, AgentPromptVariantInferenceConfigurationArgs

    Text AgentPromptVariantInferenceConfigurationText
    Inference configurations for the prompt variant. See variant.inference_configuration.text Block for more information.
    Text AgentPromptVariantInferenceConfigurationText
    Inference configurations for the prompt variant. See variant.inference_configuration.text Block for more information.
    text object
    Inference configurations for the prompt variant. See variant.inference_configuration.text Block for more information.
    text AgentPromptVariantInferenceConfigurationText
    Inference configurations for the prompt variant. See variant.inference_configuration.text Block for more information.
    text AgentPromptVariantInferenceConfigurationText
    Inference configurations for the prompt variant. See variant.inference_configuration.text Block for more information.
    text AgentPromptVariantInferenceConfigurationText
    Inference configurations for the prompt variant. See variant.inference_configuration.text Block for more information.
    text Property Map
    Inference configurations for the prompt variant. See variant.inference_configuration.text Block for more information.

    AgentPromptVariantInferenceConfigurationText, AgentPromptVariantInferenceConfigurationTextArgs

    MaxTokens int
    Maximum number of tokens to return in the response.
    StopSequences List<string>
    List of strings that define sequences after which the model will stop generating.
    Temperature double
    Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
    TopP double
    Percentage of most-likely candidates that the model considers for the next token.
    MaxTokens int
    Maximum number of tokens to return in the response.
    StopSequences []string
    List of strings that define sequences after which the model will stop generating.
    Temperature float64
    Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
    TopP float64
    Percentage of most-likely candidates that the model considers for the next token.
    max_tokens number
    Maximum number of tokens to return in the response.
    stop_sequences list(string)
    List of strings that define sequences after which the model will stop generating.
    temperature number
    Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
    top_p number
    Percentage of most-likely candidates that the model considers for the next token.
    maxTokens Integer
    Maximum number of tokens to return in the response.
    stopSequences List<String>
    List of strings that define sequences after which the model will stop generating.
    temperature Double
    Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
    topP Double
    Percentage of most-likely candidates that the model considers for the next token.
    maxTokens number
    Maximum number of tokens to return in the response.
    stopSequences string[]
    List of strings that define sequences after which the model will stop generating.
    temperature number
    Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
    topP number
    Percentage of most-likely candidates that the model considers for the next token.
    max_tokens int
    Maximum number of tokens to return in the response.
    stop_sequences Sequence[str]
    List of strings that define sequences after which the model will stop generating.
    temperature float
    Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
    top_p float
    Percentage of most-likely candidates that the model considers for the next token.
    maxTokens Number
    Maximum number of tokens to return in the response.
    stopSequences List<String>
    List of strings that define sequences after which the model will stop generating.
    temperature Number
    Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs.
    topP Number
    Percentage of most-likely candidates that the model considers for the next token.

    AgentPromptVariantMetadata, AgentPromptVariantMetadataArgs

    Key string
    Key of a metadata tag for a prompt variant.
    Value string
    Value of a metadata tag for a prompt variant.
    Key string
    Key of a metadata tag for a prompt variant.
    Value string
    Value of a metadata tag for a prompt variant.
    key string
    Key of a metadata tag for a prompt variant.
    value string
    Value of a metadata tag for a prompt variant.
    key String
    Key of a metadata tag for a prompt variant.
    value String
    Value of a metadata tag for a prompt variant.
    key string
    Key of a metadata tag for a prompt variant.
    value string
    Value of a metadata tag for a prompt variant.
    key str
    Key of a metadata tag for a prompt variant.
    value str
    Value of a metadata tag for a prompt variant.
    key String
    Key of a metadata tag for a prompt variant.
    value String
    Value of a metadata tag for a prompt variant.

    AgentPromptVariantTemplateConfiguration, AgentPromptVariantTemplateConfigurationArgs

    Chat AgentPromptVariantTemplateConfigurationChat
    Configurations to use the prompt in a conversational format. See chat Block for more information.
    Text AgentPromptVariantTemplateConfigurationText
    Configurations for the text in a message for a prompt. See variant.template_configuration.text Block for more information.
    Chat AgentPromptVariantTemplateConfigurationChat
    Configurations to use the prompt in a conversational format. See chat Block for more information.
    Text AgentPromptVariantTemplateConfigurationText
    Configurations for the text in a message for a prompt. See variant.template_configuration.text Block for more information.
    chat object
    Configurations to use the prompt in a conversational format. See chat Block for more information.
    text object
    Configurations for the text in a message for a prompt. See variant.template_configuration.text Block for more information.
    chat AgentPromptVariantTemplateConfigurationChat
    Configurations to use the prompt in a conversational format. See chat Block for more information.
    text AgentPromptVariantTemplateConfigurationText
    Configurations for the text in a message for a prompt. See variant.template_configuration.text Block for more information.
    chat AgentPromptVariantTemplateConfigurationChat
    Configurations to use the prompt in a conversational format. See chat Block for more information.
    text AgentPromptVariantTemplateConfigurationText
    Configurations for the text in a message for a prompt. See variant.template_configuration.text Block for more information.
    chat AgentPromptVariantTemplateConfigurationChat
    Configurations to use the prompt in a conversational format. See chat Block for more information.
    text AgentPromptVariantTemplateConfigurationText
    Configurations for the text in a message for a prompt. See variant.template_configuration.text Block for more information.
    chat Property Map
    Configurations to use the prompt in a conversational format. See chat Block for more information.
    text Property Map
    Configurations for the text in a message for a prompt. See variant.template_configuration.text Block for more information.

    AgentPromptVariantTemplateConfigurationChat, AgentPromptVariantTemplateConfigurationChatArgs

    Messages List<AgentPromptVariantTemplateConfigurationChatMessage>
    List of messages in the chat for the prompt. See message Block for more information.
    InputVariables List<AgentPromptVariantTemplateConfigurationChatInputVariable>
    List of variables in the prompt template. See inputVariable Block for more information.
    Systems List<AgentPromptVariantTemplateConfigurationChatSystem>
    List of system prompts to provide context to the model or to describe how it should behave. See system Block for more information.
    ToolConfiguration AgentPromptVariantTemplateConfigurationChatToolConfiguration
    Configuration information for the tools that the model can use when generating a response. See toolConfiguration Block for more information.
    Messages []AgentPromptVariantTemplateConfigurationChatMessage
    List of messages in the chat for the prompt. See message Block for more information.
    InputVariables []AgentPromptVariantTemplateConfigurationChatInputVariable
    List of variables in the prompt template. See inputVariable Block for more information.
    Systems []AgentPromptVariantTemplateConfigurationChatSystem
    List of system prompts to provide context to the model or to describe how it should behave. See system Block for more information.
    ToolConfiguration AgentPromptVariantTemplateConfigurationChatToolConfiguration
    Configuration information for the tools that the model can use when generating a response. See toolConfiguration Block for more information.
    messages list(object)
    List of messages in the chat for the prompt. See message Block for more information.
    input_variables list(object)
    List of variables in the prompt template. See inputVariable Block for more information.
    systems list(object)
    List of system prompts to provide context to the model or to describe how it should behave. See system Block for more information.
    tool_configuration object
    Configuration information for the tools that the model can use when generating a response. See toolConfiguration Block for more information.
    messages List<AgentPromptVariantTemplateConfigurationChatMessage>
    List of messages in the chat for the prompt. See message Block for more information.
    inputVariables List<AgentPromptVariantTemplateConfigurationChatInputVariable>
    List of variables in the prompt template. See inputVariable Block for more information.
    systems List<AgentPromptVariantTemplateConfigurationChatSystem>
    List of system prompts to provide context to the model or to describe how it should behave. See system Block for more information.
    toolConfiguration AgentPromptVariantTemplateConfigurationChatToolConfiguration
    Configuration information for the tools that the model can use when generating a response. See toolConfiguration Block for more information.
    messages AgentPromptVariantTemplateConfigurationChatMessage[]
    List of messages in the chat for the prompt. See message Block for more information.
    inputVariables AgentPromptVariantTemplateConfigurationChatInputVariable[]
    List of variables in the prompt template. See inputVariable Block for more information.
    systems AgentPromptVariantTemplateConfigurationChatSystem[]
    List of system prompts to provide context to the model or to describe how it should behave. See system Block for more information.
    toolConfiguration AgentPromptVariantTemplateConfigurationChatToolConfiguration
    Configuration information for the tools that the model can use when generating a response. See toolConfiguration Block for more information.
    messages Sequence[AgentPromptVariantTemplateConfigurationChatMessage]
    List of messages in the chat for the prompt. See message Block for more information.
    input_variables Sequence[AgentPromptVariantTemplateConfigurationChatInputVariable]
    List of variables in the prompt template. See inputVariable Block for more information.
    systems Sequence[AgentPromptVariantTemplateConfigurationChatSystem]
    List of system prompts to provide context to the model or to describe how it should behave. See system Block for more information.
    tool_configuration AgentPromptVariantTemplateConfigurationChatToolConfiguration
    Configuration information for the tools that the model can use when generating a response. See toolConfiguration Block for more information.
    messages List<Property Map>
    List of messages in the chat for the prompt. See message Block for more information.
    inputVariables List<Property Map>
    List of variables in the prompt template. See inputVariable Block for more information.
    systems List<Property Map>
    List of system prompts to provide context to the model or to describe how it should behave. See system Block for more information.
    toolConfiguration Property Map
    Configuration information for the tools that the model can use when generating a response. See toolConfiguration Block for more information.

    AgentPromptVariantTemplateConfigurationChatInputVariable, AgentPromptVariantTemplateConfigurationChatInputVariableArgs

    Name string
    Name of the variable.
    Name string
    Name of the variable.
    name string
    Name of the variable.
    name String
    Name of the variable.
    name string
    Name of the variable.
    name str
    Name of the variable.
    name String
    Name of the variable.

    AgentPromptVariantTemplateConfigurationChatMessage, AgentPromptVariantTemplateConfigurationChatMessageArgs

    Role string
    Role that the message belongs to.
    Content AgentPromptVariantTemplateConfigurationChatMessageContent
    Content for the message you pass to, or receive from a model. See content Block for more information.
    Role string
    Role that the message belongs to.
    Content AgentPromptVariantTemplateConfigurationChatMessageContent
    Content for the message you pass to, or receive from a model. See content Block for more information.
    role string
    Role that the message belongs to.
    content object
    Content for the message you pass to, or receive from a model. See content Block for more information.
    role String
    Role that the message belongs to.
    content AgentPromptVariantTemplateConfigurationChatMessageContent
    Content for the message you pass to, or receive from a model. See content Block for more information.
    role string
    Role that the message belongs to.
    content AgentPromptVariantTemplateConfigurationChatMessageContent
    Content for the message you pass to, or receive from a model. See content Block for more information.
    role str
    Role that the message belongs to.
    content AgentPromptVariantTemplateConfigurationChatMessageContent
    Content for the message you pass to, or receive from a model. See content Block for more information.
    role String
    Role that the message belongs to.
    content Property Map
    Content for the message you pass to, or receive from a model. See content Block for more information.

    AgentPromptVariantTemplateConfigurationChatMessageContent, AgentPromptVariantTemplateConfigurationChatMessageContentArgs

    CachePoint AgentPromptVariantTemplateConfigurationChatMessageContentCachePoint
    Cache checkpoint within a message. See cachePoint Block for more information.
    Text string
    Text in the message.
    CachePoint AgentPromptVariantTemplateConfigurationChatMessageContentCachePoint
    Cache checkpoint within a message. See cachePoint Block for more information.
    Text string
    Text in the message.
    cache_point object
    Cache checkpoint within a message. See cachePoint Block for more information.
    text string
    Text in the message.
    cachePoint AgentPromptVariantTemplateConfigurationChatMessageContentCachePoint
    Cache checkpoint within a message. See cachePoint Block for more information.
    text String
    Text in the message.
    cachePoint AgentPromptVariantTemplateConfigurationChatMessageContentCachePoint
    Cache checkpoint within a message. See cachePoint Block for more information.
    text string
    Text in the message.
    cache_point AgentPromptVariantTemplateConfigurationChatMessageContentCachePoint
    Cache checkpoint within a message. See cachePoint Block for more information.
    text str
    Text in the message.
    cachePoint Property Map
    Cache checkpoint within a message. See cachePoint Block for more information.
    text String
    Text in the message.

    AgentPromptVariantTemplateConfigurationChatMessageContentCachePoint, AgentPromptVariantTemplateConfigurationChatMessageContentCachePointArgs

    Type string
    Cache point type. Valid values: default.
    Type string
    Cache point type. Valid values: default.
    type string
    Cache point type. Valid values: default.
    type String
    Cache point type. Valid values: default.
    type string
    Cache point type. Valid values: default.
    type str
    Cache point type. Valid values: default.
    type String
    Cache point type. Valid values: default.

    AgentPromptVariantTemplateConfigurationChatSystem, AgentPromptVariantTemplateConfigurationChatSystemArgs

    CachePoint AgentPromptVariantTemplateConfigurationChatSystemCachePoint
    Cache checkpoint within the system prompt. See cachePoint Block for more information.
    Text string
    Text in the system prompt.
    CachePoint AgentPromptVariantTemplateConfigurationChatSystemCachePoint
    Cache checkpoint within the system prompt. See cachePoint Block for more information.
    Text string
    Text in the system prompt.
    cache_point object
    Cache checkpoint within the system prompt. See cachePoint Block for more information.
    text string
    Text in the system prompt.
    cachePoint AgentPromptVariantTemplateConfigurationChatSystemCachePoint
    Cache checkpoint within the system prompt. See cachePoint Block for more information.
    text String
    Text in the system prompt.
    cachePoint AgentPromptVariantTemplateConfigurationChatSystemCachePoint
    Cache checkpoint within the system prompt. See cachePoint Block for more information.
    text string
    Text in the system prompt.
    cache_point AgentPromptVariantTemplateConfigurationChatSystemCachePoint
    Cache checkpoint within the system prompt. See cachePoint Block for more information.
    text str
    Text in the system prompt.
    cachePoint Property Map
    Cache checkpoint within the system prompt. See cachePoint Block for more information.
    text String
    Text in the system prompt.

    AgentPromptVariantTemplateConfigurationChatSystemCachePoint, AgentPromptVariantTemplateConfigurationChatSystemCachePointArgs

    Type string
    Cache point type. Valid values: default.
    Type string
    Cache point type. Valid values: default.
    type string
    Cache point type. Valid values: default.
    type String
    Cache point type. Valid values: default.
    type string
    Cache point type. Valid values: default.
    type str
    Cache point type. Valid values: default.
    type String
    Cache point type. Valid values: default.

    AgentPromptVariantTemplateConfigurationChatToolConfiguration, AgentPromptVariantTemplateConfigurationChatToolConfigurationArgs

    ToolChoice AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoice
    Configuration for which tools the model should request when invoked. See toolChoice Block for more information.
    Tools List<AgentPromptVariantTemplateConfigurationChatToolConfigurationTool>
    List of tools to pass to a model. See variant.template_configuration.chat.tool_configuration.tool Block for more information.
    ToolChoice AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoice
    Configuration for which tools the model should request when invoked. See toolChoice Block for more information.
    Tools []AgentPromptVariantTemplateConfigurationChatToolConfigurationTool
    List of tools to pass to a model. See variant.template_configuration.chat.tool_configuration.tool Block for more information.
    tool_choice object
    Configuration for which tools the model should request when invoked. See toolChoice Block for more information.
    tools list(object)
    List of tools to pass to a model. See variant.template_configuration.chat.tool_configuration.tool Block for more information.
    toolChoice AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoice
    Configuration for which tools the model should request when invoked. See toolChoice Block for more information.
    tools List<AgentPromptVariantTemplateConfigurationChatToolConfigurationTool>
    List of tools to pass to a model. See variant.template_configuration.chat.tool_configuration.tool Block for more information.
    toolChoice AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoice
    Configuration for which tools the model should request when invoked. See toolChoice Block for more information.
    tools AgentPromptVariantTemplateConfigurationChatToolConfigurationTool[]
    List of tools to pass to a model. See variant.template_configuration.chat.tool_configuration.tool Block for more information.
    tool_choice AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoice
    Configuration for which tools the model should request when invoked. See toolChoice Block for more information.
    tools Sequence[AgentPromptVariantTemplateConfigurationChatToolConfigurationTool]
    List of tools to pass to a model. See variant.template_configuration.chat.tool_configuration.tool Block for more information.
    toolChoice Property Map
    Configuration for which tools the model should request when invoked. See toolChoice Block for more information.
    tools List<Property Map>
    List of tools to pass to a model. See variant.template_configuration.chat.tool_configuration.tool Block for more information.

    AgentPromptVariantTemplateConfigurationChatToolConfigurationTool, AgentPromptVariantTemplateConfigurationChatToolConfigurationToolArgs

    cache_point object
    tool_spec object
    Specification for the tool. See toolSpec Block for more information.
    cachePoint Property Map
    toolSpec Property Map
    Specification for the tool. See toolSpec Block for more information.

    AgentPromptVariantTemplateConfigurationChatToolConfigurationToolCachePoint, AgentPromptVariantTemplateConfigurationChatToolConfigurationToolCachePointArgs

    Type string
    Cache point type. Valid values: default.
    Type string
    Cache point type. Valid values: default.
    type string
    Cache point type. Valid values: default.
    type String
    Cache point type. Valid values: default.
    type string
    Cache point type. Valid values: default.
    type str
    Cache point type. Valid values: default.
    type String
    Cache point type. Valid values: default.

    AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoice, AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceArgs

    Any AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceAny
    Tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response. This object has no fields.
    Auto AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceAuto
    Tools from which the model automatically decides whether to call a tool or to generate text instead. This object has no fields.
    Tool AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceTool
    Specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response. See variant.template_configuration.chat.tool_configuration.tool_choice.tool Block for more information.
    Any AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceAny
    Tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response. This object has no fields.
    Auto AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceAuto
    Tools from which the model automatically decides whether to call a tool or to generate text instead. This object has no fields.
    Tool AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceTool
    Specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response. See variant.template_configuration.chat.tool_configuration.tool_choice.tool Block for more information.
    any object
    Tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response. This object has no fields.
    auto object
    Tools from which the model automatically decides whether to call a tool or to generate text instead. This object has no fields.
    tool object
    Specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response. See variant.template_configuration.chat.tool_configuration.tool_choice.tool Block for more information.
    any AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceAny
    Tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response. This object has no fields.
    auto AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceAuto
    Tools from which the model automatically decides whether to call a tool or to generate text instead. This object has no fields.
    tool AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceTool
    Specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response. See variant.template_configuration.chat.tool_configuration.tool_choice.tool Block for more information.
    any AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceAny
    Tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response. This object has no fields.
    auto AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceAuto
    Tools from which the model automatically decides whether to call a tool or to generate text instead. This object has no fields.
    tool AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceTool
    Specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response. See variant.template_configuration.chat.tool_configuration.tool_choice.tool Block for more information.
    any AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceAny
    Tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response. This object has no fields.
    auto AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceAuto
    Tools from which the model automatically decides whether to call a tool or to generate text instead. This object has no fields.
    tool AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceTool
    Specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response. See variant.template_configuration.chat.tool_configuration.tool_choice.tool Block for more information.
    any Property Map
    Tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response. This object has no fields.
    auto Property Map
    Tools from which the model automatically decides whether to call a tool or to generate text instead. This object has no fields.
    tool Property Map
    Specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response. See variant.template_configuration.chat.tool_configuration.tool_choice.tool Block for more information.

    AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceTool, AgentPromptVariantTemplateConfigurationChatToolConfigurationToolChoiceToolArgs

    Name string

    Name of the prompt.

    The following arguments are optional:

    Name string

    Name of the prompt.

    The following arguments are optional:

    name string

    Name of the prompt.

    The following arguments are optional:

    name String

    Name of the prompt.

    The following arguments are optional:

    name string

    Name of the prompt.

    The following arguments are optional:

    name str

    Name of the prompt.

    The following arguments are optional:

    name String

    Name of the prompt.

    The following arguments are optional:

    AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpec, AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpecArgs

    Name string
    Name of the tool.
    Description string
    Description of the tool.
    InputSchema AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpecInputSchema
    Input schema of the tool. See inputSchema Block for more information.
    Name string
    Name of the tool.
    Description string
    Description of the tool.
    InputSchema AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpecInputSchema
    Input schema of the tool. See inputSchema Block for more information.
    name string
    Name of the tool.
    description string
    Description of the tool.
    input_schema object
    Input schema of the tool. See inputSchema Block for more information.
    name String
    Name of the tool.
    description String
    Description of the tool.
    inputSchema AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpecInputSchema
    Input schema of the tool. See inputSchema Block for more information.
    name string
    Name of the tool.
    description string
    Description of the tool.
    inputSchema AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpecInputSchema
    Input schema of the tool. See inputSchema Block for more information.
    name str
    Name of the tool.
    description str
    Description of the tool.
    input_schema AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpecInputSchema
    Input schema of the tool. See inputSchema Block for more information.
    name String
    Name of the tool.
    description String
    Description of the tool.
    inputSchema Property Map
    Input schema of the tool. See inputSchema Block for more information.

    AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpecInputSchema, AgentPromptVariantTemplateConfigurationChatToolConfigurationToolToolSpecInputSchemaArgs

    Json string
    JSON object defining the input schema for the tool.
    Json string
    JSON object defining the input schema for the tool.
    json string
    JSON object defining the input schema for the tool.
    json String
    JSON object defining the input schema for the tool.
    json string
    JSON object defining the input schema for the tool.
    json str
    JSON object defining the input schema for the tool.
    json String
    JSON object defining the input schema for the tool.

    AgentPromptVariantTemplateConfigurationText, AgentPromptVariantTemplateConfigurationTextArgs

    AgentPromptVariantTemplateConfigurationTextCachePoint, AgentPromptVariantTemplateConfigurationTextCachePointArgs

    Type string
    Cache point type. Valid values: default.
    Type string
    Cache point type. Valid values: default.
    type string
    Cache point type. Valid values: default.
    type String
    Cache point type. Valid values: default.
    type string
    Cache point type. Valid values: default.
    type str
    Cache point type. Valid values: default.
    type String
    Cache point type. Valid values: default.

    AgentPromptVariantTemplateConfigurationTextInputVariable, AgentPromptVariantTemplateConfigurationTextInputVariableArgs

    Name string
    Name of the variable.
    Name string
    Name of the variable.
    name string
    Name of the variable.
    name String
    Name of the variable.
    name string
    Name of the variable.
    name str
    Name of the variable.
    name String
    Name of the variable.

    Import

    Using pulumi import, import Bedrock Agents Prompt using the id. For example:

    $ pulumi import aws:bedrock/agentPrompt:AgentPrompt example 1A2BC3DEFG

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo aws logo
    Viewing docs for AWS v7.50.0
    published on Thursday, Oct 8, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial