Package software.amazon.awscdk.services.apigatewayv2

Class WebSocketStage.Builder

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

  • Method Details

    • create

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

    • accessLogSettings

      @Stability(Stable) public WebSocketStage.Builder accessLogSettings(IAccessLogSettings accessLogSettings)
      Settings for access logging.

      Default: - No access logging

      Parameters:
      accessLogSettings - Settings for access logging. This parameter is required.
      Returns:
      this

    • autoDeploy

      @Stability(Stable) public WebSocketStage.Builder autoDeploy(Boolean autoDeploy)
      Whether updates to an API automatically trigger a new deployment.

      Default: false

      Parameters:
      autoDeploy - Whether updates to an API automatically trigger a new deployment. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public WebSocketStage.Builder description(String description)
      The description for the API stage.

      Default: - no description

      Parameters:
      description - The description for the API stage. This parameter is required.
      Returns:
      this

    • detailedMetricsEnabled

      @Stability(Stable) public WebSocketStage.Builder detailedMetricsEnabled(Boolean detailedMetricsEnabled)
      Specifies whether detailed metrics are enabled.

      Default: false

      Parameters:
      detailedMetricsEnabled - Specifies whether detailed metrics are enabled. This parameter is required.
      Returns:
      this

    • domainMapping

      @Stability(Stable) public WebSocketStage.Builder domainMapping(DomainMappingOptions domainMapping)
      The options for custom domain and api mapping.

      Default: - no custom domain and api mapping configuration

      Parameters:
      domainMapping - The options for custom domain and api mapping. This parameter is required.
      Returns:
      this

    • stageVariables

      @Stability(Stable) public WebSocketStage.Builder stageVariables(Map<String,String> stageVariables)
      Stage variables for the stage. These are key-value pairs that you can define and use in your API routes.

      The allowed characters for variable names and the required pattern for variable values are specified here: https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-apigateway-stage.html#cfn-apigateway-stage-variables

      Default: - No stage variables

      Parameters:
      stageVariables - Stage variables for the stage. These are key-value pairs that you can define and use in your API routes. This parameter is required.
      Returns:
      this

    • throttle

      @Stability(Stable) public WebSocketStage.Builder throttle(ThrottleSettings throttle)
      Throttle settings for the routes of this stage.

      Default: - no throttling configuration

      Parameters:
      throttle - Throttle settings for the routes of this stage. This parameter is required.
      Returns:
      this

    • stageName

      @Stability(Stable) public WebSocketStage.Builder stageName(String stageName)
      The name of the stage.

      Parameters:
      stageName - The name of the stage. This parameter is required.
      Returns:
      this

    • webSocketApi

      @Stability(Stable) public WebSocketStage.Builder webSocketApi(IWebSocketApi webSocketApi)
      The WebSocket API to which this stage is associated.

      Parameters:
      webSocketApi - The WebSocket API to which this stage is associated. This parameter is required.
      Returns:
      this

    • build

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