Package com.pulumi.aws.bedrock

Class AgentPrompt

  • public class AgentPrompt
extends com.pulumi.resources.CustomResource
    Manages an AWS Bedrock Agents Prompt. ## Example Usage ### Basic Usage 
     
 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());
 
     }
 }
    ### With Variants 
     
 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());
 
     }
 }
    ## Import Using `pulumi import`, import Bedrock Agents Prompt using the `id`. For example: ```sh $ pulumi import aws:bedrock/agentPrompt:AgentPrompt example 1A2BC3DEFG ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> createdAt()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> customerEncryptionKeyArn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> defaultVariant()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static AgentPrompt get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AgentPromptState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> updatedAt()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<AgentPromptVariant>>> variants()  
      com.pulumi.core.Output<java.lang.String> version()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AgentPrompt

        public AgentPrompt​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • AgentPrompt

        public AgentPrompt​(java.lang.String name,
                   @Nullable
                   AgentPromptArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • AgentPrompt

        public AgentPrompt​(java.lang.String name,
                   @Nullable
                   AgentPromptArgs args,
                   @Nullable
                   com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the prompt.

      • createdAt

        public com.pulumi.core.Output<java.lang.String> createdAt()
        Returns:
        Time at which the prompt was created.

      • customerEncryptionKeyArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> customerEncryptionKeyArn()
        Returns:
        ARN of the KMS key that you encrypted the prompt with.

      • defaultVariant

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> defaultVariant()
        Returns:
        Name of the default variant for your prompt.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description of the prompt.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the prompt. The following arguments are optional:

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        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.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • updatedAt

        public com.pulumi.core.Output<java.lang.String> updatedAt()
        Returns:
        Time at which the prompt was last updated.

      • variants

        public com.pulumi.core.Output<java.util.Optional<java.util.List<AgentPromptVariant>>> variants()
        Returns:
        List of objects, each containing details about a variant of the prompt. See `variant` Block for more information.

      • version

        public com.pulumi.core.Output<java.lang.String> version()
        Returns:
        Version of the prompt. When you create a prompt, the version created is the `DRAFT` version.

      • get

        public static AgentPrompt get​(java.lang.String name,
                              com.pulumi.core.Output<java.lang.String> id,
                              @Nullable
                              AgentPromptState state,
                              @Nullable
                              com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.