io.github.cdklabs.generative_ai_cdk_constructs.bedrock.IPrompt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of generative-ai-cdk-constructs Show documentation
AWS Generative AI CDK Constructs is a library for well-architected generative AI patterns.
There is a newer version: 0.1.271
Show newest version
package io.github.cdklabs.generative_ai_cdk_constructs.bedrock;

/**
 * (experimental) Represents a Prompt, either created with CDK or imported.
 */
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-09-23T22:27:31.965Z")
@software.amazon.jsii.Jsii(module = io.github.cdklabs.generative_ai_cdk_constructs.$Module.class, fqn = "@cdklabs/generative-ai-cdk-constructs.bedrock.IPrompt")
@software.amazon.jsii.Jsii.Proxy(IPrompt.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
public interface IPrompt extends software.amazon.jsii.JsiiSerializable {

    /**
     * (experimental) The ARN of the prompt.
     * 
     * Example:
     * 

     * 
     * "arn:aws:bedrock:us-east-1:123456789012:prompt/PROMPT12345"
     * 
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    @org.jetbrains.annotations.NotNull java.lang.String getPromptArn();

    /**
     * (experimental) The ID of the prompt.
     * 
     * Example:
     * 

     * 
     * "PROMPT12345"
     * 
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    @org.jetbrains.annotations.NotNull java.lang.String getPromptId();

    /**
     * A proxy class which represents a concrete javascript instance of this type.
     */
    @software.amazon.jsii.Internal
    final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements io.github.cdklabs.generative_ai_cdk_constructs.bedrock.IPrompt.Jsii$Default {
        protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
            super(objRef);
        }

        /**
         * (experimental) The ARN of the prompt.
         * 
         * Example:
         * 

         * 
         * "arn:aws:bedrock:us-east-1:123456789012:prompt/PROMPT12345"
         * 
         */
        @Override
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
        public final @org.jetbrains.annotations.NotNull java.lang.String getPromptArn() {
            return software.amazon.jsii.Kernel.get(this, "promptArn", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
        }

        /**
         * (experimental) The ID of the prompt.
         * 
         * Example:
         * 

         * 
         * "PROMPT12345"
         * 
         */
        @Override
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
        public final @org.jetbrains.annotations.NotNull java.lang.String getPromptId() {
            return software.amazon.jsii.Kernel.get(this, "promptId", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
        }
    }

    /**
     * Internal default implementation for {@link IPrompt}.
     */
    @software.amazon.jsii.Internal
    interface Jsii$Default extends IPrompt {

        /**
         * (experimental) The ARN of the prompt.
         * 
         * Example:
         * 

         * 
         * "arn:aws:bedrock:us-east-1:123456789012:prompt/PROMPT12345"
         * 
         */
        @Override
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
        default @org.jetbrains.annotations.NotNull java.lang.String getPromptArn() {
            return software.amazon.jsii.Kernel.get(this, "promptArn", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
        }

        /**
         * (experimental) The ID of the prompt.
         * 
         * Example:
         * 

         * 
         * "PROMPT12345"
         * 
         */
        @Override
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
        default @org.jetbrains.annotations.NotNull java.lang.String getPromptId() {
            return software.amazon.jsii.Kernel.get(this, "promptId", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
        }
    }
}