com.amazonaws.services.migrationhubrefactorspaces

Class AbstractAWSMigrationHubRefactorSpaces

java.lang.Object

com.amazonaws.services.migrationhubrefactorspaces.AbstractAWSMigrationHubRefactorSpaces

All Implemented Interfaces:

AWSMigrationHubRefactorSpaces

Direct Known Subclasses:

AbstractAWSMigrationHubRefactorSpacesAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSMigrationHubRefactorSpaces
extends Object
implements AWSMigrationHubRefactorSpaces

Abstract implementation of AWSMigrationHubRefactorSpaces. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

Fields inherited from interface com.amazonaws.services.migrationhubrefactorspaces.AWSMigrationHubRefactorSpaces

ENDPOINT_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAWSMigrationHubRefactorSpaces()

Method Summary

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractAWSMigrationHubRefactorSpaces

protected AbstractAWSMigrationHubRefactorSpaces()

Method Detail

createApplication

public CreateApplicationResult createApplication(CreateApplicationRequest request)

Description copied from interface: 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.

Specified by:

createApplication in interface AWSMigrationHubRefactorSpaces

Returns:

Result of the CreateApplication operation returned by the service.

See Also:

AWS API Documentation

createEnvironment

public CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest request)

Description copied from interface: 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, Refactor Spaces provisions a transit gateway in your account.

Specified by:

createEnvironment in interface AWSMigrationHubRefactorSpaces

Returns:

Result of the CreateEnvironment operation returned by the service.

See Also:

AWS API Documentation

createRoute

public CreateRouteResult createRoute(CreateRouteRequest request)

Description copied from interface: 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:

• 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 configures the Lambda function's resource policy to allow the application's API Gateway to invoke the function.

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

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

For private URLS, a target group is created on the Elastic Load Balancing 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.

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.

Specified by:

createRoute in interface AWSMigrationHubRefactorSpaces

Returns:

Result of the CreateRoute operation returned by the service.

See Also:

AWS API Documentation

createService

public CreateServiceResult createService(CreateServiceRequest request)

Description copied from interface: 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.

Specified by:

createService in interface AWSMigrationHubRefactorSpaces

Returns:

Result of the CreateService operation returned by the service.

See Also:

AWS API Documentation

deleteApplication

public DeleteApplicationResult deleteApplication(DeleteApplicationRequest request)

Description copied from interface: 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.

Specified by:

deleteApplication in interface AWSMigrationHubRefactorSpaces

Returns:

Result of the DeleteApplication operation returned by the service.

See Also:

AWS API Documentation

deleteEnvironment

public DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest request)

Description copied from interface: 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.

Specified by:

deleteEnvironment in interface AWSMigrationHubRefactorSpaces

Returns:

Result of the DeleteEnvironment operation returned by the service.

See Also:

AWS API Documentation

deleteResourcePolicy

public DeleteResourcePolicyResult deleteResourcePolicy(DeleteResourcePolicyRequest request)

Description copied from interface: AWSMigrationHubRefactorSpaces

Deletes the resource policy set for the environment.

Specified by:

deleteResourcePolicy in interface AWSMigrationHubRefactorSpaces

Returns:

Result of the DeleteResourcePolicy operation returned by the service.

See Also:

AWS API Documentation

deleteRoute

public DeleteRouteResult deleteRoute(DeleteRouteRequest request)

Description copied from interface: AWSMigrationHubRefactorSpaces

Deletes an Amazon Web Services Migration Hub Refactor Spaces route.

Specified by:

deleteRoute in interface AWSMigrationHubRefactorSpaces

Returns:

Result of the DeleteRoute operation returned by the service.

See Also:

AWS API Documentation

deleteService

public DeleteServiceResult deleteService(DeleteServiceRequest request)

Description copied from interface: AWSMigrationHubRefactorSpaces

Deletes an Amazon Web Services Migration Hub Refactor Spaces service.

Specified by:

deleteService in interface AWSMigrationHubRefactorSpaces

Returns:

Result of the DeleteService operation returned by the service.

See Also:

AWS API Documentation

getApplication

public GetApplicationResult getApplication(GetApplicationRequest request)

Description copied from interface: AWSMigrationHubRefactorSpaces

Gets an Amazon Web Services Migration Hub Refactor Spaces application.

Specified by:

getApplication in interface AWSMigrationHubRefactorSpaces

Returns:

Result of the GetApplication operation returned by the service.

See Also:

AWS API Documentation

