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

Interface IPrompt.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IPrompt, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IPrompt.Jsii$Proxy
Enclosing interface:
IPrompt
@Internal public static interface IPrompt.Jsii$Default extends IPrompt, IResource.Jsii$Default
Internal default implementation for IPrompt.

  • Nested Class Summary

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

    software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

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

    software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

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

    IPrompt.Jsii$Default, IPrompt.Jsii$Proxy

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

    IResource.Jsii$Default, IResource.Jsii$Proxy

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    applyRemovalPolicy(RemovalPolicy policy)
    Apply the given removal policy to this resource.
    default ResourceEnvironment
    getEnv()
    The environment this resource belongs to.
    default IKey
    getKmsKey()
    (experimental) Optional KMS encryption key associated with this prompt.
    default software.constructs.Node
    getNode()
    The tree node.
    default String
    getPromptArn()
    (experimental) The ARN of the prompt.
    default String
    getPromptId()
    (experimental) The ID of the prompt.
    default String
    getPromptVersion()
    (experimental) The version of the prompt.
    default Stack
    getStack()
    The stack in which this resource is defined.
    default Grant
    grantGet(IGrantable grantee)
    (experimental) Grant the given identity permissions to get the prompt.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default software.constructs.Node getNode()
      The tree node.
      Specified by:
      getNode in interface software.constructs.IConstruct
      Specified by:
      getNode in interface software.constructs.IConstruct.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull default ResourceEnvironment getEnv()
      The environment this resource belongs to.

      For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

      Specified by:
      getEnv in interface IResource
      Specified by:
      getEnv in interface IResource.Jsii$Default

    • getStack

      @Stability(Stable) @NotNull default Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default

    • getPromptArn

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

      Example: 

       "arn:aws:bedrock:us-east-1:123456789012:prompt/PROMPT12345";
      Specified by:
      getPromptArn in interface IPrompt

    • getPromptId

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

      Example: 

       "PROMPT12345";
      Specified by:
      getPromptId in interface IPrompt

    • getPromptVersion

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

      Default: "DRAFT"

      Specified by:
      getPromptVersion in interface IPrompt

    • getKmsKey

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

    • applyRemovalPolicy

      @Stability(Stable) default void applyRemovalPolicy(@NotNull RemovalPolicy policy)
      Apply the given removal policy to this resource.

      The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

      The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

      Specified by:
      applyRemovalPolicy in interface IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.

    • grantGet

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

      Specified by:
      grantGet in interface IPrompt
      Parameters:
      grantee - This parameter is required.