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 -
Method Summary
Modifier and TypeMethodDescriptionapiGatewayToolConfiguration(ApiGatewayToolConfiguration apiGatewayToolConfiguration) Sets the value ofAddApiGatewayTargetOptions.getApiGatewayToolConfiguration()build()Builds the configured instance.credentialProviderConfigurations(List<? extends ICredentialProviderConfig> credentialProviderConfigurations) Sets the value ofAddApiGatewayTargetOptions.getCredentialProviderConfigurations()description(String description) Sets the value ofAddApiGatewayTargetOptions.getDescription()gatewayTargetName(String gatewayTargetName) Sets the value ofAddApiGatewayTargetOptions.getGatewayTargetName()metadataConfiguration(MetadataConfiguration metadataConfiguration) Sets the value ofAddApiGatewayTargetOptions.getMetadataConfiguration()Sets the value ofAddApiGatewayTargetOptions.getRestApi()Sets the value ofAddApiGatewayTargetOptions.getStage()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
apiGatewayToolConfiguration
@Stability(Stable) public AddApiGatewayTargetOptions.Builder apiGatewayToolConfiguration(ApiGatewayToolConfiguration apiGatewayToolConfiguration) Sets the value ofAddApiGatewayTargetOptions.getApiGatewayToolConfiguration()- Parameters:
apiGatewayToolConfiguration- Tool configuration defining which operations to expose. This parameter is required.- Returns:
this
-
restApi
Sets the value ofAddApiGatewayTargetOptions.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 ofAddApiGatewayTargetOptions.getCredentialProviderConfigurations()- Parameters:
credentialProviderConfigurations- Credential providers for authentication API Gateway targets support IAM and API key authentication.- Returns:
this
-
description
Sets the value ofAddApiGatewayTargetOptions.getDescription()- Parameters:
description- Optional description for the gateway target.- Returns:
this
-
gatewayTargetName
@Stability(Stable) public AddApiGatewayTargetOptions.Builder gatewayTargetName(String gatewayTargetName) Sets the value ofAddApiGatewayTargetOptions.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 ofAddApiGatewayTargetOptions.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
Sets the value ofAddApiGatewayTargetOptions.getStage()- Parameters:
stage- The stage name of the REST API.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<AddApiGatewayTargetOptions>- Returns:
- a new instance of
AddApiGatewayTargetOptions - Throws:
NullPointerException- if any required attribute was not provided
-