interface SchemaDefinitionProperty

Language	Type name
.NET	Amazon.CDK.AWS.BedrockAgentCore.CfnGatewayTarget.SchemaDefinitionProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbedrockagentcore#CfnGatewayTarget_SchemaDefinitionProperty
Java	software.amazon.awscdk.services.bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty
Python	aws_cdk.aws_bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty
TypeScript	aws-cdk-lib » aws_bedrockagentcore » CfnGatewayTarget » SchemaDefinitionProperty

The schema definition for the gateway target.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html

Example

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

declare const schemaDefinitionProperty_: bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty;
const schemaDefinitionProperty: bedrockagentcore.CfnGatewayTarget.SchemaDefinitionProperty = {
  type: 'type',

  // the properties below are optional
  description: 'description',
  items: schemaDefinitionProperty_,
  properties: {
    propertiesKey: schemaDefinitionProperty_,
  },
  required: ['required'],
};

Properties

Name	Type	Description
type	string	The scheme definition type for the gateway target.
description?	string	The workload identity details for the gateway.
items?	IResolvable | SchemaDefinitionProperty
properties?	IResolvable | { [string]: IResolvable | SchemaDefinitionProperty }	The schema definition properties for the gateway target.
required?	string[]	The schema definition.

---

type

Type: string

The scheme definition type for the gateway target.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-type

---

description?

Type: string (optional)

The workload identity details for the gateway.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-description

---

items?

Type: IResolvable | SchemaDefinitionProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-items

---

properties?

Type: IResolvable | { [string]: IResolvable | SchemaDefinitionProperty } (optional)

The schema definition properties for the gateway target.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-properties

---

required?

Type: string[] (optional)

The schema definition.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-gatewaytarget-schemadefinition.html#cfn-bedrockagentcore-gatewaytarget-schemadefinition-required