interface CfnAgentProps
Language | Type name |
---|---|
![]() | Amazon.CDK.aws_bedrock.CfnAgentProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsbedrock#CfnAgentProps |
![]() | software.amazon.awscdk.services.bedrock.CfnAgentProps |
![]() | aws_cdk.aws_bedrock.CfnAgentProps |
![]() | aws-cdk-lib » aws_bedrock » CfnAgentProps |
Properties for defining a CfnAgent
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html
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 cfnAgentProps: bedrock.CfnAgentProps = {
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,
},
},
requireConfirmation: 'requireConfirmation',
}],
},
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',
},
};
Properties
Name | Type | Description |
---|---|---|
agent | string | The name of the agent. |
action | IResolvable | IResolvable | Agent [] | The action groups that belong to an agent. |
agent | string | The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent. |
auto | boolean | IResolvable | Specifies whether to automatically update the DRAFT version of the agent after making changes to the agent. |
customer | string | The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the agent. |
description? | string | The description of the agent. |
foundation | string | The foundation model used for orchestration by the agent. |
guardrail | IResolvable | Guardrail | Details about the guardrail associated with the agent. |
idle | 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. |
knowledge | IResolvable | IResolvable | Agent [] | The knowledge bases associated with the agent. |
prompt | IResolvable | Prompt | Contains configurations to override prompt templates in different parts of an agent sequence. |
skip | 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:. |
test | { [string]: string } | IResolvable | 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
|
Agent
[]
(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
|
Guardrail
(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
|
Agent
[]
(optional)
The knowledge bases associated with the agent.
promptOverrideConfiguration?
Type:
IResolvable
|
Prompt
(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:
{ [string]: string } |
IResolvable
(optional)
Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.