Interface StageProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
,MethodDeploymentOptions
,StageOptions
- All Known Implementing Classes:
StageProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
date="2025-02-06T22:15:48.794Z")
@Stability(Stable)
public interface StageProps
extends software.amazon.jsii.JsiiSerializable, StageOptions
Example:
// production stage LogGroup prodLogGroup = new LogGroup(this, "PrdLogs"); RestApi api = RestApi.Builder.create(this, "books") .deployOptions(StageOptions.builder() .accessLogDestination(new LogGroupLogDestination(prodLogGroup)) .accessLogFormat(AccessLogFormat.jsonWithStandardFields()) .build()) .build(); Deployment deployment = Deployment.Builder.create(this, "Deployment").api(api).build(); // development stage LogGroup devLogGroup = new LogGroup(this, "DevLogs"); Stage.Builder.create(this, "dev") .deployment(deployment) .accessLogDestination(new LogGroupLogDestination(devLogGroup)) .accessLogFormat(AccessLogFormat.jsonWithStandardFields(JsonWithStandardFieldProps.builder() .caller(false) .httpMethod(true) .ip(true) .protocol(true) .requestTime(true) .resourcePath(true) .responseLength(true) .status(true) .user(true) .build())) .build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forStageProps
static final class
An implementation forStageProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic StageProps.Builder
builder()
The deployment that this stage points to [disable-awslint:ref-via-interface].Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
Methods inherited from interface software.amazon.awscdk.services.apigateway.MethodDeploymentOptions
getCacheDataEncrypted, getCacheTtl, getCachingEnabled, getDataTraceEnabled, getLoggingLevel, getMetricsEnabled, getThrottlingBurstLimit, getThrottlingRateLimit
Methods inherited from interface software.amazon.awscdk.services.apigateway.StageOptions
getAccessLogDestination, getAccessLogFormat, getCacheClusterEnabled, getCacheClusterSize, getClientCertificateId, getDescription, getDocumentationVersion, getMethodOptions, getStageName, getTracingEnabled, getVariables
-
Method Details
-
getDeployment
The deployment that this stage points to [disable-awslint:ref-via-interface]. -
builder
- Returns:
- a
StageProps.Builder
ofStageProps
-