Package software.amazon.awscdk.services.bedrockagentcore

Class GatewayTarget.Builder

java.lang.Object
software.amazon.awscdk.services.bedrockagentcore.GatewayTarget.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<GatewayTarget>
Enclosing class:
GatewayTarget
@Stability(Stable) public static final class GatewayTarget.Builder extends Object implements software.amazon.jsii.Builder<GatewayTarget>
A fluent builder for GatewayTarget.

  • Method Details

    • create

      @Stability(Stable) public static GatewayTarget.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of GatewayTarget.Builder.

    • description

      @Stability(Stable) public GatewayTarget.Builder description(String description)
      Optional description for the gateway target The description can have up to 200 characters.

      Default: - No description

      Parameters:
      description - Optional description for the gateway target The description can have up to 200 characters. This parameter is required.
      Returns:
      this

    • gatewayTargetName

      @Stability(Stable) public GatewayTarget.Builder gatewayTargetName(String gatewayTargetName)
      The name of the gateway target The name must be unique within the gateway Pattern: ^([0-9a-zA-Z][-]?){1,100}$.

      Default: - auto generate

      Parameters:
      gatewayTargetName - The name of the gateway target The name must be unique within the gateway Pattern: ^([0-9a-zA-Z][-]?){1,100}$. This parameter is required.
      Returns:
      this

    • gateway

      @Stability(Stable) public GatewayTarget.Builder gateway(IGateway gateway)
      The gateway this target belongs to.

      Parameters:
      gateway - The gateway this target belongs to. This parameter is required.
      Returns:
      this

    • targetConfiguration

      @Stability(Stable) public GatewayTarget.Builder targetConfiguration(ITargetConfiguration targetConfiguration)
      The target configuration (Lambda, OpenAPI, or Smithy) Use one of the configuration helper classes: - LambdaTargetConfiguration.create() - OpenApiTargetConfiguration.create() - SmithyTargetConfiguration.create().

      Parameters:
      targetConfiguration - The target configuration (Lambda, OpenAPI, or Smithy) Use one of the configuration helper classes: - LambdaTargetConfiguration.create() - OpenApiTargetConfiguration.create() - SmithyTargetConfiguration.create(). This parameter is required.
      Returns:
      this

    • credentialProviderConfigurations

      @Stability(Stable) public GatewayTarget.Builder credentialProviderConfigurations(List<? extends ICredentialProviderConfig> credentialProviderConfigurations)
      Credential providers for authentication.

      Default: - [GatewayCredentialProvider.fromIamRole()]

      Parameters:
      credentialProviderConfigurations - Credential providers for authentication. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public GatewayTarget build()
      Specified by:
      build in interface software.amazon.jsii.Builder<GatewayTarget>
      Returns:
      a newly built instance of GatewayTarget.