Interface EndpointConfig.Builder

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

  • Method Details

    • endpointName

      EndpointConfig.Builder endpointName(String endpointName)

      The name of the endpoint. The name can contain letters, numbers, hyphens (-), and underscores (_), and can't begin or end with a hyphen or an underscore. The length constraint applies only to the full ARN. If you specify only the endpoint name, it is limited to 64 characters in length.

      Parameters:
      endpointName - The name of the endpoint. The name can contain letters, numbers, hyphens (-), and underscores (_), and can't begin or end with a hyphen or an underscore. The length constraint applies only to the full ARN. If you specify only the endpoint name, it is limited to 64 characters in length.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      EndpointConfig.Builder description(String description)

      A description of the endpoint.

      Parameters:
      description - A description of the endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endpointType

      EndpointConfig.Builder endpointType(String endpointType)

      The type of endpoint. Determines how traffic is served and routed across Regions.

      Parameters:
      endpointType - The type of endpoint. Determines how traffic is served and routed across Regions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • endpointType

      EndpointConfig.Builder endpointType(EndpointType endpointType)

      The type of endpoint. Determines how traffic is served and routed across Regions.

      Parameters:
      endpointType - The type of endpoint. Determines how traffic is served and routed across Regions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authType

      EndpointConfig.Builder authType(String authType)

      The authorization type for the endpoint.

      Parameters:
      authType - The authorization type for the endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • authType

      EndpointConfig.Builder authType(AuthType authType)

      The authorization type for the endpoint.

      Parameters:
      authType - The authorization type for the endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • autoDeploymentMode

      EndpointConfig.Builder autoDeploymentMode(String autoDeploymentMode)

      The auto-deployment mode for the endpoint. If you don't specify a value, the default is Disabled , and this default is returned in the response.

      Parameters:
      autoDeploymentMode - The auto-deployment mode for the endpoint. If you don't specify a value, the default is Disabled, and this default is returned in the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • autoDeploymentMode

      EndpointConfig.Builder autoDeploymentMode(AutoDeploymentMode autoDeploymentMode)

      The auto-deployment mode for the endpoint. If you don't specify a value, the default is Disabled , and this default is returned in the response.

      Parameters:
      autoDeploymentMode - The auto-deployment mode for the endpoint. If you don't specify a value, the default is Disabled, and this default is returned in the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • regions

      EndpointConfig.Builder regions(Collection<String> regions)

      The list of Regions for the endpoint. Required when the endpoint type is MultiRegion or PerRegion: specify at least one Region other than the Region where you create the endpoint (the home Region). The home Region is added automatically if you don't include it; specifying only the home Region isn't allowed. When the endpoint type is HomeRegion, omit this field or specify only the home Region.

      Parameters:
      regions - The list of Regions for the endpoint. Required when the endpoint type is MultiRegion or PerRegion: specify at least one Region other than the Region where you create the endpoint (the home Region). The home Region is added automatically if you don't include it; specifying only the home Region isn't allowed. When the endpoint type is HomeRegion, omit this field or specify only the home Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • regions

      EndpointConfig.Builder regions(String... regions)

      The list of Regions for the endpoint. Required when the endpoint type is MultiRegion or PerRegion: specify at least one Region other than the Region where you create the endpoint (the home Region). The home Region is added automatically if you don't include it; specifying only the home Region isn't allowed. When the endpoint type is HomeRegion, omit this field or specify only the home Region.

      Parameters:
      regions - The list of Regions for the endpoint. Required when the endpoint type is MultiRegion or PerRegion: specify at least one Region other than the Region where you create the endpoint (the home Region). The home Region is added automatically if you don't include it; specifying only the home Region isn't allowed. When the endpoint type is HomeRegion, omit this field or specify only the home Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scalingConfig

      EndpointConfig.Builder scalingConfig(ScalingConfig scalingConfig)

      The scaling configuration for the endpoint.

      Parameters:
      scalingConfig - The scaling configuration for the endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scalingConfig

      default EndpointConfig.Builder scalingConfig(Consumer<ScalingConfig.Builder> scalingConfig)

      The scaling configuration for the endpoint.

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

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

      Parameters:
      scalingConfig - a consumer that will call methods on ScalingConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • throttleConfig

      EndpointConfig.Builder throttleConfig(ThrottleConfig throttleConfig)

      The throttling configuration for the endpoint.

      Parameters:
      throttleConfig - The throttling configuration for the endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • throttleConfig

      default EndpointConfig.Builder throttleConfig(Consumer<ThrottleConfig.Builder> throttleConfig)

      The throttling configuration for the endpoint.

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

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

      Parameters:
      throttleConfig - a consumer that will call methods on ThrottleConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: