Package software.amazon.awscdk.services.bedrock.alpha

Interface IPrompt

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IResource, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IPrompt.Jsii$Default
All Known Implementing Classes:
IPrompt.Jsii$Proxy, Prompt, PromptBase
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:21.209Z") @Stability(Experimental) public interface IPrompt extends software.amazon.jsii.JsiiSerializable, IResource
(experimental) Represents a Prompt, either created with CDK or imported.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    IPrompt.Jsii$Default
    Internal default implementation for IPrompt.
    static final class 
    IPrompt.Jsii$Proxy
    A proxy class which represents a concrete javascript instance of this type.

  • Method Summary

    Modifier and Type
    Method
    Description
    default IKey
    getKmsKey()
    (experimental) Optional KMS encryption key associated with this prompt.
    String
    getPromptArn()
    (experimental) The ARN of the prompt.
    String
    getPromptId()
    (experimental) The ID of the prompt.
    String
    getPromptVersion()
    (experimental) The version of the prompt.
    Grant
    grantGet(IGrantable grantee)
    (experimental) Grant the given identity permissions to get the prompt.

    Methods inherited from interface software.constructs.IConstruct

    getNode

    Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

    getEnv

    Methods inherited from interface software.amazon.awscdk.IResource

    applyRemovalPolicy, getStack

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getPromptArn

      @Stability(Experimental) @NotNull String getPromptArn()
      (experimental) The ARN of the prompt.

      Example: 

       "arn:aws:bedrock:us-east-1:123456789012:prompt/PROMPT12345";

    • getPromptId

      @Stability(Experimental) @NotNull String getPromptId()
      (experimental) The ID of the prompt.

      Example: 

       "PROMPT12345";

    • getPromptVersion

      @Stability(Experimental) @NotNull String getPromptVersion()
      (experimental) The version of the prompt.

      Default: "DRAFT"

    • getKmsKey

      @Stability(Experimental) @Nullable default IKey getKmsKey()
      (experimental) Optional KMS encryption key associated with this prompt.

    • grantGet

      @Stability(Experimental) @NotNull Grant grantGet(@NotNull IGrantable grantee)
      (experimental) Grant the given identity permissions to get the prompt.

      Parameters:
      grantee - This parameter is required.