Package software.amazon.awscdk.cfnpropertymixins.services.bedrock

Class CfnAgentMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.bedrock.CfnAgentMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAgentMixinProps>

Enclosing interface:

CfnAgentMixinProps

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

A builder for CfnAgentMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

actionGroups

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

Sets the value of CfnAgentMixinProps.getActionGroups()

Parameters:

actionGroups - The action groups that belong to an agent.

Returns:

this

actionGroups

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

Sets the value of CfnAgentMixinProps.getActionGroups()

Parameters:

actionGroups - The action groups that belong to an agent.

Returns:

this

agentCollaboration

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

Sets the value of CfnAgentMixinProps.getAgentCollaboration()

Parameters:

agentCollaboration - The agent's collaboration settings.

Returns:

this

agentCollaborators

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

Sets the value of CfnAgentMixinProps.getAgentCollaborators()

Parameters:

agentCollaborators - List of Agent Collaborators.

Returns:

this

agentCollaborators

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

Sets the value of CfnAgentMixinProps.getAgentCollaborators()

Parameters:

agentCollaborators - List of Agent Collaborators.

Returns:

this

agentName

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

Sets the value of CfnAgentMixinProps.getAgentName()

Parameters:

agentName - The name of the agent.

Returns:

this

agentResourceRoleArn

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

Sets the value of CfnAgentMixinProps.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 CfnAgentMixinProps.Builder autoPrepare(Boolean autoPrepare)

Sets the value of CfnAgentMixinProps.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 CfnAgentMixinProps.Builder autoPrepare(IResolvable autoPrepare)

Sets the value of CfnAgentMixinProps.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 CfnAgentMixinProps.Builder customerEncryptionKeyArn(String customerEncryptionKeyArn)

Sets the value of CfnAgentMixinProps.getCustomerEncryptionKeyArn()

Parameters:

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

Returns:

this

customOrchestration

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

Sets the value of CfnAgentMixinProps.getCustomOrchestration()

Parameters:

customOrchestration - Contains custom orchestration configurations for the agent.

Returns:

this

customOrchestration

@Stability(Stable)
public CfnAgentMixinProps.Builder customOrchestration(CfnAgentPropsMixin.CustomOrchestrationProperty customOrchestration)

Sets the value of CfnAgentMixinProps.getCustomOrchestration()

Parameters:

customOrchestration - Contains custom orchestration configurations for the agent.

Returns:

this

description

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

Sets the value of CfnAgentMixinProps.getDescription()

Parameters:

description - The description of the agent.

Returns:

this

foundationModel

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

Sets the value of CfnAgentMixinProps.getFoundationModel()

Parameters:

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

Returns:

this

guardrailConfiguration

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

Sets the value of CfnAgentMixinProps.getGuardrailConfiguration()

Parameters:

guardrailConfiguration - Details about the guardrail associated with the agent.

Returns:

this

guardrailConfiguration

@Stability(Stable)
public CfnAgentMixinProps.Builder guardrailConfiguration(CfnAgentPropsMixin.GuardrailConfigurationProperty guardrailConfiguration)

Sets the value of CfnAgentMixinProps.getGuardrailConfiguration()

Parameters:

guardrailConfiguration - Details about the guardrail associated with the agent.

Returns:

this

idleSessionTtlInSeconds

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

Sets the value of CfnAgentMixinProps.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 CfnAgentMixinProps.Builder instruction(String instruction)

Sets the value of CfnAgentMixinProps.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 CfnAgentMixinProps.Builder knowledgeBases(IResolvable knowledgeBases)

Sets the value of CfnAgentMixinProps.getKnowledgeBases()

Parameters:

knowledgeBases - The knowledge bases associated with the agent.

Returns:

this

knowledgeBases

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

Sets the value of CfnAgentMixinProps.getKnowledgeBases()

Parameters:

knowledgeBases - The knowledge bases associated with the agent.

Returns:

this

memoryConfiguration

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

Sets the value of CfnAgentMixinProps.getMemoryConfiguration()

Parameters:

memoryConfiguration - Contains memory configuration for the agent.

Returns:

this

memoryConfiguration

@Stability(Stable)
public CfnAgentMixinProps.Builder memoryConfiguration(CfnAgentPropsMixin.MemoryConfigurationProperty memoryConfiguration)

Sets the value of CfnAgentMixinProps.getMemoryConfiguration()

Parameters:

memoryConfiguration - Contains memory configuration for the agent.

Returns:

this

orchestrationType

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

Sets the value of CfnAgentMixinProps.getOrchestrationType()

Parameters:

orchestrationType - Specifies the orchestration strategy for the agent.

Returns:

this

promptOverrideConfiguration

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

Sets the value of CfnAgentMixinProps.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 CfnAgentMixinProps.Builder promptOverrideConfiguration(CfnAgentPropsMixin.PromptOverrideConfigurationProperty promptOverrideConfiguration)

Sets the value of CfnAgentMixinProps.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 CfnAgentMixinProps.Builder skipResourceInUseCheckOnDelete(Boolean skipResourceInUseCheckOnDelete)

Sets the value of CfnAgentMixinProps.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 CfnAgentMixinProps.Builder skipResourceInUseCheckOnDelete(IResolvable skipResourceInUseCheckOnDelete)

Sets the value of CfnAgentMixinProps.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 CfnAgentMixinProps.Builder tags(Map<String,String> tags)

Sets the value of CfnAgentMixinProps.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 CfnAgentMixinProps.Builder testAliasTags(Map<String,String> testAliasTags)

Sets the value of CfnAgentMixinProps.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 CfnAgentMixinProps.Builder testAliasTags(IResolvable testAliasTags)

Sets the value of CfnAgentMixinProps.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 CfnAgentMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnAgentMixinProps

Throws:

NullPointerException - if any required attribute was not provided