Package software.amazon.awscdk.services.bedrock

Class CfnAgentProps.Builder

java.lang.Object

software.amazon.awscdk.services.bedrock.CfnAgentProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAgentProps>

Enclosing interface:

CfnAgentProps

@Stability(Stable)
public static final class CfnAgentProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAgentProps>

A builder for CfnAgentProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnAgentProps.Builder	actionGroups(List<? extends Object> actionGroups)	Sets the value of CfnAgentProps.getActionGroups()
CfnAgentProps.Builder	actionGroups(IResolvable actionGroups)	Sets the value of CfnAgentProps.getActionGroups()
CfnAgentProps.Builder	agentCollaboration(String agentCollaboration)	Sets the value of CfnAgentProps.getAgentCollaboration()
CfnAgentProps.Builder	agentCollaborators(List<? extends Object> agentCollaborators)	Sets the value of CfnAgentProps.getAgentCollaborators()
CfnAgentProps.Builder	agentCollaborators(IResolvable agentCollaborators)	Sets the value of CfnAgentProps.getAgentCollaborators()
CfnAgentProps.Builder	agentName(String agentName)	Sets the value of CfnAgentProps.getAgentName()
CfnAgentProps.Builder	agentResourceRoleArn(String agentResourceRoleArn)	Sets the value of CfnAgentProps.getAgentResourceRoleArn()
CfnAgentProps.Builder	autoPrepare(Boolean autoPrepare)	Sets the value of CfnAgentProps.getAutoPrepare()
CfnAgentProps.Builder	autoPrepare(IResolvable autoPrepare)	Sets the value of CfnAgentProps.getAutoPrepare()
CfnAgentProps	build()	Builds the configured instance.
CfnAgentProps.Builder	customerEncryptionKeyArn(String customerEncryptionKeyArn)	Sets the value of CfnAgentProps.getCustomerEncryptionKeyArn()
CfnAgentProps.Builder	customOrchestration(IResolvable customOrchestration)	Sets the value of CfnAgentProps.getCustomOrchestration()
CfnAgentProps.Builder	customOrchestration(CfnAgent.CustomOrchestrationProperty customOrchestration)	Sets the value of CfnAgentProps.getCustomOrchestration()
CfnAgentProps.Builder	description(String description)	Sets the value of CfnAgentProps.getDescription()
CfnAgentProps.Builder	foundationModel(String foundationModel)	Sets the value of CfnAgentProps.getFoundationModel()
CfnAgentProps.Builder	guardrailConfiguration(IResolvable guardrailConfiguration)	Sets the value of CfnAgentProps.getGuardrailConfiguration()
CfnAgentProps.Builder	guardrailConfiguration(CfnAgent.GuardrailConfigurationProperty guardrailConfiguration)	Sets the value of CfnAgentProps.getGuardrailConfiguration()
CfnAgentProps.Builder	idleSessionTtlInSeconds(Number idleSessionTtlInSeconds)	Sets the value of CfnAgentProps.getIdleSessionTtlInSeconds()
CfnAgentProps.Builder	instruction(String instruction)	Sets the value of CfnAgentProps.getInstruction()
CfnAgentProps.Builder	knowledgeBases(List<? extends Object> knowledgeBases)	Sets the value of CfnAgentProps.getKnowledgeBases()
CfnAgentProps.Builder	knowledgeBases(IResolvable knowledgeBases)	Sets the value of CfnAgentProps.getKnowledgeBases()
CfnAgentProps.Builder	memoryConfiguration(IResolvable memoryConfiguration)	Sets the value of CfnAgentProps.getMemoryConfiguration()
CfnAgentProps.Builder	memoryConfiguration(CfnAgent.MemoryConfigurationProperty memoryConfiguration)	Sets the value of CfnAgentProps.getMemoryConfiguration()
CfnAgentProps.Builder	orchestrationType(String orchestrationType)	Sets the value of CfnAgentProps.getOrchestrationType()
CfnAgentProps.Builder	promptOverrideConfiguration(IResolvable promptOverrideConfiguration)	Sets the value of CfnAgentProps.getPromptOverrideConfiguration()
CfnAgentProps.Builder	promptOverrideConfiguration(CfnAgent.PromptOverrideConfigurationProperty promptOverrideConfiguration)	Sets the value of CfnAgentProps.getPromptOverrideConfiguration()
CfnAgentProps.Builder	skipResourceInUseCheckOnDelete(Boolean skipResourceInUseCheckOnDelete)	Sets the value of CfnAgentProps.getSkipResourceInUseCheckOnDelete()
CfnAgentProps.Builder	skipResourceInUseCheckOnDelete(IResolvable skipResourceInUseCheckOnDelete)	Sets the value of CfnAgentProps.getSkipResourceInUseCheckOnDelete()
CfnAgentProps.Builder	tags(Map<String,String> tags)	Sets the value of CfnAgentProps.getTags()
CfnAgentProps.Builder	testAliasTags(Map<String,String> testAliasTags)	Sets the value of CfnAgentProps.getTestAliasTags()
CfnAgentProps.Builder	testAliasTags(IResolvable testAliasTags)	Sets the value of CfnAgentProps.getTestAliasTags()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

