This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS Migration Hub Refactor Spaces
<a name="AWS_RefactorSpaces"></a>

**Resource types**
+ [AWS::RefactorSpaces::Application](aws-resource-refactorspaces-application.md)
+ [AWS::RefactorSpaces::Environment](aws-resource-refactorspaces-environment.md)
+ [AWS::RefactorSpaces::Route](aws-resource-refactorspaces-route.md)
+ [AWS::RefactorSpaces::Service](aws-resource-refactorspaces-service.md)

# AWS::RefactorSpaces::Application
<a name="aws-resource-refactorspaces-application"></a>

**Note**  
AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

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](https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType) of `NONE` you need to configure [ VPC to VPC connectivity](https://docs.aws.amazon.com/whitepapers/latest/aws-vpc-connectivity-options/amazon-vpc-to-amazon-vpc-connectivity-options.html) 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](https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/userguide/getting-started-create-application.html) in the *Refactor Spaces User Guide*. 

## Syntax
<a name="aws-resource-refactorspaces-application-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-refactorspaces-application-syntax.json"></a>

```
{
  "Type" : "AWS::RefactorSpaces::Application",
  "Properties" : {
      "[ApiGatewayProxy](#cfn-refactorspaces-application-apigatewayproxy)" : ApiGatewayProxyInput,
      "[EnvironmentIdentifier](#cfn-refactorspaces-application-environmentidentifier)" : String,
      "[Name](#cfn-refactorspaces-application-name)" : String,
      "[ProxyType](#cfn-refactorspaces-application-proxytype)" : String,
      "[Tags](#cfn-refactorspaces-application-tags)" : [ Tag, ... ],
      "[VpcId](#cfn-refactorspaces-application-vpcid)" : String
    }
}
```

### YAML
<a name="aws-resource-refactorspaces-application-syntax.yaml"></a>

```
Type: AWS::RefactorSpaces::Application
Properties:
  [ApiGatewayProxy](#cfn-refactorspaces-application-apigatewayproxy): 
    ApiGatewayProxyInput
  [EnvironmentIdentifier](#cfn-refactorspaces-application-environmentidentifier): String
  [Name](#cfn-refactorspaces-application-name): String
  [ProxyType](#cfn-refactorspaces-application-proxytype): String
  [Tags](#cfn-refactorspaces-application-tags): 
    - Tag
  [VpcId](#cfn-refactorspaces-application-vpcid): String
```

## Properties
<a name="aws-resource-refactorspaces-application-properties"></a>

`ApiGatewayProxy`  <a name="cfn-refactorspaces-application-apigatewayproxy"></a>
The endpoint URL of the Amazon API Gateway proxy.   
*Required*: No  
*Type*: [ApiGatewayProxyInput](aws-properties-refactorspaces-application-apigatewayproxyinput.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`EnvironmentIdentifier`  <a name="cfn-refactorspaces-application-environmentidentifier"></a>
The unique identifier of the environment.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^env-([0-9A-Za-z]{10}$)`  
*Minimum*: `14`  
*Maximum*: `14`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Name`  <a name="cfn-refactorspaces-application-name"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ProxyType`  <a name="cfn-refactorspaces-application-proxytype"></a>
The proxy type of the proxy created within the application.   
*Required*: Yes  
*Type*: String  
*Allowed values*: `API_GATEWAY`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-refactorspaces-application-tags"></a>
The tags assigned to the application.   
*Required*: No  
*Type*: Array of [Tag](aws-properties-refactorspaces-application-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcId`  <a name="cfn-refactorspaces-application-vpcid"></a>
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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-refactorspaces-application-return-values"></a>

### Ref
<a name="aws-resource-refactorspaces-application-return-values-ref"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-refactorspaces-application-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-refactorspaces-application-return-values-fn--getatt-fn--getatt"></a>

`ApiGatewayId`  <a name="ApiGatewayId-fn::getatt"></a>
The resource ID of the API Gateway for the proxy. 

`ApplicationIdentifier`  <a name="ApplicationIdentifier-fn::getatt"></a>
The unique identifier of the application.

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the application.

`NlbArn`  <a name="NlbArn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the Network Load Balancer.

`NlbName`  <a name="NlbName-fn::getatt"></a>
The name of the Network Load Balancer configured by the API Gateway proxy.

`ProxyUrl`  <a name="ProxyUrl-fn::getatt"></a>
The endpoint URL of the Amazon API Gateway proxy.

`StageName`  <a name="StageName-fn::getatt"></a>
The name of the API Gateway stage. The name defaults to `prod`.

`VpcLinkId`  <a name="VpcLinkId-fn::getatt"></a>
The `VpcLink` ID of the API Gateway proxy. 

# AWS::RefactorSpaces::Application ApiGatewayProxyInput
<a name="aws-properties-refactorspaces-application-apigatewayproxyinput"></a>

A wrapper object holding the Amazon API Gateway endpoint input. 

## Syntax
<a name="aws-properties-refactorspaces-application-apigatewayproxyinput-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-refactorspaces-application-apigatewayproxyinput-syntax.json"></a>

```
{
  "[EndpointType](#cfn-refactorspaces-application-apigatewayproxyinput-endpointtype)" : String,
  "[StageName](#cfn-refactorspaces-application-apigatewayproxyinput-stagename)" : String
}
```

### YAML
<a name="aws-properties-refactorspaces-application-apigatewayproxyinput-syntax.yaml"></a>

```
  [EndpointType](#cfn-refactorspaces-application-apigatewayproxyinput-endpointtype): String
  [StageName](#cfn-refactorspaces-application-apigatewayproxyinput-stagename): String
```

## Properties
<a name="aws-properties-refactorspaces-application-apigatewayproxyinput-properties"></a>

`EndpointType`  <a name="cfn-refactorspaces-application-apigatewayproxyinput-endpointtype"></a>
The type of endpoint to use for the API Gateway proxy. If no value is specified in the request, the value is set to `REGIONAL` by default.  
If the value is set to `PRIVATE` in the request, this creates a private API endpoint that is isolated from the public internet. The private endpoint can only be accessed by using Amazon Virtual Private Cloud (Amazon VPC) interface endpoints for the Amazon API Gateway that has been granted access. For more information about creating a private connection with Refactor Spaces and interface endpoint (AWS PrivateLink) availability, see [Access Refactor Spaces using an interface endpoint (AWS PrivateLink)](https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/userguide/vpc-interface-endpoints.html).  
*Required*: No  
*Type*: String  
*Allowed values*: `REGIONAL | PRIVATE`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`StageName`  <a name="cfn-refactorspaces-application-apigatewayproxyinput-stagename"></a>
The name of the API Gateway stage. The name defaults to `prod`.   
*Required*: No  
*Type*: String  
*Pattern*: `^[-a-zA-Z0-9_]*$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::RefactorSpaces::Application Tag
<a name="aws-properties-refactorspaces-application-tag"></a>

<a name="aws-properties-refactorspaces-application-tag-description"></a>The `Tag` property type specifies Property description not available. for an [AWS::RefactorSpaces::Application](aws-resource-refactorspaces-application.md).

## Syntax
<a name="aws-properties-refactorspaces-application-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-refactorspaces-application-tag-syntax.json"></a>

```
{
  "[Key](#cfn-refactorspaces-application-tag-key)" : String,
  "[Value](#cfn-refactorspaces-application-tag-value)" : String
}
```

### YAML
<a name="aws-properties-refactorspaces-application-tag-syntax.yaml"></a>

```
  [Key](#cfn-refactorspaces-application-tag-key): String
  [Value](#cfn-refactorspaces-application-tag-value): String
```

## Properties
<a name="aws-properties-refactorspaces-application-tag-properties"></a>

`Key`  <a name="cfn-refactorspaces-application-tag-key"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(?!aws:).+`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-refactorspaces-application-tag-value"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::RefactorSpaces::Environment
<a name="aws-resource-refactorspaces-environment"></a>

**Note**  
AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

Creates an AWS 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](https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType) of `TRANSIT_GATEWAY`, Refactor Spaces provisions a transit gateway to enable services in VPCs to communicate directly across accounts. If [CreateEnvironment:NetworkFabricType](https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-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.

## Syntax
<a name="aws-resource-refactorspaces-environment-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-refactorspaces-environment-syntax.json"></a>

```
{
  "Type" : "AWS::RefactorSpaces::Environment",
  "Properties" : {
      "[Description](#cfn-refactorspaces-environment-description)" : String,
      "[Name](#cfn-refactorspaces-environment-name)" : String,
      "[NetworkFabricType](#cfn-refactorspaces-environment-networkfabrictype)" : String,
      "[Tags](#cfn-refactorspaces-environment-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-refactorspaces-environment-syntax.yaml"></a>

```
Type: AWS::RefactorSpaces::Environment
Properties:
  [Description](#cfn-refactorspaces-environment-description): String
  [Name](#cfn-refactorspaces-environment-name): String
  [NetworkFabricType](#cfn-refactorspaces-environment-networkfabrictype): String
  [Tags](#cfn-refactorspaces-environment-tags): 
    - Tag
```

## Properties
<a name="aws-resource-refactorspaces-environment-properties"></a>

`Description`  <a name="cfn-refactorspaces-environment-description"></a>
A description of the environment.   
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9-_\s\.\!\*\#\@\']+$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Name`  <a name="cfn-refactorspaces-environment-name"></a>
The name of the environment.   
*Required*: No  
*Type*: String  
*Pattern*: `^(?!env-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$`  
*Minimum*: `3`  
*Maximum*: `63`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`NetworkFabricType`  <a name="cfn-refactorspaces-environment-networkfabrictype"></a>
The network fabric type of the environment.   
*Required*: No  
*Type*: String  
*Allowed values*: `TRANSIT_GATEWAY | NONE`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-refactorspaces-environment-tags"></a>
The tags assigned to the environment.   
*Required*: No  
*Type*: Array of [Tag](aws-properties-refactorspaces-environment-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-refactorspaces-environment-return-values"></a>

### Ref
<a name="aws-resource-refactorspaces-environment-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ID of the environment, for example, `env-1234654123`.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-refactorspaces-environment-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-refactorspaces-environment-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the environment.

`EnvironmentIdentifier`  <a name="EnvironmentIdentifier-fn::getatt"></a>
The unique identifier of the environment.

`TransitGatewayId`  <a name="TransitGatewayId-fn::getatt"></a>
The ID of the AWS Transit Gateway set up by the environment.

# AWS::RefactorSpaces::Environment Tag
<a name="aws-properties-refactorspaces-environment-tag"></a>

<a name="aws-properties-refactorspaces-environment-tag-description"></a>The `Tag` property type specifies Property description not available. for an [AWS::RefactorSpaces::Environment](aws-resource-refactorspaces-environment.md).

## Syntax
<a name="aws-properties-refactorspaces-environment-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-refactorspaces-environment-tag-syntax.json"></a>

```
{
  "[Key](#cfn-refactorspaces-environment-tag-key)" : String,
  "[Value](#cfn-refactorspaces-environment-tag-value)" : String
}
```

### YAML
<a name="aws-properties-refactorspaces-environment-tag-syntax.yaml"></a>

```
  [Key](#cfn-refactorspaces-environment-tag-key): String
  [Value](#cfn-refactorspaces-environment-tag-value): String
```

## Properties
<a name="aws-properties-refactorspaces-environment-tag-properties"></a>

`Key`  <a name="cfn-refactorspaces-environment-tag-key"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(?!aws:).+`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-refactorspaces-environment-tag-value"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::RefactorSpaces::Route
<a name="aws-resource-refactorspaces-route"></a>

Creates an AWS 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.

**Note**  
 In the `AWS::RefactorSpaces::Route` resource, you can only update the `ActivationState` property, which resides under the `UriPathRoute` and `DefaultRoute` properties. All other properties associated with the `AWS::RefactorSpaces::Route` cannot be updated, even though the property description might indicate otherwise. Updating all other properties will result in the replacement of Route. 

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 of `SERVICE_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](https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateService.html#migrationhubrefactorspaces-CreateService-request-UrlEndpoint) parameter. All other health check settings for the load balancer use the default values described in the [Health checks for your target groups](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/target-group-health-checks.html) 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.

  
+  **AWS Lambda function endpoints** 

  If the service has an AWS 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](https://docs.aws.amazon.com/lambda/latest/dg/API_GetFunctionConfiguration.html#SSS-GetFunctionConfiguration-response-State) in the *AWS 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](https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/APIReference/API_CreateEnvironment.html#migrationhubrefactorspaces-CreateEnvironment-request-NetworkFabricType) is `NONE)` and you use your own networking infrastructure, you need to configure [VPC to VPC connectivity](https://docs.aws.amazon.com/whitepapers/latest/aws-vpc-connectivity-options/amazon-vpc-to-amazon-vpc-connectivity-options.html) 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](https://docs.aws.amazon.com/migrationhub-refactor-spaces/latest/userguide/getting-started-create-role.html) in the *Refactor Spaces User Guide*.



## Syntax
<a name="aws-resource-refactorspaces-route-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-refactorspaces-route-syntax.json"></a>

```
{
  "Type" : "AWS::RefactorSpaces::Route",
  "Properties" : {
      "[ApplicationIdentifier](#cfn-refactorspaces-route-applicationidentifier)" : String,
      "[DefaultRoute](#cfn-refactorspaces-route-defaultroute)" : DefaultRouteInput,
      "[EnvironmentIdentifier](#cfn-refactorspaces-route-environmentidentifier)" : String,
      "[RouteType](#cfn-refactorspaces-route-routetype)" : String,
      "[ServiceIdentifier](#cfn-refactorspaces-route-serviceidentifier)" : String,
      "[Tags](#cfn-refactorspaces-route-tags)" : [ Tag, ... ],
      "[UriPathRoute](#cfn-refactorspaces-route-uripathroute)" : UriPathRouteInput
    }
}
```

### YAML
<a name="aws-resource-refactorspaces-route-syntax.yaml"></a>

```
Type: AWS::RefactorSpaces::Route
Properties:
  [ApplicationIdentifier](#cfn-refactorspaces-route-applicationidentifier): String
  [DefaultRoute](#cfn-refactorspaces-route-defaultroute): 
    DefaultRouteInput
  [EnvironmentIdentifier](#cfn-refactorspaces-route-environmentidentifier): String
  [RouteType](#cfn-refactorspaces-route-routetype): String
  [ServiceIdentifier](#cfn-refactorspaces-route-serviceidentifier): String
  [Tags](#cfn-refactorspaces-route-tags): 
    - Tag
  [UriPathRoute](#cfn-refactorspaces-route-uripathroute): 
    UriPathRouteInput
```

## Properties
<a name="aws-resource-refactorspaces-route-properties"></a>

`ApplicationIdentifier`  <a name="cfn-refactorspaces-route-applicationidentifier"></a>
The unique identifier of the application.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^app-([0-9A-Za-z]{10}$)`  
*Minimum*: `14`  
*Maximum*: `14`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DefaultRoute`  <a name="cfn-refactorspaces-route-defaultroute"></a>
 Configuration for the default route type.   
*Required*: No  
*Type*: [DefaultRouteInput](aws-properties-refactorspaces-route-defaultrouteinput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EnvironmentIdentifier`  <a name="cfn-refactorspaces-route-environmentidentifier"></a>
The unique identifier of the environment.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^env-([0-9A-Za-z]{10}$)`  
*Minimum*: `14`  
*Maximum*: `14`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RouteType`  <a name="cfn-refactorspaces-route-routetype"></a>
The route type of the route.   
*Required*: Yes  
*Type*: String  
*Allowed values*: `DEFAULT | URI_PATH`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ServiceIdentifier`  <a name="cfn-refactorspaces-route-serviceidentifier"></a>
The unique identifier of the service.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^svc-([0-9A-Za-z]{10}$)`  
*Minimum*: `14`  
*Maximum*: `14`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-refactorspaces-route-tags"></a>
The tags assigned to the route.   
*Required*: No  
*Type*: Array of [Tag](aws-properties-refactorspaces-route-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UriPathRoute`  <a name="cfn-refactorspaces-route-uripathroute"></a>
The configuration for the URI path route type.  
*Required*: No  
*Type*: [UriPathRouteInput](aws-properties-refactorspaces-route-uripathrouteinput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-refactorspaces-route-return-values"></a>

### Ref
<a name="aws-resource-refactorspaces-route-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a composite ID following this format: `<EnvironmentId>|<ApplicationId>|<RouteId>`, for example, `env-1234654123|app-1234654123|rte-1234654123`.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-refactorspaces-route-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-refactorspaces-route-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the route.

`PathResourceToId`  <a name="PathResourceToId-fn::getatt"></a>
A mapping of Amazon API Gateway path resources to resource IDs.

`RouteIdentifier`  <a name="RouteIdentifier-fn::getatt"></a>
The unique identifier of the route.

# AWS::RefactorSpaces::Route DefaultRouteInput
<a name="aws-properties-refactorspaces-route-defaultrouteinput"></a>

 The configuration for the default route type. 

## Syntax
<a name="aws-properties-refactorspaces-route-defaultrouteinput-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-refactorspaces-route-defaultrouteinput-syntax.json"></a>

```
{
  "[ActivationState](#cfn-refactorspaces-route-defaultrouteinput-activationstate)" : String
}
```

### YAML
<a name="aws-properties-refactorspaces-route-defaultrouteinput-syntax.yaml"></a>

```
  [ActivationState](#cfn-refactorspaces-route-defaultrouteinput-activationstate): String
```

## Properties
<a name="aws-properties-refactorspaces-route-defaultrouteinput-properties"></a>

`ActivationState`  <a name="cfn-refactorspaces-route-defaultrouteinput-activationstate"></a>
If set to `ACTIVE`, traffic is forwarded to this route’s service after the route is created.   
*Required*: Yes  
*Type*: String  
*Allowed values*: `INACTIVE | ACTIVE`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::RefactorSpaces::Route Tag
<a name="aws-properties-refactorspaces-route-tag"></a>

<a name="aws-properties-refactorspaces-route-tag-description"></a>The `Tag` property type specifies Property description not available. for an [AWS::RefactorSpaces::Route](aws-resource-refactorspaces-route.md).

## Syntax
<a name="aws-properties-refactorspaces-route-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-refactorspaces-route-tag-syntax.json"></a>

```
{
  "[Key](#cfn-refactorspaces-route-tag-key)" : String,
  "[Value](#cfn-refactorspaces-route-tag-value)" : String
}
```

### YAML
<a name="aws-properties-refactorspaces-route-tag-syntax.yaml"></a>

```
  [Key](#cfn-refactorspaces-route-tag-key): String
  [Value](#cfn-refactorspaces-route-tag-value): String
```

## Properties
<a name="aws-properties-refactorspaces-route-tag-properties"></a>

`Key`  <a name="cfn-refactorspaces-route-tag-key"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(?!aws:).+`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-refactorspaces-route-tag-value"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::RefactorSpaces::Route UriPathRouteInput
<a name="aws-properties-refactorspaces-route-uripathrouteinput"></a>

The configuration for the URI path route type. 

## Syntax
<a name="aws-properties-refactorspaces-route-uripathrouteinput-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-refactorspaces-route-uripathrouteinput-syntax.json"></a>

```
{
  "[ActivationState](#cfn-refactorspaces-route-uripathrouteinput-activationstate)" : String,
  "[AppendSourcePath](#cfn-refactorspaces-route-uripathrouteinput-appendsourcepath)" : Boolean,
  "[IncludeChildPaths](#cfn-refactorspaces-route-uripathrouteinput-includechildpaths)" : Boolean,
  "[Methods](#cfn-refactorspaces-route-uripathrouteinput-methods)" : [ String, ... ],
  "[SourcePath](#cfn-refactorspaces-route-uripathrouteinput-sourcepath)" : String
}
```

### YAML
<a name="aws-properties-refactorspaces-route-uripathrouteinput-syntax.yaml"></a>

```
  [ActivationState](#cfn-refactorspaces-route-uripathrouteinput-activationstate): String
  [AppendSourcePath](#cfn-refactorspaces-route-uripathrouteinput-appendsourcepath): Boolean
  [IncludeChildPaths](#cfn-refactorspaces-route-uripathrouteinput-includechildpaths): Boolean
  [Methods](#cfn-refactorspaces-route-uripathrouteinput-methods): 
    - String
  [SourcePath](#cfn-refactorspaces-route-uripathrouteinput-sourcepath): String
```

## Properties
<a name="aws-properties-refactorspaces-route-uripathrouteinput-properties"></a>

`ActivationState`  <a name="cfn-refactorspaces-route-uripathrouteinput-activationstate"></a>
If set to `ACTIVE`, traffic is forwarded to this route’s service after the route is created.   
*Required*: Yes  
*Type*: String  
*Allowed values*: `INACTIVE | ACTIVE`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AppendSourcePath`  <a name="cfn-refactorspaces-route-uripathrouteinput-appendsourcepath"></a>
If set to `true`, this option appends the source path to the service URL endpoint.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`IncludeChildPaths`  <a name="cfn-refactorspaces-route-uripathrouteinput-includechildpaths"></a>
Indicates whether to match all subpaths of the given source path. If this value is `false`, requests must match the source path exactly before they are forwarded to this route's service.   
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Methods`  <a name="cfn-refactorspaces-route-uripathrouteinput-methods"></a>
A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.   
*Required*: No  
*Type*: Array of String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SourcePath`  <a name="cfn-refactorspaces-route-uripathrouteinput-sourcepath"></a>
This is the path that Refactor Spaces uses to match traffic. Paths must start with `/` and are relative to the base of the application. To use path parameters in the source path, add a variable in curly braces. For example, the resource path \$1user\$1 represents a path parameter called 'user'.  
*Required*: No  
*Type*: String  
*Pattern*: `^(/([a-zA-Z0-9._:-]+|\{[a-zA-Z0-9._:-]+\}))+$`  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::RefactorSpaces::Service
<a name="aws-resource-refactorspaces-service"></a>

**Note**  
AWS Migration Hub is no longer open to new customers as of November 7, 2025. For capabilities similar to AWS Migration Hub, explore [AWS Migration Hub](https://aws.amazon.com/transform).

Creates an AWS 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.

**Important**  
If an AWS 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.

## Syntax
<a name="aws-resource-refactorspaces-service-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-refactorspaces-service-syntax.json"></a>

```
{
  "Type" : "AWS::RefactorSpaces::Service",
  "Properties" : {
      "[ApplicationIdentifier](#cfn-refactorspaces-service-applicationidentifier)" : String,
      "[Description](#cfn-refactorspaces-service-description)" : String,
      "[EndpointType](#cfn-refactorspaces-service-endpointtype)" : String,
      "[EnvironmentIdentifier](#cfn-refactorspaces-service-environmentidentifier)" : String,
      "[LambdaEndpoint](#cfn-refactorspaces-service-lambdaendpoint)" : LambdaEndpointInput,
      "[Name](#cfn-refactorspaces-service-name)" : String,
      "[Tags](#cfn-refactorspaces-service-tags)" : [ Tag, ... ],
      "[UrlEndpoint](#cfn-refactorspaces-service-urlendpoint)" : UrlEndpointInput,
      "[VpcId](#cfn-refactorspaces-service-vpcid)" : String
    }
}
```

### YAML
<a name="aws-resource-refactorspaces-service-syntax.yaml"></a>

```
Type: AWS::RefactorSpaces::Service
Properties:
  [ApplicationIdentifier](#cfn-refactorspaces-service-applicationidentifier): String
  [Description](#cfn-refactorspaces-service-description): String
  [EndpointType](#cfn-refactorspaces-service-endpointtype): String
  [EnvironmentIdentifier](#cfn-refactorspaces-service-environmentidentifier): String
  [LambdaEndpoint](#cfn-refactorspaces-service-lambdaendpoint): 
    LambdaEndpointInput
  [Name](#cfn-refactorspaces-service-name): String
  [Tags](#cfn-refactorspaces-service-tags): 
    - Tag
  [UrlEndpoint](#cfn-refactorspaces-service-urlendpoint): 
    UrlEndpointInput
  [VpcId](#cfn-refactorspaces-service-vpcid): String
```

## Properties
<a name="aws-resource-refactorspaces-service-properties"></a>

`ApplicationIdentifier`  <a name="cfn-refactorspaces-service-applicationidentifier"></a>
The unique identifier of the application.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^app-([0-9A-Za-z]{10}$)`  
*Minimum*: `14`  
*Maximum*: `14`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Description`  <a name="cfn-refactorspaces-service-description"></a>
A description of the service.   
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9-_\s\.\!\*\#\@\']+$`  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`EndpointType`  <a name="cfn-refactorspaces-service-endpointtype"></a>
The endpoint type of the service.   
*Required*: Yes  
*Type*: String  
*Allowed values*: `LAMBDA | URL`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`EnvironmentIdentifier`  <a name="cfn-refactorspaces-service-environmentidentifier"></a>
The unique identifier of the environment.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^env-([0-9A-Za-z]{10}$)`  
*Minimum*: `14`  
*Maximum*: `14`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`LambdaEndpoint`  <a name="cfn-refactorspaces-service-lambdaendpoint"></a>
A summary of the configuration for the AWS Lambda endpoint type.   
*Required*: No  
*Type*: [LambdaEndpointInput](aws-properties-refactorspaces-service-lambdaendpointinput.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Name`  <a name="cfn-refactorspaces-service-name"></a>
The name of the service.   
*Required*: Yes  
*Type*: String  
*Pattern*: `^(?!svc-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$`  
*Minimum*: `3`  
*Maximum*: `63`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-refactorspaces-service-tags"></a>
The tags assigned to the service.   
*Required*: No  
*Type*: Array of [Tag](aws-properties-refactorspaces-service-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UrlEndpoint`  <a name="cfn-refactorspaces-service-urlendpoint"></a>
The summary of the configuration for the URL endpoint type.   
*Required*: No  
*Type*: [UrlEndpointInput](aws-properties-refactorspaces-service-urlendpointinput.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`VpcId`  <a name="cfn-refactorspaces-service-vpcid"></a>
The ID of the virtual private cloud (VPC).   
*Required*: No  
*Type*: String  
*Pattern*: `^vpc-[-a-f0-9]{8}([-a-f0-9]{9})?$`  
*Minimum*: `12`  
*Maximum*: `21`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-refactorspaces-service-return-values"></a>

### Ref
<a name="aws-resource-refactorspaces-service-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns a composite ID following this format: `<EnvironmentId>|<ApplicationId>|<ServiceId>`. For example, `env-1234654123|app-1234654123|svc-1234654123`.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-refactorspaces-service-return-values-fn--getatt"></a>

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 [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-refactorspaces-service-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the service.

`ServiceIdentifier`  <a name="ServiceIdentifier-fn::getatt"></a>
The unique identifier of the service.

# AWS::RefactorSpaces::Service LambdaEndpointInput
<a name="aws-properties-refactorspaces-service-lambdaendpointinput"></a>

The input for the AWS Lambda endpoint type. 

## Syntax
<a name="aws-properties-refactorspaces-service-lambdaendpointinput-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-refactorspaces-service-lambdaendpointinput-syntax.json"></a>

```
{
  "[Arn](#cfn-refactorspaces-service-lambdaendpointinput-arn)" : String
}
```

### YAML
<a name="aws-properties-refactorspaces-service-lambdaendpointinput-syntax.yaml"></a>

```
  [Arn](#cfn-refactorspaces-service-lambdaendpointinput-arn): String
```

## Properties
<a name="aws-properties-refactorspaces-service-lambdaendpointinput-properties"></a>

`Arn`  <a name="cfn-refactorspaces-service-lambdaendpointinput-arn"></a>
The Amazon Resource Name (ARN) of the Lambda function or alias.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:function:[a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?$`  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::RefactorSpaces::Service Tag
<a name="aws-properties-refactorspaces-service-tag"></a>

<a name="aws-properties-refactorspaces-service-tag-description"></a>The `Tag` property type specifies Property description not available. for an [AWS::RefactorSpaces::Service](aws-resource-refactorspaces-service.md).

## Syntax
<a name="aws-properties-refactorspaces-service-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-refactorspaces-service-tag-syntax.json"></a>

```
{
  "[Key](#cfn-refactorspaces-service-tag-key)" : String,
  "[Value](#cfn-refactorspaces-service-tag-value)" : String
}
```

### YAML
<a name="aws-properties-refactorspaces-service-tag-syntax.yaml"></a>

```
  [Key](#cfn-refactorspaces-service-tag-key): String
  [Value](#cfn-refactorspaces-service-tag-value): String
```

## Properties
<a name="aws-properties-refactorspaces-service-tag-properties"></a>

`Key`  <a name="cfn-refactorspaces-service-tag-key"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(?!aws:).+`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-refactorspaces-service-tag-value"></a>
Property description not available.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::RefactorSpaces::Service UrlEndpointInput
<a name="aws-properties-refactorspaces-service-urlendpointinput"></a>

The configuration for the URL endpoint type. 

## Syntax
<a name="aws-properties-refactorspaces-service-urlendpointinput-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-refactorspaces-service-urlendpointinput-syntax.json"></a>

```
{
  "[HealthUrl](#cfn-refactorspaces-service-urlendpointinput-healthurl)" : String,
  "[Url](#cfn-refactorspaces-service-urlendpointinput-url)" : String
}
```

### YAML
<a name="aws-properties-refactorspaces-service-urlendpointinput-syntax.yaml"></a>

```
  [HealthUrl](#cfn-refactorspaces-service-urlendpointinput-healthurl): String
  [Url](#cfn-refactorspaces-service-urlendpointinput-url): String
```

## Properties
<a name="aws-properties-refactorspaces-service-urlendpointinput-properties"></a>

`HealthUrl`  <a name="cfn-refactorspaces-service-urlendpointinput-healthurl"></a>
The health check URL of the URL endpoint type. If the URL is a public endpoint, the `HealthUrl` must also be a public endpoint. If the URL is a private endpoint inside a virtual private cloud (VPC), the health URL must also be a private endpoint, and the host must be the same as the URL.   
*Required*: No  
*Type*: String  
*Pattern*: `^https?://[-a-zA-Z0-9+\x38@#/%?=~_|!:,.;]*[-a-zA-Z0-9+\x38@#/%=~_|]$`  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Url`  <a name="cfn-refactorspaces-service-urlendpointinput-url"></a>
The URL to route traffic to. The URL must be an [rfc3986-formatted URL](https://datatracker.ietf.org/doc/html/rfc3986). If the host is a domain name, the name must be resolvable over the public internet. If the scheme is `https`, the top level domain of the host must be listed in the [IANA root zone database](https://www.iana.org/domains/root/db).   
*Required*: Yes  
*Type*: String  
*Pattern*: `^https?://[-a-zA-Z0-9+\x38@#/%?=~_|!:,.;]*[-a-zA-Z0-9+\x38@#/%=~_|]$`  
*Minimum*: `1`  
*Maximum*: `2048`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)