AWS::BedrockAgentCore::RuntimeEndpoint - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::BedrockAgentCore::RuntimeEndpoint

Note

Amazon Bedrock AgentCore is in preview release and is subject to change.

AgentCore Runtime is a secure, serverless runtime purpose-built for deploying and scaling dynamic AI agents and tools using any open-source framework including LangGraph, CrewAI, and Strands Agents, any protocol, and any model.

For more information about using agent runtime endpoints in Amazon Bedrock AgentCore, see AgentCore Runtime versioning and endpoints.

See the Properties section below for descriptions of both the required and optional properties.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::BedrockAgentCore::RuntimeEndpoint",
  "Properties" : {
      "AgentRuntimeId" : String,
      "AgentRuntimeVersion" : String,
      "Description" : String,
      "Name" : String,
      "Tags" : {Key: Value, ...}
    }
}

YAML

Type: AWS::BedrockAgentCore::RuntimeEndpoint
Properties:
  AgentRuntimeId: String
  AgentRuntimeVersion: String
  Description: String
  Name: String
  Tags: 
    Key: Value

Properties

AgentRuntimeId

The agent runtime ID.

Required: Yes

Type: String

Pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,99}-[a-zA-Z0-9]{10}$

Update requires: Replacement

AgentRuntimeVersion

The version of the agent.

Required: No

Type: String

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

Update requires: Replacement

Description

Contains information about an agent runtime endpoint. An agent runtime is the execution environment for a Amazon Bedrock Agent.

Required: No

Type: String

Minimum: 1

Maximum: 256

Update requires: No interruption

Name

The name of the AgentCore Runtime endpoint.

Required: Yes

Type: String

Pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,47}$

Minimum: 1

Maximum: 48

Update requires: Replacement

Tags

The tags for the AgentCore Runtime endpoint.

Required: No

Type: Object of String

Pattern: ^[a-zA-Z0-9\s._:/=+@-]*$

Minimum: 0

Maximum: 256

Update requires: No interruption

Return values

Ref

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

AgentRuntimeArn

The Amazon Resource Name (ARN) of the runtime agent.

AgentRuntimeEndpointArn

The endpoint Amazon Resource Name (ARN).

CreatedAt

The time at which the endpoint was created.

FailureReason

The reason for failure if the memory is in a failed state.

Id

The ID of the runtime endpoint.

LastUpdatedAt

The time at which the endpoint was last updated.

LiveVersion

The live version for the runtime endpoint.

Status

The status of the runtime endpoint.

TargetVersion

The target version.