feat(client-migration-hub-refactor-spaces): This release adds the new API UpdateRoute that allows route to be updated to ACTIVE/INACTIVE state. In addition, CreateRoute API will now allow users to create route in ACTIVE/INACTIVE state.

Author: awstools

clients/client-migration-hub-refactor-spaces/src/MigrationHubRefactorSpaces.ts

@@ -92,6 +92,7 @@ import {
   UntagResourceCommandInput,
   UntagResourceCommandOutput,
 } from "./commands/UntagResourceCommand";
+import { UpdateRouteCommand, UpdateRouteCommandInput, UpdateRouteCommandOutput } from "./commands/UpdateRouteCommand";
 import { MigrationHubRefactorSpacesClient } from "./MigrationHubRefactorSpacesClient";
 
 /**
@@ -184,6 +185,10 @@ export class MigrationHubRefactorSpaces extends MigrationHubRefactorSpacesClient
    *       the application. If an application does not have any routes, then the first route must be
    *       created as a <code>DEFAULT</code>
    *             <code>RouteType</code>.</p>
+   *          <p>When created, the default route defaults to an active state so state is not a required
+   *       input. However, like all other state values the state of the default route can be updated
+   *       after creation, but only when all other routes are also inactive. Conversely, no route can be
+   *       active without the default route also being active.</p>
    *          <p>When you create a route, Refactor Spaces configures the Amazon API Gateway to send traffic
    *       to the target service as follows:</p>
    *          <ul>
@@ -201,24 +206,28 @@ export class MigrationHubRefactorSpaces extends MigrationHubRefactorSpacesClient
    *             API Gateway to invoke the function.</p>
    *             </li>
    *          </ul>
-   *          <p>A one-time health check is performed on the service when the route is created. If the
-   *       health check fails, the route transitions to <code>FAILED</code>, and no traffic is sent to
+   *          <p>A one-time health check is performed on the service when either the route is updated from
+   *       inactive to active, or when it is created with an active state. If the health check fails, the
+   *       route transitions the route state to <code>FAILED</code>, an error code of
+   *         <code>SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE</code> is provided, and no traffic is sent to
    *       the service.</p>
    *          <p>For Lambda functions, the Lambda function state is checked. If the
    *       function is not active, the function configuration is updated so that Lambda
    *       resources are provisioned. If the Lambda state is <code>Failed</code>, then the
    *       route creation fails. For more information, see the <a href="https://docs.aws.amazon.com/lambda/latest/dg/API_GetFunctionConfiguration.html#SSS-GetFunctionConfiguration-response-State">GetFunctionConfiguration's State response parameter</a> in the <i>Lambda Developer Guide</i>.</p>
-   *          <p>For public URLs, a connection is opened to the public endpoint. If the URL is not
-   *       reachable, the health check fails. For private URLs, a target group is created and the target
-   *       group health check is run.</p>
-   *          <p>The <code>HealthCheckProtocol</code>, <code>HealthCheckPort</code>, and
-   *         <code>HealthCheckPath</code> are the same protocol, port, and path specified in the URL or
+   *          <p>For Lambda endpoints, a check is performed to determine that a Lambda function with the
+   *       specified ARN exists. If it does not exist, the health check fails. For public URLs, a
+   *       connection is opened to the public endpoint. If the URL is not reachable, the health check
+   *       fails. </p>
+   *          <p>For private URLS, a target group is created on the Elastic Load Balancing and the target
+   *       group health check is run. The <code>HealthCheckProtocol</code>, <code>HealthCheckPort</code>,
+   *       and <code>HealthCheckPath</code> are the same protocol, port, and path specified in the URL or
    *       health URL, if used. All other settings use the default values, as described in <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-health-checks.html">Health checks
    *         for your target groups</a>. The health check is considered successful if at least one
    *       target within the target group transitions to a healthy state.</p>
    *          <p>Services can have HTTP or HTTPS URL endpoints. For HTTPS URLs, publicly-signed
    *       certificates are supported. Private Certificate Authorities (CAs) are permitted only if the
-   *       CA's domain is publicly resolvable.</p>
+   *       CA's domain is also publicly resolvable.</p>
    */
   public createRoute(args: CreateRouteCommandInput, options?: __HttpHandlerOptions): Promise<CreateRouteCommandOutput>;
   public createRoute(args: CreateRouteCommandInput, cb: (err: any, data?: CreateRouteCommandOutput) => void): void;
@@ -875,4 +884,32 @@ export class MigrationHubRefactorSpaces extends MigrationHubRefactorSpacesClient
       return this.send(command, optionsOrCb);
     }
   }
