Package software.amazon.awscdk.services.bedrockagentcore

Interface IGatewayTarget

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IGatewayTargetRef, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IGatewayTarget.Jsii$Default, IMcpGatewayTarget, IMcpGatewayTarget.Jsii$Default

All Known Implementing Classes:

GatewayTarget, GatewayTargetBase, IGatewayTarget.Jsii$Proxy, IMcpGatewayTarget.Jsii$Proxy

@Generated(value="jsii-pacmak/1.129.0 (build eaca441)",
           date="2026-05-19T08:18:44.444Z")
@Stability(Stable)
public interface IGatewayTarget
extends software.amazon.jsii.JsiiSerializable, IResource, IGatewayTargetRef

Interface for GatewayTarget resources.

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IGatewayTarget.Jsii$Default	Internal default implementation for IGatewayTarget.
static final class	IGatewayTarget.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
default String	getCreatedAt()	Timestamp when the gateway target was created.
default List<ICredentialProviderConfig>	getCredentialProviderConfigurations()	The credential provider configuration for the target.
default String	getDescription()	The description of the gateway target.
IGateway	getGateway()	The gateway that this target belongs to.
String	getGatewayTargetName()	The name of the gateway target.
default String	getStatus()	The status of the gateway target.
default List<String>	getStatusReasons()	The status reasons for the gateway target.
String	getTargetArn()	The ARN of the gateway target resource.
String	getTargetId()	The id of the gateway target.
GatewayTargetProtocolType	getTargetProtocolType()	The target protocol.
default String	getUpdatedAt()	Timestamp when the gateway target was last updated.
Grant	grant(IGrantable grantee, String... actions)	Grants IAM actions to the IAM Principal.
Grant	grantManage(IGrantable grantee)	Grants Create, Update, and Delete actions on the Gateway Target.
Grant	grantRead(IGrantable grantee)	Grants Get and List actions on the Gateway Target.

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.interfaces.bedrockagentcore.IGatewayTargetRef

getGatewayTargetRef

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getGateway

@Stability(Stable)
@NotNull
IGateway getGateway()

The gateway that this target belongs to.

getGatewayTargetName

@Stability(Stable)
@NotNull
String getGatewayTargetName()

The name of the gateway target.

getTargetArn

@Stability(Stable)
@NotNull
String getTargetArn()

The ARN of the gateway target resource.

getTargetId

@Stability(Stable)
@NotNull
String getTargetId()

The id of the gateway target.

getTargetProtocolType

@Stability(Stable)
@NotNull
GatewayTargetProtocolType getTargetProtocolType()

The target protocol.

getCreatedAt

@Stability(Stable)
@Nullable
default String getCreatedAt()

Timestamp when the gateway target was created.

getCredentialProviderConfigurations

@Stability(Stable)
@Nullable
default List<ICredentialProviderConfig> getCredentialProviderConfigurations()

The credential provider configuration for the target.

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the gateway target.

getStatus

@Stability(Stable)
@Nullable
default String getStatus()

The status of the gateway target.

getStatusReasons

@Stability(Stable)
@Nullable
default List<String> getStatusReasons()

The status reasons for the gateway target.

getUpdatedAt

@Stability(Stable)
@Nullable
default String getUpdatedAt()

Timestamp when the gateway target was last updated.

grant

@Stability(Stable)
@NotNull
Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 String... actions)

Grants IAM actions to the IAM Principal.

Parameters:

grantee - This parameter is required.

actions - This parameter is required.

grantManage

@Stability(Stable)
@NotNull
Grant grantManage(@NotNull
 IGrantable grantee)

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

Parameters:

grantee - This parameter is required.

grantRead

@Stability(Stable)
@NotNull
Grant grantRead(@NotNull
 IGrantable grantee)

Grants Get and List actions on the Gateway Target.

Parameters:

grantee - This parameter is required.