Package software.amazon.awscdk.services.bedrockagentcore

Class ApiGatewayTargetConfiguration.Builder

java.lang.Object

software.amazon.awscdk.services.bedrockagentcore.ApiGatewayTargetConfiguration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ApiGatewayTargetConfiguration>

Enclosing class:

ApiGatewayTargetConfiguration

@Stability(Stable)
public static final class ApiGatewayTargetConfiguration.Builder
extends Object
implements software.amazon.jsii.Builder<ApiGatewayTargetConfiguration>

A fluent builder for ApiGatewayTargetConfiguration.

Method Summary

Modifier and Type	Method	Description
ApiGatewayTargetConfiguration.Builder	apiGatewayToolConfiguration(ApiGatewayToolConfiguration apiGatewayToolConfiguration)	Tool configuration defining which operations to expose.
ApiGatewayTargetConfiguration	build()
static ApiGatewayTargetConfiguration.Builder	create()
ApiGatewayTargetConfiguration.Builder	metadataConfiguration(MetadataConfiguration metadataConfiguration)	Metadata configuration for passing headers and query parameters Allows you to pass additional context through headers and query parameters.
ApiGatewayTargetConfiguration.Builder	restApi(IRestApi restApi)	The REST API to integrate with Must be in the same account and region as the gateway.
ApiGatewayTargetConfiguration.Builder	stage(String stage)	The stage name of the REST API.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static ApiGatewayTargetConfiguration.Builder create()

Returns:

a new instance of ApiGatewayTargetConfiguration.Builder.

apiGatewayToolConfiguration

@Stability(Stable)
public ApiGatewayTargetConfiguration.Builder apiGatewayToolConfiguration(ApiGatewayToolConfiguration apiGatewayToolConfiguration)

Tool configuration defining which operations to expose.

Parameters:

apiGatewayToolConfiguration - Tool configuration defining which operations to expose. This parameter is required.

Returns:

this

restApi

@Stability(Stable)
public ApiGatewayTargetConfiguration.Builder restApi(IRestApi restApi)

The REST API to integrate with Must be in the same account and region as the gateway.

Parameters:

restApi - The REST API to integrate with Must be in the same account and region as the gateway. This parameter is required.

Returns:

this

metadataConfiguration

@Stability(Stable)
public ApiGatewayTargetConfiguration.Builder metadataConfiguration(MetadataConfiguration metadataConfiguration)

Metadata configuration for passing headers and query parameters Allows you to pass additional context through headers and query parameters.

Default: - No metadata configuration

Parameters:

metadataConfiguration - Metadata configuration for passing headers and query parameters Allows you to pass additional context through headers and query parameters. This parameter is required.

Returns:

this

stage

@Stability(Stable)
public ApiGatewayTargetConfiguration.Builder stage(String stage)

The stage name of the REST API.

Default: - Uses the deployment stage from the RestApi (restApi.deploymentStage.stageName)

Parameters:

stage - The stage name of the REST API. This parameter is required.

Returns:

this

build

@Stability(Stable)
public ApiGatewayTargetConfiguration build()

Specified by:

build in interface software.amazon.jsii.Builder<ApiGatewayTargetConfiguration>

Returns:

a newly built instance of ApiGatewayTargetConfiguration.