Container for the parameters to the CreateStage operation. Creates a new Stage resource that references a pre-existing Deployment for the API.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.APIGateway.AmazonAPIGatewayRequest
Amazon.APIGateway.Model.CreateStageRequest
Namespace: Amazon.APIGateway.Model
Assembly: AWSSDK.APIGateway.dll
Version: 3.x.y.z
Syntax
public class CreateStageRequest : AmazonAPIGatewayRequest IAmazonWebServiceRequest
The CreateStageRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CreateStageRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
CacheClusterEnabled | System.Boolean |
Gets and sets the property CacheClusterEnabled. Whether cache clustering is enabled for the stage. |
|
|
CacheClusterSize | Amazon.APIGateway.CacheClusterSize |
Gets and sets the property CacheClusterSize. The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness. |
|
|
CanarySettings | Amazon.APIGateway.Model.CanarySettings |
Gets and sets the property CanarySettings. The canary deployment settings of this stage. |
|
|
DeploymentId | System.String |
Gets and sets the property DeploymentId. The identifier of the Deployment resource for the Stage resource. |
|
|
Description | System.String |
Gets and sets the property Description. The description of the Stage resource. |
|
|
DocumentationVersion | System.String |
Gets and sets the property DocumentationVersion. The version of the associated API documentation. |
|
|
RestApiId | System.String |
Gets and sets the property RestApiId. The string identifier of the associated RestApi. |
|
|
StageName | System.String |
Gets and sets the property StageName. The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters. |
|
|
Tags | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property Tags.
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag
key can be up to 128 characters and must not start with |
|
|
TracingEnabled | System.Boolean |
Gets and sets the property TracingEnabled. Specifies whether active tracing with X-ray is enabled for the Stage. |
|
|
Variables | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property Variables.
A map that defines the stage variables for the new Stage resource. Variable names
can have alphanumeric and underscore characters, and the values must match |
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5