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

Interface CfnGatewayTargetMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGatewayTargetMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:56.685Z")
@Stability(Stable)
public interface CfnGatewayTargetMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnGatewayTargetPropsMixin.

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.*;
 SchemaDefinitionProperty schemaDefinitionProperty_;
 CfnGatewayTargetMixinProps cfnGatewayTargetMixinProps = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGatewayTargetMixinProps.Builder	A builder for CfnGatewayTargetMixinProps
static final class	CfnGatewayTargetMixinProps.Jsii$Proxy	An implementation for CfnGatewayTargetMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnGatewayTargetMixinProps.Builder	builder()
default Object	getCredentialProviderConfigurations()	The OAuth credential provider configuration.
default String	getDescription()	The description for the gateway target.
default String	getGatewayIdentifier()	The gateway ID for the gateway target.
default Object	getMetadataConfiguration()	Returns union: either IResolvable or CfnGatewayTargetPropsMixin.MetadataConfigurationProperty
default String	getName()	The name for the gateway target.
default Object	getTargetConfiguration()	The target configuration for the Smithy model target.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCredentialProviderConfigurations

@Stability(Stable)
@Nullable
default Object getCredentialProviderConfigurations()

The OAuth credential provider configuration.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnGatewayTargetPropsMixin.CredentialProviderConfigurationProperty>

See Also:

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

getDescription

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

The description for the gateway target.

See Also:

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

getGatewayIdentifier

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

The gateway ID for the gateway target.

See Also:

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

getMetadataConfiguration

@Stability(Stable)
@Nullable
default Object getMetadataConfiguration()

Returns union: either IResolvable or CfnGatewayTargetPropsMixin.MetadataConfigurationProperty

See Also:

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

getName

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

The name for the gateway target.

See Also:

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

getTargetConfiguration

@Stability(Stable)
@Nullable
default Object getTargetConfiguration()

The target configuration for the Smithy model target.

Returns union: either IResolvable or CfnGatewayTargetPropsMixin.TargetConfigurationProperty

See Also:

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

builder

@Stability(Stable)
static CfnGatewayTargetMixinProps.Builder builder()

Returns:

a CfnGatewayTargetMixinProps.Builder of CfnGatewayTargetMixinProps