Package software.amazon.awscdk.services.bedrockagentcore

Class CfnGatewayTarget

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.bedrockagentcore.CfnGatewayTarget

All Implemented Interfaces:

IInspectable, IGatewayTargetRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)",
           date="2025-10-14T12:28:06.330Z")
@Stability(Stable)
public class CfnGatewayTarget
extends CfnResource
implements IInspectable, IGatewayTargetRef

Amazon Bedrock AgentCore is in preview release and is subject to change.

After creating a gateway, you can add targets, which define the tools that your gateway will host.

For more information about adding gateway targets, see Add targets to an existing gateway .

See the Properties section below for descriptions of both the required and optional properties.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.bedrockagentcore.*;
 SchemaDefinitionProperty schemaDefinitionProperty_;
 CfnGatewayTarget cfnGatewayTarget = CfnGatewayTarget.Builder.create(this, "MyCfnGatewayTarget")
         .credentialProviderConfigurations(List.of(CredentialProviderConfigurationProperty.builder()
                 .credentialProviderType("credentialProviderType")
                 // the properties below are optional
                 .credentialProvider(CredentialProviderProperty.builder()
                         .apiKeyCredentialProvider(ApiKeyCredentialProviderProperty.builder()
                                 .providerArn("providerArn")
                                 // the properties below are optional
                                 .credentialLocation("credentialLocation")
                                 .credentialParameterName("credentialParameterName")
                                 .credentialPrefix("credentialPrefix")
                                 .build())
                         .oauthCredentialProvider(OAuthCredentialProviderProperty.builder()
                                 .providerArn("providerArn")
                                 .scopes(List.of("scopes"))
                                 // the properties below are optional
                                 .customParameters(Map.of(
                                         "customParametersKey", "customParameters"))
                                 .build())
                         .build())
                 .build()))
         .name("name")
         .targetConfiguration(TargetConfigurationProperty.builder()
                 .mcp(McpTargetConfigurationProperty.builder()
                         .lambda(McpLambdaTargetConfigurationProperty.builder()
                                 .lambdaArn("lambdaArn")
                                 .toolSchema(ToolSchemaProperty.builder()
                                         .inlinePayload(List.of(ToolDefinitionProperty.builder()
                                                 .description("description")
                                                 .inputSchema(SchemaDefinitionProperty.builder()
                                                         .type("type")
                                                         // the properties below are optional
                                                         .description("description")
                                                         .items(schemaDefinitionProperty_)
                                                         .properties(Map.of(
                                                                 "propertiesKey", schemaDefinitionProperty_))
                                                         .required(List.of("required"))
                                                         .build())
                                                 .name("name")
                                                 // the properties below are optional
                                                 .outputSchema(SchemaDefinitionProperty.builder()
                                                         .type("type")
                                                         // the properties below are optional
                                                         .description("description")
                                                         .items(schemaDefinitionProperty_)
                                                         .properties(Map.of(
                                                                 "propertiesKey", schemaDefinitionProperty_))
                                                         .required(List.of("required"))
                                                         .build())
                                                 .build()))
                                         .s3(S3ConfigurationProperty.builder()
                                                 .bucketOwnerAccountId("bucketOwnerAccountId")
                                                 .uri("uri")
                                                 .build())
                                         .build())
                                 .build())
                         .openApiSchema(ApiSchemaConfigurationProperty.builder()
                                 .inlinePayload("inlinePayload")
                                 .s3(S3ConfigurationProperty.builder()
                                         .bucketOwnerAccountId("bucketOwnerAccountId")
                                         .uri("uri")
                                         .build())
                                 .build())
                         .smithyModel(ApiSchemaConfigurationProperty.builder()
                                 .inlinePayload("inlinePayload")
                                 .s3(S3ConfigurationProperty.builder()
                                         .bucketOwnerAccountId("bucketOwnerAccountId")
                                         .uri("uri")
                                         .build())
                                 .build())
                         .build())
                 .build())
         // the properties below are optional
         .description("description")
         .gatewayIdentifier("gatewayIdentifier")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-gatewaytarget.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnGatewayTarget.ApiKeyCredentialProviderProperty	The API key credential provider for the gateway target.
static interface	CfnGatewayTarget.ApiSchemaConfigurationProperty	The API schema configuration for the gateway target.
static final class	CfnGatewayTarget.Builder	A fluent builder for CfnGatewayTarget.
static interface	CfnGatewayTarget.CredentialProviderConfigurationProperty	The credential provider configuration for the gateway target.
static interface	CfnGatewayTarget.CredentialProviderProperty	Example:
static interface	CfnGatewayTarget.McpLambdaTargetConfigurationProperty	The Lambda target configuration.
static interface	CfnGatewayTarget.McpTargetConfigurationProperty	The MCP target configuration for the gateway target.
static interface	CfnGatewayTarget.OAuthCredentialProviderProperty	The OAuth credential provider for the gateway target.
static interface	CfnGatewayTarget.S3ConfigurationProperty	The S3 configuration for the gateway target.
static interface	CfnGatewayTarget.SchemaDefinitionProperty	The schema definition for the gateway target.
static interface	CfnGatewayTarget.TargetConfigurationProperty	The target configuration.
static interface	CfnGatewayTarget.ToolDefinitionProperty	The tool definition for the gateway.
static interface	CfnGatewayTarget.ToolSchemaProperty	The tool schema for the gateway target.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.bedrockagentcore.IGatewayTargetRef

