Class GatewayProps.Builder
java.lang.Object
software.amazon.awscdk.services.bedrockagentcore.GatewayProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<GatewayProps>
- Enclosing interface:
GatewayProps
@Stability(Stable)
public static final class GatewayProps.Builder
extends Object
implements software.amazon.jsii.Builder<GatewayProps>
A builder for
GatewayProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionauthorizerConfiguration(IGatewayAuthorizerConfig authorizerConfiguration) Sets the value ofGatewayProps.getAuthorizerConfiguration()build()Builds the configured instance.description(String description) Sets the value ofGatewayProps.getDescription()exceptionLevel(GatewayExceptionLevel exceptionLevel) Sets the value ofGatewayProps.getExceptionLevel()gatewayName(String gatewayName) Sets the value ofGatewayProps.getGatewayName()interceptorConfigurations(List<? extends IInterceptor> interceptorConfigurations) Sets the value ofGatewayProps.getInterceptorConfigurations()Sets the value ofGatewayProps.getKmsKey()protocolConfiguration(IGatewayProtocolConfig protocolConfiguration) Sets the value ofGatewayProps.getProtocolConfiguration()Sets the value ofGatewayProps.getRole()Sets the value ofGatewayProps.getTags()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
authorizerConfiguration
@Stability(Stable) public GatewayProps.Builder authorizerConfiguration(IGatewayAuthorizerConfig authorizerConfiguration) Sets the value ofGatewayProps.getAuthorizerConfiguration()- Parameters:
authorizerConfiguration- The authorizer configuration for the gateway.- Returns:
this
-
description
Sets the value ofGatewayProps.getDescription()- Parameters:
description- Optional description for the gateway Valid characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and spaces The description can have up to 200 characters.- Returns:
this
-
exceptionLevel
Sets the value ofGatewayProps.getExceptionLevel()- Parameters:
exceptionLevel- The verbosity of exception messages Use DEBUG mode to see granular exception messages from a Gateway.- Returns:
this
-
gatewayName
Sets the value ofGatewayProps.getGatewayName()- Parameters:
gatewayName- The name of the gateway Valid characters are a-z, A-Z, 0-9, _ (underscore) and - (hyphen) The name must be unique within your account.- Returns:
this
-
interceptorConfigurations
@Stability(Stable) public GatewayProps.Builder interceptorConfigurations(List<? extends IInterceptor> interceptorConfigurations) Sets the value ofGatewayProps.getInterceptorConfigurations()- Parameters:
interceptorConfigurations- Interceptor configurations for the gateway. Interceptors allow you to run custom code during each gateway invocation:- REQUEST interceptors execute before the gateway calls the target
- RESPONSE interceptors execute after the target responds
A gateway can have at most one REQUEST interceptor and one RESPONSE interceptor.
- Returns:
this
-
kmsKey
Sets the value ofGatewayProps.getKmsKey()- Parameters:
kmsKey- The AWS KMS key used to encrypt data associated with the gateway.- Returns:
this
-
protocolConfiguration
@Stability(Stable) public GatewayProps.Builder protocolConfiguration(IGatewayProtocolConfig protocolConfiguration) Sets the value ofGatewayProps.getProtocolConfiguration()- Parameters:
protocolConfiguration- The protocol configuration for the gateway.- Returns:
this
-
role
Sets the value ofGatewayProps.getRole()- Parameters:
role- The IAM role that provides permissions for the gateway to access AWS services.- Returns:
this
-
tags
Sets the value ofGatewayProps.getTags()- Parameters:
tags- Tags for the gateway A list of key:value pairs of tags to apply to this Gateway resource.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<GatewayProps>- Returns:
- a new instance of
GatewayProps - Throws:
NullPointerException- if any required attribute was not provided
-