Class: Aws::MigrationHubRefactorSpaces::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::MigrationHubRefactorSpaces::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb
Overview
An API client for MigrationHubRefactorSpaces. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::MigrationHubRefactorSpaces::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
Creates an Amazon Web Services Migration Hub Refactor Spaces application.
-
#create_environment(params = {}) ⇒ Types::CreateEnvironmentResponse
Creates an Amazon Web Services Migration Hub Refactor Spaces environment.
-
#create_route(params = {}) ⇒ Types::CreateRouteResponse
Creates an Amazon Web Services Migration Hub Refactor Spaces route.
-
#create_service(params = {}) ⇒ Types::CreateServiceResponse
Creates an Amazon Web Services Migration Hub Refactor Spaces service.
-
#delete_application(params = {}) ⇒ Types::DeleteApplicationResponse
Deletes an Amazon Web Services Migration Hub Refactor Spaces application.
-
#delete_environment(params = {}) ⇒ Types::DeleteEnvironmentResponse
Deletes an Amazon Web Services Migration Hub Refactor Spaces environment.
-
#delete_resource_policy(params = {}) ⇒ Struct
Deletes the resource policy set for the environment.
-
#delete_route(params = {}) ⇒ Types::DeleteRouteResponse
Deletes an Amazon Web Services Migration Hub Refactor Spaces route.
-
#delete_service(params = {}) ⇒ Types::DeleteServiceResponse
Deletes an Amazon Web Services Migration Hub Refactor Spaces service.
-
#get_application(params = {}) ⇒ Types::GetApplicationResponse
Gets an Amazon Web Services Migration Hub Refactor Spaces application.
-
#get_environment(params = {}) ⇒ Types::GetEnvironmentResponse
Gets an Amazon Web Services Migration Hub Refactor Spaces environment.
-
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse
Gets the resource-based permission policy that is set for the given environment.
-
#get_route(params = {}) ⇒ Types::GetRouteResponse
Gets an Amazon Web Services Migration Hub Refactor Spaces route.
-
#get_service(params = {}) ⇒ Types::GetServiceResponse
Gets an Amazon Web Services Migration Hub Refactor Spaces service.
-
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment.
-
#list_environment_vpcs(params = {}) ⇒ Types::ListEnvironmentVpcsResponse
Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds (VPCs) that are part of the environment.
-
#list_environments(params = {}) ⇒ Types::ListEnvironmentsResponse
Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller account.
-
#list_routes(params = {}) ⇒ Types::ListRoutesResponse
Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application.
-
#list_services(params = {}) ⇒ Types::ListServicesResponse
Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags of a resource.
-
#put_resource_policy(params = {}) ⇒ Struct
Attaches a resource-based permission policy to the Amazon Web Services Migration Hub Refactor Spaces environment.
-
#tag_resource(params = {}) ⇒ Struct
Removes the tags of a given resource.
-
#untag_resource(params = {}) ⇒ Struct
Adds to or modifies the tags of the given resource.
-
#update_route(params = {}) ⇒ Types::UpdateRouteResponse
Updates an Amazon Web Services Migration Hub Refactor Spaces route.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
446 447 448 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 446 def initialize(*args) super end |
Instance Method Details
#create_application(params = {}) ⇒ Types::CreateApplicationResponse
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.
555 556 557 558 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 555 def create_application(params = {}, = {}) req = build_request(:create_application, params) req.send_request() end |
#create_environment(params = {}) ⇒ Types::CreateEnvironmentResponse
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.
645 646 647 648 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 645 def create_environment(params = {}, = {}) req = build_request(:create_environment, params) req.send_request() end |
#create_route(params = {}) ⇒ Types::CreateRouteResponse
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 ofSERVICE_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.
846 847 848 849 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 846 def create_route(params = {}, = {}) req = build_request(:create_route, params) req.send_request() end |
#create_service(params = {}) ⇒ Types::CreateServiceResponse
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.
970 971 972 973 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 970 def create_service(params = {}, = {}) req = build_request(:create_service, params) req.send_request() end |
#delete_application(params = {}) ⇒ Types::DeleteApplicationResponse
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.
1014 1015 1016 1017 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1014 def delete_application(params = {}, = {}) req = build_request(:delete_application, params) req.send_request() end |
#delete_environment(params = {}) ⇒ Types::DeleteEnvironmentResponse
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.
1052 1053 1054 1055 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1052 def delete_environment(params = {}, = {}) req = build_request(:delete_environment, params) req.send_request() end |
#delete_resource_policy(params = {}) ⇒ Struct
Deletes the resource policy set for the environment.
1074 1075 1076 1077 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1074 def delete_resource_policy(params = {}, = {}) req = build_request(:delete_resource_policy, params) req.send_request() end |
#delete_route(params = {}) ⇒ Types::DeleteRouteResponse
Deletes an Amazon Web Services Migration Hub Refactor Spaces route.
1120 1121 1122 1123 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1120 def delete_route(params = {}, = {}) req = build_request(:delete_route, params) req.send_request() end |
#delete_service(params = {}) ⇒ Types::DeleteServiceResponse
Deletes an Amazon Web Services Migration Hub Refactor Spaces service.
1174 1175 1176 1177 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1174 def delete_service(params = {}, = {}) req = build_request(:delete_service, params) req.send_request() end |
#get_application(params = {}) ⇒ Types::GetApplicationResponse
Gets an Amazon Web Services Migration Hub Refactor Spaces application.
1245 1246 1247 1248 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1245 def get_application(params = {}, = {}) req = build_request(:get_application, params) req.send_request() end |
#get_environment(params = {}) ⇒ Types::GetEnvironmentResponse
Gets an Amazon Web Services Migration Hub Refactor Spaces environment.
1302 1303 1304 1305 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1302 def get_environment(params = {}, = {}) req = build_request(:get_environment, params) req.send_request() end |
#get_resource_policy(params = {}) ⇒ Types::GetResourcePolicyResponse
Gets the resource-based permission policy that is set for the given environment.
1332 1333 1334 1335 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1332 def get_resource_policy(params = {}, = {}) req = build_request(:get_resource_policy, params) req.send_request() end |
#get_route(params = {}) ⇒ Types::GetRouteResponse
Gets an Amazon Web Services Migration Hub Refactor Spaces route.
1411 1412 1413 1414 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1411 def get_route(params = {}, = {}) req = build_request(:get_route, params) req.send_request() end |
#get_service(params = {}) ⇒ Types::GetServiceResponse
Gets an Amazon Web Services Migration Hub Refactor Spaces service.
1487 1488 1489 1490 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1487 def get_service(params = {}, = {}) req = build_request(:get_service, params) req.send_request() end |
#list_applications(params = {}) ⇒ Types::ListApplicationsResponse
Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1557 1558 1559 1560 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1557 def list_applications(params = {}, = {}) req = build_request(:list_applications, params) req.send_request() end |
#list_environment_vpcs(params = {}) ⇒ Types::ListEnvironmentVpcsResponse
Lists all Amazon Web Services Migration Hub Refactor Spaces service virtual private clouds (VPCs) that are part of the environment.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1608 1609 1610 1611 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1608 def list_environment_vpcs(params = {}, = {}) req = build_request(:list_environment_vpcs, params) req.send_request() end |
#list_environments(params = {}) ⇒ Types::ListEnvironmentsResponse
Lists Amazon Web Services Migration Hub Refactor Spaces environments owned by a caller account or shared with the caller account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1666 1667 1668 1669 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1666 def list_environments(params = {}, = {}) req = build_request(:list_environments, params) req.send_request() end |
#list_routes(params = {}) ⇒ Types::ListRoutesResponse
Lists all the Amazon Web Services Migration Hub Refactor Spaces routes within an application.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1740 1741 1742 1743 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1740 def list_routes(params = {}, = {}) req = build_request(:list_routes, params) req.send_request() end |
#list_services(params = {}) ⇒ Types::ListServicesResponse
Lists all the Amazon Web Services Migration Hub Refactor Spaces services within an application.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1812 1813 1814 1815 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1812 def list_services(params = {}, = {}) req = build_request(:list_services, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
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.
1843 1844 1845 1846 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1843 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_resource_policy(params = {}) ⇒ Struct
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.
1876 1877 1878 1879 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1876 def put_resource_policy(params = {}, = {}) req = build_request(:put_resource_policy, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
1913 1914 1915 1916 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1913 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
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.
1942 1943 1944 1945 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1942 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_route(params = {}) ⇒ Types::UpdateRouteResponse
Updates an Amazon Web Services Migration Hub Refactor Spaces route.
1993 1994 1995 1996 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1993 def update_route(params = {}, = {}) req = build_request(:update_route, params) req.send_request() end |