Stage class

Represents an API stage.

Constructors

Stage({required String stageName, AccessLogSettings? accessLogSettings, bool? apiGatewayManaged, bool? autoDeploy, String? clientCertificateId, DateTime? createdDate, RouteSettings? defaultRouteSettings, String? deploymentId, String? description, String? lastDeploymentStatusMessage, DateTime? lastUpdatedDate, Map<String, RouteSettings>? routeSettings, Map<String, String>? stageVariables, Map<String, String>? tags})
Stage.fromJson(Map<String, dynamic> json)
factory

Properties

accessLogSettings AccessLogSettings?
Settings for logging access in this stage.
final
apiGatewayManaged bool?
Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
final
autoDeploy bool?
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
final
clientCertificateId String?
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
final
createdDate DateTime?
The timestamp when the stage was created.
final
defaultRouteSettings RouteSettings?
Default route settings for the stage.
final
deploymentId String?
The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
final
description String?
The description of the stage.
final
hashCode int
The hash code for this object.
no setterinherited
lastDeploymentStatusMessage String?
Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
final
lastUpdatedDate DateTime?
The timestamp when the stage was last updated.
final
routeSettings Map<String, RouteSettings>?
Route settings for the stage, by routeKey.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
stageName String
The name of the stage.
final
stageVariables Map<String, String>?
A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match A-Za-z0-9-._~:/?#&amp;=,+.
final
tags Map<String, String>?
The collection of tags. Each tag element is associated with a given resource.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited