Class CfnAgent.Builder
java.lang.Object
software.amazon.awscdk.services.bedrock.CfnAgent.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnAgent>
- Enclosing class:
CfnAgent
@Stability(Stable)
public static final class CfnAgent.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAgent>
A fluent builder for
CfnAgent
.-
Method Summary
Modifier and TypeMethodDescriptionactionGroups
(List<? extends Object> actionGroups) The action groups that belong to an agent.actionGroups
(IResolvable actionGroups) The action groups that belong to an agent.The name of the agent.agentResourceRoleArn
(String agentResourceRoleArn) The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.autoPrepare
(Boolean autoPrepare) Specifies whether to automatically update theDRAFT
version of the agent after making changes to the agent.autoPrepare
(IResolvable autoPrepare) Specifies whether to automatically update theDRAFT
version of the agent after making changes to the agent.build()
static CfnAgent.Builder
customerEncryptionKeyArn
(String customerEncryptionKeyArn) The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the agent.description
(String description) The description of the agent.foundationModel
(String foundationModel) The foundation model used for orchestration by the agent.guardrailConfiguration
(IResolvable guardrailConfiguration) Details about the guardrail associated with the agent.guardrailConfiguration
(CfnAgent.GuardrailConfigurationProperty guardrailConfiguration) Details about the guardrail associated with the agent.idleSessionTtlInSeconds
(Number idleSessionTtlInSeconds) The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.instruction
(String instruction) Instructions that tell the agent what it should do and how it should interact with users.knowledgeBases
(List<? extends Object> knowledgeBases) The knowledge bases associated with the agent.knowledgeBases
(IResolvable knowledgeBases) The knowledge bases associated with the agent.promptOverrideConfiguration
(IResolvable promptOverrideConfiguration) Contains configurations to override prompt templates in different parts of an agent sequence.promptOverrideConfiguration
(CfnAgent.PromptOverrideConfigurationProperty promptOverrideConfiguration) Contains configurations to override prompt templates in different parts of an agent sequence.skipResourceInUseCheckOnDelete
(Boolean skipResourceInUseCheckOnDelete) Specifies whether to delete the resource even if it's in use.skipResourceInUseCheckOnDelete
(IResolvable skipResourceInUseCheckOnDelete) Specifies whether to delete the resource even if it's in use.Metadata that you can assign to a resource as key-value pairs.testAliasTags
(Map<String, String> testAliasTags) Metadata that you can assign to a resource as key-value pairs.testAliasTags
(IResolvable testAliasTags) Metadata that you can assign to a resource as key-value pairs.
-
Method Details
-
create
@Stability(Stable) public static CfnAgent.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.- Returns:
- a new instance of
CfnAgent.Builder
.
-
agentName
The name of the agent.- Parameters:
agentName
- The name of the agent. This parameter is required.- Returns:
this
- See Also:
-
actionGroups
The action groups that belong to an agent.- Parameters:
actionGroups
- The action groups that belong to an agent. This parameter is required.- Returns:
this
- See Also:
-
actionGroups
The action groups that belong to an agent.- Parameters:
actionGroups
- The action groups that belong to an agent. This parameter is required.- Returns:
this
- See Also:
-
agentResourceRoleArn
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.- Parameters:
agentResourceRoleArn
- The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent. This parameter is required.- Returns:
this
- See Also:
-
autoPrepare
Specifies whether to automatically update theDRAFT
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 isfalse
.Default: - false
- Parameters:
autoPrepare
- Specifies whether to automatically update theDRAFT
version of the agent after making changes to the agent. This parameter is required.- Returns:
this
- See Also:
-
autoPrepare
Specifies whether to automatically update theDRAFT
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 isfalse
.Default: - false
- Parameters:
autoPrepare
- Specifies whether to automatically update theDRAFT
version of the agent after making changes to the agent. This parameter is required.- Returns:
this
- See Also:
-
customerEncryptionKeyArn
@Stability(Stable) public CfnAgent.Builder customerEncryptionKeyArn(String customerEncryptionKeyArn) The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the agent.- Parameters:
customerEncryptionKeyArn
- The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the agent. This parameter is required.- Returns:
this
- See Also:
-
description
The description of the agent.- Parameters:
description
- The description of the agent. This parameter is required.- Returns:
this
- See Also:
-
foundationModel
The foundation model used for orchestration by the agent.- Parameters:
foundationModel
- The foundation model used for orchestration by the agent. This parameter is required.- Returns:
this
- See Also:
-
guardrailConfiguration
@Stability(Stable) public CfnAgent.Builder guardrailConfiguration(IResolvable guardrailConfiguration) Details about the guardrail associated with the agent.- Parameters:
guardrailConfiguration
- Details about the guardrail associated with the agent. This parameter is required.- Returns:
this
- See Also:
-
guardrailConfiguration
@Stability(Stable) public CfnAgent.Builder guardrailConfiguration(CfnAgent.GuardrailConfigurationProperty guardrailConfiguration) Details about the guardrail associated with the agent.- Parameters:
guardrailConfiguration
- Details about the guardrail associated with the agent. This parameter is required.- Returns:
this
- See Also:
-
idleSessionTtlInSeconds
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.
- Parameters:
idleSessionTtlInSeconds
- The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent. This parameter is required.- Returns:
this
- See Also:
-
instruction
Instructions that tell the agent what it should do and how it should interact with users.- Parameters:
instruction
- Instructions that tell the agent what it should do and how it should interact with users. This parameter is required.- Returns:
this
- See Also:
-
knowledgeBases
The knowledge bases associated with the agent.- Parameters:
knowledgeBases
- The knowledge bases associated with the agent. This parameter is required.- Returns:
this
- See Also:
-
knowledgeBases
The knowledge bases associated with the agent.- Parameters:
knowledgeBases
- The knowledge bases associated with the agent. This parameter is required.- Returns:
this
- See Also:
-
promptOverrideConfiguration
@Stability(Stable) public CfnAgent.Builder promptOverrideConfiguration(IResolvable promptOverrideConfiguration) Contains configurations to override prompt templates in different parts of an agent sequence.For more information, see Advanced prompts .
- Parameters:
promptOverrideConfiguration
- Contains configurations to override prompt templates in different parts of an agent sequence. This parameter is required.- Returns:
this
- See Also:
-
promptOverrideConfiguration
@Stability(Stable) public CfnAgent.Builder promptOverrideConfiguration(CfnAgent.PromptOverrideConfigurationProperty promptOverrideConfiguration) Contains configurations to override prompt templates in different parts of an agent sequence.For more information, see Advanced prompts .
- Parameters:
promptOverrideConfiguration
- Contains configurations to override prompt templates in different parts of an agent sequence. This parameter is required.- Returns:
this
- See Also:
-
skipResourceInUseCheckOnDelete
@Stability(Stable) public CfnAgent.Builder skipResourceInUseCheckOnDelete(Boolean skipResourceInUseCheckOnDelete) Specifies whether to delete the resource even if it's in use.By default, this value is
false
.Default: - false
- Parameters:
skipResourceInUseCheckOnDelete
- Specifies whether to delete the resource even if it's in use. This parameter is required.- Returns:
this
- See Also:
-
skipResourceInUseCheckOnDelete
@Stability(Stable) public CfnAgent.Builder skipResourceInUseCheckOnDelete(IResolvable skipResourceInUseCheckOnDelete) Specifies whether to delete the resource even if it's in use.By default, this value is
false
.Default: - false
- Parameters:
skipResourceInUseCheckOnDelete
- Specifies whether to delete the resource even if it's in use. This parameter is required.- Returns:
this
- See Also:
-
tags
Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.- Parameters:
tags
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:. This parameter is required.- Returns:
this
- See Also:
-
testAliasTags
Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.- Parameters:
testAliasTags
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:. This parameter is required.- Returns:
this
- See Also:
-
testAliasTags
Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.- Parameters:
testAliasTags
- Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:. This parameter is required.- Returns:
this
- See Also:
-
build
-