@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-05-19T23:09:31.639Z") @Stability(value=Stable) public interface StageOptions extends software.amazon.jsii.JsiiSerializable, MethodDeploymentOptions
LogGroup logGroup = new LogGroup(this, "ApiGatewayAccessLogs"); RestApi api = RestApi.Builder.create(this, "books") .deployOptions(StageOptions.builder() .accessLogDestination(new LogGroupLogDestination(logGroup)) .accessLogFormat(AccessLogFormat.clf()) .build()) .build();
Modifier and Type | Interface and Description |
---|---|
static class |
StageOptions.Builder
A builder for
StageOptions |
static class |
StageOptions.Jsii$Proxy
An implementation for
StageOptions |
Modifier and Type | Method and Description |
---|---|
static StageOptions.Builder |
builder() |
default IAccessLogDestination |
getAccessLogDestination()
The CloudWatch Logs log group.
|
default AccessLogFormat |
getAccessLogFormat()
A single line format of access logs of data, as specified by selected $content variables.
|
default Boolean |
getCacheClusterEnabled()
Indicates whether cache clustering is enabled for the stage.
|
default String |
getCacheClusterSize()
The stage's cache cluster size.
|
default String |
getClientCertificateId()
The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
|
default String |
getDescription()
A description of the purpose of the stage.
|
default String |
getDocumentationVersion()
The version identifier of the API documentation snapshot.
|
default Map<String,MethodDeploymentOptions> |
getMethodOptions()
Method deployment options for specific resources/methods.
|
default String |
getStageName()
The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
|
default Boolean |
getTracingEnabled()
Specifies whether Amazon X-Ray tracing is enabled for this method.
|
default Map<String,String> |
getVariables()
A map that defines the stage variables.
|
getCacheDataEncrypted, getCacheTtl, getCachingEnabled, getDataTraceEnabled, getLoggingLevel, getMetricsEnabled, getThrottlingBurstLimit, getThrottlingRateLimit
@Stability(value=Stable) @Nullable default IAccessLogDestination getAccessLogDestination()
Default: - No destination
@Stability(value=Stable) @Nullable default AccessLogFormat getAccessLogFormat()
The format must include at least AccessLogFormat.contextRequestId()
.
Default: - Common Log Format
@Stability(value=Stable) @Nullable default Boolean getCacheClusterEnabled()
Default: - Disabled for the stage.
@Stability(value=Stable) @Nullable default String getCacheClusterSize()
Default: 0.5
@Stability(value=Stable) @Nullable default String getClientCertificateId()
Default: - None.
@Stability(value=Stable) @Nullable default String getDescription()
Default: - No description.
@Stability(value=Stable) @Nullable default String getDocumentationVersion()
Default: - No documentation version.
@Stability(value=Stable) @Nullable default Map<String,MethodDeploymentOptions> getMethodOptions()
These will
override common options defined in StageOptions#methodOptions
.
Default: - Common options will be used.
@Stability(value=Stable) @Nullable default String getStageName()
Default: - "prod"
@Stability(value=Stable) @Nullable default Boolean getTracingEnabled()
Default: false
@Stability(value=Stable) @Nullable default Map<String,String> getVariables()
Variable names must consist of alphanumeric characters, and the values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.
Default: - No stage variables.
@Stability(value=Stable) static StageOptions.Builder builder()
builder
in interface MethodDeploymentOptions
StageOptions.Builder
of StageOptions
Copyright © 2023. All rights reserved.