We recommend new projects start with resources from the AWS provider.
aws-native.refactorspaces.Route
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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)
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:
- Application
Identifier This property is required. string - The unique identifier of the application.
- Environment
Identifier This property is required. string - The unique identifier of the environment.
- Route
Type This property is required. Pulumi.Aws Native. Refactor Spaces. Route Type - The route type of the route.
- Service
Identifier This property is required. string - The unique identifier of the service.
- Default
Route Pulumi.Aws Native. Refactor Spaces. Inputs. Route Default Route Input - Configuration for the default route type.
- List<Pulumi.
Aws Native. Inputs. Tag> - Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
- Uri
Path Pulumi.Route Aws Native. Refactor Spaces. Inputs. Route Uri Path Route Input - The configuration for the URI path route type.
- Application
Identifier This property is required. string - The unique identifier of the application.
- Environment
Identifier This property is required. string - 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. string - The unique identifier of the service.
- Default
Route RouteDefault Route Input Args - Configuration for the default route type.
- Tag
Args - Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
- Uri
Path RouteRoute Uri Path Route Input Args - The configuration for the URI path route type.
- application
Identifier This property is required. String - The unique identifier of the application.
- environment
Identifier This property is required. String - 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. String - The unique identifier of the service.
- default
Route RouteDefault Route Input - Configuration for the default route type.
- List<Tag>
- Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
- uri
Path RouteRoute Uri Path Route Input - The configuration for the URI path route type.
- application
Identifier This property is required. string - The unique identifier of the application.
- environment
Identifier This property is required. string - 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. string - The unique identifier of the service.
- default
Route RouteDefault Route Input - Configuration for the default route type.
- Tag[]
- Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
- uri
Path RouteRoute Uri Path Route Input - 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 RouteDefault Route Input Args - Configuration for the default route type.
- Sequence[Tag
Args] - Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
- uri_
path_ Routeroute Uri Path Route Input Args - The configuration for the URI path route type.
- application
Identifier This property is required. String - The unique identifier of the application.
- environment
Identifier This property is required. String - The unique identifier of the environment.
- route
Type This property is required. "DEFAULT" | "URI_PATH" - The route type of the route.
- service
Identifier This property is required. String - The unique identifier of the service.
- default
Route Property Map - Configuration for the default route type.
- List<Property Map>
- Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
- uri
Path Property MapRoute - 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.
- Path
Resource stringTo Id - A mapping of Amazon API Gateway path resources to resource IDs.
- Route
Identifier 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.
- Path
Resource stringTo Id - A mapping of Amazon API Gateway path resources to resource IDs.
- Route
Identifier 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.
- path
Resource StringTo Id - A mapping of Amazon API Gateway path resources to resource IDs.
- route
Identifier 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.
- path
Resource stringTo Id - A mapping of Amazon API Gateway path resources to resource IDs.
- route
Identifier 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_ strto_ id - 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.
- path
Resource StringTo Id - A mapping of Amazon API Gateway path resources to resource IDs.
- route
Identifier String - The unique identifier of the route.
Supporting Types
RouteActivationState, RouteActivationStateArgs
- Inactive
- INACTIVE
- Active
- ACTIVE
- Route
Activation State Inactive - INACTIVE
- Route
Activation State Active - ACTIVE
- Inactive
- INACTIVE
- Active
- ACTIVE
- Inactive
- INACTIVE
- Active
- ACTIVE
- INACTIVE
- INACTIVE
- ACTIVE
- ACTIVE
- "INACTIVE"
- INACTIVE
- "ACTIVE"
- ACTIVE
RouteDefaultRouteInput, RouteDefaultRouteInputArgs
- Activation
State This property is required. Pulumi.Aws Native. Refactor Spaces. Route Activation State - If set to
ACTIVE
, traffic is forwarded to this route’s service after the route is created.
- Activation
State This property is required. RouteActivation State - If set to
ACTIVE
, traffic is forwarded to this route’s service after the route is created.
- activation
State This property is required. RouteActivation State - If set to
ACTIVE
, traffic is forwarded to this route’s service after the route is created.
- activation
State This property is required. RouteActivation State - If set to
ACTIVE
, traffic is forwarded to this route’s service after the route is created.
- activation_
state This property is required. RouteActivation State - If set to
ACTIVE
, traffic is forwarded to this route’s service after the route is created.
- activation
State 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
- Route
Method Delete - DELETE
- Route
Method Get - GET
- Route
Method Head - HEAD
- Route
Method Options - OPTIONS
- Route
Method Patch - PATCH
- Route
Method Post - POST
- Route
Method 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
- "DELETE"
- DELETE
- "GET"
- GET
- "HEAD"
- HEAD
- "OPTIONS"
- OPTIONS
- "PATCH"
- PATCH
- "POST"
- POST
- "PUT"
- PUT
RouteType, RouteTypeArgs
- Default
- DEFAULT
- Uri
Path - URI_PATH
- Route
Type Default - DEFAULT
- Route
Type Uri Path - URI_PATH
- Default
- DEFAULT
- Uri
Path - URI_PATH
- Default
- DEFAULT
- Uri
Path - URI_PATH
- DEFAULT
- DEFAULT
- URI_PATH
- URI_PATH
- "DEFAULT"
- DEFAULT
- "URI_PATH"
- URI_PATH
RouteUriPathRouteInput, RouteUriPathRouteInputArgs
- Activation
State This property is required. Pulumi.Aws Native. Refactor Spaces. Route Activation State - 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.
- 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.
- 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.
Aws Native. Refactor Spaces. Route Method> - 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.
- 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. RouteActivation State - 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.
- 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.
- 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.
Method - 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.
- 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. RouteActivation State - 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.
- 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.
- 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.
Method> - 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.
- 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. RouteActivation State - 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.
- 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.
- 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.
Method[] - 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.
- 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. RouteActivation State - 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.
- 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.
- 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.
Method] - 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.
- 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. "INACTIVE" | "ACTIVE" - 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.
- 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.
- 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.
- 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.
- 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
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.