AWS::BedrockAgentCore::Gateway - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new 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

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 CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::BedrockAgentCore::Gateway",
  "Properties" : {
      "AuthorizerConfiguration" : AuthorizerConfiguration,
      "AuthorizerType" : String,
      "Description" : String,
      "ExceptionLevel" : String,
      "InterceptorConfigurations" : [ GatewayInterceptorConfiguration, ... ],
      "KmsKeyArn" : String,
      "Name" : String,
      "ProtocolConfiguration" : GatewayProtocolConfiguration,
      "ProtocolType" : String,
      "RoleArn" : String,
      "Tags" : {Key: Value, ...}
    }
}

Properties

AuthorizerConfiguration

Represents inbound authorization configuration options used to authenticate incoming requests.

Required: No

Type: AuthorizerConfiguration

Update requires: No interruption

AuthorizerType

The type of authorizer used by the gateway.

Required: Yes

Type: String

Allowed values: CUSTOM_JWT | AWS_IAM | NONE

Update requires: No interruption

Description

The description of 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

InterceptorConfigurations

A list of configuration settings for a gateway interceptor. Gateway interceptors allow custom code to be invoked during gateway invocations.

Required: No

Type: Array of GatewayInterceptorConfiguration

Minimum: 1

Maximum: 2

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 of 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 used by the gateway.

Required: Yes

Type: String

Allowed values: MCP

Update requires: No interruption

RoleArn

The ARN of the IAM role that provides permissions for the gateway to access AWS services.

Required: Yes

Type: String

Pattern: ^arn:aws(-[^:]+)?:iam::([0-9]{12})?:role/.+$

Minimum: 1

Maximum: 2048

Update requires: No interruption

Tags

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

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the gateway identifier. For example:

my-gateway-a1b2c3d4e5

For more information about using the Ref function, see 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.

CreatedAt

The date and time at which the target was created.

GatewayArn

The Amazon Resource Name (ARN) of the gateway target.

GatewayIdentifier

The unique identifier of the gateway.

GatewayUrl

The URL endpoint for the gateway.

Status

The status for the gateway.

StatusReasons

The status reasons for the target status.

UpdatedAt

The date and time at which the target was updated.