Interface CreateStageRequest.Builder

All Superinterfaces:
ApiGatewayV2Request.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateStageRequest.Builder,CreateStageRequest>, SdkBuilder<CreateStageRequest.Builder,CreateStageRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateStageRequest

public static interface CreateStageRequest.Builder extends ApiGatewayV2Request.Builder, SdkPojo, CopyableBuilder<CreateStageRequest.Builder,CreateStageRequest>
  • Method Details

    • accessLogSettings

      CreateStageRequest.Builder accessLogSettings(AccessLogSettings accessLogSettings)

      Settings for logging access in this stage.

      Parameters:
      accessLogSettings - Settings for logging access in this stage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • accessLogSettings

      default CreateStageRequest.Builder accessLogSettings(Consumer<AccessLogSettings.Builder> accessLogSettings)

      Settings for logging access in this stage.

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

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

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

      The API identifier.

      Parameters:
      apiId - The API identifier.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • autoDeploy

      CreateStageRequest.Builder autoDeploy(Boolean autoDeploy)

      Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

      Parameters:
      autoDeploy - Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • clientCertificateId

      CreateStageRequest.Builder clientCertificateId(String clientCertificateId)

      The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

      Parameters:
      clientCertificateId - The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • defaultRouteSettings

      CreateStageRequest.Builder defaultRouteSettings(RouteSettings defaultRouteSettings)

      The default route settings for the stage.

      Parameters:
      defaultRouteSettings - The default route settings for the stage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • defaultRouteSettings

      default CreateStageRequest.Builder defaultRouteSettings(Consumer<RouteSettings.Builder> defaultRouteSettings)

      The default route settings for the stage.

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

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

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

      CreateStageRequest.Builder deploymentId(String deploymentId)

      The deployment identifier of the API stage.

      Parameters:
      deploymentId - The deployment identifier of the API stage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • description

      CreateStageRequest.Builder description(String description)

      The description for the API stage.

      Parameters:
      description - The description for the API stage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • routeSettings

      CreateStageRequest.Builder routeSettings(Map<String,RouteSettings> routeSettings)

      Route settings for the stage, by routeKey.

      Parameters:
      routeSettings - Route settings for the stage, by routeKey.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • stageName

      CreateStageRequest.Builder stageName(String stageName)

      The name of the stage.

      Parameters:
      stageName - The name of the stage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • stageVariables

      CreateStageRequest.Builder stageVariables(Map<String,String> stageVariables)

      A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

      Parameters:
      stageVariables - A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • tags

      The collection of tags. Each tag element is associated with a given resource.

      Parameters:
      tags - The collection of tags. Each tag element is associated with a given resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • overrideConfiguration

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

      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.