Interface UpdateGatewayRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockAgentCoreControlRequest.Builder, Buildable, CopyableBuilder<UpdateGatewayRequest.Builder,UpdateGatewayRequest>, SdkBuilder<UpdateGatewayRequest.Builder,UpdateGatewayRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdateGatewayRequest

@Mutable
@NotThreadSafe
public static interface UpdateGatewayRequest.Builder
extends BedrockAgentCoreControlRequest.Builder, SdkPojo, CopyableBuilder<UpdateGatewayRequest.Builder,UpdateGatewayRequest>

Method Summary

Modifier and Type	Method	Description
default UpdateGatewayRequest.Builder	authorizerConfiguration(Consumer<AuthorizerConfiguration.Builder> authorizerConfiguration)	The updated authorizer configuration for the gateway.
UpdateGatewayRequest.Builder	authorizerConfiguration(AuthorizerConfiguration authorizerConfiguration)	The updated authorizer configuration for the gateway.
UpdateGatewayRequest.Builder	authorizerType(String authorizerType)	The updated authorizer type for the gateway.
UpdateGatewayRequest.Builder	authorizerType(AuthorizerType authorizerType)	The updated authorizer type for the gateway.
UpdateGatewayRequest.Builder	description(String description)	The updated description for the gateway.
UpdateGatewayRequest.Builder	exceptionLevel(String exceptionLevel)	The level of detail in error messages returned when invoking the gateway.
UpdateGatewayRequest.Builder	exceptionLevel(ExceptionLevel exceptionLevel)	The level of detail in error messages returned when invoking the gateway.
UpdateGatewayRequest.Builder	gatewayIdentifier(String gatewayIdentifier)	The identifier of the gateway to update.
UpdateGatewayRequest.Builder	interceptorConfigurations(Collection<GatewayInterceptorConfiguration> interceptorConfigurations)	The updated interceptor configurations for the gateway.
UpdateGatewayRequest.Builder	interceptorConfigurations(Consumer<GatewayInterceptorConfiguration.Builder>... interceptorConfigurations)	The updated interceptor configurations for the gateway.
UpdateGatewayRequest.Builder	interceptorConfigurations(GatewayInterceptorConfiguration... interceptorConfigurations)	The updated interceptor configurations for the gateway.
UpdateGatewayRequest.Builder	kmsKeyArn(String kmsKeyArn)	The updated ARN of the KMS key used to encrypt the gateway.
UpdateGatewayRequest.Builder	name(String name)	The name of the gateway.
UpdateGatewayRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateGatewayRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default UpdateGatewayRequest.Builder	policyEngineConfiguration(Consumer<GatewayPolicyEngineConfiguration.Builder> policyEngineConfiguration)	The updated policy engine configuration for the gateway.
UpdateGatewayRequest.Builder	policyEngineConfiguration(GatewayPolicyEngineConfiguration policyEngineConfiguration)	The updated policy engine configuration for the gateway.
default UpdateGatewayRequest.Builder	protocolConfiguration(Consumer<GatewayProtocolConfiguration.Builder> protocolConfiguration)	Sets the value of the ProtocolConfiguration property for this object.
UpdateGatewayRequest.Builder	protocolConfiguration(GatewayProtocolConfiguration protocolConfiguration)	Sets the value of the ProtocolConfiguration property for this object.
UpdateGatewayRequest.Builder	protocolType(String protocolType)	The updated protocol type for the gateway.
UpdateGatewayRequest.Builder	protocolType(GatewayProtocolType protocolType)	The updated protocol type for the gateway.
UpdateGatewayRequest.Builder	roleArn(String roleArn)	The updated IAM role ARN that provides permissions for the gateway.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrockagentcorecontrol.model.BedrockAgentCoreControlRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

gatewayIdentifier

UpdateGatewayRequest.Builder gatewayIdentifier(String gatewayIdentifier)

The identifier of the gateway to update.

Parameters:

gatewayIdentifier - The identifier of the gateway to update.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

UpdateGatewayRequest.Builder name(String name)

The name of the gateway. This name must be the same as the one when the gateway was created.

Parameters:

name - The name of the gateway. This name must be the same as the one when the gateway was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

UpdateGatewayRequest.Builder description(String description)

The updated description for the gateway.

Parameters:

description - The updated description for the gateway.

Returns:

Returns a reference to this object so that method calls can be chained together.

roleArn

UpdateGatewayRequest.Builder roleArn(String roleArn)

The updated IAM role ARN that provides permissions for the gateway.

Parameters:

roleArn - The updated IAM role ARN that provides permissions for the gateway.

Returns:

Returns a reference to this object so that method calls can be chained together.

protocolType

UpdateGatewayRequest.Builder protocolType(String protocolType)

The updated protocol type for the gateway.

Parameters:

protocolType - The updated protocol type for the gateway.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• GatewayProtocolType
• GatewayProtocolType

protocolType

UpdateGatewayRequest.Builder protocolType(GatewayProtocolType protocolType)

The updated protocol type for the gateway.

Parameters:

protocolType - The updated protocol type for the gateway.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• GatewayProtocolType
• GatewayProtocolType

protocolConfiguration

UpdateGatewayRequest.Builder protocolConfiguration(GatewayProtocolConfiguration protocolConfiguration)

Sets the value of the ProtocolConfiguration property for this object.

Parameters:

protocolConfiguration - The new value for the ProtocolConfiguration property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

protocolConfiguration

default UpdateGatewayRequest.Builder protocolConfiguration(Consumer<GatewayProtocolConfiguration.Builder> protocolConfiguration)

