Package software.amazon.awscdk.services.apigatewayv2

Interface HttpStageProps

All Superinterfaces:

HttpStageOptions, software.amazon.jsii.JsiiSerializable, StageOptions

All Known Implementing Classes:

HttpStageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-05-20T23:52:49.606Z")
@Stability(Stable)
public interface HttpStageProps
extends software.amazon.jsii.JsiiSerializable, HttpStageOptions

Properties to initialize an instance of HttpStage.

Example:

 import software.amazon.awscdk.services.logs.*;
 HttpApi api;
 LogGroup logGroup;
 HttpStage stage = HttpStage.Builder.create(this, "Stage")
         .httpApi(api)
         .accessLogSettings(Map.of(
                 "destination", new LogGroupLogDestination(logGroup)))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	HttpStageProps.Builder	A builder for HttpStageProps
static final class	HttpStageProps.Jsii$Proxy	An implementation for HttpStageProps

Method Summary

Modifier and Type	Method	Description
static HttpStageProps.Builder	builder()
IHttpApi	getHttpApi()	The HTTP API to which this stage is associated.

Methods inherited from interface software.amazon.awscdk.services.apigatewayv2.HttpStageOptions

getStageName

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.apigatewayv2.StageOptions

getAccessLogSettings, getAutoDeploy, getDescription, getDetailedMetricsEnabled, getDomainMapping, getThrottle

Method Details

getHttpApi

@Stability(Stable)
@NotNull
IHttpApi getHttpApi()

The HTTP API to which this stage is associated.

builder

@Stability(Stable)
static HttpStageProps.Builder builder()

Returns:

a HttpStageProps.Builder of HttpStageProps