1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. refactorspaces
  5. Route

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.refactorspaces.Route

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

Definition of AWS::RefactorSpaces::Route Resource Type

Create Route Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Route(name: string, args: RouteArgs, opts?: CustomResourceOptions);
@overload
def Route(resource_name: str,
          args: RouteArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Route(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          application_identifier: Optional[str] = None,
          environment_identifier: Optional[str] = None,
          route_type: Optional[RouteType] = None,
          service_identifier: Optional[str] = None,
          default_route: Optional[RouteDefaultRouteInputArgs] = None,
          tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
          uri_path_route: Optional[RouteUriPathRouteInputArgs] = None)
func NewRoute(ctx *Context, name string, args RouteArgs, opts ...ResourceOption) (*Route, error)
public Route(string name, RouteArgs args, CustomResourceOptions? opts = null)
public Route(String name, RouteArgs args)
public Route(String name, RouteArgs args, CustomResourceOptions options)
type: aws-native:refactorspaces:Route
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. RouteArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. RouteArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. RouteArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. RouteArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. RouteArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Route Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Route resource accepts the following input properties:

ApplicationIdentifier This property is required. string
The unique identifier of the application.
EnvironmentIdentifier This property is required. string
The unique identifier of the environment.
RouteType This property is required. Pulumi.AwsNative.RefactorSpaces.RouteType
The route type of the route.
ServiceIdentifier This property is required. string
The unique identifier of the service.
DefaultRoute Pulumi.AwsNative.RefactorSpaces.Inputs.RouteDefaultRouteInput
Configuration for the default route type.
Tags List<Pulumi.AwsNative.Inputs.Tag>
Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
UriPathRoute Pulumi.AwsNative.RefactorSpaces.Inputs.RouteUriPathRouteInput
The configuration for the URI path route type.
ApplicationIdentifier This property is required. string
The unique identifier of the application.
EnvironmentIdentifier This property is required. string
The unique identifier of the environment.
RouteType This property is required. RouteType
The route type of the route.
ServiceIdentifier This property is required. string
The unique identifier of the service.
DefaultRoute RouteDefaultRouteInputArgs
Configuration for the default route type.
Tags TagArgs
Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
UriPathRoute RouteUriPathRouteInputArgs
The configuration for the URI path route type.
applicationIdentifier This property is required. String
The unique identifier of the application.
environmentIdentifier This property is required. String
The unique identifier of the environment.
routeType This property is required. RouteType
The route type of the route.
serviceIdentifier This property is required. String
The unique identifier of the service.
defaultRoute RouteDefaultRouteInput
Configuration for the default route type.
tags List<Tag>
Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
uriPathRoute RouteUriPathRouteInput
The configuration for the URI path route type.
applicationIdentifier This property is required. string
The unique identifier of the application.
environmentIdentifier This property is required. string
The unique identifier of the environment.
routeType This property is required. RouteType
The route type of the route.
serviceIdentifier This property is required. string
The unique identifier of the service.
defaultRoute RouteDefaultRouteInput
Configuration for the default route type.
tags Tag[]
Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
uriPathRoute RouteUriPathRouteInput
The configuration for the URI path route type.
application_identifier This property is required. str
The unique identifier of the application.
environment_identifier This property is required. str
The unique identifier of the environment.
route_type This property is required. RouteType
The route type of the route.
service_identifier This property is required. str
The unique identifier of the service.
default_route RouteDefaultRouteInputArgs
Configuration for the default route type.
tags Sequence[TagArgs]
Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
uri_path_route RouteUriPathRouteInputArgs
The configuration for the URI path route type.
applicationIdentifier This property is required. String
The unique identifier of the application.
environmentIdentifier This property is required. String
The unique identifier of the environment.
routeType This property is required. "DEFAULT" | "URI_PATH"
The route type of the route.
serviceIdentifier This property is required. String
The unique identifier of the service.
defaultRoute Property Map
Configuration for the default route type.
tags List<Property Map>
Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
uriPathRoute Property Map
The configuration for the URI path route type.

Outputs

All input properties are implicitly available as output properties. Additionally, the Route resource produces the following output properties:

Arn string
The Amazon Resource Name (ARN) of the route.
Id string
The provider-assigned unique ID for this managed resource.
PathResourceToId string
A mapping of Amazon API Gateway path resources to resource IDs.
RouteIdentifier string
The unique identifier of the route.
Arn string
The Amazon Resource Name (ARN) of the route.
Id string
The provider-assigned unique ID for this managed resource.
PathResourceToId string
A mapping of Amazon API Gateway path resources to resource IDs.
RouteIdentifier string
The unique identifier of the route.
arn String
The Amazon Resource Name (ARN) of the route.
id String
The provider-assigned unique ID for this managed resource.
pathResourceToId String
A mapping of Amazon API Gateway path resources to resource IDs.
routeIdentifier String
The unique identifier of the route.
arn string
The Amazon Resource Name (ARN) of the route.
id string
The provider-assigned unique ID for this managed resource.
pathResourceToId string
A mapping of Amazon API Gateway path resources to resource IDs.
routeIdentifier string
The unique identifier of the route.
arn str
The Amazon Resource Name (ARN) of the route.
id str
The provider-assigned unique ID for this managed resource.
path_resource_to_id str
A mapping of Amazon API Gateway path resources to resource IDs.
route_identifier str
The unique identifier of the route.
arn String
The Amazon Resource Name (ARN) of the route.
id String
The provider-assigned unique ID for this managed resource.
pathResourceToId String
A mapping of Amazon API Gateway path resources to resource IDs.
routeIdentifier String
The unique identifier of the route.

Supporting Types

RouteActivationState
, RouteActivationStateArgs

Inactive
INACTIVE
Active
ACTIVE
RouteActivationStateInactive
INACTIVE
RouteActivationStateActive
ACTIVE
Inactive
INACTIVE
Active
ACTIVE
Inactive
INACTIVE
Active
ACTIVE
INACTIVE
INACTIVE
ACTIVE
ACTIVE
"INACTIVE"
INACTIVE
"ACTIVE"
ACTIVE

RouteDefaultRouteInput
, RouteDefaultRouteInputArgs

ActivationState This property is required. Pulumi.AwsNative.RefactorSpaces.RouteActivationState
If set to ACTIVE , traffic is forwarded to this route’s service after the route is created.
ActivationState This property is required. RouteActivationState
If set to ACTIVE , traffic is forwarded to this route’s service after the route is created.
activationState This property is required. RouteActivationState
If set to ACTIVE , traffic is forwarded to this route’s service after the route is created.
activationState This property is required. RouteActivationState
If set to ACTIVE , traffic is forwarded to this route’s service after the route is created.
activation_state This property is required. RouteActivationState
If set to ACTIVE , traffic is forwarded to this route’s service after the route is created.
activationState This property is required. "INACTIVE" | "ACTIVE"
If set to ACTIVE , traffic is forwarded to this route’s service after the route is created.

RouteMethod
, RouteMethodArgs

Delete
DELETE
Get
GET
Head
HEAD
Options
OPTIONS
Patch
PATCH
Post
POST
Put
PUT
RouteMethodDelete
DELETE
RouteMethodGet
GET
RouteMethodHead
HEAD
RouteMethodOptions
OPTIONS
RouteMethodPatch
PATCH
RouteMethodPost
POST
RouteMethodPut
PUT
Delete
DELETE
Get
GET
Head
HEAD
Options
OPTIONS
Patch
PATCH
Post
POST
Put
PUT
Delete
DELETE
Get
GET
Head
HEAD
Options
OPTIONS
Patch
PATCH
Post
POST
Put
PUT
DELETE
DELETE
GET
GET
HEAD
HEAD
OPTIONS
OPTIONS
PATCH
PATCH
POST
POST
PUT
PUT
"DELETE"
DELETE
"GET"
GET
"HEAD"
HEAD
"OPTIONS"
OPTIONS
"PATCH"
PATCH
"POST"
POST
"PUT"
PUT

RouteType
, RouteTypeArgs

Default
DEFAULT
UriPath
URI_PATH
RouteTypeDefault
DEFAULT
RouteTypeUriPath
URI_PATH
Default
DEFAULT
UriPath
URI_PATH
Default
DEFAULT
UriPath
URI_PATH
DEFAULT
DEFAULT
URI_PATH
URI_PATH
"DEFAULT"
DEFAULT
"URI_PATH"
URI_PATH

RouteUriPathRouteInput
, RouteUriPathRouteInputArgs

ActivationState This property is required. Pulumi.AwsNative.RefactorSpaces.RouteActivationState
If set to ACTIVE , traffic is forwarded to this route’s service after the route is created.
AppendSourcePath Changes to this property will trigger replacement. bool
If set to true , this option appends the source path to the service URL endpoint.
IncludeChildPaths Changes to this property will trigger replacement. bool
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.
Methods Changes to this property will trigger replacement. List<Pulumi.AwsNative.RefactorSpaces.RouteMethod>
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.
SourcePath Changes to this property will trigger replacement. string
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 {user} represents a path parameter called 'user'.
ActivationState This property is required. RouteActivationState
If set to ACTIVE , traffic is forwarded to this route’s service after the route is created.
AppendSourcePath Changes to this property will trigger replacement. bool
If set to true , this option appends the source path to the service URL endpoint.
IncludeChildPaths Changes to this property will trigger replacement. bool
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.
Methods Changes to this property will trigger replacement. []RouteMethod
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.
SourcePath Changes to this property will trigger replacement. string
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 {user} represents a path parameter called 'user'.
activationState This property is required. RouteActivationState
If set to ACTIVE , traffic is forwarded to this route’s service after the route is created.
appendSourcePath Changes to this property will trigger replacement. Boolean
If set to true , this option appends the source path to the service URL endpoint.
includeChildPaths Changes to this property will trigger replacement. Boolean
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.
methods Changes to this property will trigger replacement. List<RouteMethod>
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.
sourcePath Changes to this property will trigger replacement. String
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 {user} represents a path parameter called 'user'.
activationState This property is required. RouteActivationState
If set to ACTIVE , traffic is forwarded to this route’s service after the route is created.
appendSourcePath Changes to this property will trigger replacement. boolean
If set to true , this option appends the source path to the service URL endpoint.
includeChildPaths Changes to this property will trigger replacement. boolean
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.
methods Changes to this property will trigger replacement. RouteMethod[]
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.
sourcePath Changes to this property will trigger replacement. string
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 {user} represents a path parameter called 'user'.
activation_state This property is required. RouteActivationState
If set to ACTIVE , traffic is forwarded to this route’s service after the route is created.
append_source_path Changes to this property will trigger replacement. bool
If set to true , this option appends the source path to the service URL endpoint.
include_child_paths Changes to this property will trigger replacement. bool
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.
methods Changes to this property will trigger replacement. Sequence[RouteMethod]
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.
source_path Changes to this property will trigger replacement. str
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 {user} represents a path parameter called 'user'.
activationState This property is required. "INACTIVE" | "ACTIVE"
If set to ACTIVE , traffic is forwarded to this route’s service after the route is created.
appendSourcePath Changes to this property will trigger replacement. Boolean
If set to true , this option appends the source path to the service URL endpoint.
includeChildPaths Changes to this property will trigger replacement. Boolean
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.
methods Changes to this property will trigger replacement. List<"DELETE" | "GET" | "HEAD" | "OPTIONS" | "PATCH" | "POST" | "PUT">
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.
sourcePath Changes to this property will trigger replacement. String
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 {user} represents a path parameter called 'user'.

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi