Package 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.104.0 (build e79254c)", date="2024-11-06T23:25:03.563Z") @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();

  • Method Details

    • getAccessLogDestination

      @Stability(Stable) @Nullable default IAccessLogDestination getAccessLogDestination()
      The CloudWatch Logs log group or Firehose delivery stream where to write access logs.

      Default: - No destination

    • getAccessLogFormat

      @Stability(Stable) @Nullable default AccessLogFormat getAccessLogFormat()
      A single line format of access logs of data, as specified by selected $content variables.

      The format must include either AccessLogFormat.contextRequestId() or AccessLogFormat.contextExtendedRequestId().

      Default: - Common Log Format

      See Also:

    • getCacheClusterEnabled

      @Stability(Stable) @Nullable default Boolean getCacheClusterEnabled()
      Indicates whether cache clustering is enabled for the stage.

      Default: - Disabled for the stage.

    • getCacheClusterSize

      @Stability(Stable) @Nullable default String getCacheClusterSize()
      The stage's cache cluster size.

      Default: 0.5

    • getClientCertificateId

      @Stability(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(Stable) @Nullable default String getDescription()
      A description of the purpose of the stage.

      Default: - No description.

    • getDocumentationVersion

      @Stability(Stable) @Nullable default String getDocumentationVersion()
      The version identifier of the API documentation snapshot.

      Default: - No documentation version.

    • getMethodOptions

      @Stability(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(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(Stable) @Nullable default Boolean getTracingEnabled()
      Specifies whether Amazon X-Ray tracing is enabled for this method.

      Default: false

    • getVariables

      @Stability(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(Stable) static StageOptions.Builder builder()
      Returns:
      a StageOptions.Builder of StageOptions