aws-elixir

View Source AWS.MigrationHubRefactorSpaces (aws-elixir v1.0.4)

Amazon Web Services Migration Hub Refactor Spaces

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.

Link to this section Summary

Functions

create_application(client, environment_identifier, input, options \\ [])

Creates an Amazon Web Services Migration Hub Refactor Spaces application.

create_environment(client, input, options \\ [])

Creates an Amazon Web Services Migration Hub Refactor Spaces environment.

create_route(client, application_identifier, environment_identifier, input, options \\ [])

Creates an Amazon Web Services Migration Hub Refactor Spaces route.

create_service(client, application_identifier, environment_identifier, input, options \\ [])

Creates an Amazon Web Services Migration Hub Refactor Spaces service.

delete_application(client, application_identifier, environment_identifier, input, options \\ [])

Deletes an Amazon Web Services Migration Hub Refactor Spaces application.

delete_environment(client, environment_identifier, input, options \\ [])

Deletes an Amazon Web Services Migration Hub Refactor Spaces environment.

delete_resource_policy(client, identifier, input, options \\ [])

Deletes the resource policy set for the environment.

delete_route(client, application_identifier, environment_identifier, route_identifier, input, options \\ [])

Deletes an Amazon Web Services Migration Hub Refactor Spaces route.

delete_service(client, application_identifier, environment_identifier, service_identifier, input, options \\ [])

Deletes an Amazon Web Services Migration Hub Refactor Spaces service.

get_application(client, application_identifier, environment_identifier, options \\ [])

Gets an Amazon Web Services Migration Hub Refactor Spaces application.

get_environment(client, environment_identifier, options \\ [])

Gets an Amazon Web Services Migration Hub Refactor Spaces environment.

get_resource_policy(client, identifier, options \\ [])

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

get_route(client, application_identifier, environment_identifier, route_identifier, options \\ [])

Gets an Amazon Web Services Migration Hub Refactor Spaces route.

get_service(client, application_identifier, environment_identifier, service_identifier, options \\ [])

Gets an Amazon Web Services Migration Hub Refactor Spaces service.

list_applications(client, environment_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_environment_vpcs(client, environment_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_environments(client, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_routes(client, application_identifier, environment_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_services(client, application_identifier, environment_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_tags_for_resource(client, resource_arn, options \\ [])

Lists the tags of a resource.

metadata()
put_resource_policy(client, input, options \\ [])

Attaches a resource-based permission policy to the Amazon Web Services Migration Hub Refactor Spaces environment.

tag_resource(client, resource_arn, input, options \\ [])

Removes the tags of a given resource.

untag_resource(client, resource_arn, input, options \\ [])

Adds to or modifies the tags of the given resource.

update_route(client, application_identifier, environment_identifier, route_identifier, input, options \\ [])

Updates an Amazon Web Services Migration Hub Refactor Spaces route.

Link to this section Functions

Link to this function

create_application(client, environment_identifier, input, options \\ [])

View Source

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.

Link to this function

create_environment(client, input, options \\ [])

View Source

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.

Link to this function

create_route(client, application_identifier, environment_identifier, input, options \\ [])

View Source

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:

*

url-endpoints

 URL Endpoints

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 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.

Refactor Spaces automatically resolves the public Domain Name System (DNS) names that are set in CreateService:UrlEndpointwhen 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.

one-time-health-check

 One-time health check

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 FAILED, an error code of SERVICE_ENDPOINT_HEALTH_CHECK_FAILURE is provided, and no traffic is sent to the service.

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 CreateService:UrlEndpoint parameter. All other health check settings for the load balancer use the default values described in the Health checks for your target groups in the Elastic Load Balancing guide. The health check is considered successful if at least one target within the target group transitions to a healthy state.

*

lambda-function-endpoints

 Lambda function endpoints

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.

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.

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.

environments-without-a-network-bridge

 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.

Link to this function

create_service(client, application_identifier, environment_identifier, input, options \\ [])

View Source

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.

Link to this function

delete_application(client, application_identifier, environment_identifier, input, options \\ [])

View Source

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.

Link to this function

delete_environment(client, environment_identifier, input, options \\ [])

View Source

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.

Link to this function

delete_resource_policy(client, identifier, input, options \\ [])

View Source

Deletes the resource policy set for the environment.

Link to this function

delete_route(client, application_identifier, environment_identifier, route_identifier, input, options \\ [])

View Source

Deletes an Amazon Web Services Migration Hub Refactor Spaces route.

Link to this function

delete_service(client, application_identifier, environment_identifier, service_identifier, input, options \\ [])

View Source

Deletes an Amazon Web Services Migration Hub Refactor Spaces service.

Link to this function

get_application(client, application_identifier, environment_identifier, options \\ [])

View Source

Gets an Amazon Web Services Migration Hub Refactor Spaces application.

Link to this function

get_environment(client, environment_identifier, options \\ [])

View Source

Gets an Amazon Web Services Migration Hub Refactor Spaces environment.

Link to this function

get_resource_policy(client, identifier, options \\ [])

View Source

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

Link to this function

get_route(client, application_identifier, environment_identifier, route_identifier, options \\ [])

View Source

Gets an Amazon Web Services Migration Hub Refactor Spaces route.

Link to this function

get_service(client, application_identifier, environment_identifier, service_identifier, options \\ [])

View Source

Gets an Amazon Web Services Migration Hub Refactor Spaces service.

Link to this function

list_applications(client, environment_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_environment_vpcs(client, environment_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_environments(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_routes(client, application_identifier, environment_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_services(client, application_identifier, environment_identifier, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

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.

Link to this function

metadata()

View Source
Link to this function

put_resource_policy(client, input, options \\ [])

View Source

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.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

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.

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

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

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.

Link to this function

update_route(client, application_identifier, environment_identifier, route_identifier, input, options \\ [])

View Source

Updates an Amazon Web Services Migration Hub Refactor Spaces route.