@aws-cdk/aws-bedrock-alpha.IPrompt

Experimental

@aws-cdk/aws-bedrock-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

IPrompt Interface

Represents a Prompt, either created with CDK or imported.

IPrompt

extends

• IResource

implemented by

• Prompt,
• PromptBase

Stability

Experimental

Source

bedrock/prompts/prompt.ts

Properties

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

kmsKey?may be undefinedIKeykms_key?may be undefinedIKeykmsKey?may be undefinedIKeyKmsKey?may be undefinedIKeyKmsKey?may be undefinedIKey#

Optional KMS encryption key associated with this prompt.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

promptArnstringprompt_arnstrpromptArnStringPromptArnstringPromptArn*string#

The ARN of the prompt.

example

"arn:aws:bedrock:us-east-1:123456789012:prompt/PROMPT12345"

promptIdstringprompt_idstrpromptIdStringPromptIdstringPromptId*string#

The ID of the prompt.

example

"PROMPT12345"

promptVersionstringprompt_versionstrpromptVersionStringPromptVersionstringPromptVersion*string= "DRAFT"#

The version of the prompt.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this resource is defined.

Methods

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

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).

grantGet(grantee: IGrantable): Grantdef grant_get(self, grantee: IGrantable) -> Grantpublic Grant grantGet(IGrantable grantee)public Grant GrantGet(IGrantable grantee)func GrantGet(Grantee IGrantable) Grant#

Grant the given identity permissions to get the prompt.

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

• mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining