class CfnAgent (construct)

Language	Type name
.NET	`Amazon.CDK.aws_bedrock.CfnAgent`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsbedrock#CfnAgent`
Java	`software.amazon.awscdk.services.bedrock.CfnAgent`
Python	`aws_cdk.aws_bedrock.CfnAgent`
TypeScript	`aws-cdk-lib` » `aws_bedrock` » `CfnAgent`

Implements IConstruct, IDependable, IInspectable, ITaggableV2

Specifies an agent as a resource in a top-level template. Minimally, you must specify the following properties:.

AgentName – Specify a name for the agent.
AgentResourceRoleArn – Specify the Amazon Resource Name (ARN) of the service role with permissions to invoke API operations on the agent. For more information, see Create a service role for Agents for Amazon Bedrock .
FoundationModel – Specify the model ID of a foundation model to use when invoking the agent. For more information, see Supported regions and models for Agents for Amazon Bedrock .

For more information about using agents in Amazon Bedrock , see Agents for Amazon Bedrock .

See the Properties section below for descriptions of both the required and optional properties.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrock as bedrock } from 'aws-cdk-lib';
const cfnAgent = new bedrock.CfnAgent(this, 'MyCfnAgent', {
  agentName: 'agentName',

  // the properties below are optional
  actionGroups: [{
    actionGroupName: 'actionGroupName',

    // the properties below are optional
    actionGroupExecutor: {
      customControl: 'customControl',
      lambda: 'lambda',
    },
    actionGroupState: 'actionGroupState',
    apiSchema: {
      payload: 'payload',
      s3: {
        s3BucketName: 's3BucketName',
        s3ObjectKey: 's3ObjectKey',
      },
    },
    description: 'description',
    functionSchema: {
      functions: [{
        name: 'name',

        // the properties below are optional
        description: 'description',
        parameters: {
          parametersKey: {
            type: 'type',

            // the properties below are optional
            description: 'description',
            required: false,
          },
        },
      }],
    },
    parentActionGroupSignature: 'parentActionGroupSignature',
    skipResourceInUseCheckOnDelete: false,
  }],
  agentResourceRoleArn: 'agentResourceRoleArn',
  autoPrepare: false,
  customerEncryptionKeyArn: 'customerEncryptionKeyArn',
  description: 'description',
  foundationModel: 'foundationModel',
  guardrailConfiguration: {
    guardrailIdentifier: 'guardrailIdentifier',
    guardrailVersion: 'guardrailVersion',
  },
  idleSessionTtlInSeconds: 123,
  instruction: 'instruction',
  knowledgeBases: [{
    description: 'description',
    knowledgeBaseId: 'knowledgeBaseId',

    // the properties below are optional
    knowledgeBaseState: 'knowledgeBaseState',
  }],
  promptOverrideConfiguration: {
    promptConfigurations: [{
      basePromptTemplate: 'basePromptTemplate',
      inferenceConfiguration: {
        maximumLength: 123,
        stopSequences: ['stopSequences'],
        temperature: 123,
        topK: 123,
        topP: 123,
      },
      parserMode: 'parserMode',
      promptCreationMode: 'promptCreationMode',
      promptState: 'promptState',
      promptType: 'promptType',
    }],

    // the properties below are optional
    overrideLambda: 'overrideLambda',
  },
  skipResourceInUseCheckOnDelete: false,
  tags: {
    tagsKey: 'tags',
  },
  testAliasTags: {
    testAliasTagsKey: 'testAliasTags',
  },
});

Initializer

