Package software.amazon.awscdk.services.bedrock

Class CfnAgent.AgentActionGroupProperty.Builder

java.lang.Object

software.amazon.awscdk.services.bedrock.CfnAgent.AgentActionGroupProperty.Builder

All Implemented Interfaces:

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

Enclosing interface:

CfnAgent.AgentActionGroupProperty

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

A builder for CfnAgent.AgentActionGroupProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

actionGroupName

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

Sets the value of CfnAgent.AgentActionGroupProperty.getActionGroupName()

Parameters:

actionGroupName - The name of the action group. This parameter is required.

Returns:

this

actionGroupExecutor

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

Sets the value of CfnAgent.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 CfnAgent.AgentActionGroupProperty.Builder actionGroupExecutor(CfnAgent.ActionGroupExecutorProperty actionGroupExecutor)

Sets the value of CfnAgent.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

actionGroupState

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

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

Sets the value of CfnAgent.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 CfnAgent.AgentActionGroupProperty.Builder apiSchema(CfnAgent.APISchemaProperty apiSchema)

Sets the value of CfnAgent.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 CfnAgent.AgentActionGroupProperty.Builder description(String description)

Sets the value of CfnAgent.AgentActionGroupProperty.getDescription()

Parameters:

description - The description of the action group.

Returns:

this

functionSchema

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

Sets the value of CfnAgent.AgentActionGroupProperty.getFunctionSchema()

Parameters:

functionSchema - Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.

Returns:

this

functionSchema

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

Sets the value of CfnAgent.AgentActionGroupProperty.getFunctionSchema()

Parameters:

functionSchema - Defines functions that each define parameters that the agent needs to invoke from the user. Each function represents an action in an action group.

Returns:

this

parentActionGroupSignature

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

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

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

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnAgent.AgentActionGroupProperty

Throws:

NullPointerException - if any required attribute was not provided