IGatewayTargetRef.Jsii$Default, IGatewayTargetRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnGatewayTarget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnGatewayTarget(software.amazon.jsii.JsiiObjectRef objRef)
	CfnGatewayTarget(software.constructs.Construct scope, String id, CfnGatewayTargetProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrCreatedAt()	The date and time at which the gateway target was created.
String	getAttrGatewayArn()
String	getAttrStatus()	The status for the gateway target.
List<String>	getAttrStatusReasons()	The status reasons for the gateway target.
String	getAttrTargetId()	The target ID for the gateway target.
String	getAttrUpdatedAt()	The time at which the resource was updated.
protected Map<String,Object>	getCfnProperties()
Object	getCredentialProviderConfigurations()	The OAuth credential provider configuration.
String	getDescription()	The description for the gateway target.
String	getGatewayIdentifier()	The gateway ID for the gateway target.
GatewayTargetReference	getGatewayTargetRef()	A reference to a GatewayTarget resource.
String	getName()	The name for the gateway target.
Object	getTargetConfiguration()	The target configuration for the Smithy model target.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCredentialProviderConfigurations(List<Object> value)	The OAuth credential provider configuration.
void	setCredentialProviderConfigurations(IResolvable value)	The OAuth credential provider configuration.
void	setDescription(String value)	The description for the gateway target.
void	setGatewayIdentifier(String value)	The gateway ID for the gateway target.
void	setName(String value)	The name for the gateway target.
void	setTargetConfiguration(IResolvable value)	The target configuration for the Smithy model target.
void	setTargetConfiguration(CfnGatewayTarget.TargetConfigurationProperty value)	The target configuration for the Smithy model target.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnGatewayTarget

protected CfnGatewayTarget(software.amazon.jsii.JsiiObjectRef objRef)

CfnGatewayTarget

protected CfnGatewayTarget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnGatewayTarget

@Stability(Stable)
public CfnGatewayTarget(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnGatewayTargetProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrCreatedAt

@Stability(Stable)
@NotNull
public String getAttrCreatedAt()

The date and time at which the gateway target was created.

getAttrGatewayArn

@Stability(Stable)
@NotNull
public String getAttrGatewayArn()

getAttrStatus

@Stability(Stable)
@NotNull
public String getAttrStatus()

The status for the gateway target.

getAttrStatusReasons

@Stability(Stable)
@NotNull
public List<String> getAttrStatusReasons()

The status reasons for the gateway target.

getAttrTargetId

@Stability(Stable)
@NotNull
public String getAttrTargetId()

The target ID for the gateway target.

getAttrUpdatedAt

@Stability(Stable)
@NotNull
public String getAttrUpdatedAt()

The time at which the resource was updated.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getGatewayTargetRef

@Stability(Stable)
@NotNull
public GatewayTargetReference getGatewayTargetRef()

A reference to a GatewayTarget resource.

Specified by:

getGatewayTargetRef in interface IGatewayTargetRef

getCredentialProviderConfigurations

@Stability(Stable)
@NotNull
public Object getCredentialProviderConfigurations()

The OAuth credential provider configuration.

setCredentialProviderConfigurations

@Stability(Stable)
public void setCredentialProviderConfigurations(@NotNull
 IResolvable value)

The OAuth credential provider configuration.

setCredentialProviderConfigurations

@Stability(Stable)
public void setCredentialProviderConfigurations(@NotNull
 List<Object> value)

The OAuth credential provider configuration.

getName

@Stability(Stable)
@NotNull
public String getName()

The name for the gateway target.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The name for the gateway target.

getTargetConfiguration

@Stability(Stable)
@NotNull
public Object getTargetConfiguration()

The target configuration for the Smithy model target.

setTargetConfiguration

@Stability(Stable)
public void setTargetConfiguration(@NotNull
 IResolvable value)

The target configuration for the Smithy model target.

setTargetConfiguration

@Stability(Stable)
public void setTargetConfiguration(@NotNull
 CfnGatewayTarget.TargetConfigurationProperty value)

The target configuration for the Smithy model target.

getDescription

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

The description for the gateway target.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The description for the gateway target.

getGatewayIdentifier

@Stability(Stable)
@Nullable
public String getGatewayIdentifier()

The gateway ID for the gateway target.

setGatewayIdentifier

@Stability(Stable)
public void setGatewayIdentifier(@Nullable
 String value)

The gateway ID for the gateway target.