Interface CreateGatewayRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,BedrockAgentCoreControlRequest.Builder
,Buildable
,CopyableBuilder<CreateGatewayRequest.Builder,
,CreateGatewayRequest> SdkBuilder<CreateGatewayRequest.Builder,
,CreateGatewayRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateGatewayRequest
-
Method Summary
Modifier and TypeMethodDescriptiondefault CreateGatewayRequest.Builder
authorizerConfiguration
(Consumer<AuthorizerConfiguration.Builder> authorizerConfiguration) The authorizer configuration for the gateway.authorizerConfiguration
(AuthorizerConfiguration authorizerConfiguration) The authorizer configuration for the gateway.authorizerType
(String authorizerType) The type of authorizer to use for the gateway.authorizerType
(AuthorizerType authorizerType) The type of authorizer to use for the gateway.clientToken
(String clientToken) A unique, case-sensitive identifier to ensure that the API request completes no more than one time.description
(String description) The description of the gateway.exceptionLevel
(String exceptionLevel) The level of detail in error messages returned when invoking the gateway.exceptionLevel
(ExceptionLevel exceptionLevel) The level of detail in error messages returned when invoking the gateway.The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway.The name of the gateway.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.default CreateGatewayRequest.Builder
protocolConfiguration
(Consumer<GatewayProtocolConfiguration.Builder> protocolConfiguration) The configuration settings for the protocol specified in theprotocolType
parameter.protocolConfiguration
(GatewayProtocolConfiguration protocolConfiguration) The configuration settings for the protocol specified in theprotocolType
parameter.protocolType
(String protocolType) The protocol type for the gateway.protocolType
(GatewayProtocolType protocolType) The protocol type for the gateway.The Amazon Resource Name (ARN) of the IAM role that provides permissions for the gateway to access Amazon Web Services services.A map of key-value pairs to associate with the gateway as metadata tags.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
-
name
The name of the gateway. The name must be unique within your account.
- Parameters:
name
- The name of the gateway. The name must be unique within your account.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
The description of the gateway.
- Parameters:
description
- The description of the gateway.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientToken
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error. For more information, see Ensuring idempotency.
- Parameters:
clientToken
- A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error. For more information, see Ensuring idempotency.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
roleArn
The Amazon Resource Name (ARN) of the IAM role that provides permissions for the gateway to access Amazon Web Services services.
- Parameters:
roleArn
- The Amazon Resource Name (ARN) of the IAM role that provides permissions for the gateway to access Amazon Web Services services.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
protocolType
The protocol type for the gateway.
- Parameters:
protocolType
- The protocol type for the gateway.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
protocolType
The protocol type for the gateway.
- Parameters:
protocolType
- The protocol type for the gateway.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
protocolConfiguration
CreateGatewayRequest.Builder protocolConfiguration(GatewayProtocolConfiguration protocolConfiguration) The configuration settings for the protocol specified in the
protocolType
parameter.- Parameters:
protocolConfiguration
- The configuration settings for the protocol specified in theprotocolType
parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
protocolConfiguration
default CreateGatewayRequest.Builder protocolConfiguration(Consumer<GatewayProtocolConfiguration.Builder> protocolConfiguration) The configuration settings for the protocol specified in the
This is a convenience method that creates an instance of theprotocolType
parameter.GatewayProtocolConfiguration.Builder
avoiding the need to create one manually viaGatewayProtocolConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toprotocolConfiguration(GatewayProtocolConfiguration)
.- Parameters:
protocolConfiguration
- a consumer that will call methods onGatewayProtocolConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
authorizerType
The type of authorizer to use for the gateway.
- Parameters:
authorizerType
- The type of authorizer to use for the gateway.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
authorizerType
The type of authorizer to use for the gateway.
- Parameters:
authorizerType
- The type of authorizer to use for the gateway.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
authorizerConfiguration
CreateGatewayRequest.Builder authorizerConfiguration(AuthorizerConfiguration authorizerConfiguration) The authorizer configuration for the gateway.
- Parameters:
authorizerConfiguration
- The authorizer configuration for the gateway.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
authorizerConfiguration
default CreateGatewayRequest.Builder authorizerConfiguration(Consumer<AuthorizerConfiguration.Builder> authorizerConfiguration) The authorizer configuration for the gateway.
This is a convenience method that creates an instance of theAuthorizerConfiguration.Builder
avoiding the need to create one manually viaAuthorizerConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toauthorizerConfiguration(AuthorizerConfiguration)
.- Parameters:
authorizerConfiguration
- a consumer that will call methods onAuthorizerConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
kmsKeyArn
The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway.
- Parameters:
kmsKeyArn
- The Amazon Resource Name (ARN) of the KMS key used to encrypt data associated with the gateway.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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:
-
-
tags
A map of key-value pairs to associate with the gateway as metadata tags.
- Parameters:
tags
- A map of key-value pairs to associate with the gateway as metadata tags.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateGatewayRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateGatewayRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-