software.amazon.awscdk.services.apigateway

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.74.0 (build 6d08790)",
           date="2023-05-19T23:09:31.639Z")
 @Stability(value=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 Classes

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

Method Summary

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.

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

getAccessLogDestination

@Stability(value=Stable)
 @Nullable
default IAccessLogDestination getAccessLogDestination()

The CloudWatch Logs log group.

Default: - No destination

getAccessLogFormat

@Stability(value=Stable)
 @Nullable
default AccessLogFormat 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:

https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference

getCacheClusterEnabled

@Stability(value=Stable)
 @Nullable
default Boolean getCacheClusterEnabled()

Indicates whether cache clustering is enabled for the stage.

Default: - Disabled for the stage.

getCacheClusterSize

@Stability(value=Stable)
 @Nullable
default String getCacheClusterSize()

The stage's cache cluster size.

Default: 0.5

getClientCertificateId

@Stability(value=Stable)
 @Nullable
default String getClientCertificateId()

The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.

Default: - None.

getDescription

@Stability(value=Stable)
 @Nullable
default String getDescription()

A description of the purpose of the stage.

Default: - No description.

getDocumentationVersion

@Stability(value=Stable)
 @Nullable
default String getDocumentationVersion()

The version identifier of the API documentation snapshot.

Default: - No documentation version.

getMethodOptions

@Stability(value=Stable)
 @Nullable
default Map<String,MethodDeploymentOptions> getMethodOptions()

Method deployment options for specific resources/methods.

These will override common options defined in StageOptions#methodOptions.

Default: - Common options will be used.

getStageName

@Stability(value=Stable)
 @Nullable
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: - "prod"

getTracingEnabled

@Stability(value=Stable)
 @Nullable
default Boolean getTracingEnabled()

Specifies whether Amazon X-Ray tracing is enabled for this method.

Default: false

getVariables

@Stability(value=Stable)
 @Nullable
default Map<String,String> 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

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

Specified by:

builder in interface MethodDeploymentOptions

Returns:

a StageOptions.Builder of StageOptions