AWS CDK Reference

Appearance

v2.276.0

Experimental

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

PromptAttributes Struct ​

Attributes for specifying an imported Bedrock Prompt.

Stability
Experimental
Source
bedrock/prompts/prompt.ts

Example ​

ts
// Import an existing prompt by ARN
const importedPrompt = bedrock.Prompt.fromPromptAttributes(this, 'ImportedPrompt', {
  promptArn: 'arn:aws:bedrock:region:account:prompt/prompt-id',
  kmsKey: kms.Key.fromKeyArn(this, 'ImportedKey', 'arn:aws:kms:region:account:key/key-id'), // optional
  promptVersion: '1', // optional, defaults to 'DRAFT'
});
python
# Import an existing prompt by ARN
imported_prompt = bedrock.Prompt.from_prompt_attributes(self, "ImportedPrompt",
    prompt_arn="arn:aws:bedrock:region:account:prompt/prompt-id",
    kms_key=kms.Key.from_key_arn(self, "ImportedKey", "arn:aws:kms:region:account:key/key-id"),  # optional
    prompt_version="1"
)
java
// Import an existing prompt by ARN
IPrompt importedPrompt = Prompt.fromPromptAttributes(this, "ImportedPrompt", PromptAttributes.builder()
        .promptArn("arn:aws:bedrock:region:account:prompt/prompt-id")
        .kmsKey(Key.fromKeyArn(this, "ImportedKey", "arn:aws:kms:region:account:key/key-id")) // optional
        .promptVersion("1")
        .build());
csharp
// Install: dotnet add package Amazon.CDK.AWS.Bedrock.Alpha
// Import an existing prompt by ARN
var importedPrompt = Prompt.FromPromptAttributes(this, "ImportedPrompt", new PromptAttributes {
    PromptArn = "arn:aws:bedrock:region:account:prompt/prompt-id",
    KmsKey = Key.FromKeyArn(this, "ImportedKey", "arn:aws:kms:region:account:key/key-id"),  // optional
    PromptVersion = "1"
});
go
// Install: go get github.com/aws/aws-cdk-go/awsbedrockalpha/v2
// Import an existing prompt by ARN
importedPrompt := bedrock.Prompt_FromPromptAttributes(this, jsii.String("ImportedPrompt"), &PromptAttributes{
	PromptArn: jsii.String("arn:aws:bedrock:region:account:prompt/prompt-id"),
	KmsKey: kms.Key_FromKeyArn(this, jsii.String("ImportedKey"), jsii.String("arn:aws:kms:region:account:key/key-id")),
	 // optional
	PromptVersion: jsii.String("1"),
})

Properties ​

kmsKeyoptionalIKeykms_keyoptionalIKeykmsKeyoptionalIKeyKmsKeyoptionalIKeyKmsKeyoptionalIKey#
Optional KMS encryption key associated with this prompt.

Default: undefined - An AWS managed key is used

promptArnstringprompt_arnstrpromptArnStringPromptArnstringPromptArn*stringrequired#
The ARN of the prompt.
example
ts
"arn:aws:bedrock:us-east-1:123456789012:prompt/PROMPT12345"
promptVersionoptionalstringprompt_versionoptionalstrpromptVersionoptionalStringPromptVersionoptionalstringPromptVersionoptional*string= "DRAFT"#
The version of the prompt.