Package software.amazon.awscdk.services.bedrockagentcore

Interface CfnGatewayTargetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGatewayTargetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.133.0 (build 0f43e37)",
           date="2026-07-02T13:32:33.924Z")
@Stability(Stable)
public interface CfnGatewayTargetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnGatewayTarget.

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.*;
 Object parameterValues;
 SchemaDefinitionProperty schemaDefinitionProperty_;
 CfnGatewayTargetProps cfnGatewayTargetProps = CfnGatewayTargetProps.builder()
         .targetConfiguration(TargetConfigurationProperty.builder()
                 .http(HttpTargetConfigurationProperty.builder()
                         .agentcoreRuntime(RuntimeTargetConfigurationProperty.builder()
                                 .arn("arn")
                                 // the properties below are optional
                                 .qualifier("qualifier")
                                 .schema(HttpApiSchemaConfigurationProperty.builder()
                                         .source(ApiSchemaConfigurationProperty.builder()
                                                 .inlinePayload("inlinePayload")
                                                 .s3(S3ConfigurationProperty.builder()
                                                         .bucketOwnerAccountId("bucketOwnerAccountId")
                                                         .uri("uri")
                                                         .build())
                                                 .build())
                                         .build())
                                 .build())
                         .passthrough(PassthroughTargetConfigurationProperty.builder()
                                 .endpoint("endpoint")
                                 .protocolType("protocolType")
                                 // the properties below are optional
                                 .schema(HttpApiSchemaConfigurationProperty.builder()
                                         .source(ApiSchemaConfigurationProperty.builder()
                                                 .inlinePayload("inlinePayload")
                                                 .s3(S3ConfigurationProperty.builder()
                                                         .bucketOwnerAccountId("bucketOwnerAccountId")
                                                         .uri("uri")
                                                         .build())
                                                 .build())
                                         .build())
                                 .stickinessConfiguration(StickinessConfigurationProperty.builder()
                                         .identifier("identifier")
                                         // the properties below are optional
                                         .timeout(123)
                                         .build())
                                 .build())
                         .build())
                 .mcp(McpTargetConfigurationProperty.builder()
                         .apiGateway(ApiGatewayTargetConfigurationProperty.builder()
                                 .apiGatewayToolConfiguration(ApiGatewayToolConfigurationProperty.builder()
                                         .toolFilters(List.of(ApiGatewayToolFilterProperty.builder()
                                                 .filterPath("filterPath")
                                                 .methods(List.of("methods"))
                                                 .build()))
                                         // the properties below are optional
                                         .toolOverrides(List.of(ApiGatewayToolOverrideProperty.builder()
                                                 .method("method")
                                                 .name("name")
                                                 .path("path")
                                                 // the properties below are optional
                                                 .description("description")
                                                 .build()))
                                         .build())
                                 .restApiId("restApiId")
                                 .stage("stage")
                                 .build())
                         .connector(ConnectorTargetConfigurationProperty.builder()
                                 .source(ConnectorSourceProperty.builder()
                                         .connectorId("connectorId")
                                         .build())
                                 // the properties below are optional
                                 .configurations(List.of(ConnectorConfigurationProperty.builder()
                                         .name("name")
                                         // the properties below are optional
                                         .description("description")
                                         .parameterOverrides(List.of(ConnectorParameterOverrideProperty.builder()
                                                 .path("path")
                                                 // the properties below are optional
                                                 .description("description")
                                                 .visible(false)
                                                 .build()))
                                         .parameterValues(parameterValues)
                                         .build()))
                                 .enabled(List.of("enabled"))
                                 .build())
                         .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())
                         .mcpServer(McpServerTargetConfigurationProperty.builder()
                                 .endpoint("endpoint")
                                 // the properties below are optional
                                 .listingMode("listingMode")
                                 .mcpToolSchema(McpToolSchemaConfigurationProperty.builder()
                                         .inlinePayload("inlinePayload")
                                         .s3(S3ConfigurationProperty.builder()
                                                 .bucketOwnerAccountId("bucketOwnerAccountId")
                                                 .uri("uri")
                                                 .build())
                                         .build())
                                 .resourcePriority(123)
                                 .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
         .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())
                         .iamCredentialProvider(IamCredentialProviderProperty.builder()
                                 .service("service")
                                 // the properties below are optional
                                 .region("region")
                                 .build())
                         .oauthCredentialProvider(OAuthCredentialProviderProperty.builder()
                                 .providerArn("providerArn")
                                 .scopes(List.of("scopes"))
                                 // the properties below are optional
                                 .customParameters(Map.of(
                                         "customParametersKey", "customParameters"))
                                 .defaultReturnUrl("defaultReturnUrl")
                                 .grantType("grantType")
                                 .build())
                         .build())
                 .build()))
         .description("description")
         .gatewayIdentifier("gatewayIdentifier")
         .metadataConfiguration(MetadataConfigurationProperty.builder()
                 .allowedQueryParameters(List.of("allowedQueryParameters"))
                 .allowedRequestHeaders(List.of("allowedRequestHeaders"))
                 .allowedResponseHeaders(List.of("allowedResponseHeaders"))
                 .build())
         .name("name")
         .privateEndpoint(PrivateEndpointProperty.builder()
                 .managedVpcResource(ManagedVpcResourceProperty.builder()
                         .endpointIpAddressType("endpointIpAddressType")
                         .subnetIds(List.of("subnetIds"))
                         .vpcIdentifier("vpcIdentifier")
                         // the properties below are optional
                         .routingDomain("routingDomain")
                         .securityGroupIds(List.of("securityGroupIds"))
                         .build())
                 .selfManagedLatticeResource(SelfManagedLatticeResourceProperty.builder()
                         .resourceConfigurationIdentifier("resourceConfigurationIdentifier")
                         .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	CfnGatewayTargetProps.Builder	A builder for CfnGatewayTargetProps
static final class	CfnGatewayTargetProps.Jsii$Proxy	An implementation for CfnGatewayTargetProps

Method Summary

Modifier and Type	Method	Description
static CfnGatewayTargetProps.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 CfnGatewayTarget.MetadataConfigurationProperty
default String	getName()	The name for the gateway target.
default Object	getPrivateEndpoint()	Returns union: either IResolvable or CfnGatewayTarget.PrivateEndpointProperty
Object	getTargetConfiguration()	The target configuration for the Smithy model target.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getTargetConfiguration

@Stability(Stable)
@NotNull
Object getTargetConfiguration()

The target configuration for the Smithy model target.

Returns union: either IResolvable or CfnGatewayTarget.TargetConfigurationProperty

See Also:

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

getCredentialProviderConfigurations

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

The OAuth credential provider configuration.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnGatewayTarget.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 CfnGatewayTarget.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

getPrivateEndpoint

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

Returns union: either IResolvable or CfnGatewayTarget.PrivateEndpointProperty

See Also:

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

builder

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

Returns:

a CfnGatewayTargetProps.Builder of CfnGatewayTargetProps