# ToolSpecificationProperty

The specification for the tool.

For more information, see [Call a tool with the Converse API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide.

- Source: Generated at build time
- Type last changed: v2.177.0 · 25 Jan 2025

## Example

TypeScript:

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrock as bedrock } from 'aws-cdk-lib';

declare const json: any;
const toolSpecificationProperty: bedrock.CfnPromptVersion.ToolSpecificationProperty = {
  inputSchema: {
    json: json,
  },
  name: 'name',

  // the properties below are optional
  description: 'description',
};
```

Python:

```python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrock as bedrock

# json: Any

tool_specification_property = bedrock.CfnPromptVersion.ToolSpecificationProperty(
    input_schema=bedrock.CfnPromptVersion.ToolInputSchemaProperty(
        json=json
    ),
    name="name",

    # the properties below are optional
    description="description"
)
```

Java:

```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.*;

Object json;

ToolSpecificationProperty toolSpecificationProperty = ToolSpecificationProperty.builder()
        .inputSchema(ToolInputSchemaProperty.builder()
                .json(json)
                .build())
        .name("name")

        // the properties below are optional
        .description("description")
        .build();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Bedrock;

var json;

var toolSpecificationProperty = new ToolSpecificationProperty {
    InputSchema = new ToolInputSchemaProperty {
        Json = json
    },
    Name = "name",

    // the properties below are optional
    Description = "description"
};
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/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/awscdk"

var json interface{}

toolSpecificationProperty := &ToolSpecificationProperty{
	InputSchema: &ToolInputSchemaProperty{
		Json: json,
	},
	Name: jsii.String("name"),

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

## Properties

- `description`: string — The description for the tool.

- `inputSchema`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnPromptVersion.ToolInputSchemaProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_bedrock.CfnPromptVersion.ToolInputSchemaProperty.html) (required) — The input schema for the tool in JSON format.

- `name`: string (required) — The name for the tool.
