Interface CreateGatewayRequest.Builder

All Superinterfaces:
AwsRequest.Builder, BedrockAgentCoreControlRequest.Builder, Buildable, CopyableBuilder<CreateGatewayRequest.Builder,CreateGatewayRequest>, SdkBuilder<CreateGatewayRequest.Builder,CreateGatewayRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateGatewayRequest
@Mutable @NotThreadSafe public static interface CreateGatewayRequest.Builder extends BedrockAgentCoreControlRequest.Builder, SdkPojo, CopyableBuilder<CreateGatewayRequest.Builder,CreateGatewayRequest>

  • Method Details

    • name

      CreateGatewayRequest.Builder name(String 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

      CreateGatewayRequest.Builder description(String 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

      CreateGatewayRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't 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 you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't 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

      CreateGatewayRequest.Builder roleArn(String 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

      CreateGatewayRequest.Builder protocolType(String 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

      CreateGatewayRequest.Builder protocolType(GatewayProtocolType 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 the protocolType 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 protocolType parameter.

      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:

    • authorizerType

      CreateGatewayRequest.Builder authorizerType(String authorizerType)

      The type of authorizer to use for the gateway.

      • CUSTOM_JWT - Authorize with a bearer token.

      • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

      Parameters:
      authorizerType - The type of authorizer to use for the gateway.

      • CUSTOM_JWT - Authorize with a bearer token.

      • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

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

    • authorizerType

      CreateGatewayRequest.Builder authorizerType(AuthorizerType authorizerType)

      The type of authorizer to use for the gateway.

      • CUSTOM_JWT - Authorize with a bearer token.

      • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

      Parameters:
      authorizerType - The type of authorizer to use for the gateway.

      • CUSTOM_JWT - Authorize with a bearer token.

      • AWS_IAM - Authorize with your Amazon Web Services IAM credentials.

      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. Required if authorizerType is CUSTOM_JWT.

      Parameters:
      authorizerConfiguration - The authorizer configuration for the gateway. Required if authorizerType is CUSTOM_JWT.
      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. Required if authorizerType is CUSTOM_JWT.

      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:

    • kmsKeyArn

      CreateGatewayRequest.Builder kmsKeyArn(String 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

      CreateGatewayRequest.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

      CreateGatewayRequest.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:

    • tags

      CreateGatewayRequest.Builder tags(Map<String,String> 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 interface AwsRequest.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 interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.