Interface RuntimeEndpointProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
RuntimeEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.129.0 (build eaca441)", date="2026-05-19T08:18:44.501Z") @Stability(Stable) public interface RuntimeEndpointProps extends software.amazon.jsii.JsiiSerializable
Properties for creating a Bedrock Agent Core Runtime Endpoint resource.

Example:

 // Reference an existing runtime by its ID
 String existingRuntimeId = "abc123-runtime-id"; // The ID of an existing runtime
 // Create a standalone endpoint
 RuntimeEndpoint endpoint = RuntimeEndpoint.Builder.create(this, "MyEndpoint")
         .endpointName("production")
         .agentRuntimeId(existingRuntimeId)
         .agentRuntimeVersion("1") // Specify which version to use
         .description("Production endpoint for existing runtime")
         .build();
 
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    A builder for RuntimeEndpointProps
    static final class 
    An implementation for RuntimeEndpointProps
  • Method Summary

    Modifier and Type
    Method
    Description
     
    The ID of the agent runtime to associate with this endpoint This is the unique identifier of the runtime resource Pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,99}-[a-zA-Z0-9]{10}$.
    default String
    The version of the agent runtime to use for this endpoint If not specified, the endpoint will point to version "1" of the runtime.
    default String
    Optional description for the agent runtime endpoint Length Minimum: 1 , Maximum: 256.
    default String
    The name of the agent runtime endpoint Valid characters are a-z, A-Z, 0-9, _ (underscore) Must start with a letter and can be up to 48 characters long Pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,47}$.
    default Map<String,String>
    Tags for the agent runtime endpoint A list of key:value pairs of tags to apply to this RuntimeEndpoint resource Pattern: ^[a-zA-Z0-9\s._:/=+@-]*$.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson
  • Method Details

    • getAgentRuntimeId

      @Stability(Stable) @NotNull String getAgentRuntimeId()
      The ID of the agent runtime to associate with this endpoint This is the unique identifier of the runtime resource Pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,99}-[a-zA-Z0-9]{10}$.
    • getAgentRuntimeVersion

      @Stability(Stable) @Nullable default String getAgentRuntimeVersion()
      The version of the agent runtime to use for this endpoint If not specified, the endpoint will point to version "1" of the runtime.

      Pattern: ^([1-9][0-9]{0,4})$

      Default: "1"

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      Optional description for the agent runtime endpoint Length Minimum: 1 , Maximum: 256.

      Default: - No description

    • getEndpointName

      @Stability(Stable) @Nullable default String getEndpointName()
      The name of the agent runtime endpoint Valid characters are a-z, A-Z, 0-9, _ (underscore) Must start with a letter and can be up to 48 characters long Pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,47}$.

      Default: - auto generate

    • getTags

      @Stability(Stable) @Nullable default Map<String,String> getTags()
      Tags for the agent runtime endpoint A list of key:value pairs of tags to apply to this RuntimeEndpoint resource Pattern: ^[a-zA-Z0-9\s._:/=+@-]*$.

      Default: {} - no tags

    • builder

      @Stability(Stable) static RuntimeEndpointProps.Builder builder()
      Returns:
      a RuntimeEndpointProps.Builder of RuntimeEndpointProps