getEnvironment

public GetEnvironmentResult getEnvironment(GetEnvironmentRequest request)

Description copied from interface: AWSMigrationHubRefactorSpaces

Gets an Amazon Web Services Migration Hub Refactor Spaces environment.

Specified by:

getEnvironment in interface AWSMigrationHubRefactorSpaces

Returns:

Result of the GetEnvironment operation returned by the service.

See Also:

AWS API Documentation

getResourcePolicy

public GetResourcePolicyResult getResourcePolicy(GetResourcePolicyRequest request)

Description copied from interface: AWSMigrationHubRefactorSpaces

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

Specified by:

getResourcePolicy in interface AWSMigrationHubRefactorSpaces

Returns:

Result of the GetResourcePolicy operation returned by the service.

See Also:

AWS API Documentation

getRoute

public GetRouteResult getRoute(GetRouteRequest request)

Description copied from interface: AWSMigrationHubRefactorSpaces

Gets an Amazon Web Services Migration Hub Refactor Spaces route.

Specified by:

getRoute in interface AWSMigrationHubRefactorSpaces

Returns:

Result of the GetRoute operation returned by the service.

See Also:

AWS API Documentation

getService

public GetServiceResult getService(GetServiceRequest request)

Description copied from interface: AWSMigrationHubRefactorSpaces

Gets an Amazon Web Services Migration Hub Refactor Spaces service.

Specified by:

getService in interface AWSMigrationHubRefactorSpaces

Returns:

Result of the GetService operation returned by the service.

See Also:

AWS API Documentation

listApplications

public ListApplicationsResult listApplications(ListApplicationsRequest request)

Description copied from interface: AWSMigrationHubRefactorSpaces

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

Specified by:

listApplications in interface AWSMigrationHubRefactorSpaces

Returns:

Result of the ListApplications operation returned by the service.

See Also:

AWS API Documentation

listEnvironmentVpcs

public ListEnvironmentVpcsResult listEnvironmentVpcs(ListEnvironmentVpcsRequest request)

Description copied from interface: AWSMigrationHubRefactorSpaces

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

Specified by:

listEnvironmentVpcs in interface AWSMigrationHubRefactorSpaces

Returns:

Result of the ListEnvironmentVpcs operation returned by the service.

See Also:

AWS API Documentation

listEnvironments

public ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest request)

Description copied from interface: AWSMigrationHubRefactorSpaces

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

Specified by:

listEnvironments in interface AWSMigrationHubRefactorSpaces

Returns:

Result of the ListEnvironments operation returned by the service.

See Also:

AWS API Documentation

listRoutes

public ListRoutesResult listRoutes(ListRoutesRequest request)

Description copied from interface: AWSMigrationHubRefactorSpaces

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

Specified by:

listRoutes in interface AWSMigrationHubRefactorSpaces

Returns:

Result of the ListRoutes operation returned by the service.

See Also:

AWS API Documentation

listServices

public ListServicesResult listServices(ListServicesRequest request)

Description copied from interface: AWSMigrationHubRefactorSpaces

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

Specified by:

listServices in interface AWSMigrationHubRefactorSpaces

Returns:

Result of the ListServices operation returned by the service.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Description copied from interface: 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.

Specified by:

listTagsForResource in interface AWSMigrationHubRefactorSpaces

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

putResourcePolicy

public PutResourcePolicyResult putResourcePolicy(PutResourcePolicyRequest request)

Description copied from interface: 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.

Specified by:

putResourcePolicy in interface AWSMigrationHubRefactorSpaces

Returns:

Result of the PutResourcePolicy operation returned by the service.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Description copied from interface: 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.

Specified by:

tagResource in interface AWSMigrationHubRefactorSpaces

Returns:

Result of the TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Description copied from interface: 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.

Specified by:

untagResource in interface AWSMigrationHubRefactorSpaces

Returns:

Result of the UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateRoute

public UpdateRouteResult updateRoute(UpdateRouteRequest request)

Description copied from interface: AWSMigrationHubRefactorSpaces

Updates an Amazon Web Services Migration Hub Refactor Spaces route.

Specified by:

updateRoute in interface AWSMigrationHubRefactorSpaces

Returns:

Result of the UpdateRoute operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AWSMigrationHubRefactorSpaces

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSMigrationHubRefactorSpaces

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AWSMigrationHubRefactorSpaces

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Specified by:

getCachedResponseMetadata in interface AWSMigrationHubRefactorSpaces

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.