generative-ai-cdk-constructs

@cdklabs/generative-ai-cdk-constructs

@cdklabs/generative-ai-cdk-constructs / bedrock / Agent

Class: Agent

Class to create (or import) an Agent with CDK.

Cloudformation Resource

AWS::Bedrock::Agent

Extends

Constructors

new Agent()

new Agent(scope, id, props): Agent

Parameters

scope

Construct

id

string

props

AgentProps

Returns

Agent

Overrides

AgentBase.constructor

Properties

actionGroups

actionGroups: AgentActionGroup[]

The action groups associated with the agent.

agentArn

readonly agentArn: string

The ARN of the agent.

Overrides

AgentBase.agentArn

agentId

readonly agentId: string

The unique identifier for the agent

Overrides

AgentBase.agentId

agentVersion

agentVersion: string

The version of the agent.

Overrides

AgentBase.agentVersion

codeInterpreterEnabled

readonly codeInterpreterEnabled: boolean

Whether the agent can generate, run, and troubleshoot code when trying to complete a task.

description?

readonly optional description: string

The description for the agent.

env

readonly env: ResourceEnvironment

The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Inherited from

AgentBase.env

forceDelete

readonly forceDelete: boolean

Whether the resource will be deleted even if it’s in use.

foundationModel

readonly foundationModel: IInvokable

The foundation model used for orchestration by the agent.

guardrail?

optional guardrail: IGuardrail

The guardrail associated with the agent.

idleSessionTTL

readonly idleSessionTTL: Duration

How long sessions should be kept open for the agent.

instruction?

readonly optional instruction: string

The instruction used by the agent. This determines how the agent will perform his task.

kmsKey?

readonly optional kmsKey: IKey

Optional KMS encryption key associated with this agent

Overrides

AgentBase.kmsKey

knowledgeBases

knowledgeBases: IKnowledgeBase[]

The KnowledgeBases associated with the agent.

lastUpdated?

readonly optional lastUpdated: string

When this agent was last updated.

Overrides

AgentBase.lastUpdated

name

readonly name: string

The name of the agent.

node

readonly node: Node

The tree node.

Inherited from

AgentBase.node

physicalName

protected readonly physicalName: string

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

Inherited from

AgentBase.physicalName

promptOverrideConfiguration?

readonly optional promptOverrideConfiguration: PromptOverrideConfiguration

Overrides some prompt templates in different parts of an agent sequence configuration.

Default

- No overrides are provided.

role

readonly role: IRole

The IAM role associated to the agent.

Overrides

AgentBase.role

shouldPrepareAgent

readonly shouldPrepareAgent: boolean

Whether the agent will automatically update the DRAFT version of the agent after making changes to the agent.

stack

readonly stack: Stack

The stack in which this resource is defined.

Inherited from

AgentBase.stack

testAlias

readonly testAlias: IAgentAlias

The default test alias for this agent. This corresponds to the test alias (TSTALIASID) that points to the working (DRAFT) version.

userInputEnabled

readonly userInputEnabled: boolean

Whether the agent can prompt additional information from the user when it does not have enough information to respond to an utterance

Methods

_enableCrossEnvironment()

_enableCrossEnvironment(): void

Internal

Called when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.

Returns

void

Inherited from

AgentBase._enableCrossEnvironment

addActionGroup()

addActionGroup(actionGroup): void

Add an action group to the agent.

Parameters

actionGroup

AgentActionGroup

Returns

void

addActionGroups()

addActionGroups(…actionGroups): void

Add multiple action groups to the agent.

Parameters

actionGroups

…AgentActionGroup[]

Returns

void

addGuardrail()

addGuardrail(guardrail): void

Add guardrail to the agent.

Parameters

guardrail

IGuardrail

Returns

void

addKnowledgeBase()

addKnowledgeBase(knowledgeBase): void

Add knowledge base to the agent.

Parameters

knowledgeBase

IKnowledgeBase

Returns

void

applyRemovalPolicy()

applyRemovalPolicy(policy): void

Apply the given removal policy to this resource

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

Parameters

policy

RemovalPolicy

Returns

void

Inherited from

AgentBase.applyRemovalPolicy

generatePhysicalName()

protected generatePhysicalName(): string

Returns

string

Inherited from

AgentBase.generatePhysicalName

getResourceArnAttribute()

protected getResourceArnAttribute(arnAttr, arnComponents): string

Returns an environment-sensitive token that should be used for the resource’s “ARN” attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arnAttr, but if the resource is referenced across environments, arnComponents will be used to synthesize a concrete ARN with the resource’s physical name. Make sure to reference this.physicalName in arnComponents.

Parameters

arnAttr

string

The CFN attribute which resolves to the ARN of the resource. Commonly it will be called “Arn” (e.g. resource.attrArn), but sometimes it’s the CFN resource’s ref.

arnComponents

ArnComponents

The format of the ARN of this resource. You must reference this.physicalName somewhere within the ARN in order for cross-environment references to work.

Returns

string

Inherited from

AgentBase.getResourceArnAttribute

getResourceNameAttribute()

protected getResourceNameAttribute(nameAttr): string

Returns an environment-sensitive token that should be used for the resource’s “name” attribute (e.g. bucket.bucketName).

Normally, this token will resolve to nameAttr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters

nameAttr

string

The CFN attribute which resolves to the resource’s name. Commonly this is the resource’s ref.

Returns

string

Inherited from

AgentBase.getResourceNameAttribute

toString()

toString(): string

Returns a string representation of this construct.

Returns

string

Inherited from

AgentBase.toString

fromAgentAttrs()

static fromAgentAttrs(scope, id, attrs): IAgent

Static Method for importing an existing Bedrock Agent.

Parameters

scope

Construct

id

string

attrs

AgentAttributes

Returns

IAgent

isConstruct()

static isConstruct(x): x is Construct

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

x

any

Any object

Returns

x is Construct

true if x is an object created from a class which extends Construct.

Inherited from

AgentBase.isConstruct

isOwnedResource()

static isOwnedResource(construct): boolean

Returns true if the construct was created by CDK, and false otherwise

Parameters

construct

IConstruct

Returns

boolean

Inherited from

AgentBase.isOwnedResource

isResource()

static isResource(construct): construct is Resource

Check whether the given construct is a Resource

Parameters

construct

IConstruct

Returns

construct is Resource

Inherited from

AgentBase.isResource

This site is open source. Improve this page.