+
+  /**
+   * <p>
+   *     Updates an Amazon Web Services Migration Hub Refactor Spaces route.
+   *   </p>
+   */
+  public updateRoute(args: UpdateRouteCommandInput, options?: __HttpHandlerOptions): Promise<UpdateRouteCommandOutput>;
+  public updateRoute(args: UpdateRouteCommandInput, cb: (err: any, data?: UpdateRouteCommandOutput) => void): void;
+  public updateRoute(
+    args: UpdateRouteCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: UpdateRouteCommandOutput) => void
+  ): void;
+  public updateRoute(
+    args: UpdateRouteCommandInput,
+    optionsOrCb?: __HttpHandlerOptions | ((err: any, data?: UpdateRouteCommandOutput) => void),
+    cb?: (err: any, data?: UpdateRouteCommandOutput) => void
+  ): Promise<UpdateRouteCommandOutput> | void {
+    const command = new UpdateRouteCommand(args);
+    if (typeof optionsOrCb === "function") {
+      this.send(command, optionsOrCb);
+    } else if (typeof cb === "function") {
+      if (typeof optionsOrCb !== "object") throw new Error(`Expect http options but get ${typeof optionsOrCb}`);
+      this.send(command, optionsOrCb || {}, cb);
+    } else {
+      return this.send(command, optionsOrCb);
+    }
+  }
 }

clients/client-migration-hub-refactor-spaces/src/MigrationHubRefactorSpacesClient.ts

