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

Class CfnAgentPropsMixin.AgentActionGroupProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAgentPropsMixin.AgentActionGroupProperty>

Enclosing interface:

CfnAgentPropsMixin.AgentActionGroupProperty

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

A builder for CfnAgentPropsMixin.AgentActionGroupProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnAgentPropsMixin.AgentActionGroupProperty.Builder	actionGroupExecutor(CfnAgentPropsMixin.ActionGroupExecutorProperty actionGroupExecutor)	Sets the value of CfnAgentPropsMixin.AgentActionGroupProperty.getActionGroupExecutor()
CfnAgentPropsMixin.AgentActionGroupProperty.Builder	actionGroupExecutor(IResolvable actionGroupExecutor)	Sets the value of CfnAgentPropsMixin.AgentActionGroupProperty.getActionGroupExecutor()
CfnAgentPropsMixin.AgentActionGroupProperty.Builder	actionGroupName(String actionGroupName)	Sets the value of CfnAgentPropsMixin.AgentActionGroupProperty.getActionGroupName()
CfnAgentPropsMixin.AgentActionGroupProperty.Builder	actionGroupState(String actionGroupState)	Sets the value of CfnAgentPropsMixin.AgentActionGroupProperty.getActionGroupState()
CfnAgentPropsMixin.AgentActionGroupProperty.Builder	apiSchema(CfnAgentPropsMixin.APISchemaProperty apiSchema)	Sets the value of CfnAgentPropsMixin.AgentActionGroupProperty.getApiSchema()
CfnAgentPropsMixin.AgentActionGroupProperty.Builder	apiSchema(IResolvable apiSchema)	Sets the value of CfnAgentPropsMixin.AgentActionGroupProperty.getApiSchema()
CfnAgentPropsMixin.AgentActionGroupProperty	build()	Builds the configured instance.
CfnAgentPropsMixin.AgentActionGroupProperty.Builder	description(String description)	Sets the value of CfnAgentPropsMixin.AgentActionGroupProperty.getDescription()
CfnAgentPropsMixin.AgentActionGroupProperty.Builder	functionSchema(CfnAgentPropsMixin.FunctionSchemaProperty functionSchema)	Sets the value of CfnAgentPropsMixin.AgentActionGroupProperty.getFunctionSchema()
CfnAgentPropsMixin.AgentActionGroupProperty.Builder	functionSchema(IResolvable functionSchema)	Sets the value of CfnAgentPropsMixin.AgentActionGroupProperty.getFunctionSchema()
CfnAgentPropsMixin.AgentActionGroupProperty.Builder	parentActionGroupSignature(String parentActionGroupSignature)	Sets the value of CfnAgentPropsMixin.AgentActionGroupProperty.getParentActionGroupSignature()
CfnAgentPropsMixin.AgentActionGroupProperty.Builder	skipResourceInUseCheckOnDelete(Boolean skipResourceInUseCheckOnDelete)	Sets the value of CfnAgentPropsMixin.AgentActionGroupProperty.getSkipResourceInUseCheckOnDelete()
CfnAgentPropsMixin.AgentActionGroupProperty.Builder	skipResourceInUseCheckOnDelete(IResolvable skipResourceInUseCheckOnDelete)	Sets the value of CfnAgentPropsMixin.AgentActionGroupProperty.getSkipResourceInUseCheckOnDelete()

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

actionGroupExecutor

@Stability(Stable)
public CfnAgentPropsMixin.AgentActionGroupProperty.Builder actionGroupExecutor(IResolvable actionGroupExecutor)

Sets the value of CfnAgentPropsMixin.AgentActionGroupProperty.getActionGroupExecutor()

Parameters:

actionGroupExecutor - The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.

Returns:

this

actionGroupExecutor

@Stability(Stable)
public CfnAgentPropsMixin.AgentActionGroupProperty.Builder actionGroupExecutor(CfnAgentPropsMixin.ActionGroupExecutorProperty actionGroupExecutor)

Sets the value of CfnAgentPropsMixin.AgentActionGroupProperty.getActionGroupExecutor()

Parameters:

actionGroupExecutor - The Amazon Resource Name (ARN) of the Lambda function containing the business logic that is carried out upon invoking the action or the custom control method for handling the information elicited from the user.

Returns:

this

actionGroupName

@Stability(Stable)
public CfnAgentPropsMixin.AgentActionGroupProperty.Builder actionGroupName(String actionGroupName)

Sets the value of CfnAgentPropsMixin.AgentActionGroupProperty.getActionGroupName()

Parameters:

actionGroupName - The name of the action group.

Returns:

this

actionGroupState

@Stability(Stable)
public CfnAgentPropsMixin.AgentActionGroupProperty.Builder actionGroupState(String actionGroupState)

Sets the value of CfnAgentPropsMixin.AgentActionGroupProperty.getActionGroupState()

Parameters:

actionGroupState - Specifies whether the action group is available for the agent to invoke or not when sending an InvokeAgent request.

Returns:

this

apiSchema

@Stability(Stable)
public CfnAgentPropsMixin.AgentActionGroupProperty.Builder apiSchema(IResolvable apiSchema)

Sets the value of CfnAgentPropsMixin.AgentActionGroupProperty.getApiSchema()

Parameters:

apiSchema - Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas .

Returns:

this

apiSchema

@Stability(Stable)
public CfnAgentPropsMixin.AgentActionGroupProperty.Builder apiSchema(CfnAgentPropsMixin.APISchemaProperty apiSchema)

Sets the value of CfnAgentPropsMixin.AgentActionGroupProperty.getApiSchema()

Parameters:

apiSchema - Contains either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see Action group OpenAPI schemas .

Returns:

this

description

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

Sets the value of CfnAgentPropsMixin.AgentActionGroupProperty.getDescription()

Parameters:

description - A description of the action group.

Returns:

this

functionSchema

@Stability(Stable)
public CfnAgentPropsMixin.AgentActionGroupProperty.Builder functionSchema(IResolvable functionSchema)

Sets the value of CfnAgentPropsMixin.AgentActionGroupProperty.getFunctionSchema()

Parameters:

functionSchema - Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

Returns:

this

functionSchema

@Stability(Stable)
public CfnAgentPropsMixin.AgentActionGroupProperty.Builder functionSchema(CfnAgentPropsMixin.FunctionSchemaProperty functionSchema)

Sets the value of CfnAgentPropsMixin.AgentActionGroupProperty.getFunctionSchema()

Parameters:

functionSchema - Contains details about the function schema for the action group or the JSON or YAML-formatted payload defining the schema.

Returns:

this

parentActionGroupSignature

@Stability(Stable)
public CfnAgentPropsMixin.AgentActionGroupProperty.Builder parentActionGroupSignature(String parentActionGroupSignature)

Sets the value of CfnAgentPropsMixin.AgentActionGroupProperty.getParentActionGroupSignature()

Parameters:

parentActionGroupSignature - If this field is set as AMAZON.UserInput , the agent can request the user for additional information when trying to complete a task. The description , apiSchema , and actionGroupExecutor fields must be blank for this action group. During orchestration, if the agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

Returns:

this

skipResourceInUseCheckOnDelete

@Stability(Stable)
public CfnAgentPropsMixin.AgentActionGroupProperty.Builder skipResourceInUseCheckOnDelete(Boolean skipResourceInUseCheckOnDelete)

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

Sets the value of CfnAgentPropsMixin.AgentActionGroupProperty.getSkipResourceInUseCheckOnDelete()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnAgentPropsMixin.AgentActionGroupProperty build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnAgentPropsMixin.AgentActionGroupProperty

Throws:

NullPointerException - if any required attribute was not provided