Class CfnAgent.APISchemaProperty

Contains details about the OpenAPI schema for the action group.

Inheritance

object

CfnAgent.APISchemaProperty

Implements

CfnAgent.IAPISchemaProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Bedrock

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnAgent.APISchemaProperty : CfnAgent.IAPISchemaProperty

Syntax (vb)

Public Class CfnAgent.APISchemaProperty Implements CfnAgent.IAPISchemaProperty

Remarks

For more information, see Action group OpenAPI schemas . You can either include the schema directly in the payload field or you can upload it to an S3 bucket and specify the S3 bucket location in the s3 field.

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

ExampleMetadata: fixture=_generated

Examples

// 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 aPISchemaProperty = new APISchemaProperty {
                 Payload = "payload",
                 S3 = new S3IdentifierProperty {
                     S3BucketName = "s3BucketName",
                     S3ObjectKey = "s3ObjectKey"
                 }
             };

Synopsis

Constructors

APISchemaProperty()

Contains details about the OpenAPI schema for the action group.

Properties

Payload	The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.
S3	Contains details about the S3 object containing the OpenAPI schema for the action group.

Constructors

APISchemaProperty()

Contains details about the OpenAPI schema for the action group.

public APISchemaProperty()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// 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 aPISchemaProperty = new APISchemaProperty {
                 Payload = "payload",
                 S3 = new S3IdentifierProperty {
                     S3BucketName = "s3BucketName",
                     S3ObjectKey = "s3ObjectKey"
                 }
             };

Properties

Payload

The JSON or YAML-formatted payload defining the OpenAPI schema for the action group.

public string? Payload { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-apischema.html#cfn-bedrock-agent-apischema-payload

S3

Contains details about the S3 object containing the OpenAPI schema for the action group.

public object? S3 { get; set; }