Skip to content

Commit

Permalink
docs(client-migration-hub-refactor-spaces): Doc only update for Refac…
Browse files Browse the repository at this point in the history 
…tor Spaces environments without network bridge feature.
  • Loading branch information
awstools committed Apr 14, 2023
1 parent bc16f2d commit 8b5eba4
Show file tree
Hide file tree
Showing 8 changed files with 671 additions and 300 deletions.
95 changes: 61 additions & 34 deletions clients/client-migration-hub-refactor-spaces/src/MigrationHubRefactorSpaces.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,11 @@ export class MigrationHubRefactorSpaces extends MigrationHubRefactorSpacesClient
* applications created inside the environment, regardless of the account that creates the
* application. Refactor Spaces provisions an Amazon API Gateway, API Gateway VPC link, and
* Network Load Balancer for the application proxy inside your account.</p>
* <p>In environments created with a <a href="https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType">CreateEnvironment:NetworkFabricType</a> of <code>NONE</code> you need to configure
* <a href="https://docs.aws.amazon.com/whitepapers/latest/aws-vpc-connectivity-options/amazon-vpc-to-amazon-vpc-connectivity-options.html"> VPC to VPC connectivity</a> between your service VPC and the application proxy VPC to
* route traffic through the application proxy to a service with a private URL endpoint. For more
* information, see <a href="https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/userguide/getting-started-create-application.html">
* Create an application</a> in the <i>Refactor Spaces User Guide</i>. </p>
*/
public createApplication(
args: CreateApplicationCommandInput,
Expand Down Expand Up @@ -150,9 +155,11 @@ export class MigrationHubRefactorSpaces extends MigrationHubRefactorSpacesClient
* to as the <i>environment owner</i>. The environment owner has cross-account
* visibility and control of Refactor Spaces resources that are added to the environment by other
* accounts that the environment is shared with.</p>
* <p>When creating an environment with
* a network fabric type of <code>TRANSIT_GATEWAY</code>,
* Refactor Spaces provisions a transit gateway in your account.</p>
* <p>When creating an environment with a <a href="https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType">CreateEnvironment:NetworkFabricType</a> of <code>TRANSIT_GATEWAY</code>, Refactor Spaces
* provisions a transit gateway to enable services in VPCs to communicate directly across
* accounts. If <a href="https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType">CreateEnvironment:NetworkFabricType</a> is <code>NONE</code>, Refactor Spaces does not create
* a transit gateway and you must use your network infrastructure to route traffic to services
* with private URL endpoints.</p>
*/
public createEnvironment(
args: CreateEnvironmentCommandInput,
Expand Down Expand Up @@ -198,45 +205,65 @@ export class MigrationHubRefactorSpaces extends MigrationHubRefactorSpacesClient
* to the target service as follows:</p>
* <ul>
* <li>
* <p>
* <b>URL Endpoints</b>
* </p>
* <p>If the service has a URL endpoint, and the endpoint resolves to a private IP address,
* Refactor Spaces routes traffic using the API Gateway VPC link. </p>
* </li>
* <li>
* <p>If the service has a URL endpoint, and the endpoint resolves to a public IP address,
* Refactor Spaces routes traffic over the public internet.</p>
* Refactor Spaces routes traffic using the API Gateway VPC link. If a service endpoint
* resolves to a public IP address, Refactor Spaces routes traffic over the public internet.
* 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 also publicly resolvable. </p>
* <p>Refactor Spaces automatically resolves the public Domain Name System (DNS) names that are
* set in <code>CreateService:UrlEndpoint </code>when you create a service. The DNS names
* resolve when the DNS time-to-live (TTL) expires, or every 60 seconds for TTLs less than 60
* seconds. This periodic DNS resolution ensures that the route configuration remains
* up-to-date. </p>
* <p/>
* <p>
* <b>One-time health check</b>
* </p>
* <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 private URLs, a target group is created on the Network Load Balancer and the load
* balancer target group runs default target health checks. By default, the health check is
* run against the service endpoint URL. Optionally, the health check can be performed
* against a different protocol, port, and/or path using the <a href="https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateService.html#migrationhubrefactorspaces-CreateService-request-UrlEndpoint">CreateService:UrlEndpoint</a> parameter. All other health check settings for the
* load balancer use the default values described in the <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-health-checks.html">Health
* checks for your target groups</a> in the <i>Elastic Load Balancing
* guide</i>. The health check is considered successful if at least one target
* within the target group transitions to a healthy state.</p>
* <p/>
* </li>
* <li>
* <p>
* <b>Lambda function endpoints</b>
* </p>
* <p>If the service has an Lambda function endpoint, then Refactor Spaces
* configures the Lambda function's resource policy to allow the application's
* API Gateway to invoke the function.</p>
* <p>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>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>
* </li>
* </ul>
* <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 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>Refactor Spaces automatically resolves the public Domain Name System (DNS) names that are set in
* <a>CreateServiceRequest$UrlEndpoint</a> when you create a service. The DNS names
* resolve when the DNS time-to-live (TTL) expires, or every 60 seconds for TTLs less than 60
* seconds. This periodic DNS resolution ensures that the route configuration remains up-to-date. </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 also publicly resolvable.</p>
* <p>
* <b>Environments without a network bridge</b>
* </p>
* <p>When you create environments without a network bridge (<a href="https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType">CreateEnvironment:NetworkFabricType</a> is <code>NONE)</code> and you use your own
* networking infrastructure, you need to configure <a href="https://docs.aws.amazon.com/whitepapers/latest/aws-vpc-connectivity-options/amazon-vpc-to-amazon-vpc-connectivity-options.html">VPC to VPC connectivity</a> between your network and the application proxy VPC. Route
* creation from the application proxy to service endpoints will fail if your network is not
* configured to connect to the application proxy VPC. For more information, see <a href="https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/userguide/getting-started-create-role.html"> Create
* a route</a> in the <i>Refactor Spaces User Guide</i>.</p>
* <p/>
*/
public createRoute(args: CreateRouteCommandInput, options?: __HttpHandlerOptions): Promise<CreateRouteCommandOutput>;
public createRoute(args: CreateRouteCommandInput, cb: (err: any, data?: CreateRouteCommandOutput) => void): void;
Expand Down
5 changes: 5 additions & 0 deletions clients/client-migration-hub-refactor-spaces/src/commands/CreateApplicationCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,11 @@ export interface CreateApplicationCommandOutput extends CreateApplicationRespons
* applications created inside the environment, regardless of the account that creates the
* application. Refactor Spaces provisions an Amazon API Gateway, API Gateway VPC link, and
* Network Load Balancer for the application proxy inside your account.</p>
* <p>In environments created with a <a href="https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType">CreateEnvironment:NetworkFabricType</a> of <code>NONE</code> you need to configure
* <a href="https://docs.aws.amazon.com/whitepapers/latest/aws-vpc-connectivity-options/amazon-vpc-to-amazon-vpc-connectivity-options.html"> VPC to VPC connectivity</a> between your service VPC and the application proxy VPC to
* route traffic through the application proxy to a service with a private URL endpoint. For more
* information, see <a href="https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/userguide/getting-started-create-application.html">
* Create an application</a> in the <i>Refactor Spaces User Guide</i>. </p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
8 changes: 5 additions & 3 deletions clients/client-migration-hub-refactor-spaces/src/commands/CreateEnvironmentCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,11 @@ export interface CreateEnvironmentCommandOutput extends CreateEnvironmentRespons
* to as the <i>environment owner</i>. The environment owner has cross-account
* visibility and control of Refactor Spaces resources that are added to the environment by other
* accounts that the environment is shared with.</p>
* <p>When creating an environment with
* a network fabric type of <code>TRANSIT_GATEWAY</code>,
* Refactor Spaces provisions a transit gateway in your account.</p>
* <p>When creating an environment with a <a href="https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType">CreateEnvironment:NetworkFabricType</a> of <code>TRANSIT_GATEWAY</code>, Refactor Spaces
* provisions a transit gateway to enable services in VPCs to communicate directly across
* accounts. If <a href="https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType">CreateEnvironment:NetworkFabricType</a> is <code>NONE</code>, Refactor Spaces does not create
* a transit gateway and you must use your network infrastructure to route traffic to services
* with private URL endpoints.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Loading

0 comments on commit 8b5eba4

Please sign in to comment.