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.

FunctionParameter Class ​

Represents a function parameter 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 functionParameter = new bedrock_alpha.FunctionParameter({
  type: bedrock_alpha.ParameterType.STRING,

  // the properties below are optional
  description: 'description',
  required: false,
});
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_bedrock_alpha as bedrock_alpha

function_parameter = bedrock_alpha.FunctionParameter(
    type=bedrock_alpha.ParameterType.STRING,

    # the properties below are optional
    description="description",
    required=False
)
java
// 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.alpha.*;

FunctionParameter functionParameter = FunctionParameter.Builder.create()
        .type(ParameterType.STRING)

        // the properties below are optional
        .description("description")
        .required(false)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Bedrock.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Bedrock.Alpha;

var functionParameter = new FunctionParameter(new FunctionParameterProps {
    Type = ParameterType.STRING,

    // the properties below are optional
    Description = "description",
    Required = false
});
go
// Install: go get github.com/aws/aws-cdk-go/awsbedrockalpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awsbedrockalpha"

functionParameter := bedrock_alpha.NewFunctionParameter(&FunctionParameterProps{
	Type: bedrock_alpha.ParameterType_STRING,

	// the properties below are optional
	Description: jsii.String("description"),
	Required: jsii.Boolean(false),
})

Initializer ​

ts
new FunctionParameter(props: FunctionParameterProps)
python
FunctionParameter(props: FunctionParameterProps)
java
new FunctionParameter(FunctionParameterProps props)
csharp
new FunctionParameter(FunctionParameterProps props)
go
NewFunctionParameter(Props FunctionParameterProps)

Properties ​

descriptionmay be undefinedstringdescriptionmay be undefinedstrdescriptionmay be undefinedStringDescriptionmay be undefinedstringDescriptionmay be undefined*string#
Description of the parameter.

Default: undefined no description will be present

requiredbooleanrequiredboolrequiredBooleanRequiredboolRequired*bool#
Whether the parameter is required.
typeParameterTypetypeParameterTypetypeParameterTypeTypeParameterTypeTypeParameterType#
The type of the parameter.