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

Class CfnAgentPropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAgentPropsMixin>

Enclosing class:

CfnAgentPropsMixin

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

A fluent builder for CfnAgentPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnAgentPropsMixin.Builder	actionGroups(List<? extends Object> actionGroups)	The action groups that belong to an agent.
CfnAgentPropsMixin.Builder	actionGroups(IResolvable actionGroups)	The action groups that belong to an agent.
CfnAgentPropsMixin.Builder	agentCollaboration(String agentCollaboration)	The agent's collaboration settings.
CfnAgentPropsMixin.Builder	agentCollaborators(List<? extends Object> agentCollaborators)	List of Agent Collaborators.
CfnAgentPropsMixin.Builder	agentCollaborators(IResolvable agentCollaborators)	List of Agent Collaborators.
CfnAgentPropsMixin.Builder	agentName(String agentName)	The name of the agent.
CfnAgentPropsMixin.Builder	agentResourceRoleArn(String agentResourceRoleArn)	The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
CfnAgentPropsMixin.Builder	autoPrepare(Boolean autoPrepare)	Specifies whether to automatically update the DRAFT version of the agent after making changes to the agent.
CfnAgentPropsMixin.Builder	autoPrepare(IResolvable autoPrepare)	Specifies whether to automatically update the DRAFT version of the agent after making changes to the agent.
CfnAgentPropsMixin	build()
static CfnAgentPropsMixin.Builder	create()
static CfnAgentPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnAgentPropsMixin.Builder	customerEncryptionKeyArn(String customerEncryptionKeyArn)	The Amazon Resource Name (ARN) of the AWS key that encrypts the agent.
CfnAgentPropsMixin.Builder	customOrchestration(CfnAgentPropsMixin.CustomOrchestrationProperty customOrchestration)	Contains custom orchestration configurations for the agent.
CfnAgentPropsMixin.Builder	customOrchestration(IResolvable customOrchestration)	Contains custom orchestration configurations for the agent.
CfnAgentPropsMixin.Builder	description(String description)	The description of the agent.
CfnAgentPropsMixin.Builder	foundationModel(String foundationModel)	The foundation model used for orchestration by the agent.
CfnAgentPropsMixin.Builder	guardrailConfiguration(CfnAgentPropsMixin.GuardrailConfigurationProperty guardrailConfiguration)	Details about the guardrail associated with the agent.
CfnAgentPropsMixin.Builder	guardrailConfiguration(IResolvable guardrailConfiguration)	Details about the guardrail associated with the agent.
CfnAgentPropsMixin.Builder	idleSessionTtlInSeconds(Number idleSessionTtlInSeconds)	The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
CfnAgentPropsMixin.Builder	instruction(String instruction)	Instructions that tell the agent what it should do and how it should interact with users.
CfnAgentPropsMixin.Builder	knowledgeBases(List<? extends Object> knowledgeBases)	The knowledge bases associated with the agent.
CfnAgentPropsMixin.Builder	knowledgeBases(IResolvable knowledgeBases)	The knowledge bases associated with the agent.
CfnAgentPropsMixin.Builder	memoryConfiguration(CfnAgentPropsMixin.MemoryConfigurationProperty memoryConfiguration)	Contains memory configuration for the agent.
CfnAgentPropsMixin.Builder	memoryConfiguration(IResolvable memoryConfiguration)	Contains memory configuration for the agent.
CfnAgentPropsMixin.Builder	orchestrationType(String orchestrationType)	Specifies the orchestration strategy for the agent.
CfnAgentPropsMixin.Builder	promptOverrideConfiguration(CfnAgentPropsMixin.PromptOverrideConfigurationProperty promptOverrideConfiguration)	Contains configurations to override prompt templates in different parts of an agent sequence.
CfnAgentPropsMixin.Builder	promptOverrideConfiguration(IResolvable promptOverrideConfiguration)	Contains configurations to override prompt templates in different parts of an agent sequence.
CfnAgentPropsMixin.Builder	skipResourceInUseCheckOnDelete(Boolean skipResourceInUseCheckOnDelete)	Specifies whether to delete the resource even if it's in use.
CfnAgentPropsMixin.Builder	skipResourceInUseCheckOnDelete(IResolvable skipResourceInUseCheckOnDelete)	Specifies whether to delete the resource even if it's in use.
CfnAgentPropsMixin.Builder	tags(Map<String,String> tags)	Metadata that you can assign to a resource as key-value pairs.
CfnAgentPropsMixin.Builder	testAliasTags(Map<String,String> testAliasTags)	Metadata that you can assign to a resource as key-value pairs.
CfnAgentPropsMixin.Builder	testAliasTags(IResolvable testAliasTags)	Metadata that you can assign to a resource as key-value pairs.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnAgentPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnAgentPropsMixin.Builder.

