> **Experimental**
>
> `@aws-cdk/aws-bedrock-agentcore-alpha` is an [**experimental**](/stability) (alpha) package: its API may change in any release, without a major version bump.
# Gateway

Gateway resource for AWS Bedrock Agent Core.

Serves as an integration point between your agent and external services.

Extends: Construct › Resource › GatewayBase › Gateway
Implements: IGateway, IResource, IEnvironmentAware, IGatewayRef, IConstruct, IDependable

- Stability: [Experimental](/cdk/api/stability.html)
- CloudFormation: [`AWS::BedrockAgentCore::Gateway`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-bedrockagentcore-gateway.html)
- L1 type: [`CfnGateway`](/cdk/api/v2/docs/aws-cdk-lib.aws_bedrockagentcore.CfnGateway.html)
- Source: [`lib/gateway/gateway.ts`](https://github.com/aws/aws-cdk/blob/v2.277.0-alpha.0/packages/@aws-cdk/aws-bedrock-agentcore-alpha/lib/gateway/gateway.ts#L405)

## Example

```ts

// Create a Policy engine
const policyEngine = new agentcore.PolicyEngine(this, "MyPolicyEngine", {
  policyEngineName: "my_policy_engine",
  description: "Policy engine for access control",
});

const gateway = new agentcore.Gateway(this, "MyGateway", {
  gatewayName: "my-gateway",
  policyEngineConfiguration: {
    policyEngine: policyEngine,
    mode: agentcore.PolicyEngineMode.ENFORCE, // Default is LOG_ONLY
  },
});

// Add policy to policy engine
policyEngine.addPolicy("AllowAllActions", {
  definition: `
    permit(
      principal,
      action,
      resource == AgentCore::Gateway::"${gateway.gatewayArn}"
    );
  `,
  description: "Allow all actions on specific gateway (development)",
  validationMode: agentcore.PolicyValidationMode.IGNORE_ALL_FINDINGS, // This will ignore all cedar warnings
});

// you can add multiple policies to the policy engine
policyEngine.addPolicy("SpecificToolPolicy", {
  definition: `
    permit(
      principal is AgentCore::OAuthUser,
      action == AgentCore::Action::"WeatherTool__get_forecast",
      resource == AgentCore::Gateway::"${gateway.gatewayArn}"
    );
  `,
  description: "Allow specific weather tool access",
  validationMode: agentcore.PolicyValidationMode.FAIL_ON_ANY_FINDINGS, // This will fail policy creation for any cedar warning
});
```

## Initializer

```ts
new Gateway(scope: Construct, id: string, props?: GatewayProps)
```

## Construct Props

- `authorizerConfiguration`: [IGatewayAuthorizerConfig](/cdk/api/v2/docs/@aws-cdk_aws-bedrock-agentcore-alpha.IGatewayAuthorizerConfig.html) — The authorizer configuration for the gateway.

  **Default:** A default authorizer will be created using Cognito

- `description`: string — Optional description for the gateway Valid characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and spaces The description can have up to 200 characters.

  **Default:** No description

- `exceptionLevel`: [GatewayExceptionLevel](/cdk/api/v2/docs/@aws-cdk_aws-bedrock-agentcore-alpha.GatewayExceptionLevel.html) — The verbosity of exception messages Use DEBUG mode to see granular exception messages from a Gateway.

  **Default:** Exception messages are sanitized for presentation to end users

- `gatewayName`: string — The name of the gateway Valid characters are a-z, A-Z, 0-9, _ (underscore) and - (hyphen) The name must be unique within your account.

  **Default:** auto generate

- `interceptorConfigurations`: [IInterceptor](/cdk/api/v2/docs/@aws-cdk_aws-bedrock-agentcore-alpha.IInterceptor.html)[] — Interceptor configurations for the gateway.

  **Default:** No interceptors

  Interceptors allow you to run custom code during each gateway invocation:
  - REQUEST interceptors execute before the gateway calls the target
  - RESPONSE interceptors execute after the target responds

  A gateway can have at most one REQUEST interceptor and one RESPONSE interceptor.

- `kmsKey`: [IKey](/cdk/api/v2/docs/aws-cdk-lib.aws_kms.IKey.html) — The AWS KMS key used to encrypt data associated with the gateway.

  **Default:** No encryption

- `policyEngineConfiguration`: [GatewayPolicyEngineConfig](/cdk/api/v2/docs/@aws-cdk_aws-bedrock-agentcore-alpha.GatewayPolicyEngineConfig.html) — The policy engine configuration for this gateway.

  **Default:** No policy engine (requests are not subject to Cedar policy authorization)

  When provided, the specified policy engine will be associated with this gateway.
  All agent requests through this gateway will be evaluated against the Cedar policies
  defined in the policy engine.

- `protocolConfiguration`: [IGatewayProtocolConfig](/cdk/api/v2/docs/@aws-cdk_aws-bedrock-agentcore-alpha.IGatewayProtocolConfig.html) — The protocol configuration for the gateway.

  **Default:** A default protocol configuration will be created using MCP with following params supportedVersions: [MCPProtocolVersion.MCP_2025_03_26], searchType: McpGatewaySearchType.SEMANTIC, instructions: "Default gateway to connect to external MCP tools",

- `role`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) — The IAM role that provides permissions for the gateway to access AWS services.

  **Default:** A new role will be created

