Package software.amazon.awscdk.services.bedrockagentcore

Class GatewayTargetApiGatewayProps.Builder

java.lang.Object

software.amazon.awscdk.services.bedrockagentcore.GatewayTargetApiGatewayProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GatewayTargetApiGatewayProps>

Enclosing interface:

GatewayTargetApiGatewayProps

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

A builder for GatewayTargetApiGatewayProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GatewayTargetApiGatewayProps.Builder	apiGatewayToolConfiguration(ApiGatewayToolConfiguration apiGatewayToolConfiguration)	Sets the value of GatewayTargetApiGatewayProps.getApiGatewayToolConfiguration()
GatewayTargetApiGatewayProps	build()	Builds the configured instance.
GatewayTargetApiGatewayProps.Builder	credentialProviderConfigurations(List<? extends ICredentialProviderConfig> credentialProviderConfigurations)	Sets the value of GatewayTargetApiGatewayProps.getCredentialProviderConfigurations()
GatewayTargetApiGatewayProps.Builder	description(String description)	Sets the value of GatewayTargetCommonProps.getDescription()
GatewayTargetApiGatewayProps.Builder	gateway(IGateway gateway)	Sets the value of GatewayTargetApiGatewayProps.getGateway()
GatewayTargetApiGatewayProps.Builder	gatewayTargetName(String gatewayTargetName)	Sets the value of GatewayTargetCommonProps.getGatewayTargetName()
GatewayTargetApiGatewayProps.Builder	metadataConfiguration(MetadataConfiguration metadataConfiguration)	Sets the value of GatewayTargetApiGatewayProps.getMetadataConfiguration()
GatewayTargetApiGatewayProps.Builder	restApi(IRestApi restApi)	Sets the value of GatewayTargetApiGatewayProps.getRestApi()
GatewayTargetApiGatewayProps.Builder	stage(String stage)	Sets the value of GatewayTargetApiGatewayProps.getStage()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

apiGatewayToolConfiguration

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

Sets the value of GatewayTargetApiGatewayProps.getApiGatewayToolConfiguration()

Parameters:

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

Returns:

this

gateway

@Stability(Stable)
public GatewayTargetApiGatewayProps.Builder gateway(IGateway gateway)

Sets the value of GatewayTargetApiGatewayProps.getGateway()

Parameters:

gateway - The gateway this target belongs to [disable-awslint:prefer-ref-interface]. This parameter is required.

Returns:

this

restApi

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

Sets the value of GatewayTargetApiGatewayProps.getRestApi()

Parameters:

restApi - The REST API to integrate with Must be in the same account and region as the gateway [disable-awslint:prefer-ref-interface]. This parameter is required.

Returns:

this

credentialProviderConfigurations

@Stability(Stable)
public GatewayTargetApiGatewayProps.Builder credentialProviderConfigurations(List<? extends ICredentialProviderConfig> credentialProviderConfigurations)

Sets the value of GatewayTargetApiGatewayProps.getCredentialProviderConfigurations()

Parameters:

credentialProviderConfigurations - Credential providers for authentication API Gateway targets support IAM and API key authentication.

Returns:

this

metadataConfiguration

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

Sets the value of GatewayTargetApiGatewayProps.getMetadataConfiguration()

Parameters:

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

Returns:

this

stage

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

Sets the value of GatewayTargetApiGatewayProps.getStage()

Parameters:

stage - The stage name of the REST API.

Returns:

this

description

@Stability(Stable)
public GatewayTargetApiGatewayProps.Builder description(String description)

Sets the value of GatewayTargetCommonProps.getDescription()

Parameters:

description - Optional description for the gateway target The description can have up to 200 characters.

Returns:

this

gatewayTargetName

@Stability(Stable)
public GatewayTargetApiGatewayProps.Builder gatewayTargetName(String gatewayTargetName)

Sets the value of GatewayTargetCommonProps.getGatewayTargetName()

Parameters:

gatewayTargetName - The name of the gateway target The name must be unique within the gateway Pattern: ^([0-9a-zA-Z][-]?){1,100}$.

Returns:

this

build

@Stability(Stable)
public GatewayTargetApiGatewayProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of GatewayTargetApiGatewayProps

Throws:

NullPointerException - if any required attribute was not provided