Package software.amazon.awscdk.services.bedrockagentcore

Class AddApiGatewayTargetOptions.Builder

java.lang.Object

software.amazon.awscdk.services.bedrockagentcore.AddApiGatewayTargetOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AddApiGatewayTargetOptions>

Enclosing interface:

AddApiGatewayTargetOptions

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

A builder for AddApiGatewayTargetOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AddApiGatewayTargetOptions.Builder	apiGatewayToolConfiguration(ApiGatewayToolConfiguration apiGatewayToolConfiguration)	Sets the value of AddApiGatewayTargetOptions.getApiGatewayToolConfiguration()
AddApiGatewayTargetOptions	build()	Builds the configured instance.
AddApiGatewayTargetOptions.Builder	credentialProviderConfigurations(List<? extends ICredentialProviderConfig> credentialProviderConfigurations)	Sets the value of AddApiGatewayTargetOptions.getCredentialProviderConfigurations()
AddApiGatewayTargetOptions.Builder	description(String description)	Sets the value of AddApiGatewayTargetOptions.getDescription()
AddApiGatewayTargetOptions.Builder	gatewayTargetName(String gatewayTargetName)	Sets the value of AddApiGatewayTargetOptions.getGatewayTargetName()
AddApiGatewayTargetOptions.Builder	metadataConfiguration(MetadataConfiguration metadataConfiguration)	Sets the value of AddApiGatewayTargetOptions.getMetadataConfiguration()
AddApiGatewayTargetOptions.Builder	restApi(IRestApi restApi)	Sets the value of AddApiGatewayTargetOptions.getRestApi()
AddApiGatewayTargetOptions.Builder	stage(String stage)	Sets the value of AddApiGatewayTargetOptions.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 AddApiGatewayTargetOptions.Builder apiGatewayToolConfiguration(ApiGatewayToolConfiguration apiGatewayToolConfiguration)

Sets the value of AddApiGatewayTargetOptions.getApiGatewayToolConfiguration()

Parameters:

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

Returns:

this

restApi

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

Sets the value of AddApiGatewayTargetOptions.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 AddApiGatewayTargetOptions.Builder credentialProviderConfigurations(List<? extends ICredentialProviderConfig> credentialProviderConfigurations)

Sets the value of AddApiGatewayTargetOptions.getCredentialProviderConfigurations()

Parameters:

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

Returns:

this

description

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

Sets the value of AddApiGatewayTargetOptions.getDescription()

Parameters:

description - Optional description for the gateway target.

Returns:

this

gatewayTargetName

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

Sets the value of AddApiGatewayTargetOptions.getGatewayTargetName()

Parameters:

gatewayTargetName - The name of the gateway target Valid characters are a-z, A-Z, 0-9, _ (underscore) and - (hyphen).

Returns:

this

metadataConfiguration

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

Sets the value of AddApiGatewayTargetOptions.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 AddApiGatewayTargetOptions.Builder stage(String stage)

Sets the value of AddApiGatewayTargetOptions.getStage()

Parameters:

stage - The stage name of the REST API.

Returns:

this

build

@Stability(Stable)
public AddApiGatewayTargetOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of AddApiGatewayTargetOptions

Throws:

NullPointerException - if any required attribute was not provided