Package software.amazon.awscdk.services.bedrockagentcore

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

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GatewayProps.Builder	authorizerConfiguration(IGatewayAuthorizerConfig authorizerConfiguration)	Sets the value of GatewayProps.getAuthorizerConfiguration()
GatewayProps	build()	Builds the configured instance.
GatewayProps.Builder	description(String description)	Sets the value of GatewayProps.getDescription()
GatewayProps.Builder	exceptionLevel(GatewayExceptionLevel exceptionLevel)	Sets the value of GatewayProps.getExceptionLevel()
GatewayProps.Builder	gatewayName(String gatewayName)	Sets the value of GatewayProps.getGatewayName()
GatewayProps.Builder	interceptorConfigurations(List<? extends IInterceptor> interceptorConfigurations)	Sets the value of GatewayProps.getInterceptorConfigurations()
GatewayProps.Builder	kmsKey(IKey kmsKey)	Sets the value of GatewayProps.getKmsKey()
GatewayProps.Builder	protocolConfiguration(IGatewayProtocolConfig protocolConfiguration)	Sets the value of GatewayProps.getProtocolConfiguration()
GatewayProps.Builder	role(IRole role)	Sets the value of GatewayProps.getRole()
GatewayProps.Builder	tags(Map<String,String> tags)	Sets the value of GatewayProps.getTags()

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

authorizerConfiguration

@Stability(Stable)
public GatewayProps.Builder authorizerConfiguration(IGatewayAuthorizerConfig authorizerConfiguration)

Sets the value of GatewayProps.getAuthorizerConfiguration()

Parameters:

authorizerConfiguration - The authorizer configuration for the gateway.

Returns:

this

description

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

Sets the value of GatewayProps.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

@Stability(Stable)
public GatewayProps.Builder exceptionLevel(GatewayExceptionLevel exceptionLevel)

Sets the value of GatewayProps.getExceptionLevel()

Parameters:

exceptionLevel - The verbosity of exception messages Use DEBUG mode to see granular exception messages from a Gateway.

Returns:

this

gatewayName

@Stability(Stable)
public GatewayProps.Builder gatewayName(String gatewayName)

Sets the value of GatewayProps.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 of GatewayProps.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

@Stability(Stable)
public GatewayProps.Builder kmsKey(IKey kmsKey)

Sets the value of GatewayProps.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 of GatewayProps.getProtocolConfiguration()

Parameters:

protocolConfiguration - The protocol configuration for the gateway.

Returns:

this

role

@Stability(Stable)
public GatewayProps.Builder role(IRole role)

Sets the value of GatewayProps.getRole()

Parameters:

role - The IAM role that provides permissions for the gateway to access AWS services.

Returns:

this

tags

@Stability(Stable)
public GatewayProps.Builder tags(Map<String,String> tags)

Sets the value of GatewayProps.getTags()

Parameters:

tags - Tags for the gateway A list of key:value pairs of tags to apply to this Gateway resource.

Returns:

this

build

@Stability(Stable)
public GatewayProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of GatewayProps

Throws:

NullPointerException - if any required attribute was not provided