# IGatewayTarget

Interface for GatewayTarget resources.

Represents a target that hosts tools for the gateway.
Targets can be Lambda functions, OpenAPI schemas, or Smithy models.

Extends: IGatewayTarget
Extends: IResource, IGatewayTargetRef
Implemented by: GatewayTarget, GatewayTargetBase

- Source: [`aws-bedrockagentcore/lib/gateway/targets/target-base.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-bedrockagentcore/lib/gateway/targets/target-base.ts#L45)
- Type last changed: v2.255.0 · 19 May 2026

## Properties

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

- `credentialProviderConfigurations`: [ICredentialProviderConfig](/cdk/api/v2/docs/aws-cdk-lib.aws_bedrockagentcore.ICredentialProviderConfig.html)[] — The credential provider configuration for the target.

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

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

- `gateway`: [IGateway](/cdk/api/v2/docs/aws-cdk-lib.aws_bedrockagentcore.IGateway.html) — The gateway that this target belongs to.

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

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

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

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

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

- `targetArn`: string — The ARN of the gateway target resource.

- `targetId`: string — The id of the gateway target.

- `targetProtocolType`: [GatewayTargetProtocolType](/cdk/api/v2/docs/aws-cdk-lib.aws_bedrockagentcore.GatewayTargetProtocolType.html) — The target protocol.

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

## Methods

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

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

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

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

  **Parameters**

  - `mixins` — The mixins to apply.

  **Returns:** This construct for chaining