| Package | Description |
|---|---|
| software.amazon.awscdk.services.apigateway |
Amazon API Gateway Construct Library
|
| Modifier and Type | Method and Description |
|---|---|
Stage.Builder |
Stage.Builder.accessLogDestination(IAccessLogDestination accessLogDestination)
The CloudWatch Logs log group.
|
Stage.Builder |
Stage.Builder.accessLogFormat(AccessLogFormat accessLogFormat)
A single line format of access logs of data, as specified by selected $content variables.
|
Stage.Builder |
Stage.Builder.cacheClusterEnabled(Boolean cacheClusterEnabled)
Indicates whether cache clustering is enabled for the stage.
|
Stage.Builder |
Stage.Builder.cacheClusterSize(String cacheClusterSize)
The stage's cache cluster size.
|
Stage.Builder |
Stage.Builder.cacheDataEncrypted(Boolean cacheDataEncrypted)
Indicates whether the cached responses are encrypted.
|
Stage.Builder |
Stage.Builder.cacheTtl(Duration cacheTtl)
Specifies the time to live (TTL), in seconds, for cached responses.
|
Stage.Builder |
Stage.Builder.cachingEnabled(Boolean cachingEnabled)
Specifies whether responses should be cached and returned for requests.
|
Stage.Builder |
Stage.Builder.clientCertificateId(String clientCertificateId)
The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
|
static Stage.Builder |
Stage.Builder.create(software.constructs.Construct scope,
String id) |
Stage.Builder |
Stage.Builder.dataTraceEnabled(Boolean dataTraceEnabled)
Specifies whether data trace logging is enabled for this method.
|
Stage.Builder |
Stage.Builder.deployment(Deployment deployment)
The deployment that this stage points to [disable-awslint:ref-via-interface].
|
Stage.Builder |
Stage.Builder.description(String description)
A description of the purpose of the stage.
|
Stage.Builder |
Stage.Builder.documentationVersion(String documentationVersion)
The version identifier of the API documentation snapshot.
|
Stage.Builder |
Stage.Builder.loggingLevel(MethodLoggingLevel loggingLevel)
Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
|
Stage.Builder |
Stage.Builder.methodOptions(Map<String,? extends MethodDeploymentOptions> methodOptions)
Method deployment options for specific resources/methods.
|
Stage.Builder |
Stage.Builder.metricsEnabled(Boolean metricsEnabled)
Specifies whether Amazon CloudWatch metrics are enabled for this method.
|
Stage.Builder |
Stage.Builder.stageName(String stageName)
The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
|
Stage.Builder |
Stage.Builder.throttlingBurstLimit(Number throttlingBurstLimit)
Specifies the throttling burst limit.
|
Stage.Builder |
Stage.Builder.throttlingRateLimit(Number throttlingRateLimit)
Specifies the throttling rate limit.
|
Stage.Builder |
Stage.Builder.tracingEnabled(Boolean tracingEnabled)
Specifies whether Amazon X-Ray tracing is enabled for this method.
|
Stage.Builder |
Stage.Builder.variables(Map<String,String> variables)
A map that defines the stage variables.
|
Copyright © 2022. All rights reserved.