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

Class PromptBase

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.bedrock.alpha.PromptBase
All Implemented Interfaces:
IResource, IPrompt, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
Direct Known Subclasses:
Prompt
@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)", date="2025-08-06T18:14:48.074Z") @Stability(Experimental) public abstract class PromptBase extends Resource implements IPrompt
(experimental) Abstract base class for a Prompt.

Contains methods and attributes valid for Prompts either created with CDK or imported.

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.bedrock.alpha.IPrompt

    IPrompt.Jsii$Default

    Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

    IResource.Jsii$Default

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    PromptBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    PromptBase(software.amazon.jsii.JsiiObjectRef objRef)
     
    protected
    PromptBase(software.constructs.Construct scope, String id)
     
    protected
    PromptBase(software.constructs.Construct scope, String id, ResourceProps props)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract IKey
    getKmsKey()
    (experimental) Optional KMS encryption key associated with this prompt.
    abstract String
    getPromptArn()
    (experimental) The ARN of the prompt.
    abstract String
    getPromptId()
    (experimental) The ID of the prompt.
    abstract 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 class software.amazon.awscdk.Resource

    applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

    Methods inherited from class software.constructs.Construct

    getNode, isConstruct, toString

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface software.constructs.IConstruct

    getNode

    Methods inherited from interface software.amazon.awscdk.IResource

    applyRemovalPolicy, getEnv, getStack

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • PromptBase

      protected PromptBase(software.amazon.jsii.JsiiObjectRef objRef)

    • PromptBase

      protected PromptBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • PromptBase

      @Stability(Stable) protected PromptBase(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable ResourceProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props -

    • PromptBase

      @Stability(Stable) protected PromptBase(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.

  • Method Details

    • grantGet

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

      Default: - Default grant configuration: - actions: ['bedrock:GetPrompt'] - resourceArns: [this.promptArn]

      Specified by:
      grantGet in interface IPrompt
      Parameters:
      grantee -
      • The IAM principal to grant permissions to.
      This parameter is required.
      Returns:
      An IAM Grant object representing the granted permissions

    • getPromptArn

      @Stability(Experimental) @NotNull public abstract String getPromptArn()
      (experimental) The ARN of the prompt.
      Specified by:
      getPromptArn in interface IPrompt

    • getPromptId

      @Stability(Experimental) @NotNull public abstract String getPromptId()
      (experimental) The ID of the prompt.
      Specified by:
      getPromptId in interface IPrompt

    • getPromptVersion

      @Stability(Experimental) @NotNull public abstract String getPromptVersion()
      (experimental) The version of the prompt.
      Specified by:
      getPromptVersion in interface IPrompt

    • getKmsKey

      @Stability(Experimental) @Nullable public abstract IKey getKmsKey()
      (experimental) Optional KMS encryption key associated with this prompt.
      Specified by:
      getKmsKey in interface IPrompt