Update integ test and stage name description

aws · Mar 15, 2024 · 00306b6 · 00306b6
1 parent bade9dc
commit 00306b6
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 154 deletions.
diff --git a/....import-deploymentstage.js.snapshot/integtest-restapi-import-deployment-stage.assets.json b/....import-deploymentstage.js.snapshot/integtest-restapi-import-deployment-stage.assets.json
diff --git a/...mport-deploymentstage.js.snapshot/integtest-restapi-import-deployment-stage.template.json b/...mport-deploymentstage.js.snapshot/integtest-restapi-import-deployment-stage.template.json
@@ -6,30 +6,6 @@
     "Name": "my-api"
    }
   },
-  "myapiDeployment92F2CB4972a890db5063ec679071ba7eefc76f2a": {
-   "Type": "AWS::ApiGateway::Deployment",
-   "Properties": {
-    "Description": "Automatically created by the RestApi construct",
-    "RestApiId": {
-     "Ref": "myapi4C7BF186"
-    }
-   },
-   "DependsOn": [
-    "myapiGETF990CE3C"
-   ]
-  },
-  "myapiDeploymentStagedevB1704B15": {
-   "Type": "AWS::ApiGateway::Stage",
-   "Properties": {
-    "DeploymentId": {
-     "Ref": "myapiDeployment92F2CB4972a890db5063ec679071ba7eefc76f2a"
-    },
-    "RestApiId": {
-     "Ref": "myapi4C7BF186"
-    },
-    "StageName": "dev"
-   }
-  },
   "myapiGETF990CE3C": {
    "Type": "AWS::ApiGateway::Method",
    "Properties": {
@@ -49,46 +25,19 @@
     }
    }
   },
-  "MyDeployment74F2406B6f3141cef1e8fea8ab3b3b8bc90df36d": {
+  "MyManualDeployment92F2175C6f3141cef1e8fea8ab3b3b8bc90df36d": {
    "Type": "AWS::ApiGateway::Deployment",
    "Properties": {
     "RestApiId": {
      "Ref": "myapi4C7BF186"
-    }
+    },
+    "StageName": "myStage"
    },
    "DependsOn": [
     "myapiGETF990CE3C"
    ]
   }
  },
- "Outputs": {
-  "myapiEndpoint3628AFE3": {
-   "Value": {
-    "Fn::Join": [
-     "",
-     [
-      "https://",
-      {
-       "Ref": "myapi4C7BF186"
-      },
-      ".execute-api.",
-      {
-       "Ref": "AWS::Region"
-      },
-      ".",
-      {
-       "Ref": "AWS::URLSuffix"
-      },
-      "/",
-      {
-       "Ref": "myapiDeploymentStagedevB1704B15"
-      },
-      "/"
-     ]
-    ]
-   }
-  }
- },
  "Parameters": {
   "BootstrapVersion": {
    "Type": "AWS::SSM::Parameter::Value<String>",

diff --git a/...g/test/aws-apigateway/test/integ.restapi.import-deploymentstage.js.snapshot/manifest.json b/...g/test/aws-apigateway/test/integ.restapi.import-deploymentstage.js.snapshot/manifest.json
diff --git a/...integ/test/aws-apigateway/test/integ.restapi.import-deploymentstage.js.snapshot/tree.json b/...integ/test/aws-apigateway/test/integ.restapi.import-deploymentstage.js.snapshot/tree.json
diff --git a/...-testing/framework-integ/test/aws-apigateway/test/integ.restapi.import-deploymentstage.ts b/...-testing/framework-integ/test/aws-apigateway/test/integ.restapi.import-deploymentstage.ts
@@ -6,16 +6,14 @@ const app = new cdk.App();
 const stack = new cdk.Stack(app, 'integtest-restapi-import-deployment-stage');
 
 const api = new apigateway.RestApi(stack, 'my-api', {
-  deployOptions: {
-    stageName: 'dev',
-  },
+  deploy: false,
 });
 api.root.addMethod('GET');
 
 // Create a new deployment that uses existing stage
-new apigateway.Deployment(stack, 'MyDeployment', {
+new apigateway.Deployment(stack, 'MyManualDeployment', {
   api: api,
-  stageName: 'dev',
+  stageName: 'myStage',
 });
 
 new integ.IntegTest(app, 'restapi-import-deployment-stage', {

diff --git a/packages/aws-cdk-lib/aws-apigateway/lib/deployment.ts b/packages/aws-cdk-lib/aws-apigateway/lib/deployment.ts
@@ -28,9 +28,9 @@ export interface DeploymentProps {
   readonly retainDeployments?: boolean;
 
   /**
-   * The stage of the API Gateway deployment.
+   * The name of the stage the API Gateway deployment deploys to.
    *
-   * @default - If `stageName` is not specified, a "prod" stage will be automatically created for the API Gateway deployment.
+   * @default - No stage name.
    */
   readonly stageName?: string;
 }