create

@Stability(Stable)
public static CfnAgentPropsMixin.Builder create()

Returns:

a new instance of CfnAgentPropsMixin.Builder.

actionGroups

@Stability(Stable)
public CfnAgentPropsMixin.Builder actionGroups(IResolvable 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-actiongroups

actionGroups

@Stability(Stable)
public CfnAgentPropsMixin.Builder actionGroups(List<? extends Object> 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-actiongroups

agentCollaboration

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

The agent's collaboration settings.

Parameters:

agentCollaboration - The agent's collaboration settings. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-agentcollaboration

agentCollaborators

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

List of Agent Collaborators.

Parameters:

agentCollaborators - List of Agent Collaborators. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-agentcollaborators

agentCollaborators

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

List of Agent Collaborators.

Parameters:

agentCollaborators - List of Agent Collaborators. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-agentcollaborators

agentName

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

The name of the agent.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-agentname

agentResourceRoleArn

@Stability(Stable)
public CfnAgentPropsMixin.Builder agentResourceRoleArn(String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-agentresourcerolearn

autoPrepare

@Stability(Stable)
public CfnAgentPropsMixin.Builder autoPrepare(Boolean 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 .

Default: - false

Parameters:

autoPrepare - Specifies whether to automatically update the DRAFT version of the agent after making changes to the agent. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-autoprepare

autoPrepare

@Stability(Stable)
public CfnAgentPropsMixin.Builder autoPrepare(IResolvable 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 .

Default: - false

Parameters:

autoPrepare - Specifies whether to automatically update the DRAFT version of the agent after making changes to the agent. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-autoprepare

customerEncryptionKeyArn

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

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-customerencryptionkeyarn

customOrchestration

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

Contains custom orchestration configurations for the agent.

Parameters:

customOrchestration - Contains custom orchestration configurations for the agent. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-customorchestration

customOrchestration

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

Contains custom orchestration configurations for the agent.

Parameters:

customOrchestration - Contains custom orchestration configurations for the agent. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-customorchestration

description

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

The description of the agent.

Parameters:

description - The description of the agent. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-description

foundationModel

@Stability(Stable)
public CfnAgentPropsMixin.Builder foundationModel(String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-foundationmodel

guardrailConfiguration

@Stability(Stable)
public CfnAgentPropsMixin.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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-guardrailconfiguration

guardrailConfiguration

@Stability(Stable)
public CfnAgentPropsMixin.Builder guardrailConfiguration(CfnAgentPropsMixin.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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-guardrailconfiguration

idleSessionTtlInSeconds

@Stability(Stable)
public CfnAgentPropsMixin.Builder idleSessionTtlInSeconds(Number 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-idlesessionttlinseconds

instruction

@Stability(Stable)
public CfnAgentPropsMixin.Builder instruction(String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-instruction

knowledgeBases

@Stability(Stable)
public CfnAgentPropsMixin.Builder knowledgeBases(IResolvable 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-knowledgebases

knowledgeBases

@Stability(Stable)
public CfnAgentPropsMixin.Builder knowledgeBases(List<? extends Object> 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-knowledgebases

memoryConfiguration

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

Contains memory configuration for the agent.

Parameters:

memoryConfiguration - Contains memory configuration for the agent. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-memoryconfiguration

memoryConfiguration

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

Contains memory configuration for the agent.

Parameters:

memoryConfiguration - Contains memory configuration for the agent. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-memoryconfiguration

orchestrationType

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

Specifies the orchestration strategy for the agent.

Parameters:

orchestrationType - Specifies the orchestration strategy for the agent. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-orchestrationtype

promptOverrideConfiguration

@Stability(Stable)
public CfnAgentPropsMixin.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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-promptoverrideconfiguration

promptOverrideConfiguration

@Stability(Stable)
public CfnAgentPropsMixin.Builder promptOverrideConfiguration(CfnAgentPropsMixin.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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-promptoverrideconfiguration

skipResourceInUseCheckOnDelete

@Stability(Stable)
public CfnAgentPropsMixin.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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-skipresourceinusecheckondelete

skipResourceInUseCheckOnDelete

@Stability(Stable)
public CfnAgentPropsMixin.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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-skipresourceinusecheckondelete

tags

@Stability(Stable)
public CfnAgentPropsMixin.Builder tags(Map<String,String> 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

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-tags

testAliasTags

@Stability(Stable)
public CfnAgentPropsMixin.Builder testAliasTags(Map<String,String> 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

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-testaliastags

testAliasTags

@Stability(Stable)
public CfnAgentPropsMixin.Builder testAliasTags(IResolvable 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

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-testaliastags

build

@Stability(Stable)
public CfnAgentPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnAgentPropsMixin.