software.amazon.awscdk.services.apigateway

Interface StageProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, MethodDeploymentOptions, StageOptions

All Known Implementing Classes:

StageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.220Z")
 @Stability(value=Stable)
public interface StageProps
extends software.amazon.jsii.JsiiSerializable, StageOptions

Example:

 // production stage
 LogGroup prdLogGroup = new LogGroup(this, "PrdLogs");
 RestApi api = RestApi.Builder.create(this, "books")
         .deployOptions(StageOptions.builder()
                 .accessLogDestination(new LogGroupLogDestination(prdLogGroup))
                 .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 Classes

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

Method Summary

Modifier and Type	Method and Description
static StageProps.Builder	builder()
Deployment	getDeployment() The deployment that this stage points to [disable-awslint:ref-via-interface].

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

getAccessLogDestination, getAccessLogFormat, getCacheClusterEnabled, getCacheClusterSize, getClientCertificateId, getDescription, getDocumentationVersion, getMethodOptions, getStageName, getTracingEnabled, getVariables

Methods inherited from interface software.amazon.awscdk.services.apigateway.MethodDeploymentOptions

getCacheDataEncrypted, getCacheTtl, getCachingEnabled, getDataTraceEnabled, getLoggingLevel, getMetricsEnabled, getThrottlingBurstLimit, getThrottlingRateLimit

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDeployment

@Stability(value=Stable)
 @NotNull
Deployment getDeployment()

The deployment that this stage points to [disable-awslint:ref-via-interface].

builder

@Stability(value=Stable)
static StageProps.Builder builder()

Specified by:

builder in interface MethodDeploymentOptions

Specified by:

builder in interface StageOptions

Returns:

a StageProps.Builder of StageProps