Package software.amazon.awscdk.services.bedrock

Interface CfnAgent.FunctionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAgent.FunctionProperty.Jsii$Proxy

Enclosing class:

CfnAgent

@Stability(Stable)
public static interface CfnAgent.FunctionProperty
extends software.amazon.jsii.JsiiSerializable

Defines parameters that the agent needs to invoke from the user to complete the function.

Corresponds to an action in an action group.

This data type is used in the following API operations:

• CreateAgentActionGroup request
• CreateAgentActionGroup response
• UpdateAgentActionGroup request
• UpdateAgentActionGroup response
• GetAgentActionGroup response

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.bedrock.*;
 FunctionProperty functionProperty = FunctionProperty.builder()
         .name("name")
         // the properties below are optional
         .description("description")
         .parameters(Map.of(
                 "parametersKey", ParameterDetailProperty.builder()
                         .type("type")
                         // the properties below are optional
                         .description("description")
                         .required(false)
                         .build()))
         .requireConfirmation("requireConfirmation")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-function.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAgent.FunctionProperty.Builder	A builder for CfnAgent.FunctionProperty
static final class	CfnAgent.FunctionProperty.Jsii$Proxy	An implementation for CfnAgent.FunctionProperty

Method Summary

Modifier and Type	Method	Description
static CfnAgent.FunctionProperty.Builder	builder()
default String	getDescription()	A description of the function and its purpose.
String	getName()	A name for the function.
default Object	getParameters()	The parameters that the agent elicits from the user to fulfill the function.
default String	getRequireConfirmation()	Contains information if user confirmation is required to invoke the function.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

A name for the function.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-function.html#cfn-bedrock-agent-function-name

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the function and its purpose.

See Also:

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

getParameters

@Stability(Stable)
@Nullable
default Object getParameters()

The parameters that the agent elicits from the user to fulfill the function.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-function.html#cfn-bedrock-agent-function-parameters

getRequireConfirmation

@Stability(Stable)
@Nullable
default String getRequireConfirmation()

Contains information if user confirmation is required to invoke the function.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-function.html#cfn-bedrock-agent-function-requireconfirmation

builder

@Stability(Stable)
static CfnAgent.FunctionProperty.Builder builder()

Returns:

a CfnAgent.FunctionProperty.Builder of CfnAgent.FunctionProperty