agentName

@Stability(Stable)
public CfnAgentProps.Builder agentName(String agentName)

Sets the value of CfnAgentProps.getAgentName()

Parameters:

agentName - The name of the agent. This parameter is required.

Returns:

this

actionGroups

@Stability(Stable)
public CfnAgentProps.Builder actionGroups(IResolvable actionGroups)

Sets the value of CfnAgentProps.getActionGroups()

Parameters:

actionGroups - The action groups that belong to an agent.

Returns:

this

actionGroups

@Stability(Stable)
public CfnAgentProps.Builder actionGroups(List<? extends Object> actionGroups)

Sets the value of CfnAgentProps.getActionGroups()

Parameters:

actionGroups - The action groups that belong to an agent.

Returns:

this

agentCollaboration

@Stability(Stable)
public CfnAgentProps.Builder agentCollaboration(String agentCollaboration)

Sets the value of CfnAgentProps.getAgentCollaboration()

Parameters:

agentCollaboration - The agent's collaboration settings.

Returns:

this

agentCollaborators

@Stability(Stable)
public CfnAgentProps.Builder agentCollaborators(IResolvable agentCollaborators)

Sets the value of CfnAgentProps.getAgentCollaborators()

Parameters:

agentCollaborators - List of Agent Collaborators.

Returns:

this

agentCollaborators

@Stability(Stable)
public CfnAgentProps.Builder agentCollaborators(List<? extends Object> agentCollaborators)

Sets the value of CfnAgentProps.getAgentCollaborators()

Parameters:

agentCollaborators - List of Agent Collaborators.

Returns:

this

agentResourceRoleArn

@Stability(Stable)
public CfnAgentProps.Builder agentResourceRoleArn(String agentResourceRoleArn)

Sets the value of CfnAgentProps.getAgentResourceRoleArn()

Parameters:

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

Returns:

this

autoPrepare

@Stability(Stable)
public CfnAgentProps.Builder autoPrepare(Boolean autoPrepare)

Sets the value of CfnAgentProps.getAutoPrepare()

Parameters:

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

Returns:

this

autoPrepare

@Stability(Stable)
public CfnAgentProps.Builder autoPrepare(IResolvable autoPrepare)

Sets the value of CfnAgentProps.getAutoPrepare()

Parameters:

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

Returns:

this

customerEncryptionKeyArn

@Stability(Stable)
public CfnAgentProps.Builder customerEncryptionKeyArn(String customerEncryptionKeyArn)

Sets the value of CfnAgentProps.getCustomerEncryptionKeyArn()

Parameters:

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

Returns:

this

customOrchestration

@Stability(Stable)
public CfnAgentProps.Builder customOrchestration(IResolvable customOrchestration)

Sets the value of CfnAgentProps.getCustomOrchestration()

Parameters:

customOrchestration - Contains custom orchestration configurations for the agent.

Returns:

this

customOrchestration

@Stability(Stable)
public CfnAgentProps.Builder customOrchestration(CfnAgent.CustomOrchestrationProperty customOrchestration)

Sets the value of CfnAgentProps.getCustomOrchestration()

Parameters:

customOrchestration - Contains custom orchestration configurations for the agent.

Returns:

this

description

@Stability(Stable)
public CfnAgentProps.Builder description(String description)

Sets the value of CfnAgentProps.getDescription()

Parameters:

description - The description of the agent.

Returns:

this

foundationModel

@Stability(Stable)
public CfnAgentProps.Builder foundationModel(String foundationModel)

Sets the value of CfnAgentProps.getFoundationModel()

Parameters:

foundationModel - The foundation model used for orchestration by the agent.

Returns:

this

guardrailConfiguration

@Stability(Stable)
public CfnAgentProps.Builder guardrailConfiguration(IResolvable guardrailConfiguration)

Sets the value of CfnAgentProps.getGuardrailConfiguration()

Parameters:

guardrailConfiguration - Details about the guardrail associated with the agent.

Returns:

this

guardrailConfiguration

@Stability(Stable)
public CfnAgentProps.Builder guardrailConfiguration(CfnAgent.GuardrailConfigurationProperty guardrailConfiguration)

