Package software.amazon.awscdk.cfnpropertymixins.services.bedrockagentcore

Class CfnGatewayTargetPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.bedrockagentcore.CfnGatewayTargetPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:56.687Z")
@Stability(Stable)
public class CfnGatewayTargetPropsMixin
extends Mixin
implements software.constructs.IMixin

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.cfnpropertymixins.services.bedrockagentcore.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 SchemaDefinitionProperty schemaDefinitionProperty_;
 CfnGatewayTargetPropsMixin cfnGatewayTargetPropsMixin = CfnGatewayTargetPropsMixin.Builder.create(CfnGatewayTargetMixinProps.builder()
         .credentialProviderConfigurations(List.of(CredentialProviderConfigurationProperty.builder()
                 .credentialProvider(CredentialProviderProperty.builder()
                         .apiKeyCredentialProvider(ApiKeyCredentialProviderProperty.builder()
                                 .credentialLocation("credentialLocation")
                                 .credentialParameterName("credentialParameterName")
                                 .credentialPrefix("credentialPrefix")
                                 .providerArn("providerArn")
                                 .build())
                         .oauthCredentialProvider(OAuthCredentialProviderProperty.builder()
                                 .customParameters(Map.of(
                                         "customParametersKey", "customParameters"))
                                 .defaultReturnUrl("defaultReturnUrl")
                                 .grantType("grantType")
                                 .providerArn("providerArn")
                                 .scopes(List.of("scopes"))
                                 .build())
                         .build())
                 .credentialProviderType("credentialProviderType")
                 .build()))
         .description("description")
         .gatewayIdentifier("gatewayIdentifier")
         .metadataConfiguration(MetadataConfigurationProperty.builder()
                 .allowedQueryParameters(List.of("allowedQueryParameters"))
                 .allowedRequestHeaders(List.of("allowedRequestHeaders"))
                 .allowedResponseHeaders(List.of("allowedResponseHeaders"))
                 .build())
         .name("name")
         .targetConfiguration(TargetConfigurationProperty.builder()
                 .mcp(McpTargetConfigurationProperty.builder()
                         .apiGateway(ApiGatewayTargetConfigurationProperty.builder()
                                 .apiGatewayToolConfiguration(ApiGatewayToolConfigurationProperty.builder()
                                         .toolFilters(List.of(ApiGatewayToolFilterProperty.builder()
                                                 .filterPath("filterPath")
                                                 .methods(List.of("methods"))
                                                 .build()))
                                         .toolOverrides(List.of(ApiGatewayToolOverrideProperty.builder()
                                                 .description("description")
                                                 .method("method")
                                                 .name("name")
                                                 .path("path")
                                                 .build()))
                                         .build())
                                 .restApiId("restApiId")
                                 .stage("stage")
                                 .build())
                         .lambda(McpLambdaTargetConfigurationProperty.builder()
                                 .lambdaArn("lambdaArn")
                                 .toolSchema(ToolSchemaProperty.builder()
                                         .inlinePayload(List.of(ToolDefinitionProperty.builder()
                                                 .description("description")
                                                 .inputSchema(SchemaDefinitionProperty.builder()
                                                         .description("description")
                                                         .items(schemaDefinitionProperty_)
                                                         .properties(Map.of(
                                                                 "propertiesKey", schemaDefinitionProperty_))
                                                         .required(List.of("required"))
                                                         .type("type")
                                                         .build())
                                                 .name("name")
                                                 .outputSchema(SchemaDefinitionProperty.builder()
                                                         .description("description")
                                                         .items(schemaDefinitionProperty_)
                                                         .properties(Map.of(
                                                                 "propertiesKey", schemaDefinitionProperty_))
                                                         .required(List.of("required"))
                                                         .type("type")
                                                         .build())
                                                 .build()))
                                         .s3(S3ConfigurationProperty.builder()
                                                 .bucketOwnerAccountId("bucketOwnerAccountId")
                                                 .uri("uri")
                                                 .build())
                                         .build())
                                 .build())
                         .mcpServer(McpServerTargetConfigurationProperty.builder()
                                 .endpoint("endpoint")
                                 .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())
         .build())
 .strategy(mergeStrategy)
 .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	CfnGatewayTargetPropsMixin.ApiGatewayTargetConfigurationProperty	Example:
static interface	CfnGatewayTargetPropsMixin.ApiGatewayToolConfigurationProperty	Example:
static interface	CfnGatewayTargetPropsMixin.ApiGatewayToolFilterProperty	Example:
static interface	CfnGatewayTargetPropsMixin.ApiGatewayToolOverrideProperty	Example:
static interface	CfnGatewayTargetPropsMixin.ApiKeyCredentialProviderProperty	The API key credential provider for the gateway target.
static interface	CfnGatewayTargetPropsMixin.ApiSchemaConfigurationProperty	The API schema configuration for the gateway target.
static final class	CfnGatewayTargetPropsMixin.Builder	A fluent builder for CfnGatewayTargetPropsMixin.
static interface	CfnGatewayTargetPropsMixin.CredentialProviderConfigurationProperty	The credential provider configuration for the gateway target.
static interface	CfnGatewayTargetPropsMixin.CredentialProviderProperty	Example:
static interface	CfnGatewayTargetPropsMixin.McpLambdaTargetConfigurationProperty	The Lambda target configuration.
static interface	CfnGatewayTargetPropsMixin.McpServerTargetConfigurationProperty	Example:
static interface	CfnGatewayTargetPropsMixin.McpTargetConfigurationProperty	The MCP target configuration for the gateway target.
static interface	CfnGatewayTargetPropsMixin.MetadataConfigurationProperty	Example:
static interface	CfnGatewayTargetPropsMixin.OAuthCredentialProviderProperty	The OAuth credential provider for the gateway target.
static interface	CfnGatewayTargetPropsMixin.S3ConfigurationProperty	The S3 configuration for the gateway target.
static interface	CfnGatewayTargetPropsMixin.SchemaDefinitionProperty	The schema definition for the gateway target.
static interface	CfnGatewayTargetPropsMixin.TargetConfigurationProperty	The target configuration.
static interface	CfnGatewayTargetPropsMixin.ToolDefinitionProperty	The tool definition for the gateway.
static interface	CfnGatewayTargetPropsMixin.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.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnGatewayTargetPropsMixin(CfnGatewayTargetMixinProps props)	Create a mixin to apply properties to AWS::BedrockAgentCore::GatewayTarget.
	CfnGatewayTargetPropsMixin(CfnGatewayTargetMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::BedrockAgentCore::GatewayTarget.
protected	CfnGatewayTargetPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnGatewayTargetPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnGatewayTargetMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnGatewayTargetPropsMixin

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

CfnGatewayTargetPropsMixin

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

CfnGatewayTargetPropsMixin

@Stability(Stable)
public CfnGatewayTargetPropsMixin(@NotNull
 CfnGatewayTargetMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::BedrockAgentCore::GatewayTarget.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnGatewayTargetPropsMixin

@Stability(Stable)
public CfnGatewayTargetPropsMixin(@NotNull
 CfnGatewayTargetMixinProps props)

Create a mixin to apply properties to AWS::BedrockAgentCore::GatewayTarget.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnGatewayTargetMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()