software.amazon.awscdk.services.apigateway

Interface StageOptions

All Superinterfaces:

MethodDeploymentOptions

All Known Subinterfaces:

StageProps

All Known Implementing Classes:

StageOptions.Jsii$Proxy, StageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:45.466Z")
public interface StageOptions
extends 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 java.lang.Boolean	getCacheClusterEnabled() Indicates whether cache clustering is enabled for the stage.
default java.lang.String	getCacheClusterSize() The stage's cache cluster size.
default java.lang.String	getClientCertificateId() The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
default java.lang.String	getDescription() A description of the purpose of the stage.
default java.lang.String	getDocumentationVersion() The version identifier of the API documentation snapshot.
default java.util.Map<java.lang.String,MethodDeploymentOptions>	getMethodOptions() Method deployment options for specific resources/methods.
default java.lang.String	getStageName() The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
default java.lang.Boolean	getTracingEnabled() Specifies whether Amazon X-Ray tracing is enabled for this method.
default java.util.Map<java.lang.String,java.lang.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

Method Detail

getAccessLogDestination

default IAccessLogDestination getAccessLogDestination()

The CloudWatch Logs log group.

Default: - No destination

getAccessLogFormat

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

default java.lang.Boolean getCacheClusterEnabled()

Indicates whether cache clustering is enabled for the stage.

Default: - Disabled for the stage.

getCacheClusterSize

default java.lang.String getCacheClusterSize()

The stage's cache cluster size.

Default: 0.5

getClientCertificateId

default java.lang.String getClientCertificateId()

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

Default: - None.

getDescription

default java.lang.String getDescription()

A description of the purpose of the stage.

Default: - No description.

getDocumentationVersion

default java.lang.String getDocumentationVersion()

The version identifier of the API documentation snapshot.

Default: - No documentation version.

getMethodOptions

default java.util.Map<java.lang.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

default java.lang.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

default java.lang.Boolean getTracingEnabled()

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

Default: false

getVariables

default java.util.Map<java.lang.String,java.lang.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

static StageOptions.Builder builder()

Specified by:

builder in interface MethodDeploymentOptions

Returns:

a StageOptions.Builder of StageOptions