AwsApiGatewayStageDetails
Provides information about a version 1 Amazon API Gateway stage.
Contents
- AccessLogSettings
-
Settings for logging access for the stage.
Type: AwsApiGatewayAccessLogSettings object
Required: No
- CacheClusterEnabled
-
Indicates whether a cache cluster is enabled for the stage.
Type: Boolean
Required: No
- CacheClusterSize
-
If a cache cluster is enabled, the size of the cache cluster.
Type: String
Pattern:
.*\S.*Required: No
- CacheClusterStatus
-
If a cache cluster is enabled, the status of the cache cluster.
Type: String
Pattern:
.*\S.*Required: No
- CanarySettings
-
Information about settings for canary deployment in the stage.
Type: AwsApiGatewayCanarySettings object
Required: No
- ClientCertificateId
-
The identifier of the client certificate for the stage.
Type: String
Pattern:
.*\S.*Required: No
- CreatedDate
-
Indicates when the stage was created.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,2020-03-22T13:22:13.933Z.Type: String
Pattern:
.*\S.*Required: No
- DeploymentId
-
The identifier of the deployment that the stage points to.
Type: String
Pattern:
.*\S.*Required: No
- Description
-
A description of the stage.
Type: String
Pattern:
.*\S.*Required: No
- DocumentationVersion
-
The version of the API documentation that is associated with the stage.
Type: String
Pattern:
.*\S.*Required: No
- LastUpdatedDate
-
Indicates when the stage was most recently updated.
Uses the
date-timeformat specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,2020-03-22T13:22:13.933Z.Type: String
Pattern:
.*\S.*Required: No
- MethodSettings
-
Defines the method settings for the stage.
Type: Array of AwsApiGatewayMethodSettings objects
Required: No
- StageName
-
The name of the stage.
Type: String
Pattern:
.*\S.*Required: No
- TracingEnabled
-
Indicates whether active tracing with Amazon X-Ray is enabled for the stage.
Type: Boolean
Required: No
- Variables
-
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
-
- WebAclArn
-
The ARN of the web ACL associated with the stage.
Type: String
Pattern:
.*\S.*Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: