AWS.MigrationHubRefactorSpaces — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Inherits:

AWS.Service

Identifier:

migrationhubrefactorspaces

API Version:

2021-10-26

Defined in:

(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

This API reference provides descriptions, syntax, and other details about each of the actions and data types for Amazon Web Services Migration Hub Refactor Spaces (Refactor Spaces). The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see Amazon Web Services SDKs.

To share Refactor Spaces environments with other Amazon Web Services accounts or with Organizations and their OUs, use Resource Access Manager's CreateResourceShare API. See CreateResourceShare in the Amazon Web Services RAM API Reference.

Sending a Request Using MigrationHubRefactorSpaces

var migrationhubrefactorspaces = new AWS.MigrationHubRefactorSpaces();
migrationhubrefactorspaces.createApplication(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the MigrationHubRefactorSpaces object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var migrationhubrefactorspaces = new AWS.MigrationHubRefactorSpaces({apiVersion: '2021-10-26'});

You can also set the API version globally in AWS.config.apiVersions using the migrationhubrefactorspaces service identifier:

AWS.config.apiVersions = {
  migrationhubrefactorspaces: '2021-10-26',
  // other service API versions
};

var migrationhubrefactorspaces = new AWS.MigrationHubRefactorSpaces();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.MigrationHubRefactorSpaces(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createApplication(params = {}, callback) ⇒ AWS.Request

Creates an Amazon Web Services Migration Hub Refactor Spaces application. The account that owns the environment also owns the 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.

In environments created with a CreateEnvironment:NetworkFabricType of NONE you need to configure VPC to VPC connectivity 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 Create an application in the Refactor Spaces User Guide.

createEnvironment(params = {}, callback) ⇒ AWS.Request

Creates an Amazon Web Services Migration Hub Refactor Spaces environment. The caller owns the environment resource, and all Refactor Spaces applications, services, and routes created within the environment. They are referred to as the environment owner. 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.

When creating an environment with a CreateEnvironment:NetworkFabricType of TRANSIT_GATEWAY, Refactor Spaces provisions a transit gateway to enable services in VPCs to communicate directly across accounts. If CreateEnvironment:NetworkFabricType is NONE, Refactor Spaces does not create a transit gateway and you must use your network infrastructure to route traffic to services with private URL endpoints.

createRoute(params = {}, callback) ⇒ AWS.Request

Creates an Amazon Web Services Migration Hub Refactor Spaces route. The account owner of the service resource is always the environment owner, regardless of which account creates the route. Routes target a service in the application. If an application does not have any routes, then the first route must be created as a DEFAULT RouteType.

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.

When you create a route, Refactor Spaces configures the Amazon API Gateway to send traffic to the target service as follows:

Environments without a network bridge

When you create environments without a network bridge (CreateEnvironment:NetworkFabricType is NONE) and you use your own networking infrastructure, you need to configure VPC to VPC connectivity 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 Create a route in the Refactor Spaces User Guide.

createService(params = {}, callback) ⇒ AWS.Request

Creates an Amazon Web Services Migration Hub Refactor Spaces service. The account owner of the service is always the environment owner, regardless of which account in the environment creates the service. Services have either a URL endpoint in a virtual private cloud (VPC), or a Lambda function endpoint.

If an Amazon Web Services resource is launched in a service VPC, and you want it to be accessible to all of an environment’s services with VPCs and routes, apply the RefactorSpacesSecurityGroup to the resource. Alternatively, to add more cross-account constraints, apply your own security group.

deleteApplication(params = {}, callback) ⇒ AWS.Request

Deletes an Amazon Web Services Migration Hub Refactor Spaces application. Before you can delete an application, you must first delete any services or routes within the application.

deleteEnvironment(params = {}, callback) ⇒ AWS.Request

Deletes an Amazon Web Services Migration Hub Refactor Spaces environment. Before you can delete an environment, you must first delete any applications and services within the environment.

deleteResourcePolicy(params = {}, callback) ⇒ AWS.Request

Deletes the resource policy set for the environment.

deleteRoute(params = {}, callback) ⇒ AWS.Request

Deletes an Amazon Web Services Migration Hub Refactor Spaces route.

deleteService(params = {}, callback) ⇒ AWS.Request

Deletes an Amazon Web Services Migration Hub Refactor Spaces service.

getApplication(params = {}, callback) ⇒ AWS.Request

Gets an Amazon Web Services Migration Hub Refactor Spaces application.

getEnvironment(params = {}, callback) ⇒ AWS.Request

Gets an Amazon Web Services Migration Hub Refactor Spaces environment.

getResourcePolicy(params = {}, callback) ⇒ AWS.Request

Gets the resource-based permission policy that is set for the given environment.

getRoute(params = {}, callback) ⇒ AWS.Request

Gets an Amazon Web Services Migration Hub Refactor Spaces route.

getService(params = {}, callback) ⇒ AWS.Request

Gets an Amazon Web Services Migration Hub Refactor Spaces service.

listApplications(params = {}, callback) ⇒ AWS.Request

Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment.

listEnvironments(params = {}, callback) ⇒ AWS.Request

Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller account.

listEnvironmentVpcs(params = {}, callback) ⇒ AWS.Request

Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds (VPCs) that are part of the environment.

listRoutes(params = {}, callback) ⇒ AWS.Request

Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application.

listServices(params = {}, callback) ⇒ AWS.Request

Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags of a resource. The caller account must be the same as the resource’s OwnerAccountId. Listing tags in other accounts is not supported.

putResourcePolicy(params = {}, callback) ⇒ AWS.Request

Attaches a resource-based permission policy to the Amazon Web Services Migration Hub Refactor Spaces environment. The policy must contain the same actions and condition statements as the arn:aws:ram::aws:permission/AWSRAMDefaultPermissionRefactorSpacesEnvironment permission in Resource Access Manager. The policy must not contain new lines or blank lines.

tagResource(params = {}, callback) ⇒ AWS.Request

Removes the tags of a given resource. Tags are metadata which can be used to manage a resource. To tag a resource, the caller account must be the same as the resource’s OwnerAccountId. Tagging resources in other accounts is not supported.

Note: Amazon Web Services Migration Hub Refactor Spaces does not propagate tags to orchestrated resources, such as an environment’s transit gateway.

untagResource(params = {}, callback) ⇒ AWS.Request

Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource. To untag a resource, the caller account must be the same as the resource’s OwnerAccountId. Untagging resources across accounts is not supported.

updateRoute(params = {}, callback) ⇒ AWS.Request

Updates an Amazon Web Services Migration Hub Refactor Spaces route.