AWS::RefactorSpaces::Environment
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 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.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::RefactorSpaces::Environment", "Properties" : { "Description" :
String
, "Name" :String
, "NetworkFabricType" :String
, "Tags" :[ Tag, ... ]
} }
YAML
Type: AWS::RefactorSpaces::Environment Properties: Description:
String
Name:String
NetworkFabricType:String
Tags:- Tag
Properties
Description
-
A description of the environment.
Required: No
Type: String
Pattern:
^[a-zA-Z0-9-_\s\.\!\*\#\@\']+$
Minimum:
1
Maximum:
256
Update requires: Replacement
Name
-
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
NetworkFabricType
-
The network fabric type of the environment.
Required: No
Type: String
Allowed values:
TRANSIT_GATEWAY | NONE
Update requires: Replacement
-
The tags assigned to the environment.
Required: No
Type: Array of Tag
Update requires: No interruption
Return values
Ref
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 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
.
Arn
-
The Amazon Resource Name (ARN) of the environment.
EnvironmentIdentifier
-
The unique identifier of the environment.
TransitGatewayId
-
The ID of the AWS Transit Gateway set up by the environment.