Sets the value of the ProtocolConfiguration property for this object. This is a convenience method that creates an instance of the GatewayProtocolConfiguration.Builder avoiding the need to create one manually via GatewayProtocolConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to protocolConfiguration(GatewayProtocolConfiguration).

Parameters:

protocolConfiguration - a consumer that will call methods on GatewayProtocolConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• protocolConfiguration(GatewayProtocolConfiguration)

authorizerType

UpdateGatewayRequest.Builder authorizerType(String authorizerType)

The updated authorizer type for the gateway.

Parameters:

authorizerType - The updated authorizer type for the gateway.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• AuthorizerType
• AuthorizerType

authorizerType

UpdateGatewayRequest.Builder authorizerType(AuthorizerType authorizerType)

The updated authorizer type for the gateway.

Parameters:

authorizerType - The updated authorizer type for the gateway.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• AuthorizerType
• AuthorizerType

authorizerConfiguration

UpdateGatewayRequest.Builder authorizerConfiguration(AuthorizerConfiguration authorizerConfiguration)

The updated authorizer configuration for the gateway.

Parameters:

authorizerConfiguration - The updated authorizer configuration for the gateway.

Returns:

Returns a reference to this object so that method calls can be chained together.

authorizerConfiguration

default UpdateGatewayRequest.Builder authorizerConfiguration(Consumer<AuthorizerConfiguration.Builder> authorizerConfiguration)

The updated authorizer configuration for the gateway.

This is a convenience method that creates an instance of the AuthorizerConfiguration.Builder avoiding the need to create one manually via AuthorizerConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to authorizerConfiguration(AuthorizerConfiguration).

Parameters:

authorizerConfiguration - a consumer that will call methods on AuthorizerConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• authorizerConfiguration(AuthorizerConfiguration)

kmsKeyArn

UpdateGatewayRequest.Builder kmsKeyArn(String kmsKeyArn)

The updated ARN of the KMS key used to encrypt the gateway.

Parameters:

kmsKeyArn - The updated ARN of the KMS key used to encrypt the gateway.

Returns:

Returns a reference to this object so that method calls can be chained together.

interceptorConfigurations

UpdateGatewayRequest.Builder interceptorConfigurations(Collection<GatewayInterceptorConfiguration> interceptorConfigurations)

The updated interceptor configurations for the gateway.

Parameters:

interceptorConfigurations - The updated interceptor configurations for the gateway.

Returns:

Returns a reference to this object so that method calls can be chained together.

interceptorConfigurations

UpdateGatewayRequest.Builder interceptorConfigurations(GatewayInterceptorConfiguration... interceptorConfigurations)

The updated interceptor configurations for the gateway.

Parameters:

interceptorConfigurations - The updated interceptor configurations for the gateway.

Returns:

Returns a reference to this object so that method calls can be chained together.

interceptorConfigurations

UpdateGatewayRequest.Builder interceptorConfigurations(Consumer<GatewayInterceptorConfiguration.Builder>... interceptorConfigurations)

The updated interceptor configurations for the gateway.

This is a convenience method that creates an instance of the GatewayInterceptorConfiguration.Builder avoiding the need to create one manually via GatewayInterceptorConfiguration.builder() .

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to interceptorConfigurations(List<GatewayInterceptorConfiguration>).

Parameters:

interceptorConfigurations - a consumer that will call methods on GatewayInterceptorConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• interceptorConfigurations(java.util.Collection<GatewayInterceptorConfiguration>)

policyEngineConfiguration

UpdateGatewayRequest.Builder policyEngineConfiguration(GatewayPolicyEngineConfiguration policyEngineConfiguration)

The updated policy engine configuration for the gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.

Parameters:

policyEngineConfiguration - The updated policy engine configuration for the gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.

Returns:

Returns a reference to this object so that method calls can be chained together.

policyEngineConfiguration

default UpdateGatewayRequest.Builder policyEngineConfiguration(Consumer<GatewayPolicyEngineConfiguration.Builder> policyEngineConfiguration)

The updated policy engine configuration for the gateway. A policy engine is a collection of policies that evaluates and authorizes agent tool calls. When associated with a gateway, the policy engine intercepts all agent requests and determines whether to allow or deny each action based on the defined policies.

This is a convenience method that creates an instance of the GatewayPolicyEngineConfiguration.Builder avoiding the need to create one manually via GatewayPolicyEngineConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to policyEngineConfiguration(GatewayPolicyEngineConfiguration).

Parameters:

policyEngineConfiguration - a consumer that will call methods on GatewayPolicyEngineConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• policyEngineConfiguration(GatewayPolicyEngineConfiguration)

exceptionLevel

UpdateGatewayRequest.Builder exceptionLevel(String exceptionLevel)

The level of detail in error messages returned when invoking the gateway.

• If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

• If the value is omitted, a generic error message is returned to the end user.

Parameters:

exceptionLevel - The level of detail in error messages returned when invoking the gateway.

• If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

• If the value is omitted, a generic error message is returned to the end user.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ExceptionLevel
• ExceptionLevel

exceptionLevel

UpdateGatewayRequest.Builder exceptionLevel(ExceptionLevel exceptionLevel)

The level of detail in error messages returned when invoking the gateway.

• If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

• If the value is omitted, a generic error message is returned to the end user.

Parameters:

exceptionLevel - The level of detail in error messages returned when invoking the gateway.

• If the value is DEBUG, granular exception messages are returned to help a user debug the gateway.

• If the value is omitted, a generic error message is returned to the end user.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• ExceptionLevel
• ExceptionLevel

overrideConfiguration

UpdateGatewayRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

UpdateGatewayRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.