Class: Stage

ApiGateway.Stage

new Stage()

Properties:
Name Type Description
CacheClusterEnabled Boolean Required: No. Indicates whether cache clustering is enabled for the stage.Update requires: No interruption
CacheClusterSize String Required: No. The stage's cache cluster size.Update requires: No interruption
ClientCertificateId String Required: No. The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.Update requires: No interruption
DeploymentId String Required: Yes. The ID of the deployment that the stage points to.Update requires: No interruption
Description String Required: No. A description of the stage's purpose.Update requires: No interruption
MethodSettings AmazonAPIGatewayStageMethodSetting Required: No. Settings for all methods in the stage.Update requires: No interruption
RestApiId String Required: Yes. The ID of the RestApi resource that you're deploying with this stage.Update requires: Replacement
StageName String Required: Yes. The name of the stage, which API Gateway uses as the first path segment in the invoke Uniform Resource Identifier (URI).Update requires: Replacement
Variables Map Required: No. A map (string to string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.Update requires: No interruption
Source:

Extends

  • WKResource

ApiGateway.Stage

new Stage()

Properties:
Name Type Description
CacheClusterEnabled Boolean Required: No. Indicates whether cache clustering is enabled for the stage.Update requires: No interruption
CacheClusterSize String Required: No. The stage's cache cluster size.Update requires: No interruption
ClientCertificateId String Required: No. The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.Update requires: No interruption
DeploymentId String Required: Yes. The ID of the deployment that the stage points to.Update requires: No interruption
Description String Required: No. A description of the stage's purpose.Update requires: No interruption
MethodSettings AmazonAPIGatewayStageMethodSetting Required: No. Settings for all methods in the stage.Update requires: No interruption
RestApiId String Required: Yes. The ID of the RestApi resource that you're deploying with this stage.Update requires: Replacement
StageName String Required: Yes. The name of the stage, which API Gateway uses as the first path segment in the invoke Uniform Resource Identifier (URI).Update requires: Replacement
Variables Map Required: No. A map (string to string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.Update requires: No interruption
Source:

Extends

  • WKResource