> **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.
# GatewayBase

Base class for Gateway constructs.

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

- Source: [`lib/gateway/gateway-base.ts`](https://github.com/aws/aws-cdk/blob/v2.277.0-alpha.0/packages/@aws-cdk/aws-bedrock-agentcore-alpha/lib/gateway/gateway-base.ts#L239)

## Initializer

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

## Construct Props

- `account`: string — The AWS account ID this resource belongs to.

  **Default:** the resource is in the same account as the stack it belongs to

- `environmentFromArn`: string — ARN to deduce region and account from.

  **Default:** take environment from `account`, `region` parameters, or use Stack environment.

  The ARN is parsed and the account and region are taken from the ARN.
  This should be used for imported resources.

  Cannot be supplied together with either `account` or `region`.

- `physicalName`: string — The value passed in by users to the physical name prop of the resource.

  **Default:** The physical name will be allocated by CloudFormation at deployment time

  - `undefined` implies that a physical name will be allocated by
    CloudFormation during deployment.
  - a concrete value implies a specific physical name
  - `PhysicalName.GENERATE_IF_NEEDED` is a marker that indicates that a physical will only be generated
    by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.

- `region`: string — The AWS region this resource belongs to.

  **Default:** the resource is in the same region as the stack it belongs to

## 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 resource.

- `gatewayId`: string — The id 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.

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

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

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

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

## Methods

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

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