@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSMigrationHubRefactorSpaces extends Object implements AWSMigrationHubRefactorSpaces
AWSMigrationHubRefactorSpaces
. Convenient method forms pass through to the
corresponding overload that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
CreateApplicationResult |
createApplication(CreateApplicationRequest request)
Creates an Amazon Web Services Migration Hub Refactor Spaces application.
|
CreateEnvironmentResult |
createEnvironment(CreateEnvironmentRequest request)
Creates an Amazon Web Services Migration Hub Refactor Spaces environment.
|
CreateRouteResult |
createRoute(CreateRouteRequest request)
Creates an Amazon Web Services Migration Hub Refactor Spaces route.
|
CreateServiceResult |
createService(CreateServiceRequest request)
Creates an Amazon Web Services Migration Hub Refactor Spaces service.
|
DeleteApplicationResult |
deleteApplication(DeleteApplicationRequest request)
Deletes an Amazon Web Services Migration Hub Refactor Spaces application.
|
DeleteEnvironmentResult |
deleteEnvironment(DeleteEnvironmentRequest request)
Deletes an Amazon Web Services Migration Hub Refactor Spaces environment.
|
DeleteResourcePolicyResult |
deleteResourcePolicy(DeleteResourcePolicyRequest request)
Deletes the resource policy set for the environment.
|
DeleteRouteResult |
deleteRoute(DeleteRouteRequest request)
Deletes an Amazon Web Services Migration Hub Refactor Spaces route.
|
DeleteServiceResult |
deleteService(DeleteServiceRequest request)
Deletes an Amazon Web Services Migration Hub Refactor Spaces service.
|
GetApplicationResult |
getApplication(GetApplicationRequest request)
Gets an Amazon Web Services Migration Hub Refactor Spaces application.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetEnvironmentResult |
getEnvironment(GetEnvironmentRequest request)
Gets an Amazon Web Services Migration Hub Refactor Spaces environment.
|
GetResourcePolicyResult |
getResourcePolicy(GetResourcePolicyRequest request)
Gets the resource-based permission policy that is set for the given environment.
|
GetRouteResult |
getRoute(GetRouteRequest request)
Gets an Amazon Web Services Migration Hub Refactor Spaces route.
|
GetServiceResult |
getService(GetServiceRequest request)
Gets an Amazon Web Services Migration Hub Refactor Spaces service.
|
ListApplicationsResult |
listApplications(ListApplicationsRequest request)
Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment.
|
ListEnvironmentsResult |
listEnvironments(ListEnvironmentsRequest request)
Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the
caller account.
|
ListEnvironmentVpcsResult |
listEnvironmentVpcs(ListEnvironmentVpcsRequest request)
Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds (VPCs) that are part
of the environment.
|
ListRoutesResult |
listRoutes(ListRoutesRequest request)
Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application.
|
ListServicesResult |
listServices(ListServicesRequest request)
Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Lists the tags of a resource.
|
PutResourcePolicyResult |
putResourcePolicy(PutResourcePolicyRequest request)
Attaches a resource-based permission policy to the Amazon Web Services Migration Hub Refactor Spaces environment.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Removes the tags of a given resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Adds to or modifies the tags of the given resource.
|
UpdateRouteResult |
updateRoute(UpdateRouteRequest request)
Updates an Amazon Web Services Migration Hub Refactor Spaces route.
|
public CreateApplicationResult createApplication(CreateApplicationRequest request)
AWSMigrationHubRefactorSpaces
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.
createApplication
in interface AWSMigrationHubRefactorSpaces
public CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest request)
AWSMigrationHubRefactorSpaces
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.
createEnvironment
in interface AWSMigrationHubRefactorSpaces
public CreateRouteResult createRoute(CreateRouteRequest request)
AWSMigrationHubRefactorSpaces
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
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:UrlEndpoint
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.
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
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
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.
createRoute
in interface AWSMigrationHubRefactorSpaces
public CreateServiceResult createService(CreateServiceRequest request)
AWSMigrationHubRefactorSpaces
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.
createService
in interface AWSMigrationHubRefactorSpaces
public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)
AWSMigrationHubRefactorSpaces
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.
deleteApplication
in interface AWSMigrationHubRefactorSpaces
public DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest request)
AWSMigrationHubRefactorSpaces
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.
deleteEnvironment
in interface AWSMigrationHubRefactorSpaces
public DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest request)
AWSMigrationHubRefactorSpaces
Deletes the resource policy set for the environment.
deleteResourcePolicy
in interface AWSMigrationHubRefactorSpaces
public DeleteRouteResult deleteRoute(DeleteRouteRequest request)
AWSMigrationHubRefactorSpaces
Deletes an Amazon Web Services Migration Hub Refactor Spaces route.
deleteRoute
in interface AWSMigrationHubRefactorSpaces
public DeleteServiceResult deleteService(DeleteServiceRequest request)
AWSMigrationHubRefactorSpaces
Deletes an Amazon Web Services Migration Hub Refactor Spaces service.
deleteService
in interface AWSMigrationHubRefactorSpaces
public GetApplicationResult getApplication(GetApplicationRequest request)
AWSMigrationHubRefactorSpaces
Gets an Amazon Web Services Migration Hub Refactor Spaces application.
getApplication
in interface AWSMigrationHubRefactorSpaces
public GetEnvironmentResult getEnvironment(GetEnvironmentRequest request)
AWSMigrationHubRefactorSpaces
Gets an Amazon Web Services Migration Hub Refactor Spaces environment.
getEnvironment
in interface AWSMigrationHubRefactorSpaces
public GetResourcePolicyResult getResourcePolicy(GetResourcePolicyRequest request)
AWSMigrationHubRefactorSpaces
Gets the resource-based permission policy that is set for the given environment.
getResourcePolicy
in interface AWSMigrationHubRefactorSpaces
public GetRouteResult getRoute(GetRouteRequest request)
AWSMigrationHubRefactorSpaces
Gets an Amazon Web Services Migration Hub Refactor Spaces route.
getRoute
in interface AWSMigrationHubRefactorSpaces
public GetServiceResult getService(GetServiceRequest request)
AWSMigrationHubRefactorSpaces
Gets an Amazon Web Services Migration Hub Refactor Spaces service.
getService
in interface AWSMigrationHubRefactorSpaces
public ListApplicationsResult listApplications(ListApplicationsRequest request)
AWSMigrationHubRefactorSpaces
Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment.
listApplications
in interface AWSMigrationHubRefactorSpaces
public ListEnvironmentVpcsResult listEnvironmentVpcs(ListEnvironmentVpcsRequest request)
AWSMigrationHubRefactorSpaces
Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds (VPCs) that are part of the environment.
listEnvironmentVpcs
in interface AWSMigrationHubRefactorSpaces
public ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest request)
AWSMigrationHubRefactorSpaces
Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller account.
listEnvironments
in interface AWSMigrationHubRefactorSpaces
public ListRoutesResult listRoutes(ListRoutesRequest request)
AWSMigrationHubRefactorSpaces
Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application.
listRoutes
in interface AWSMigrationHubRefactorSpaces
public ListServicesResult listServices(ListServicesRequest request)
AWSMigrationHubRefactorSpaces
Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application.
listServices
in interface AWSMigrationHubRefactorSpaces
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSMigrationHubRefactorSpaces
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.
listTagsForResource
in interface AWSMigrationHubRefactorSpaces
public PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest request)
AWSMigrationHubRefactorSpaces
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.
putResourcePolicy
in interface AWSMigrationHubRefactorSpaces
public TagResourceResult tagResource(TagResourceRequest request)
AWSMigrationHubRefactorSpaces
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.
tagResource
in interface AWSMigrationHubRefactorSpaces
public UntagResourceResult untagResource(UntagResourceRequest request)
AWSMigrationHubRefactorSpaces
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.
untagResource
in interface AWSMigrationHubRefactorSpaces
public UpdateRouteResult updateRoute(UpdateRouteRequest request)
AWSMigrationHubRefactorSpaces
Updates an Amazon Web Services Migration Hub Refactor Spaces route.
updateRoute
in interface AWSMigrationHubRefactorSpaces
public void shutdown()
AWSMigrationHubRefactorSpaces
shutdown
in interface AWSMigrationHubRefactorSpaces
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSMigrationHubRefactorSpaces
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSMigrationHubRefactorSpaces
request
- The originally executed request.