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

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

aws-native.refactorspaces.Route

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 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 string
    The unique name of the resource.
    args RouteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args RouteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RouteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RouteArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const examplerouteResourceResourceFromRefactorspaces = new aws_native.refactorspaces.Route("examplerouteResourceResourceFromRefactorspaces", {
        applicationIdentifier: "string",
        environmentIdentifier: "string",
        routeType: aws_native.refactorspaces.RouteType.Default,
        serviceIdentifier: "string",
        defaultRoute: {
            activationState: aws_native.refactorspaces.RouteActivationState.Inactive,
        },
        tags: [{
            key: "string",
            value: "string",
        }],
        uriPathRoute: {
            activationState: aws_native.refactorspaces.RouteActivationState.Inactive,
            appendSourcePath: false,
            includeChildPaths: false,
            methods: [aws_native.refactorspaces.RouteMethod.Delete],
            sourcePath: "string",
        },
    });
    
    Coming soon!
    

    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

    The Route resource accepts the following input properties:

    ApplicationIdentifier string
    EnvironmentIdentifier string
    RouteType RouteType
    ServiceIdentifier string
    DefaultRoute RouteDefaultRouteInputArgs
    Tags TagArgs
    Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
    UriPathRoute RouteUriPathRouteInputArgs
    applicationIdentifier String
    environmentIdentifier String
    routeType RouteType
    serviceIdentifier String
    defaultRoute RouteDefaultRouteInput
    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
    applicationIdentifier string
    environmentIdentifier string
    routeType RouteType
    serviceIdentifier string
    defaultRoute RouteDefaultRouteInput
    tags Tag[]
    Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.
    uriPathRoute RouteUriPathRouteInput
    application_identifier str
    environment_identifier str
    route_type RouteType
    service_identifier str
    default_route RouteDefaultRouteInputArgs
    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
    applicationIdentifier String
    environmentIdentifier String
    routeType "DEFAULT" | "URI_PATH"
    serviceIdentifier String
    defaultRoute Property Map
    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

    Outputs

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

    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    PathResourceToId string
    RouteIdentifier string
    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    PathResourceToId string
    RouteIdentifier string
    arn String
    id String
    The provider-assigned unique ID for this managed resource.
    pathResourceToId String
    routeIdentifier String
    arn string
    id string
    The provider-assigned unique ID for this managed resource.
    pathResourceToId string
    routeIdentifier string
    arn str
    id str
    The provider-assigned unique ID for this managed resource.
    path_resource_to_id str
    route_identifier str
    arn String
    id String
    The provider-assigned unique ID for this managed resource.
    pathResourceToId String
    routeIdentifier String

    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

    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

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi