Package software.amazon.awscdk.services.bedrock.agentcore.alpha

Interface IGateway

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IGatewayRef, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IGateway.Jsii$Default

All Known Implementing Classes:

Gateway, GatewayBase, IGateway.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-10T17:52:15.901Z")
@Stability(Deprecated)
@Deprecated
public interface IGateway
extends software.amazon.jsii.JsiiSerializable, IResource, IGatewayRef

Deprecated.

Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

(deprecated) Interface for Gateway resources.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IGateway.Jsii$Default	Deprecated. Internal default implementation for IGateway.
static final class	IGateway.Jsii$Proxy	Deprecated. A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
IGatewayAuthorizerConfig	getAuthorizerConfiguration()	Deprecated.
default String	getCreatedAt()	Deprecated.
default String	getDescription()	Deprecated.
default GatewayExceptionLevel	getExceptionLevel()	Deprecated.
String	getGatewayArn()	Deprecated.
String	getGatewayId()	Deprecated.
default String	getGatewayUrl()	Deprecated.
default IKey	getKmsKey()	Deprecated.
String	getName()	Deprecated.
IGatewayProtocolConfig	getProtocolConfiguration()	Deprecated.
IRole	getRole()	Deprecated.
default String	getStatus()	Deprecated.
default List<String>	getStatusReason()	Deprecated.
default String	getUpdatedAt()	Deprecated.
Grant	grant(IGrantable grantee, String... actions)	Deprecated.
Grant	grantInvoke(IGrantable grantee)	Deprecated.
Grant	grantManage(IGrantable grantee)	Deprecated.
Grant	grantRead(IGrantable grantee)	Deprecated.
Metric	metric(String metricName, Map<String,String> dimensions)	Deprecated.
Metric	metric(String metricName, Map<String,String> dimensions, MetricOptions props)	Deprecated.
Metric	metricDuration()	Deprecated.
Metric	metricDuration(MetricOptions props)	Deprecated.
Metric	metricInvocations()	Deprecated.
Metric	metricInvocations(MetricOptions props)	Deprecated.
Metric	metricLatency()	Deprecated.
Metric	metricLatency(MetricOptions props)	Deprecated.
Metric	metricSystemErrors()	Deprecated.
Metric	metricSystemErrors(MetricOptions props)	Deprecated.
Metric	metricTargetExecutionTime()	Deprecated.
Metric	metricTargetExecutionTime(MetricOptions props)	Deprecated.
Metric	metricTargetType(String targetType)	Deprecated.
Metric	metricTargetType(String targetType, MetricOptions props)	Deprecated.
Metric	metricThrottles()	Deprecated.
Metric	metricThrottles(MetricOptions props)	Deprecated.
Metric	metricUserErrors()	Deprecated.
Metric	metricUserErrors(MetricOptions props)	Deprecated.

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.interfaces.bedrockagentcore.IGatewayRef

getGatewayRef

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthorizerConfiguration

@Stability(Deprecated)
@Deprecated
@NotNull
IGatewayAuthorizerConfig getAuthorizerConfiguration()

Deprecated.

(deprecated) The authorizer configuration for the gateway.

getGatewayArn

@Stability(Deprecated)
@Deprecated
@NotNull
String getGatewayArn()

Deprecated.

(deprecated) The ARN of the gateway resource.

getGatewayId

@Stability(Deprecated)
@Deprecated
@NotNull
String getGatewayId()

Deprecated.

(deprecated) The id of the gateway.

getName

@Stability(Deprecated)
@Deprecated
@NotNull
String getName()

Deprecated.

(deprecated) The name of the gateway.

getProtocolConfiguration

@Stability(Deprecated)
@Deprecated
@NotNull
IGatewayProtocolConfig getProtocolConfiguration()

Deprecated.

(deprecated) The protocol configuration for the gateway.

getRole

@Stability(Deprecated)
@Deprecated
@NotNull
IRole getRole()

Deprecated.

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

getCreatedAt

@Stability(Deprecated)
@Deprecated
@Nullable
default String getCreatedAt()

Deprecated.

(deprecated) Timestamp when the gateway was created.

getDescription

@Stability(Deprecated)
@Deprecated
@Nullable
default String getDescription()

Deprecated.

(deprecated) The description of the gateway.

getExceptionLevel

@Stability(Deprecated)
@Deprecated
@Nullable
default GatewayExceptionLevel getExceptionLevel()

Deprecated.

(deprecated) The exception level for the gateway.

getGatewayUrl

@Stability(Deprecated)
@Deprecated
@Nullable
default String getGatewayUrl()

Deprecated.

(deprecated) The URL endpoint for the gateway.

getKmsKey

@Stability(Deprecated)
@Deprecated
@Nullable
default IKey getKmsKey()

Deprecated.

(deprecated) The KMS key used for encryption.

getStatus

@Stability(Deprecated)
@Deprecated
@Nullable
default String getStatus()

Deprecated.

(deprecated) The status of the gateway.

getStatusReason

@Stability(Deprecated)
@Deprecated
@Nullable
default List<String> getStatusReason()

Deprecated.

(deprecated) The status reasons for the gateway.

getUpdatedAt

@Stability(Deprecated)
@Deprecated
@Nullable
default String getUpdatedAt()

Deprecated.

(deprecated) Timestamp when the gateway was last updated.

grant

@Stability(Deprecated)
@Deprecated
@NotNull
Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 String... actions)

Deprecated.

(deprecated) Grants IAM actions to the IAM Principal.

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantInvoke

