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 -
Method Summary
Modifier and TypeMethodDescriptionapiGatewayToolConfiguration(ApiGatewayToolConfiguration apiGatewayToolConfiguration) Sets the value ofGatewayTargetApiGatewayProps.getApiGatewayToolConfiguration()build()Builds the configured instance.credentialProviderConfigurations(List<? extends ICredentialProviderConfig> credentialProviderConfigurations) Sets the value ofGatewayTargetApiGatewayProps.getCredentialProviderConfigurations()description(String description) Sets the value ofGatewayTargetCommonProps.getDescription()Sets the value ofGatewayTargetApiGatewayProps.getGateway()gatewayTargetName(String gatewayTargetName) Sets the value ofGatewayTargetCommonProps.getGatewayTargetName()metadataConfiguration(MetadataConfiguration metadataConfiguration) Sets the value ofGatewayTargetApiGatewayProps.getMetadataConfiguration()Sets the value ofGatewayTargetApiGatewayProps.getRestApi()Sets the value ofGatewayTargetApiGatewayProps.getStage()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
apiGatewayToolConfiguration
@Stability(Stable) public GatewayTargetApiGatewayProps.Builder apiGatewayToolConfiguration(ApiGatewayToolConfiguration apiGatewayToolConfiguration) Sets the value ofGatewayTargetApiGatewayProps.getApiGatewayToolConfiguration()- Parameters:
apiGatewayToolConfiguration- Tool configuration defining which operations to expose. This parameter is required.- Returns:
this
-
gateway
Sets the value ofGatewayTargetApiGatewayProps.getGateway()- Parameters:
gateway- The gateway this target belongs to [disable-awslint:prefer-ref-interface]. This parameter is required.- Returns:
this
-
restApi
Sets the value ofGatewayTargetApiGatewayProps.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 ofGatewayTargetApiGatewayProps.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 ofGatewayTargetApiGatewayProps.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 ofGatewayTargetApiGatewayProps.getStage()- Parameters:
stage- The stage name of the REST API.- Returns:
this
-
description
Sets the value ofGatewayTargetCommonProps.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 ofGatewayTargetCommonProps.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
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<GatewayTargetApiGatewayProps>- Returns:
- a new instance of
GatewayTargetApiGatewayProps - Throws:
NullPointerException- if any required attribute was not provided
-