class GatewayBase ⚠️

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

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Implements IConstruct, IDependable, IResource, IEnvironmentAware, IGateway, IGatewayRef

Extends Resource

Implemented by Gateway

Base class for Gateway constructs.

Initializer

new GatewayBase(scope: Construct, id: string, props?: ResourceProps)

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Parameters

scope Construct
id string
props ResourceProps

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.
gatewayRef⚠️	`GatewayReference`	A reference to a Gateway resource.
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⚠️

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Type: IGatewayAuthorizerConfig

The authorizer configuration for the gateway.

env⚠️

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

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⚠️

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Type: string

The ARN of the gateway resource.

gatewayId⚠️

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Type: string

The id of the gateway.

gatewayRef⚠️

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Type: GatewayReference

A reference to a Gateway resource.

name⚠️

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Type: string

The name of the gateway.

node⚠️

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Type: Node

The tree node.

protocolConfiguration⚠️

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Type: IGatewayProtocolConfig

The protocol configuration for the gateway.

role⚠️

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Type: IRole

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

stack⚠️

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Type: Stack

The stack in which this resource is defined.

createdAt?⚠️

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Type: string (optional)

Timestamp when the gateway was created.

description?⚠️

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Type: string (optional)

The description of the gateway.

exceptionLevel?⚠️

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Type: GatewayExceptionLevel (optional)

The exception level for the gateway.

gatewayUrl?⚠️

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Type: string (optional)

The URL endpoint for the gateway.

kmsKey?⚠️

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Type: IKey (optional)

The KMS key used for encryption.

status?⚠️

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Type: string (optional)

The status of the gateway.

statusReason?⚠️

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Type: string[] (optional)

The status reasons for the gateway.

updatedAt?⚠️

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Type: string (optional)

Timestamp when the gateway was last updated.

Methods

Name	Description
applyCrossStackReferenceStrength(strength)⚠️	Override the cross-stack reference strength for this resource.
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.
toString()⚠️	Returns a string representation of this construct.
with(...mixins)⚠️	Applies one or more mixins to this construct.

applyCrossStackReferenceStrength(strength)⚠️

public applyCrossStackReferenceStrength(strength: ReferenceStrength): void

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Parameters

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

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.

applyRemovalPolicy(policy)⚠️

public applyRemovalPolicy(policy: RemovalPolicy): void

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

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

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Parameters

grantee IGrantable — The principal to grant permissions to.
actions string — The actions to grant.

Returns

Grant

Grants IAM actions to the IAM Principal.

[disable-awslint:no-grants]

grantInvoke(grantee)⚠️

public grantInvoke(grantee: IGrantable): Grant

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Parameters

grantee IGrantable — The principal to grant invoke permissions to.

Returns

Grant

Grants permission to invoke this Gateway.

[disable-awslint:no-grants]

grantManage(grantee)⚠️

public grantManage(grantee: IGrantable): Grant

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Parameters

grantee IGrantable — The principal to grant manage permissions to.

Returns

Grant

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

[disable-awslint:no-grants]

grantRead(grantee)⚠️

public grantRead(grantee: IGrantable): Grant

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Parameters

grantee IGrantable — The principal to grant read permissions to.

Returns

Grant

Grants Get and List actions on the Gateway.

[disable-awslint:no-grants]

metric(metricName, dimensions, props?)⚠️

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

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

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.

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.

metricDuration(props?)⚠️

public metricDuration(props?: MetricOptions): Metric

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Parameters

props MetricOptions

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

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Parameters

props MetricOptions

Returns

Metric

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

metricLatency(props?)⚠️

public metricLatency(props?: MetricOptions): Metric

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Parameters

props MetricOptions

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

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Parameters

props MetricOptions

Returns

Metric

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

metricTargetExecutionTime(props?)⚠️

public metricTargetExecutionTime(props?: MetricOptions): Metric

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Parameters

props MetricOptions

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

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Parameters

targetType string
props MetricOptions

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

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Parameters

props MetricOptions

Returns

Metric

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

metricUserErrors(props?)⚠️

public metricUserErrors(props?: MetricOptions): Metric

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Parameters

props MetricOptions

Returns

Metric

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

toString()⚠️

public toString(): string

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Returns

string

Returns a string representation of this construct.

with(...mixins)⚠️

public with(...mixins: IMixin[]): IConstruct

⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.

Parameters

mixins IMixin

Returns

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.