Description |
String
|
Required: No. A description of the purpose of the API Gateway deployment.Update requires: No interruption |
RestApiId |
String
|
Required: Yes. The ID of the RestApi resource to deploy.Update requires: Replacement |
StageDescription |
AmazonAPIGatewayDeploymentStageDescription
|
Required: No. Configures the stage that API Gateway creates with this deployment.NoteWe recommend that you use the AWS::ApiGateway::Stage resource to create and associate a stage with this deployment instead of using this property to configure a stage. If you use this property, you tie this stage to this deployment, which means you can't delete one without deleting the other. For example, if you delete this deployment, API Gateway also deletes this stage, which you might want to keep. By using the
AWS::ApiGateway::Stage resource, you avoid tying your stage to this deployment.Update requires: No interruption |
StageName |
String
|
Required: Yes. A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters.NoteThis property is required by API Gateway. We recommend that you specify a name using any value (see Examples) and that you don't use this stage. We recommend not using this stage because it is tied to this deployment, which means you can't delete one without deleting the other. For example, if you delete this deployment, API Gateway also deletes this stage, which you might want to keep. Instead, use the AWS::ApiGateway::Stage resource to create and associate a stage with this deployment.Update requires: No interruption |