@Stability(Deprecated)
@Deprecated
@NotNull
Grant grantInvoke(@NotNull
 IGrantable grantee)

Deprecated.

(deprecated) Grants permission to invoke this Gateway.

Parameters:

grantee - This parameter is required.

grantManage

@Stability(Deprecated)
@Deprecated
@NotNull
Grant grantManage(@NotNull
 IGrantable grantee)

Deprecated.

(deprecated) Grants Create, Update, and Delete actions on the Gateway.

Parameters:

grantee - This parameter is required.

grantRead

@Stability(Deprecated)
@Deprecated
@NotNull
Grant grantRead(@NotNull
 IGrantable grantee)

Deprecated.

(deprecated) Grants Get and List actions on the Gateway.

Parameters:

grantee - This parameter is required.

metric

@Stability(Deprecated)
@Deprecated
@NotNull
Metric metric(@NotNull
 String metricName,
 @NotNull
 Map<String,String> dimensions,
 @Nullable
 MetricOptions props)

Deprecated.

(deprecated) Return the given named metric for this gateway.

Parameters:

metricName - The name of the metric. This parameter is required.

dimensions - Additional dimensions for the metric. This parameter is required.

props - Optional metric configuration.

metric

@Stability(Deprecated)
@Deprecated
@NotNull
Metric metric(@NotNull
 String metricName,
 @NotNull
 Map<String,String> dimensions)

Deprecated.

(deprecated) Return the given named metric for this gateway.

Parameters:

metricName - The name of the metric. This parameter is required.

dimensions - Additional dimensions for the metric. This parameter is required.

metricDuration

@Stability(Deprecated)
@Deprecated
@NotNull
Metric metricDuration(@Nullable
 MetricOptions props)

Deprecated.

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

Default: - Average statistic over 5 minutes

Parameters:

props - Optional metric configuration.

metricDuration

@Stability(Deprecated)
@Deprecated
@NotNull
Metric metricDuration()

Deprecated.

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

Default: - Average statistic over 5 minutes

metricInvocations

@Stability(Deprecated)
@Deprecated
@NotNull
Metric metricInvocations(@Nullable
 MetricOptions props)

Deprecated.

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

This metric tracks all successful invocations of the gateway.

Default: - Sum statistic over 5 minutes

Parameters:

props - Optional metric configuration.

metricInvocations

@Stability(Deprecated)
@Deprecated
@NotNull
Metric metricInvocations()

Deprecated.

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

This metric tracks all successful invocations of the gateway.

Default: - Sum statistic over 5 minutes

metricLatency

@Stability(Deprecated)
@Deprecated
@NotNull
Metric metricLatency(@Nullable
 MetricOptions props)

Deprecated.

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

Default: - Average statistic over 5 minutes

Parameters:

props - Optional metric configuration.

metricLatency

@Stability(Deprecated)
@Deprecated
@NotNull
Metric metricLatency()

Deprecated.

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

Default: - Average statistic over 5 minutes

metricSystemErrors

@Stability(Deprecated)
@Deprecated
@NotNull
Metric metricSystemErrors(@Nullable
 MetricOptions props)

Deprecated.

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

This metric tracks internal server errors and system failures.

Default: - Sum statistic over 5 minutes

Parameters:

props - Optional metric configuration.

metricSystemErrors

@Stability(Deprecated)
@Deprecated
@NotNull
Metric metricSystemErrors()

Deprecated.

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

This metric tracks internal server errors and system failures.

Default: - Sum statistic over 5 minutes

metricTargetExecutionTime

@Stability(Deprecated)
@Deprecated
@NotNull
Metric metricTargetExecutionTime(@Nullable
 MetricOptions props)

Deprecated.

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

Default: - Average statistic over 5 minutes

Parameters:

props - Optional metric configuration.

metricTargetExecutionTime

@Stability(Deprecated)
@Deprecated
@NotNull
Metric metricTargetExecutionTime()

Deprecated.

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

Default: - Average statistic over 5 minutes

metricTargetType

@Stability(Deprecated)
@Deprecated
@NotNull
Metric metricTargetType(@NotNull
 String targetType,
 @Nullable
 MetricOptions props)

Deprecated.

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

Default: - Sum statistic over 5 minutes

Parameters:

targetType - The type of target (e.g., 'Lambda', 'OpenAPI', 'Smithy'). This parameter is required.

props - Optional metric configuration.

metricTargetType

@Stability(Deprecated)
@Deprecated
@NotNull
Metric metricTargetType(@NotNull
 String targetType)

Deprecated.

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

Default: - Sum statistic over 5 minutes

Parameters:

targetType - The type of target (e.g., 'Lambda', 'OpenAPI', 'Smithy'). This parameter is required.

metricThrottles

@Stability(Deprecated)
@Deprecated
@NotNull
Metric metricThrottles(@Nullable
 MetricOptions props)

Deprecated.

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

Default: - Sum statistic over 5 minutes

Parameters:

props - Optional metric configuration.

metricThrottles

@Stability(Deprecated)
@Deprecated
@NotNull
Metric metricThrottles()

Deprecated.

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

Default: - Sum statistic over 5 minutes

metricUserErrors

@Stability(Deprecated)
@Deprecated
@NotNull
Metric metricUserErrors(@Nullable
 MetricOptions props)

Deprecated.

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

Default: - Sum statistic over 5 minutes

Parameters:

props - Optional metric configuration.

metricUserErrors

@Stability(Deprecated)
@Deprecated
@NotNull
Metric metricUserErrors()

Deprecated.

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

Default: - Sum statistic over 5 minutes