AwsApiGatewayV2StageDetails
Contains information about a version 2 stage for Amazon API Gateway.
Contents
- AccessLogSettings
-
Information about settings for logging access for the stage.
Type: AwsApiGatewayAccessLogSettings object
Required: No
- ApiGatewayManaged
-
Indicates whether the stage is managed by API Gateway.
Type: Boolean
Required: No
- AutoDeploy
-
Indicates whether updates to an API automatically trigger a new deployment.
Type: Boolean
Required: No
- ClientCertificateId
-
The identifier of a client certificate for a stage. Supported only for WebSocket API calls.
Type: String
Pattern:
.*\S.*
Required: No
- CreatedDate
-
Indicates when the stage was created.
For more information about the validation and formatting of timestamp fields in AWS Security Hub, see Timestamps.
Type: String
Pattern:
.*\S.*
Required: No
- DefaultRouteSettings
-
Default route settings for the stage.
Type: AwsApiGatewayV2RouteSettings object
Required: No
- DeploymentId
-
The identifier of the deployment that the stage is associated with.
Type: String
Pattern:
.*\S.*
Required: No
- Description
-
The description of the stage.
Type: String
Pattern:
.*\S.*
Required: No
- LastDeploymentStatusMessage
-
The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.
Type: String
Pattern:
.*\S.*
Required: No
- LastUpdatedDate
-
Indicates when the stage was most recently updated.
For more information about the validation and formatting of timestamp fields in AWS Security Hub, see Timestamps.
Type: String
Pattern:
.*\S.*
Required: No
- RouteSettings
-
The route settings for the stage.
Type: AwsApiGatewayV2RouteSettings object
Required: No
- StageName
-
The name of the stage.
Type: String
Pattern:
.*\S.*
Required: No
- StageVariables
-
A map that defines the stage variables for the stage.
Variable names can have alphanumeric and underscore characters.
Variable values can contain the following characters:
-
Uppercase and lowercase letters
-
Numbers
-
Special characters -._~:/?#&=,
Type: String to string map
Key Pattern:
.*\S.*
Value Pattern:
.*\S.*
Required: No
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: