Package software.amazon.awscdk.services.bedrockagentcore

Class InlineApiSchema

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.bedrockagentcore.ApiSchema
software.amazon.awscdk.services.bedrockagentcore.InlineApiSchema
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.129.0 (build eaca441)", date="2026-05-19T08:18:44.450Z") @Stability(Stable) public class InlineApiSchema extends ApiSchema
Class to define an API Schema from an inline string.

The schema can be provided directly as a string. Validation is performed at the target configuration level where the schema type is known.

Example: 

 InlineApiSchema inlineSchema = ApiSchema.fromInline("\nopenapi: 3.0.3\ninfo:\n  title: Library API\n  version: 1.0.0\npaths:\n  /search:\n    get:\n      summary: Search for books\n      operationId: searchBooks\n      parameters:\n        - name: query\n          in: query\n          required: true\n          schema:\n            type: string\n");

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    InlineApiSchema(String schema)
     
    protected
    InlineApiSchema(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    InlineApiSchema(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    bind(software.constructs.Construct scope)
    Bind the schema to a construct.
    void
    grantPermissionsToRole(IRole _role)
    Grant permissions to the role.

    Methods inherited from class software.amazon.awscdk.services.bedrockagentcore.ApiSchema

    fromInline, fromLocalAsset, fromS3File, fromS3File, getBucketOwnerAccountId, getInlineSchema, getS3File

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • InlineApiSchema

      protected InlineApiSchema(software.amazon.jsii.JsiiObjectRef objRef)

    • InlineApiSchema

      protected InlineApiSchema(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • InlineApiSchema

      @Stability(Stable) public InlineApiSchema(@NotNull String schema)
      Parameters:
      schema - This parameter is required.

  • Method Details

    • bind

      @Stability(Stable) public void bind(@NotNull software.constructs.Construct scope)
      Bind the schema to a construct.

      Specified by:
      bind in class ApiSchema
      Parameters:
      scope - This parameter is required.

    • grantPermissionsToRole

      @Stability(Stable) public void grantPermissionsToRole(@NotNull IRole _role)
      Grant permissions to the role.

      Specified by:
      grantPermissionsToRole in class ApiSchema
      Parameters:
      _role - This parameter is required.