- `tags`: { [key: string]: string } — Tags for the gateway A list of key:value pairs of tags to apply to this Gateway resource.

  **Default:** No tags

## Properties

- `authorizerConfiguration`: [IGatewayAuthorizerConfig](/cdk/api/v2/docs/@aws-cdk_aws-bedrock-agentcore-alpha.IGatewayAuthorizerConfig.html) — The authorizer configuration for the gateway.

- `createdAt`: string — Timestamp when the gateway was created.

- `description`: string — The description of the gateway.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `exceptionLevel`: [GatewayExceptionLevel](/cdk/api/v2/docs/@aws-cdk_aws-bedrock-agentcore-alpha.GatewayExceptionLevel.html) — The exception level for the gateway.

- `gatewayArn`: string — The ARN of the gateway.

- `gatewayId`: string — The unique identifier of the gateway.

- `gatewayRef`: [GatewayReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_bedrockagentcore.GatewayReference.html) — A reference to a Gateway resource.

- `gatewayUrl`: string — The URL endpoint for the gateway.

- `kmsKey`: [IKey](/cdk/api/v2/docs/aws-cdk-lib.aws_kms.IKey.html) — The KMS key used for encryption.

- `name`: string — The name of the gateway.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `oauthScopes`: string[] — The OAuth2 scope strings for client credentials flow.

  Only available when using the default Cognito authorizer.

- `policyEngineConfiguration`: [GatewayPolicyEngineConfig](/cdk/api/v2/docs/@aws-cdk_aws-bedrock-agentcore-alpha.GatewayPolicyEngineConfig.html) — The policy engine configuration associated with this gateway.

- `PROPERTY_INJECTION_ID`: string (static) — Uniquely identifies this class.

- `protocolConfiguration`: [IGatewayProtocolConfig](/cdk/api/v2/docs/@aws-cdk_aws-bedrock-agentcore-alpha.IGatewayProtocolConfig.html) — The protocol configuration for the gateway.

- `resourceServer`: [IUserPoolResourceServer](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.IUserPoolResourceServer.html) — The Cognito Resource Server created for the gateway (if using default Cognito authorizer).

- `role`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) — The IAM role for the gateway.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this resource is defined.

- `status`: string — The status of the gateway.

- `statusReason`: string[] — The status reasons for the gateway.

- `tags`: { [key: string]: string } — Tags applied to the gateway.

- `tokenEndpointUrl`: string — The OAuth2 token endpoint URL for client credentials flow.

  Only available when using the default Cognito authorizer.

- `updatedAt`: string — Timestamp when the gateway was last updated.

- `userPool`: [IUserPool](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.IUserPool.html) — The Cognito User Pool created for the gateway (if using default Cognito authorizer).

- `userPoolClient`: [IUserPoolClient](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.IUserPoolClient.html) — The Cognito User Pool Client created for the gateway (if using default Cognito authorizer).

- `userPoolDomain`: [IUserPoolDomain](/cdk/api/v2/docs/aws-cdk-lib.aws_cognito.IUserPoolDomain.html) — The Cognito User Pool Domain created for the gateway (if using default Cognito authorizer).

## Methods

- `addApiGatewayTarget(id: string, props: AddApiGatewayTargetOptions): GatewayTarget` — Add an API Gateway target to this gateway This is a convenience method that creates a GatewayTarget associated with this gateway.

  **Parameters**

  - `id` — The construct id for the target.
  - `props` — Properties for the API Gateway target.

  **Returns:** The created GatewayTarget

