Show / Hide Table of Contents

Class PromptBase

(experimental) Abstract base class for a Prompt.

Inheritance
object
Resource
PromptBase
Prompt
Implements
IPrompt
IResource
IConstruct
IDependable
IEnvironmentAware
Inherited Members
Resource.IsOwnedResource(IConstruct)
Resource.IsResource(IConstruct)
Resource.ApplyRemovalPolicy(RemovalPolicy)
Resource.GeneratePhysicalName()
Resource.GetResourceArnAttribute(string, IArnComponents)
Resource.GetResourceNameAttribute(string)
Resource.Env
Resource.PhysicalName
Resource.Stack
Namespace: Amazon.CDK.AWS.Bedrock.Alpha
Assembly: Amazon.CDK.AWS.Bedrock.Alpha.dll
Syntax (csharp)
public abstract class PromptBase : Resource, IPrompt, IResource, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public MustInherit Class PromptBase Inherits Resource Implements IPrompt, IResource, IConstruct, IDependable, IEnvironmentAware
Remarks

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

Stability: Experimental

Synopsis

Constructors

PromptBase(Construct, string, IResourceProps?)

(experimental) Abstract base class for a Prompt.

Properties

KmsKey

(experimental) Optional KMS encryption key associated with this prompt.

PromptArn

(experimental) The ARN of the prompt.

PromptId

(experimental) The ID of the prompt.

PromptVersion

(experimental) The version of the prompt.

Methods

GrantGet(IGrantable)

(experimental) Grant the given identity permissions to get the prompt.

Constructors

PromptBase(Construct, string, IResourceProps?)

(experimental) Abstract base class for a Prompt.

protected PromptBase(Construct scope, string id, IResourceProps? props = null)
Parameters
scope Construct
id string
props IResourceProps
Remarks

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

Stability: Experimental

Properties

KmsKey

(experimental) Optional KMS encryption key associated with this prompt.

public abstract IKey? KmsKey { get; }
Property Value

IKey

Remarks

Stability: Experimental

PromptArn

(experimental) The ARN of the prompt.

public abstract string PromptArn { get; }
Property Value

string

Remarks

Stability: Experimental

PromptId

(experimental) The ID of the prompt.

public abstract string PromptId { get; }
Property Value

string

Remarks

Stability: Experimental

PromptVersion

(experimental) The version of the prompt.

public abstract string PromptVersion { get; }
Property Value

string

Remarks

Stability: Experimental

Methods

GrantGet(IGrantable)

(experimental) Grant the given identity permissions to get the prompt.

public virtual Grant GrantGet(IGrantable grantee)
Parameters
grantee IGrantable
  • The IAM principal to grant permissions to.
Returns

Grant

An IAM Grant object representing the granted permissions

Remarks

Default: - Default grant configuration:

  • actions: ['bedrock:GetPrompt']
  • resourceArns: [this.promptArn]

Stability: Experimental

Implements

IPrompt
IResource
Constructs.IConstruct
Constructs.IDependable
IEnvironmentAware
Back to top Generated by DocFX