@@ -85,6 +85,7 @@ import {
 import { PutResourcePolicyCommandInput, PutResourcePolicyCommandOutput } from "./commands/PutResourcePolicyCommand";
 import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
 import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
+import { UpdateRouteCommandInput, UpdateRouteCommandOutput } from "./commands/UpdateRouteCommand";
 import { getRuntimeConfig as __getRuntimeConfig } from "./runtimeConfig";
 
 export type ServiceInputTypes =
@@ -110,7 +111,8 @@ export type ServiceInputTypes =
   | ListTagsForResourceCommandInput
   | PutResourcePolicyCommandInput
   | TagResourceCommandInput
-  | UntagResourceCommandInput;
+  | UntagResourceCommandInput
+  | UpdateRouteCommandInput;
 
 export type ServiceOutputTypes =
   | CreateApplicationCommandOutput
@@ -135,7 +137,8 @@ export type ServiceOutputTypes =
   | ListTagsForResourceCommandOutput
   | PutResourcePolicyCommandOutput
   | TagResourceCommandOutput
-  | UntagResourceCommandOutput;
+  | UntagResourceCommandOutput
+  | UpdateRouteCommandOutput;
 
 export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
   /**

clients/client-migration-hub-refactor-spaces/src/commands/CreateRouteCommand.ts

@@ -32,6 +32,10 @@ export interface CreateRouteCommandOutput extends CreateRouteResponse, __Metadat
  *       the application. If an application does not have any routes, then the first route must be
  *       created as a <code>DEFAULT</code>
  *             <code>RouteType</code>.</p>
+ *          <p>When created, the default route defaults to an active state so state is not a required
+ *       input. However, like all other state values the state of the default route can be updated
+ *       after creation, but only when all other routes are also inactive. Conversely, no route can be
+ *       active without the default route also being active.</p>
  *          <p>When you create a route, Refactor Spaces configures the Amazon API Gateway to send traffic
  *       to the target service as follows:</p>
  *          <ul>
@@ -49,24 +53,28 @@ export interface CreateRouteCommandOutput extends CreateRouteResponse, __Metadat
  *             API Gateway to invoke the function.</p>
  *             </li>
  *          </ul>
- *          <p>A one-time health check is performed on the service when the route is created. If the
- *       health check fails, the route transitions to <code>FAILED</code>, and no traffic is sent to
+ *          <p>A one-time health check is performed on the service when either the route is updated from
+ *       inactive to active, or when it is created with an active state. If the health check fails, the
+ *       route transitions the route state to <code>FAILED</code>, an error code of
+ *         <code>SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE</code> is provided, and no traffic is sent to
  *       the service.</p>
  *          <p>For Lambda functions, the Lambda function state is checked. If the
  *       function is not active, the function configuration is updated so that Lambda
  *       resources are provisioned. If the Lambda state is <code>Failed</code>, then the
  *       route creation fails. For more information, see the <a href="https://docs.aws.amazon.com/lambda/latest/dg/API_GetFunctionConfiguration.html#SSS-GetFunctionConfiguration-response-State">GetFunctionConfiguration's State response parameter</a> in the <i>Lambda Developer Guide</i>.</p>
- *          <p>For public URLs, a connection is opened to the public endpoint. If the URL is not
- *       reachable, the health check fails. For private URLs, a target group is created and the target
- *       group health check is run.</p>
- *          <p>The <code>HealthCheckProtocol</code>, <code>HealthCheckPort</code>, and
- *         <code>HealthCheckPath</code> are the same protocol, port, and path specified in the URL or
+ *          <p>For Lambda endpoints, a check is performed to determine that a Lambda function with the
+ *       specified ARN exists. If it does not exist, the health check fails. For public URLs, a
+ *       connection is opened to the public endpoint. If the URL is not reachable, the health check
+ *       fails. </p>
+ *          <p>For private URLS, a target group is created on the Elastic Load Balancing and the target
+ *       group health check is run. The <code>HealthCheckProtocol</code>, <code>HealthCheckPort</code>,
+ *       and <code>HealthCheckPath</code> are the same protocol, port, and path specified in the URL or
  *       health URL, if used. All other settings use the default values, as described in <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-health-checks.html">Health checks
  *         for your target groups</a>. The health check is considered successful if at least one
  *       target within the target group transitions to a healthy state.</p>
  *          <p>Services can have HTTP or HTTPS URL endpoints. For HTTPS URLs, publicly-signed
  *       certificates are supported. Private Certificate Authorities (CAs) are permitted only if the
- *       CA's domain is publicly resolvable.</p>
+ *       CA's domain is also publicly resolvable.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-migration-hub-refactor-spaces/src/commands/UpdateRouteCommand.ts

@@ -0,0 +1,102 @@
+// smithy-typescript generated code
+import { getSerdePlugin } from "@aws-sdk/middleware-serde";
+import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@aws-sdk/protocol-http";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import {
+  FinalizeHandlerArguments,
+  Handler,
+  HandlerExecutionContext,
+  HttpHandlerOptions as __HttpHandlerOptions,
+  MetadataBearer as __MetadataBearer,
+  MiddlewareStack,
+  SerdeContext as __SerdeContext,
+} from "@aws-sdk/types";
+
+import {
+  MigrationHubRefactorSpacesClientResolvedConfig,
+  ServiceInputTypes,
+  ServiceOutputTypes,
+} from "../MigrationHubRefactorSpacesClient";
+import { UpdateRouteRequest, UpdateRouteResponse } from "../models/models_0";
+import {
+  deserializeAws_restJson1UpdateRouteCommand,
+  serializeAws_restJson1UpdateRouteCommand,
+} from "../protocols/Aws_restJson1";
+
+export interface UpdateRouteCommandInput extends UpdateRouteRequest {}
+export interface UpdateRouteCommandOutput extends UpdateRouteResponse, __MetadataBearer {}
+
+/**
+ * <p>
+ *     Updates an Amazon Web Services Migration Hub Refactor Spaces route.
+ *   </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { MigrationHubRefactorSpacesClient, UpdateRouteCommand } from "@aws-sdk/client-migration-hub-refactor-spaces"; // ES Modules import
+ * // const { MigrationHubRefactorSpacesClient, UpdateRouteCommand } = require("@aws-sdk/client-migration-hub-refactor-spaces"); // CommonJS import
+ * const client = new MigrationHubRefactorSpacesClient(config);
+ * const command = new UpdateRouteCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link UpdateRouteCommandInput} for command's `input` shape.
+ * @see {@link UpdateRouteCommandOutput} for command's `response` shape.
+ * @see {@link MigrationHubRefactorSpacesClientResolvedConfig | config} for MigrationHubRefactorSpacesClient's `config` shape.
+ *
+ */
+export class UpdateRouteCommand extends $Command<
+  UpdateRouteCommandInput,
+  UpdateRouteCommandOutput,
+  MigrationHubRefactorSpacesClientResolvedConfig
+> {
+  // Start section: command_properties
+  // End section: command_properties
+
+  constructor(readonly input: UpdateRouteCommandInput) {
+    // Start section: command_constructor
+    super();
+    // End section: command_constructor
+  }
+
+  /**
+   * @internal
+   */
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: MigrationHubRefactorSpacesClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<UpdateRouteCommandInput, UpdateRouteCommandOutput> {
+    this.middlewareStack.use(getSerdePlugin(configuration, this.serialize, this.deserialize));
+
+    const stack = clientStack.concat(this.middlewareStack);
+
+    const { logger } = configuration;
+    const clientName = "MigrationHubRefactorSpacesClient";
+    const commandName = "UpdateRouteCommand";
+    const handlerExecutionContext: HandlerExecutionContext = {
+      logger,
+      clientName,
+      commandName,
+      inputFilterSensitiveLog: UpdateRouteRequest.filterSensitiveLog,
+      outputFilterSensitiveLog: UpdateRouteResponse.filterSensitiveLog,
+    };
+    const { requestHandler } = configuration;
+    return stack.resolve(
+      (request: FinalizeHandlerArguments<any>) =>
+        requestHandler.handle(request.request as __HttpRequest, options || {}),
+      handlerExecutionContext
+    );
+  }
+
+  private serialize(input: UpdateRouteCommandInput, context: __SerdeContext): Promise<__HttpRequest> {
+    return serializeAws_restJson1UpdateRouteCommand(input, context);
+  }
+
+  private deserialize(output: __HttpResponse, context: __SerdeContext): Promise<UpdateRouteCommandOutput> {
+    return deserializeAws_restJson1UpdateRouteCommand(output, context);
+  }
+
+  // Start section: command_body_extra
+  // End section: command_body_extra
+}

clients/client-migration-hub-refactor-spaces/src/commands/index.ts

@@ -22,3 +22,4 @@ export * from "./ListTagsForResourceCommand";
 export * from "./PutResourcePolicyCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
+export * from "./UpdateRouteCommand";