@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
240 lines (239 loc) • 8.4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource for managing an AWS Bedrock Agents Prompt.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* 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.",
* });
* ```
*
* ### With Variants
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.bedrock.AgentPrompt("example", {
* name: "MakePlaylist",
* description: "My first prompt.",
* defaultVariant: "Variant1",
* variants: [{
* name: "Variant1",
* modelId: "amazon.titan-text-express-v1",
* inferenceConfiguration: {
* text: {
* temperature: 0.8,
* },
* },
* templateType: "TEXT",
* templateConfiguration: {
* text: {
* text: "Make me a {{genre}} playlist consisting of the following number of songs: {{number}}.",
* inputVariables: [
* {
* name: "genre",
* },
* {
* name: "number",
* },
* ],
* },
* },
* }],
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import Bedrock Agents Prompt using the `id`. For example:
*
* ```sh
* $ pulumi import aws:bedrock/agentPrompt:AgentPrompt example 1A2BC3DEFG
* ```
*/
export declare class AgentPrompt extends pulumi.CustomResource {
/**
* Get an existing AgentPrompt resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AgentPromptState, opts?: pulumi.CustomResourceOptions): AgentPrompt;
/**
* Returns true if the given object is an instance of AgentPrompt. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is AgentPrompt;
/**
* Amazon Resource Name (ARN) of the prompt.
*/
readonly arn: pulumi.Output<string>;
/**
* Time at which the prompt was created.
*/
readonly createdAt: pulumi.Output<string>;
/**
* Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
*/
readonly customerEncryptionKeyArn: pulumi.Output<string | undefined>;
/**
* Name of the default variant for your prompt.
*/
readonly defaultVariant: pulumi.Output<string | undefined>;
/**
* Description of the prompt.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Name of the prompt.
*
* The following arguments are optional:
*/
readonly name: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<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.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* Time at which the prompt was last updated.
*/
readonly updatedAt: pulumi.Output<string>;
/**
* A list of objects, each containing details about a variant of the prompt. See Variant for more information.
*/
readonly variants: pulumi.Output<outputs.bedrock.AgentPromptVariant[] | undefined>;
/**
* Version of the prompt. When you create a prompt, the version created is the `DRAFT` version.
*/
readonly version: pulumi.Output<string>;
/**
* Create a AgentPrompt resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: AgentPromptArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AgentPrompt resources.
*/
export interface AgentPromptState {
/**
* Amazon Resource Name (ARN) of the prompt.
*/
arn?: pulumi.Input<string>;
/**
* Time at which the prompt was created.
*/
createdAt?: pulumi.Input<string>;
/**
* Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
*/
customerEncryptionKeyArn?: pulumi.Input<string>;
/**
* Name of the default variant for your prompt.
*/
defaultVariant?: pulumi.Input<string>;
/**
* Description of the prompt.
*/
description?: pulumi.Input<string>;
/**
* Name of the prompt.
*
* The following arguments are optional:
*/
name?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<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?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Time at which the prompt was last updated.
*/
updatedAt?: pulumi.Input<string>;
/**
* A list of objects, each containing details about a variant of the prompt. See Variant for more information.
*/
variants?: pulumi.Input<pulumi.Input<inputs.bedrock.AgentPromptVariant>[]>;
/**
* Version of the prompt. When you create a prompt, the version created is the `DRAFT` version.
*/
version?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a AgentPrompt resource.
*/
export interface AgentPromptArgs {
/**
* Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with.
*/
customerEncryptionKeyArn?: pulumi.Input<string>;
/**
* Name of the default variant for your prompt.
*/
defaultVariant?: pulumi.Input<string>;
/**
* Description of the prompt.
*/
description?: pulumi.Input<string>;
/**
* Name of the prompt.
*
* The following arguments are optional:
*/
name?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<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?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A list of objects, each containing details about a variant of the prompt. See Variant for more information.
*/
variants?: pulumi.Input<pulumi.Input<inputs.bedrock.AgentPromptVariant>[]>;
}