Sets the value of CfnAgentProps.getGuardrailConfiguration()

Parameters:

guardrailConfiguration - Details about the guardrail associated with the agent.

Returns:

this

idleSessionTtlInSeconds

@Stability(Stable)
public CfnAgentProps.Builder idleSessionTtlInSeconds(Number idleSessionTtlInSeconds)

Sets the value of CfnAgentProps.getIdleSessionTtlInSeconds()

Parameters:

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.

Returns:

this

instruction

@Stability(Stable)
public CfnAgentProps.Builder instruction(String instruction)

Sets the value of CfnAgentProps.getInstruction()

Parameters:

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

Returns:

this

knowledgeBases

@Stability(Stable)
public CfnAgentProps.Builder knowledgeBases(IResolvable knowledgeBases)

Sets the value of CfnAgentProps.getKnowledgeBases()

Parameters:

knowledgeBases - The knowledge bases associated with the agent.

Returns:

this

knowledgeBases

@Stability(Stable)
public CfnAgentProps.Builder knowledgeBases(List<? extends Object> knowledgeBases)

Sets the value of CfnAgentProps.getKnowledgeBases()

Parameters:

knowledgeBases - The knowledge bases associated with the agent.

Returns:

this

memoryConfiguration

@Stability(Stable)
public CfnAgentProps.Builder memoryConfiguration(IResolvable memoryConfiguration)

Sets the value of CfnAgentProps.getMemoryConfiguration()

Parameters:

memoryConfiguration - Contains memory configuration for the agent.

Returns:

this

memoryConfiguration

@Stability(Stable)
public CfnAgentProps.Builder memoryConfiguration(CfnAgent.MemoryConfigurationProperty memoryConfiguration)

Sets the value of CfnAgentProps.getMemoryConfiguration()

Parameters:

memoryConfiguration - Contains memory configuration for the agent.

Returns:

this

orchestrationType

@Stability(Stable)
public CfnAgentProps.Builder orchestrationType(String orchestrationType)

Sets the value of CfnAgentProps.getOrchestrationType()

Parameters:

orchestrationType - Specifies the orchestration strategy for the agent.

Returns:

this

promptOverrideConfiguration

@Stability(Stable)
public CfnAgentProps.Builder promptOverrideConfiguration(IResolvable promptOverrideConfiguration)

Sets the value of CfnAgentProps.getPromptOverrideConfiguration()

Parameters:

promptOverrideConfiguration - Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts .

Returns:

this

promptOverrideConfiguration

@Stability(Stable)
public CfnAgentProps.Builder promptOverrideConfiguration(CfnAgent.PromptOverrideConfigurationProperty promptOverrideConfiguration)

Sets the value of CfnAgentProps.getPromptOverrideConfiguration()

Parameters:

promptOverrideConfiguration - Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts .

Returns:

this

skipResourceInUseCheckOnDelete

@Stability(Stable)
public CfnAgentProps.Builder skipResourceInUseCheckOnDelete(Boolean skipResourceInUseCheckOnDelete)

Sets the value of CfnAgentProps.getSkipResourceInUseCheckOnDelete()

Parameters:

skipResourceInUseCheckOnDelete - Specifies whether to delete the resource even if it's in use. By default, this value is false .

Returns:

this

skipResourceInUseCheckOnDelete

@Stability(Stable)
public CfnAgentProps.Builder skipResourceInUseCheckOnDelete(IResolvable skipResourceInUseCheckOnDelete)

Sets the value of CfnAgentProps.getSkipResourceInUseCheckOnDelete()

Parameters:

skipResourceInUseCheckOnDelete - Specifies whether to delete the resource even if it's in use. By default, this value is false .

Returns:

this

tags

@Stability(Stable)
public CfnAgentProps.Builder tags(Map<String,String> tags)

Sets the value of CfnAgentProps.getTags()

Parameters:

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

• Tag naming limits and requirements
• Tagging best practices

Returns:

this

testAliasTags

@Stability(Stable)
public CfnAgentProps.Builder testAliasTags(Map<String,String> testAliasTags)

Sets the value of CfnAgentProps.getTestAliasTags()

Parameters:

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

• Tag naming limits and requirements
• Tagging best practices

Returns:

this

testAliasTags

@Stability(Stable)
public CfnAgentProps.Builder testAliasTags(IResolvable testAliasTags)

Sets the value of CfnAgentProps.getTestAliasTags()

Parameters:

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

• Tag naming limits and requirements
• Tagging best practices

Returns:

this

build

@Stability(Stable)
public CfnAgentProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnAgentProps>

Returns:

a new instance of CfnAgentProps

Throws:

NullPointerException - if any required attribute was not provided