new CfnAgent(scope: Construct, id: string, props: CfnAgentProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnAgentProps — Resource properties.

Construct Props

Name	Type	Description
agentName	`string`	The name of the agent.
actionGroups?	`IResolvable` `\|` `IResolvable` `\|` `AgentActionGroupProperty[]`	The action groups that belong to an agent.
agentResourceRoleArn?	`string`	The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
autoPrepare?	`boolean \|` `IResolvable`	Specifies whether to automatically update the `DRAFT` version of the agent after making changes to the agent.
customerEncryptionKeyArn?	`string`	The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the agent.
description?	`string`	The description of the agent.
foundationModel?	`string`	The foundation model used for orchestration by the agent.
guardrailConfiguration?	`IResolvable` `\|` `GuardrailConfigurationProperty`	Details about the guardrail associated with the agent.
idleSessionTtlInSeconds?	`number`	The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
instruction?	`string`	Instructions that tell the agent what it should do and how it should interact with users.
knowledgeBases?	`IResolvable` `\|` `IResolvable` `\|` `AgentKnowledgeBaseProperty[]`	The knowledge bases associated with the agent.
promptOverrideConfiguration?	`IResolvable` `\|` `PromptOverrideConfigurationProperty`	Contains configurations to override prompt templates in different parts of an agent sequence.
skipResourceInUseCheckOnDelete?	`boolean \|` `IResolvable`	Specifies whether to delete the resource even if it's in use.
tags?	`{ [string]: string }`	Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.
testAliasTags?	`IResolvable` `\| { [string]: string }`	Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.

agentName

Type: string

The name of the agent.

actionGroups?

Type: IResolvable | IResolvable | AgentActionGroupProperty[] (optional)

The action groups that belong to an agent.

agentResourceRoleArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

autoPrepare?

Type: boolean | IResolvable (optional, default: false)

Specifies whether to automatically update the DRAFT version of the agent after making changes to the agent.

The DRAFT version can be continually iterated upon during internal development. By default, this value is false .

customerEncryptionKeyArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the agent.

description?

Type: string (optional)

The description of the agent.

foundationModel?

Type: string (optional)

The foundation model used for orchestration by the agent.

guardrailConfiguration?

Type: IResolvable | GuardrailConfigurationProperty (optional)

Details about the guardrail associated with the agent.

idleSessionTtlInSeconds?

Type: number (optional)

The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

instruction?

Type: string (optional)

Instructions that tell the agent what it should do and how it should interact with users.

knowledgeBases?

Type: IResolvable | IResolvable | AgentKnowledgeBaseProperty[] (optional)

The knowledge bases associated with the agent.

promptOverrideConfiguration?

Type: IResolvable | PromptOverrideConfigurationProperty (optional)

Contains configurations to override prompt templates in different parts of an agent sequence.

For more information, see Advanced prompts .

skipResourceInUseCheckOnDelete?

Type: boolean | IResolvable (optional, default: false)

Specifies whether to delete the resource even if it's in use.

By default, this value is false .

tags?

Type: { [string]: string } (optional)

Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.

testAliasTags?

Type: IResolvable | { [string]: string } (optional)

Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.

Properties

Name	Type	Description
agentName	`string`	The name of the agent.
attrAgentArn	`string`	The Amazon Resource Name (ARN) of the agent.
attrAgentId	`string`	The unique identifier of the agent.
attrAgentStatus	`string`	The status of the agent and whether it is ready for use. The following statuses are possible:.
attrAgentVersion	`string`	The version of the agent.
attrCreatedAt	`string`	The time at which the agent was created.
attrFailureReasons	`string[]`	Contains reasons that the agent-related API that you invoked failed.
attrPreparedAt	`string`	The time at which the agent was last prepared.
attrRecommendedActions	`string[]`	Contains recommended actions to take for the agent-related API that you invoked to succeed.
attrUpdatedAt	`string`	The time at which the agent was last updated.
cdkTagManager	`TagManager`	Tag Manager which manages the tags for this resource.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`Node`	The tree node.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
actionGroups?	`IResolvable` `\|` `IResolvable` `\|` `AgentActionGroupProperty[]`	The action groups that belong to an agent.
agentResourceRoleArn?	`string`	The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
autoPrepare?	`boolean \|` `IResolvable`	Specifies whether to automatically update the `DRAFT` version of the agent after making changes to the agent.
customerEncryptionKeyArn?	`string`	The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the agent.
description?	`string`	The description of the agent.
foundationModel?	`string`	The foundation model used for orchestration by the agent.
guardrailConfiguration?	`IResolvable` `\|` `GuardrailConfigurationProperty`	Details about the guardrail associated with the agent.
idleSessionTtlInSeconds?	`number`	The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
instruction?	`string`	Instructions that tell the agent what it should do and how it should interact with users.
knowledgeBases?	`IResolvable` `\|` `IResolvable` `\|` `AgentKnowledgeBaseProperty[]`	The knowledge bases associated with the agent.
promptOverrideConfiguration?	`IResolvable` `\|` `PromptOverrideConfigurationProperty`	Contains configurations to override prompt templates in different parts of an agent sequence.
skipResourceInUseCheckOnDelete?	`boolean \|` `IResolvable`	Specifies whether to delete the resource even if it's in use.
tags?	`{ [string]: string }`	Metadata that you can assign to a resource as key-value pairs.
testAliasTags?	`IResolvable` `\| { [string]: string }`	Metadata that you can assign to a resource as key-value pairs.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

agentName

Type: string

The name of the agent.

attrAgentArn

Type: string

The Amazon Resource Name (ARN) of the agent.

attrAgentId

Type: string

The unique identifier of the agent.

attrAgentStatus

Type: string

The status of the agent and whether it is ready for use. The following statuses are possible:.

CREATING – The agent is being created.
PREPARING – The agent is being prepared.
PREPARED – The agent is prepared and ready to be invoked.
NOT_PREPARED – The agent has been created but not yet prepared.
FAILED – The agent API operation failed.
UPDATING – The agent is being updated.
DELETING – The agent is being deleted.

attrAgentVersion

Type: string

The version of the agent.

attrCreatedAt

Type: string

The time at which the agent was created.

attrFailureReasons

Type: string[]

Contains reasons that the agent-related API that you invoked failed.

attrPreparedAt

Type: string

The time at which the agent was last prepared.

attrRecommendedActions

Type: string[]

Contains recommended actions to take for the agent-related API that you invoked to succeed.

attrUpdatedAt

Type: string

The time at which the agent was last updated.

cdkTagManager

Type: TagManager

Tag Manager which manages the tags for this resource.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: Node

The tree node.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

actionGroups?

Type: IResolvable | IResolvable | AgentActionGroupProperty[] (optional)

The action groups that belong to an agent.

agentResourceRoleArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

autoPrepare?

Type: boolean | IResolvable (optional)

Specifies whether to automatically update the DRAFT version of the agent after making changes to the agent.

customerEncryptionKeyArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the agent.

description?

Type: string (optional)

The description of the agent.

foundationModel?

Type: string (optional)

The foundation model used for orchestration by the agent.

guardrailConfiguration?

Type: IResolvable | GuardrailConfigurationProperty (optional)

Details about the guardrail associated with the agent.

idleSessionTtlInSeconds?

Type: number (optional)

The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

instruction?

Type: string (optional)

Instructions that tell the agent what it should do and how it should interact with users.

knowledgeBases?

Type: IResolvable | IResolvable | AgentKnowledgeBaseProperty[] (optional)

The knowledge bases associated with the agent.

promptOverrideConfiguration?

Type: IResolvable | PromptOverrideConfigurationProperty (optional)

Contains configurations to override prompt templates in different parts of an agent sequence.

skipResourceInUseCheckOnDelete?

Type: boolean | IResolvable (optional)

Specifies whether to delete the resource even if it's in use.

tags?

Type: { [string]: string } (optional)

Metadata that you can assign to a resource as key-value pairs.

For more information, see the following resources:.

testAliasTags?

Type: IResolvable | { [string]: string } (optional)

Metadata that you can assign to a resource as key-value pairs.

For more information, see the following resources:.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }