Package software.amazon.awscdk.services.apigatewayv2

Class WebSocketStageProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.apigatewayv2.WebSocketStageProps.Jsii$Proxy
All Implemented Interfaces:
StageOptions, WebSocketStageProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
WebSocketStageProps
@Stability(Stable) @Internal public static final class WebSocketStageProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements WebSocketStageProps
An implementation for WebSocketStageProps

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(WebSocketStageProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the WebSocketStageProps.Builder.

  • Method Details

    • getStageName

      public final String getStageName()
      Description copied from interface: WebSocketStageProps
      The name of the stage.
      Specified by:
      getStageName in interface WebSocketStageProps

    • getWebSocketApi

      public final IWebSocketApi getWebSocketApi()
      Description copied from interface: WebSocketStageProps
      The WebSocket API to which this stage is associated.
      Specified by:
      getWebSocketApi in interface WebSocketStageProps

    • getAccessLogSettings

      public final IAccessLogSettings getAccessLogSettings()
      Description copied from interface: StageOptions
      Settings for access logging.

      Default: - No access logging

      Specified by:
      getAccessLogSettings in interface StageOptions

    • getAutoDeploy

      public final Boolean getAutoDeploy()
      Description copied from interface: StageOptions
      Whether updates to an API automatically trigger a new deployment.

      Default: false

      Specified by:
      getAutoDeploy in interface StageOptions

    • getDescription

      public final String getDescription()
      Description copied from interface: StageOptions
      The description for the API stage.

      Default: - no description

      Specified by:
      getDescription in interface StageOptions

    • getDetailedMetricsEnabled

      public final Boolean getDetailedMetricsEnabled()
      Description copied from interface: StageOptions
      Specifies whether detailed metrics are enabled.

      Default: false

      Specified by:
      getDetailedMetricsEnabled in interface StageOptions

    • getDomainMapping

      public final DomainMappingOptions getDomainMapping()
      Description copied from interface: StageOptions
      The options for custom domain and api mapping.

      Default: - no custom domain and api mapping configuration

      Specified by:
      getDomainMapping in interface StageOptions

    • getStageVariables

      public final Map<String,String> getStageVariables()
      Description copied from interface: StageOptions
      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

      Specified by:
      getStageVariables in interface StageOptions

    • getThrottle

      public final ThrottleSettings getThrottle()
      Description copied from interface: StageOptions
      Throttle settings for the routes of this stage.

      Default: - no throttling configuration

      Specified by:
      getThrottle in interface StageOptions

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object