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::Gateway
Note
Amazon Bedrock AgentCore is in preview release and is subject to change.
Amazon Bedrock AgentCore Gateway provides a unified connectivity layer between agents and the tools and resources they need to interact with.
For more information about creating a gateway, see Set up an Amazon Bedrock AgentCore gateway.
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::Gateway", "Properties" : { "AuthorizerConfiguration" :
AuthorizerConfiguration
, "AuthorizerType" :String
, "Description" :String
, "ExceptionLevel" :String
, "KmsKeyArn" :String
, "Name" :String
, "ProtocolConfiguration" :GatewayProtocolConfiguration
, "ProtocolType" :String
, "RoleArn" :String
, "Tags" :{
} }Key
:Value
, ...}
YAML
Type: AWS::BedrockAgentCore::Gateway Properties: AuthorizerConfiguration:
AuthorizerConfiguration
AuthorizerType:String
Description:String
ExceptionLevel:String
KmsKeyArn:String
Name:String
ProtocolConfiguration:GatewayProtocolConfiguration
ProtocolType:String
RoleArn:String
Tags:
Key
:Value
Properties
Property description not available.
Required: No
Type: AuthorizerConfiguration
Update requires: No interruption
-
The authorizer type for the gateway.
Required: Yes
Type: String
Allowed values:
CUSTOM_JWT | AWS_IAM
Update requires: No interruption
Description
-
The description for the gateway.
Required: No
Type: String
Minimum:
1
Maximum:
200
Update requires: No interruption
ExceptionLevel
-
The exception level for the gateway.
Required: No
Type: String
Allowed values:
DEBUG
Update requires: No interruption
KmsKeyArn
-
The KMS key ARN for the gateway.
Required: No
Type: String
Pattern:
^arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}$
Minimum:
1
Maximum:
2048
Update requires: No interruption
Name
-
The name for the gateway.
Required: Yes
Type: String
Pattern:
^([0-9a-zA-Z][-]?){1,100}$
Update requires: No interruption
ProtocolConfiguration
-
The protocol configuration for the gateway target.
Required: No
Type: GatewayProtocolConfiguration
Update requires: No interruption
ProtocolType
-
The protocol type for the gateway target.
Required: Yes
Type: String
Allowed values:
MCP
Update requires: No interruption
RoleArn
Property description not available.
Required: Yes
Type: String
Pattern:
^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$
Minimum:
1
Maximum:
2048
Update requires: No interruption
-
The tags for the gateway.
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
CreatedAt
-
The date and time at which the gateway was created.
GatewayArn
-
The ARN for the gateway.
GatewayIdentifier
Property description not available.
GatewayUrl
-
The gateway URL for the gateway.
Status
-
The status for the gateway.
StatusReasons
-
The status reasons for the gateway.
UpdatedAt
Property description not available.