Interface StageOptions
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
,MethodDeploymentOptions
- All Known Subinterfaces:
StageProps
- All Known Implementing Classes:
StageOptions.Jsii$Proxy
,StageProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:45.095Z")
@Stability(Stable)
public interface StageOptions
extends software.amazon.jsii.JsiiSerializable, MethodDeploymentOptions
Example:
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();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forStageOptions
static final class
An implementation forStageOptions
-
Method Summary
Modifier and TypeMethodDescriptionstatic StageOptions.Builder
builder()
default IAccessLogDestination
The CloudWatch Logs log group.default AccessLogFormat
A single line format of access logs of data, as specified by selected $content variables.default Boolean
Indicates whether cache clustering is enabled for the stage.default String
The stage's cache cluster size.default String
The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.default String
A description of the purpose of the stage.default String
The version identifier of the API documentation snapshot.default Map<String,
MethodDeploymentOptions> Method deployment options for specific resources/methods.default String
The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).default Boolean
Specifies whether Amazon X-Ray tracing is enabled for this method.A map that defines the stage variables.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
-
Method Details
-
getAccessLogDestination
The CloudWatch Logs log group.Default: - No destination
-
getAccessLogFormat
A single line format of access logs of data, as specified by selected $content variables.The format must include at least
AccessLogFormat.contextRequestId()
.Default: - Common Log Format
- See Also:
-
getCacheClusterEnabled
Indicates whether cache clustering is enabled for the stage.Default: - Disabled for the stage.
-
getCacheClusterSize
The stage's cache cluster size.Default: 0.5
-
getClientCertificateId
The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.Default: - None.
-
getDescription
A description of the purpose of the stage.Default: - No description.
-
getDocumentationVersion
The version identifier of the API documentation snapshot.Default: - No documentation version.
-
getMethodOptions
Method deployment options for specific resources/methods.These will override common options defined in
StageOptions#methodOptions
.Default: - Common options will be used.
-
getStageName
The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).Default: - "prod"
-
getTracingEnabled
Specifies whether Amazon X-Ray tracing is enabled for this method.Default: false
-
getVariables
A map that defines the stage variables.Variable names must consist of alphanumeric characters, and the values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.
Default: - No stage variables.
-
builder
- Returns:
- a
StageOptions.Builder
ofStageOptions
-