AWS::RefactorSpaces::Application
Creates an AWS 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.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::RefactorSpaces::Application", "Properties" : { "ApiGatewayProxy" :
ApiGatewayProxyInput
, "EnvironmentIdentifier" :String
, "Name" :String
, "ProxyType" :String
, "Tags" :[ Tag, ... ]
, "VpcId" :String
} }
YAML
Type: AWS::RefactorSpaces::Application Properties: ApiGatewayProxy:
ApiGatewayProxyInput
EnvironmentIdentifier:String
Name:String
ProxyType:String
Tags:- Tag
VpcId:String
Properties
ApiGatewayProxy
-
The endpoint URL of the Amazon API Gateway proxy.
Required: No
Type: ApiGatewayProxyInput
Update requires: Replacement
EnvironmentIdentifier
-
The unique identifier of the environment.
Required: Yes
Type: String
Pattern:
^env-([0-9A-Za-z]{10}$)
Minimum:
14
Maximum:
14
Update requires: Replacement
Name
-
The name of the application.
Required: Yes
Type: String
Pattern:
^(?!app-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$
Minimum:
3
Maximum:
63
Update requires: Replacement
ProxyType
-
The proxy type of the proxy created within the application.
Required: Yes
Type: String
Allowed values:
API_GATEWAY
Update requires: Replacement
-
The tags assigned to the application.
Required: No
Type: Array of Tag
Update requires: No interruption
VpcId
-
The ID of the virtual private cloud (VPC).
Required: Yes
Type: String
Pattern:
^vpc-[-a-f0-9]{8}([-a-f0-9]{9})?$
Minimum:
12
Maximum:
21
Update requires: Replacement
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns a composite ID following this format:
<EnvironmentId>|<ApplicationId>
, for example,
env-1234654123|app-1234654123
.
For more information about using the Ref
function, see Ref
.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt
.
ApiGatewayId
-
The resource ID of the API Gateway for the proxy.
ApplicationIdentifier
-
The unique identifier of the application.
Arn
-
The Amazon Resource Name (ARN) of the application.
NlbArn
-
The Amazon Resource Name (ARN) of the Network Load Balancer.
NlbName
-
The name of the Network Load Balancer configured by the API Gateway proxy.
ProxyUrl
-
The endpoint URL of the Amazon API Gateway proxy.
StageName
-
The name of the API Gateway stage. The name defaults to
prod
. VpcLinkId
-
The
VpcLink
ID of the API Gateway proxy.