applications

Creates, updates, deletes, gets or lists an applications resource.

Overview

Name	applications
Type	Resource
Id	aws.migration_hub_refactor_spaces.applications

Fields

The following fields are returned by SELECT queries:

get_application

Name	Datatype	Description
api_gateway_proxy	object	The endpoint URL of the API Gateway proxy.
application_id	string	The unique identifier of the application. (pattern: <code>^app-[0-9A-Za-z]{10}$</code>)
arn	string	The Amazon Resource Name (ARN) of the application. (pattern: <code>^arn:aws:refactor-spaces:[a-zA-Z0-9-]+:\w{12}:[a-zA-Z_0-9+=,.@-_/]+$</code>)
created_by_account_id	string	The Amazon Web Services account ID of the application creator. (pattern: <code>^\d{12}$</code>)
created_time	string (date-time)	A timestamp that indicates when the application is created.
environment_id	string	The unique identifier of the environment. (pattern: <code>^env-[0-9A-Za-z]{10}$</code>)
error	object	Any error associated with the application resource.
last_updated_time	string (date-time)	A timestamp that indicates when the application was last updated.
name	string	The name of the application. (pattern: <code>^(?!app-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$</code>)
owner_account_id	string	The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID). (pattern: <code>^\d{12}$</code>)
proxy_type	string	The proxy type of the proxy created within the application. (API_GATEWAY)
state	string	The current state of the application. (CREATING, ACTIVE, DELETING, FAILED, UPDATING)
tags	object	The tags assigned to the application. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.
vpc_id	string	The ID of the virtual private cloud (VPC). (pattern: <code>^vpc-[-a-f0-9]{8}([-a-f0-9]{9})?$</code>)

list_applications

Name	Datatype	Description
api_gateway_proxy	object	The endpoint URL of the Amazon API Gateway proxy.
application_id	string	The unique identifier of the application. (pattern: <code>^app-[0-9A-Za-z]{10}$</code>)
arn	string	The Amazon Resource Name (ARN) of the application. (pattern: <code>^arn:aws:refactor-spaces:[a-zA-Z0-9-]+:\w{12}:[a-zA-Z_0-9+=,.@-_/]+$</code>)
created_by_account_id	string	The Amazon Web Services account ID of the application creator. (pattern: <code>^\d{12}$</code>)
created_time	string (date-time)	A timestamp that indicates when the application is created.
environment_id	string	The unique identifier of the environment. (pattern: <code>^env-[0-9A-Za-z]{10}$</code>)
error	object	Any error associated with the application resource.
last_updated_time	string (date-time)	A timestamp that indicates when the application was last updated.
name	string	The name of the application. (pattern: <code>^(?!app-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$</code>)
owner_account_id	string	The Amazon Web Services account ID of the application owner (which is always the same as the environment owner account ID). (pattern: <code>^\d{12}$</code>)
proxy_type	string	The proxy type of the proxy created within the application. (API_GATEWAY)
state	string	The current state of the application. (CREATING, ACTIVE, DELETING, FAILED, UPDATING)
tags	object	The tags assigned to the application.
vpc_id	string	The ID of the virtual private cloud (VPC). (pattern: <code>^vpc-[-a-f0-9]{8}([-a-f0-9]{9})?$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_application	select	application_identifier, environment_identifier, region		Gets an Amazon Web Services Migration Hub Refactor Spaces application.
list_applications	select	environment_identifier, region	maxResults, nextToken	Lists all the Amazon Web Services Migration Hub Refactor Spaces applications within an environment.
create_application	insert	environment_identifier, region, ProxyType, VpcId		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.
delete_application	delete	application_identifier, environment_identifier, region		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
application_identifier	string	The ID of the application.
environment_identifier	string	The ID of the environment.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
nextToken	string	The token for the next page of results.

SELECT examples

get_application

Gets an Amazon Web Services Migration Hub Refactor Spaces application.

SELECT
api_gateway_proxy,
application_id,
arn,
created_by_account_id,
created_time,
environment_id,
error,
last_updated_time,
name,
owner_account_id,
proxy_type,
state,
tags,
vpc_id
FROM aws.migration_hub_refactor_spaces.applications
WHERE application_identifier = '{{ application_identifier }}' -- required
AND environment_identifier = '{{ environment_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_applications

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

SELECT
api_gateway_proxy,
application_id,
arn,
created_by_account_id,
created_time,
environment_id,
error,
last_updated_time,
name,
owner_account_id,
proxy_type,
state,
tags,
vpc_id
FROM aws.migration_hub_refactor_spaces.applications
WHERE environment_identifier = '{{ environment_identifier }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_application

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.

INSERT INTO aws.migration_hub_refactor_spaces.applications (
ApiGatewayProxy,
ClientToken,
Name,
ProxyType,
Tags,
VpcId,
environment_identifier,
region
)
SELECT 
'{{ ApiGatewayProxy }}',
'{{ ClientToken }}',
'{{ Name }}',
'{{ ProxyType }}' /* required */,
'{{ Tags }}',
'{{ VpcId }}' /* required */,
'{{ environment_identifier }}',
'{{ region }}'
RETURNING
api_gateway_proxy,
application_id,
arn,
created_by_account_id,
created_time,
environment_id,
last_updated_time,
name,
owner_account_id,
proxy_type,
state,
tags,
vpc_id
;

Manifest

# Description fields are for documentation purposes
- name: applications
props:
  - name: environment_identifier
    value: "{{ environment_identifier }}"
    description: Required parameter for the applications resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the applications resource.
  - name: ApiGatewayProxy
    description: |
      A wrapper object holding the Amazon API Gateway endpoint input.
    value:
      EndpointType: "{{ EndpointType }}"
      StageName: "{{ StageName }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: Name
    value: "{{ Name }}"
  - name: ProxyType
    value: "{{ ProxyType }}"
    valid_values: ['API_GATEWAY']
  - name: Tags
    value: "{{ Tags }}"
    description: |
      A collection of up to 50 unique tags
  - name: VpcId
    value: "{{ VpcId }}"

DELETE examples

delete_application

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.

DELETE FROM aws.migration_hub_refactor_spaces.applications
WHERE application_identifier = '{{ application_identifier }}' --required
AND environment_identifier = '{{ environment_identifier }}' --required
AND region = '{{ region }}' --required
;