- `addInterceptor(interceptor: IInterceptor): void` — Add an interceptor to this gateway.

  Interceptors allow you to run custom code at specific points in the gateway request/response flow:
  - REQUEST interceptors execute before the gateway calls the target
  - RESPONSE interceptors execute after the target responds

  A gateway can have at most one REQUEST interceptor and one RESPONSE interceptor.

  **Parameters**

  - `interceptor` — The interceptor to add (use LambdaInterceptor factory methods).

- `addLambdaTarget(id: string, props: AddLambdaTargetOptions): GatewayTarget` — Add a Lambda target to this gateway This is a convenience method that creates a GatewayTarget associated with this gateway.

  **Parameters**

  - `id` — The construct id for the target.
  - `props` — Properties for the Lambda target.

  **Returns:** The created GatewayTarget

- `addMcpServerTarget(id: string, props: AddMcpServerTargetOptions): GatewayTarget` — Add an MCP server target to this gateway This is a convenience method that creates a GatewayTarget associated with this gateway.

  **Parameters**

  - `id` — The construct id for the target.
  - `props` — Properties for the MCP server target.

  **Returns:** The created GatewayTarget

- `addOpenApiTarget(id: string, props: AddOpenApiTargetOptions): GatewayTarget` — Add an OpenAPI target to this gateway This is a convenience method that creates a GatewayTarget associated with this gateway.

  **Parameters**

  - `id` — The construct id for the target.
  - `props` — Properties for the OpenAPI target.

  **Returns:** The created GatewayTarget

- `addSmithyTarget(id: string, props: AddSmithyTargetOptions): GatewayTarget` — Add a Smithy target to this gateway This is a convenience method that creates a GatewayTarget associated with this gateway.

  **Parameters**

  - `id` — The construct id for the target.
  - `props` — Properties for the Smithy target.

  **Returns:** The created GatewayTarget

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

- `fromGatewayAttributes(scope: Construct, id: string, attrs: GatewayAttributes): IGateway` (static) — Import an existing Gateway using its attributes.

  **Parameters**

  - `scope` — The construct scope.
  - `id` — The construct id.
  - `attrs` — The attributes of the existing Gateway.

  **Returns:** An IGateway instance representing the imported gateway

- `grant(grantee: IGrantable, ...actions: string[]): Grant` — Grants IAM actions to the IAM Principal.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — The principal to grant permissions to.
  - `actions` — The actions to grant.

- `grantInvoke(grantee: IGrantable): Grant` — Grants permission to invoke this Gateway.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — The principal to grant invoke permissions to.

- `grantManage(grantee: IGrantable): Grant` — Grants `Create`, `Update`, and `Delete` actions on the Gateway.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — The principal to grant manage permissions to.

- `grantRead(grantee: IGrantable): Grant` — Grants `Get` and `List` actions on the Gateway.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — The principal to grant read permissions to.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `metric(metricName: string, dimensions: { [key: string]: string }, props?: MetricOptions): Metric` — Return the given named metric for this gateway.

  By default, the metric will be calculated as a sum over a period of 5 minutes.
  You can customize this by using the `statistic` and `period` properties.

  **Parameters**

  - `metricName` — The name of the metric.
  - `dimensions` — Additional dimensions for the metric.
  - `props` — Optional metric configuration.

- `metricDuration(props?: MetricOptions): Metric` — Return a metric measuring the duration of requests for this gateway.

  The duration metric represents the total time elapsed between receiving the request
  and sending the final response token, representing complete end-to-end processing time.

- `metricInvocations(props?: MetricOptions): Metric` — Return a metric containing the total number of invocations for this gateway.

- `metricLatency(props?: MetricOptions): Metric` — Return a metric measuring the latency of requests for this gateway.

  The latency metric represents the time elapsed between when the service receives
  the request and when it begins sending the first response token.

- `metricSystemErrors(props?: MetricOptions): Metric` — Return a metric containing the number of system errors (5xx status code) for this gateway.

- `metricTargetExecutionTime(props?: MetricOptions): Metric` — Return a metric measuring the target execution time for this gateway.

  This metric helps determine the contribution of the target (Lambda, OpenAPI, etc.)
  to the total latency.

- `metricTargetType(targetType: string, props?: MetricOptions): Metric` — Return a metric containing the number of requests served by each target type for this gateway.

- `metricThrottles(props?: MetricOptions): Metric` — Return a metric containing the number of throttled requests (429 status code) for this gateway.

- `metricUserErrors(props?: MetricOptions): Metric` — Return a metric containing the number of user errors (4xx status code, excluding 429) for this gateway.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.
