1.204.0

interface StageProps

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.StageProps
Javasoftware.amazon.awscdk.services.apigateway.StageProps
Pythonaws_cdk.aws_apigateway.StageProps
TypeScript (source)@aws-cdk/aws-apigateway » StageProps

Example

// production stage
const prdLogGroup = new logs.LogGroup(this, "PrdLogs");
const api = new apigateway.RestApi(this, 'books', {
  deployOptions: {
    accessLogDestination: new apigateway.LogGroupLogDestination(prdLogGroup),
    accessLogFormat: apigateway.AccessLogFormat.jsonWithStandardFields()
  }
})
const deployment = new apigateway.Deployment(this, 'Deployment', {api});

// development stage
const devLogGroup = new logs.LogGroup(this, "DevLogs");
new apigateway.Stage(this, 'dev', {
  deployment,
  accessLogDestination: new apigateway.LogGroupLogDestination(devLogGroup),
  accessLogFormat: apigateway.AccessLogFormat.jsonWithStandardFields({
    caller: false,
    httpMethod: true,
    ip: true,
    protocol: true,
    requestTime: true,
    resourcePath: true,
    responseLength: true,
    status: true,
    user: true
  })
});

Properties

NameTypeDescription
deploymentDeploymentThe deployment that this stage points to [disable-awslint:ref-via-interface].
accessLogDestination?IAccessLogDestinationThe CloudWatch Logs log group.
accessLogFormat?AccessLogFormatA single line format of access logs of data, as specified by selected $content variables.
cacheClusterEnabled?booleanIndicates whether cache clustering is enabled for the stage.
cacheClusterSize?stringThe stage's cache cluster size.
cacheDataEncrypted?booleanIndicates whether the cached responses are encrypted.
cacheTtl?DurationSpecifies the time to live (TTL), in seconds, for cached responses.
cachingEnabled?booleanSpecifies whether responses should be cached and returned for requests.
clientCertificateId?stringThe identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
dataTraceEnabled?booleanSpecifies whether data trace logging is enabled for this method.
description?stringA description of the purpose of the stage.
documentationVersion?stringThe version identifier of the API documentation snapshot.
loggingLevel?MethodLoggingLevelSpecifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
methodOptions?{ [string]: MethodDeploymentOptions }Method deployment options for specific resources/methods.
metricsEnabled?booleanSpecifies whether Amazon CloudWatch metrics are enabled for this method.
stageName?stringThe name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
throttlingBurstLimit?numberSpecifies the throttling burst limit.
throttlingRateLimit?numberSpecifies the throttling rate limit.
tracingEnabled?booleanSpecifies whether Amazon X-Ray tracing is enabled for this method.
variables?{ [string]: string }A map that defines the stage variables.

deployment

Type: Deployment

The deployment that this stage points to [disable-awslint:ref-via-interface].

accessLogDestination?

Type: IAccessLogDestination (optional, default: No destination)

The CloudWatch Logs log group.

accessLogFormat?

Type: AccessLogFormat (optional, default: Common Log Format)

A single line format of access logs of data, as specified by selected $content variables.

The format must include at least AccessLogFormat.contextRequestId().

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

cacheClusterEnabled?

Type: boolean (optional, default: Disabled for the stage.)

Indicates whether cache clustering is enabled for the stage.

cacheClusterSize?

Type: string (optional, default: 0.5)

The stage's cache cluster size.

cacheDataEncrypted?

Type: boolean (optional, default: false)

Indicates whether the cached responses are encrypted.

cacheTtl?

Type: Duration (optional, default: Duration.minutes(5))

Specifies the time to live (TTL), in seconds, for cached responses.

The higher the TTL, the longer the response will be cached.

See also: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html

cachingEnabled?

Type: boolean (optional, default: Caching is Disabled.)

Specifies whether responses should be cached and returned for requests.

A cache cluster must be enabled on the stage for responses to be cached.

clientCertificateId?

Type: string (optional, default: None.)

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

dataTraceEnabled?

Type: boolean (optional, default: false)

Specifies whether data trace logging is enabled for this method.

When enabled, API gateway will log the full API requests and responses. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this feature for production APIs.

description?

Type: string (optional, default: No description.)

A description of the purpose of the stage.

documentationVersion?

Type: string (optional, default: No documentation version.)

The version identifier of the API documentation snapshot.

loggingLevel?

Type: MethodLoggingLevel (optional, default: Off)

Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs.

methodOptions?

Type: { [string]: MethodDeploymentOptions } (optional, default: Common options will be used.)

Method deployment options for specific resources/methods.

These will override common options defined in StageOptions#methodOptions.

metricsEnabled?

Type: boolean (optional, default: false)

Specifies whether Amazon CloudWatch metrics are enabled for this method.

stageName?

Type: string (optional, default: "prod")

The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).

throttlingBurstLimit?

Type: number (optional, default: No additional restriction.)

Specifies the throttling burst limit.

The total rate of all requests in your AWS account is limited to 5,000 requests.

See also: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html

throttlingRateLimit?

Type: number (optional, default: No additional restriction.)

Specifies the throttling rate limit.

The total rate of all requests in your AWS account is limited to 10,000 requests per second (rps).

See also: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html

tracingEnabled?

Type: boolean (optional, default: false)

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

variables?

Type: { [string]: string } (optional, default: No stage variables.)

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-._~:/?#&=,]+.

← PreviousNext →