Package software.amazon.awscdk.services.bedrock

Interface CfnAgent.ParameterDetailProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAgent.ParameterDetailProperty.Jsii$Proxy

Enclosing class:

CfnAgent

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

Contains details about a parameter in a function for an action group.

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.*;
 ParameterDetailProperty parameterDetailProperty = ParameterDetailProperty.builder()
         .type("type")
         // the properties below are optional
         .description("description")
         .required(false)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAgent.ParameterDetailProperty.Builder	builder()
default String	getDescription()	A description of the parameter.
default Object	getRequired()	Whether the parameter is required for the agent to complete the function for action group invocation.
String	getType()	The data type of the parameter.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Stable)
@NotNull
String getType()

The data type of the parameter.

See Also:

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

getDescription

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

A description of the parameter.

Helps the foundation model determine how to elicit the parameters from the user.

See Also:

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

getRequired

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

Whether the parameter is required for the agent to complete the function for action group invocation.

Returns union: either Boolean or IResolvable

See Also:

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

builder

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

Returns:

a CfnAgent.ParameterDetailProperty.Builder of CfnAgent.ParameterDetailProperty