class GatewayTargetBase ⚠️

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

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

Implements IConstruct, IDependable, IResource, IEnvironmentAware, IGatewayTarget, IGatewayTargetRef

Extends Resource

Implemented by GatewayTarget

Base class for gateway target implementations.

Provides common functionality for all gateway target types including permission management and property definitions.

Initializer

new GatewayTargetBase(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
env⚠️	ResourceEnvironment	The environment this resource belongs to.
gateway⚠️	IGateway	The gateway that this target belongs to.
gatewayTargetRef⚠️	GatewayTargetReference	A reference to a GatewayTarget resource.
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⚠️

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

---

gateway⚠️

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

Type: IGateway

The gateway that this target belongs to.

---

gatewayTargetRef⚠️

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

Type: GatewayTargetReference

A reference to a GatewayTarget resource.

---

name⚠️

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

Type: string

The name of the gateway target.

---

node⚠️

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

Type: Node

The tree node.

---

stack⚠️

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

Type: Stack

The stack in which this resource is defined.

---

targetArn⚠️

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

Type: string

The ARN of the gateway target resource.

---

targetId⚠️

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

Type: string

The id of the gateway target.

---

targetProtocolType⚠️

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

Type: GatewayTargetProtocolType

The target protocol.

---

createdAt?⚠️

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

Type: string (optional)

Timestamp when the gateway target was created.

---

credentialProviderConfigurations?⚠️

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

Type: ICredentialProviderConfig[] (optional)

The credential provider configuration for the target.

---

description?⚠️

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

Type: string (optional)

The description of the gateway target.

---

status?⚠️

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

Type: string (optional)

The status of the gateway target.

---

statusReasons?⚠️

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

Type: string[] (optional)

The status reasons for the gateway target.

---

updatedAt?⚠️

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

Type: string (optional)

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

Returns

• Grant

Grants IAM actions to the IAM Principal.

[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 Target.

[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 Target.

[disable-awslint:no-grants]

---

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.