MigrationHubRefactorSpaces

import { MigrationHubRefactorSpaces } from "https://aws-api.deno.dev/v0.3/services/migrationhubrefactorspaces.ts?docs=full";

class MigrationHubRefactorSpaces {

constructor(apiFactory: client.ApiFactory);

async createApplication(params: CreateApplicationRequest, opts?: client.RequestOptions): Promise<CreateApplicationResponse>;

async createEnvironment(params: CreateEnvironmentRequest, opts?: client.RequestOptions): Promise<CreateEnvironmentResponse>;

async createRoute(params: CreateRouteRequest, opts?: client.RequestOptions): Promise<CreateRouteResponse>;

async createService(params: CreateServiceRequest, opts?: client.RequestOptions): Promise<CreateServiceResponse>;

async deleteApplication(params: DeleteApplicationRequest, opts?: client.RequestOptions): Promise<DeleteApplicationResponse>;

async deleteEnvironment(params: DeleteEnvironmentRequest, opts?: client.RequestOptions): Promise<DeleteEnvironmentResponse>;

async deleteResourcePolicy(params: DeleteResourcePolicyRequest, opts?: client.RequestOptions): Promise<void>;

async deleteRoute(params: DeleteRouteRequest, opts?: client.RequestOptions): Promise<DeleteRouteResponse>;

async deleteService(params: DeleteServiceRequest, opts?: client.RequestOptions): Promise<DeleteServiceResponse>;

async getApplication(params: GetApplicationRequest, opts?: client.RequestOptions): Promise<GetApplicationResponse>;

async getEnvironment(params: GetEnvironmentRequest, opts?: client.RequestOptions): Promise<GetEnvironmentResponse>;

async getResourcePolicy(params: GetResourcePolicyRequest, opts?: client.RequestOptions): Promise<GetResourcePolicyResponse>;

async getRoute(params: GetRouteRequest, opts?: client.RequestOptions): Promise<GetRouteResponse>;

async getService(params: GetServiceRequest, opts?: client.RequestOptions): Promise<GetServiceResponse>;

async listApplications(params: ListApplicationsRequest, opts?: client.RequestOptions): Promise<ListApplicationsResponse>;

async listEnvironments(params?: ListEnvironmentsRequest, opts?: client.RequestOptions): Promise<ListEnvironmentsResponse>;

async listEnvironmentVpcs(params: ListEnvironmentVpcsRequest, opts?: client.RequestOptions): Promise<ListEnvironmentVpcsResponse>;

async listRoutes(params: ListRoutesRequest, opts?: client.RequestOptions): Promise<ListRoutesResponse>;

async listServices(params: ListServicesRequest, opts?: client.RequestOptions): Promise<ListServicesResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async putResourcePolicy(params: PutResourcePolicyRequest, opts?: client.RequestOptions): Promise<void>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new MigrationHubRefactorSpaces(apiFactory: client.ApiFactory)

[src]

§Methods

createApplication(params: CreateApplicationRequest, opts?: client.RequestOptions): Promise<CreateApplicationResponse>

[src]

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 the Amazon API Gateway and Network Load Balancer for the application proxy inside your account.

createEnvironment(params: CreateEnvironmentRequest, opts?: client.RequestOptions): Promise<CreateEnvironmentResponse>

[src]

Creates an Amazon Web Services Migration Hub Refactor Spaces environment. The caller owns the environment resource, and 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, Refactor Spaces provisions a transit gateway in your account.

createRoute(params: CreateRouteRequest, opts?: client.RequestOptions): Promise<CreateRouteResponse>

[src]

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 you create a route, Refactor Spaces configures the Amazon API Gateway to send traffic to the target service as follows:

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.
If the service has a URL endpoint, and the endpoint resolves to a public IP address, Refactor Spaces routes traffic over the public internet.
If the service has an Lambda function endpoint, then Refactor Spaces uses the API Gateway Lambda integration.

A health check is performed on the service when the route is created. If the health check fails, the route transitions to FAILED, and no traffic is sent to the service.

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 Failed, then the route creation fails. For more information, see the GetFunctionConfiguration's State response parameter in the Lambda Developer Guide.

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.

The HealthCheckProtocol, HealthCheckPort, and HealthCheckPath 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 Health checks for your target groups. The health check is considered successful if at least one target within the target group transitions to a healthy state.

createService(params: CreateServiceRequest, opts?: client.RequestOptions): Promise<CreateServiceResponse>

[src]

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.

! IMPORTANT: ! If an Amazon Web Services resourceis 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: DeleteApplicationRequest, opts?: client.RequestOptions): Promise<DeleteApplicationResponse>

[src]

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: DeleteEnvironmentRequest, opts?: client.RequestOptions): Promise<DeleteEnvironmentResponse>

[src]

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: DeleteResourcePolicyRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes the resource policy set for the environment.

deleteRoute(params: DeleteRouteRequest, opts?: client.RequestOptions): Promise<DeleteRouteResponse>

[src]

Deletes an Amazon Web Services Migration Hub Refactor Spaces route.

deleteService(params: DeleteServiceRequest, opts?: client.RequestOptions): Promise<DeleteServiceResponse>

[src]

Deletes an Amazon Web Services Migration Hub Refactor Spaces service.

getApplication(params: GetApplicationRequest, opts?: client.RequestOptions): Promise<GetApplicationResponse>

[src]

Gets an Amazon Web Services Migration Hub Refactor Spaces application.

getEnvironment(params: GetEnvironmentRequest, opts?: client.RequestOptions): Promise<GetEnvironmentResponse>

[src]

Gets an Amazon Web Services Migration Hub Refactor Spaces environment.

getResourcePolicy(params: GetResourcePolicyRequest, opts?: client.RequestOptions): Promise<GetResourcePolicyResponse>

[src]

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

getRoute(params: GetRouteRequest, opts?: client.RequestOptions): Promise<GetRouteResponse>

[src]

Gets an Amazon Web Services Migration Hub Refactor Spaces route.

getService(params: GetServiceRequest, opts?: client.RequestOptions): Promise<GetServiceResponse>

[src]

Gets an Amazon Web Services Migration Hub Refactor Spaces service.

listApplications(params: ListApplicationsRequest, opts?: client.RequestOptions): Promise<ListApplicationsResponse>

[src]

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

listEnvironments(params?: ListEnvironmentsRequest, opts?: client.RequestOptions): Promise<ListEnvironmentsResponse>

[src]

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

listEnvironmentVpcs(params: ListEnvironmentVpcsRequest, opts?: client.RequestOptions): Promise<ListEnvironmentVpcsResponse>

[src]

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

listRoutes(params: ListRoutesRequest, opts?: client.RequestOptions): Promise<ListRoutesResponse>

[src]

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

listServices(params: ListServicesRequest, opts?: client.RequestOptions): Promise<ListServicesResponse>

[src]

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

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

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: PutResourcePolicyRequest, opts?: client.RequestOptions): Promise<void>

[src]

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: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

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.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]