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.50.0 (build d1830a4)",
           date="2022-01-04T15:39:01.846Z")
 @Stability(value=Experimental)
public interface StageProps
extends software.amazon.jsii.JsiiSerializable, StageOptions

Example:

 DomainName domain;
 RestApi restapi;
 Deployment betaDeploy = Deployment.Builder.create(this, "beta-deployment")
         .api(restapi)
         .build();
 Stage betaStage = Stage.Builder.create(this, "beta-stage")
         .deployment(betaDeploy)
         .build();
 domain.addBasePathMapping(restapi, BasePathMappingOptions.builder().basePath("api/beta").stage(betaStage).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() (experimental) 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=Experimental)
 @NotNull
Deployment getDeployment()

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

builder

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

Specified by:

builder in interface MethodDeploymentOptions

Specified by:

builder in interface StageOptions

Returns:

a StageProps.Builder of StageProps