AWS CDK Reference

Appearance

v2.275.0

Experimental

@aws-cdk/aws-bedrock-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

FunctionProps Struct ​

Properties for a function in a function schema.

Stability
Experimental
Source
bedrock/agents/function-schema.ts

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_alpha from '@aws-cdk/aws-bedrock-alpha';
const functionProps: bedrock_alpha.FunctionProps = {
  description: 'description',
  name: 'name',

  // the properties below are optional
  parameters: {
    parametersKey: {
      type: bedrock_alpha.ParameterType.STRING,

      // the properties below are optional
      description: 'description',
      required: false,
    },
  },
  requireConfirmation: bedrock_alpha.RequireConfirmation.ENABLED,
};

Properties ​

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*stringrequired#
Description of the function.
namestringnamestrnameStringNamestringName*stringrequired#
The name of the function.
parametersoptional{ [key: string]: FunctionParameterProps }parametersoptionaltyping.Mapping[str, FunctionParameterProps]parametersoptionalMap<String, FunctionParameterProps>ParametersoptionalIDictionary<string, FunctionParameterProps>Parametersoptional*map[string]FunctionParameterProps= {}#
Parameters for the function as a record of parameter name to parameter properties.
requireConfirmationoptionalRequireConfirmationrequire_confirmationoptionalRequireConfirmationrequireConfirmationoptionalRequireConfirmationRequireConfirmationoptionalRequireConfirmationRequireConfirmationoptionalRequireConfirmation= RequireConfirmation.DISABLED#
Whether to require confirmation before executing the function.