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.
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.
348 349 350 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 348 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.
444 445 446 447 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 444 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, Refactor Spaces provisions a transit gateway in your account.
522 523 524 525 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 522 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 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 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.
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 publicly resolvable.
670 671 672 673 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 670 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.
790 791 792 793 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 790 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.
834 835 836 837 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 834 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.
872 873 874 875 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 872 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.
894 895 896 897 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 894 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.
940 941 942 943 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 940 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.
994 995 996 997 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 994 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.
1065 1066 1067 1068 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1065 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.
1122 1123 1124 1125 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1122 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.
1152 1153 1154 1155 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1152 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.
1229 1230 1231 1232 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1229 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.
1305 1306 1307 1308 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1305 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.
1375 1376 1377 1378 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1375 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.
1426 1427 1428 1429 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1426 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.
1484 1485 1486 1487 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1484 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.
1557 1558 1559 1560 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1557 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.
1629 1630 1631 1632 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1629 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.
1660 1661 1662 1663 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1660 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.
1693 1694 1695 1696 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1693 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.
1730 1731 1732 1733 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1730 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.
1759 1760 1761 1762 |
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/client.rb', line 1759 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |