Package software.amazon.awscdk.services.bedrock

Class CfnPromptVersion

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.bedrock.CfnPromptVersion
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-05T03:43:39.624Z") @Stability(Stable) public class CfnPromptVersion extends CfnResource implements IInspectable, ITaggableV2
Creates a static snapshot of your prompt that can be deployed to production.

For more information, see Deploy prompts using Prompt management by creating versions in the Amazon Bedrock User Guide.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.bedrock.*;
 CfnPromptVersion cfnPromptVersion = CfnPromptVersion.Builder.create(this, "MyCfnPromptVersion")
         .promptArn("promptArn")
         // the properties below are optional
         .description("description")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnPromptVersion

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

    • CfnPromptVersion

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

    • CfnPromptVersion

      @Stability(Stable) public CfnPromptVersion(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPromptVersionProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the prompt or the prompt version (if you specified a version in the request).

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The time at which the prompt was created.

    • getAttrCustomerEncryptionKeyArn

      @Stability(Stable) @NotNull public String getAttrCustomerEncryptionKeyArn()
      A KMS key ARN.

    • getAttrDefaultVariant

      @Stability(Stable) @NotNull public String getAttrDefaultVariant()
      The name of the default variant for the prompt.

      This value must match the name field in the relevant PromptVariant object.

    • getAttrName

      @Stability(Stable) @NotNull public String getAttrName()
      The name of the prompt.

    • getAttrPromptId

      @Stability(Stable) @NotNull public String getAttrPromptId()
      The unique identifier of the prompt.

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      The time at which the prompt was last updated.

    • getAttrVariants

      @Stability(Stable) @NotNull public IResolvable getAttrVariants()
      A list of objects, each containing details about a variant of the prompt.

    • getAttrVersion

      @Stability(Stable) @NotNull public String getAttrVersion()
      The version of the prompt that this summary applies to.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getPromptArn

      @Stability(Stable) @NotNull public String getPromptArn()
      The Amazon Resource Name (ARN) of the version of the prompt.

    • setPromptArn

      @Stability(Stable) public void setPromptArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the version of the prompt.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the prompt version.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the prompt version.

    • getTags

      @Stability(Stable) @Nullable public Map<String,String> getTags()
      A map of tag keys and values.

    • setTags

      @Stability(Stable) public void setTags(@Nullable Map<String,String> value)
      A map of tag keys and values.