interface IGateway 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.IGateway
Go	github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#IGateway
Java	software.amazon.awscdk.services.bedrock.agentcore.alpha.IGateway
Python	aws_cdk.aws_bedrock_agentcore_alpha.IGateway
TypeScript (source)	@aws-cdk/aws-bedrock-agentcore-alpha » IGateway

Implemented by Gateway

Obtainable from Gateway.fromGatewayAttributes()

Interface for Gateway resources.

Properties

Name	Type	Description
authorizerConfiguration🔹	IGatewayAuthorizerConfig	The authorizer configuration for the gateway.
env🔹	ResourceEnvironment	The environment this resource belongs to.
gatewayArn🔹	string	The ARN of the gateway resource.
gatewayId🔹	string	The id of the gateway.
name🔹	string	The name of the gateway.
node🔹	Node	The tree node.
protocolConfiguration🔹	IGatewayProtocolConfig	The protocol configuration for the gateway.
role🔹	IRole	The IAM role that provides permissions for the gateway to access AWS services.
stack🔹	Stack	The stack in which this resource is defined.
createdAt?🔹	string	Timestamp when the gateway was created.
description?🔹	string	The description of the gateway.
exceptionLevel?🔹	GatewayExceptionLevel	The exception level for the gateway.
gatewayUrl?🔹	string	The URL endpoint for the gateway.
kmsKey?🔹	IKey	The KMS key used for encryption.
status?🔹	string	The status of the gateway.
statusReason?🔹	string[]	The status reasons for the gateway.
updatedAt?🔹	string	Timestamp when the gateway was last updated.

---

authorizerConfiguration🔹

Type: IGatewayAuthorizerConfig

The authorizer configuration for the gateway.

---

env🔹

Type: ResourceEnvironment

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.

---

gatewayArn🔹

Type: string

The ARN of the gateway resource.

---

gatewayId🔹

Type: string

The id of the gateway.

---

name🔹

Type: string

The name of the gateway.

---

node🔹

Type: Node

The tree node.

---

protocolConfiguration🔹

Type: IGatewayProtocolConfig

The protocol configuration for the gateway.

---

role🔹

Type: IRole

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

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

createdAt?🔹

Type: string (optional)

Timestamp when the gateway was created.

---

description?🔹

Type: string (optional)

The description of the gateway.

---

exceptionLevel?🔹

Type: GatewayExceptionLevel (optional)

The exception level for the gateway.

---

gatewayUrl?🔹

Type: string (optional)

The URL endpoint for the gateway.

---

kmsKey?🔹

Type: IKey (optional)

The KMS key used for encryption.

---

status?🔹

Type: string (optional)

The status of the gateway.

---

statusReason?🔹

Type: string[] (optional)

The status reasons for the gateway.

---

updatedAt?🔹

Type: string (optional)

Timestamp when the gateway was last updated.

Methods

Name	Description
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
grant(grantee, ...actions)🔹	Grants IAM actions to the IAM Principal.
grantInvoke(grantee)🔹	Grants permission to invoke this Gateway.
grantManage(grantee)🔹	Grants Create, Update, and Delete actions on the Gateway.
grantRead(grantee)🔹	Grants Get and List actions on the Gateway.
metric(metricName, dimensions, props?)🔹	Return the given named metric for this gateway.
metricDuration(props?)🔹	Return a metric measuring the duration of requests for this gateway.
metricInvocations(props?)🔹	Return a metric containing the total number of invocations for this gateway.
metricLatency(props?)🔹	Return a metric measuring the latency of requests for this gateway.
metricSystemErrors(props?)🔹	Return a metric containing the number of system errors (5xx status code) for this gateway.
metricTargetExecutionTime(props?)🔹	Return a metric measuring the target execution time for this gateway.
metricTargetType(targetType, props?)🔹	Return a metric containing the number of requests served by each target type for this gateway.
metricThrottles(props?)🔹	Return a metric containing the number of throttled requests (429 status code) for this gateway.
metricUserErrors(props?)🔹	Return a metric containing the number of user errors (4xx status code, excluding 429) for this gateway.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

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).

---

grant(grantee, ...actions)🔹

public grant(grantee: IGrantable, ...actions: string[]): Grant

Parameters

• grantee IGrantable
• actions string

Returns

• Grant

Grants IAM actions to the IAM Principal.

---

grantInvoke(grantee)🔹

public grantInvoke(grantee: IGrantable): Grant

Parameters

• grantee IGrantable

Returns

• Grant

Grants permission to invoke this Gateway.

---

grantManage(grantee)🔹

public grantManage(grantee: IGrantable): Grant

Parameters

• grantee IGrantable

Returns

• Grant

Grants Create, Update, and Delete actions on the Gateway.

---

grantRead(grantee)🔹

public grantRead(grantee: IGrantable): Grant

Parameters

• grantee IGrantable

Returns

• Grant

Grants Get and List actions on the Gateway.

---

metric(metricName, dimensions, props?)🔹

public metric(metricName: string, dimensions: { [string]: string }, props?: MetricOptions): Metric

Parameters

• metricName string — The name of the metric.
• dimensions { [string]: string } — Additional dimensions for the metric.
• props MetricOptions — Optional metric configuration.

Returns

• Metric

Return the given named metric for this gateway.

---

metricDuration(props?)🔹

public metricDuration(props?: MetricOptions): Metric

Parameters

• props MetricOptions — Optional metric configuration.

Returns

• 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?)🔹

public metricInvocations(props?: MetricOptions): Metric

Parameters

• props MetricOptions — Optional metric configuration.

Returns

• Metric

Return a metric containing the total number of invocations for this gateway.

This metric tracks all successful invocations of the gateway.

---

metricLatency(props?)🔹

public metricLatency(props?: MetricOptions): Metric

Parameters

• props MetricOptions — Optional metric configuration.

Returns

• 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?)🔹

public metricSystemErrors(props?: MetricOptions): Metric

Parameters

• props MetricOptions — Optional metric configuration.

Returns

• Metric

Return a metric containing the number of system errors (5xx status code) for this gateway.

This metric tracks internal server errors and system failures.

---

metricTargetExecutionTime(props?)🔹

public metricTargetExecutionTime(props?: MetricOptions): Metric

Parameters

• props MetricOptions — Optional metric configuration.

Returns

• 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, props?)🔹

public metricTargetType(targetType: string, props?: MetricOptions): Metric

Parameters

• targetType string — The type of target (e.g., 'Lambda', 'OpenAPI', 'Smithy').
• props MetricOptions — Optional metric configuration.

Returns

• Metric

Return a metric containing the number of requests served by each target type for this gateway.

---

metricThrottles(props?)🔹

public metricThrottles(props?: MetricOptions): Metric

Parameters

• props MetricOptions — Optional metric configuration.

Returns

• Metric

Return a metric containing the number of throttled requests (429 status code) for this gateway.

This metric helps identify when the gateway is rate limiting requests.

---

metricUserErrors(props?)🔹

public metricUserErrors(props?: MetricOptions): Metric

Parameters

• props MetricOptions — Optional metric configuration.

Returns

• Metric

Return a metric containing the number of user errors (4xx status code, excluding 429) for this gateway.

This metric tracks client errors like bad requests, unauthorized access, etc.