interface IGatewayTarget 🔹

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

Implemented by GatewayTarget

Obtainable from GatewayTarget.fromGatewayTargetAttributes()

Interface for GatewayTarget resources.

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

Properties

Name	Type	Description
env🔹	ResourceEnvironment	The environment this resource belongs to.
gateway🔹	IGateway	The gateway that this target belongs to.
name🔹	string	The name of the gateway target.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.
targetArn🔹	string	The ARN of the gateway target resource.
targetId🔹	string	The id of the gateway target.
targetProtocolType🔹	GatewayTargetProtocolType	The target protocol.
createdAt?🔹	string	Timestamp when the gateway target was created.
credentialProviderConfigurations?🔹	ICredentialProviderConfig[]	The credential provider configuration for the target.
description?🔹	string	The description of the gateway target.
status?🔹	string	The status of the gateway target.
statusReasons?🔹	string[]	The status reasons for the gateway target.
updatedAt?🔹	string	Timestamp when the gateway target was last updated.

---

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.

---

gateway🔹

Type: IGateway

The gateway that this target belongs to.

---

name🔹

Type: string

The name of the gateway target.

---

node🔹

Type: Node

The tree node.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

targetArn🔹

Type: string

The ARN of the gateway target resource.

---

targetId🔹

Type: string

The id of the gateway target.

---

targetProtocolType🔹

Type: GatewayTargetProtocolType

The target protocol.

---

createdAt?🔹

Type: string (optional)

Timestamp when the gateway target was created.

---

credentialProviderConfigurations?🔹

Type: ICredentialProviderConfig[] (optional)

The credential provider configuration for the target.

---

description?🔹

Type: string (optional)

The description of the gateway target.

---

status?🔹

Type: string (optional)

The status of the gateway target.

---

statusReasons?🔹

Type: string[] (optional)

The status reasons for the gateway target.

---

updatedAt?🔹

Type: string (optional)

Timestamp when the gateway target 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.
grantManage(grantee)🔹	Grants Create, Update, and Delete actions on the Gateway Target.
grantRead(grantee)🔹	Grants Get and List actions on the Gateway Target.

---

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.

---

grantManage(grantee)🔹

public grantManage(grantee: IGrantable): Grant

Parameters

• grantee IGrantable

Returns

• Grant

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

---

grantRead(grantee)🔹

public grantRead(grantee: IGrantable): Grant

Parameters

• grantee IGrantable

Returns

• Grant

Grants Get and List actions on the Gateway Target.