Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. AppRoute
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.AppRoute

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Create AppRoute Resource

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

    Constructor syntax

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

@overload
def AppRoute(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             domain_guid: Optional[str] = None,
             space_guid: Optional[str] = None,
             app_route_id: Optional[str] = None,
             host: Optional[str] = None,
             path: Optional[str] = None,
             port: Optional[float] = None,
             tags: Optional[Sequence[str]] = None)
    func NewAppRoute(ctx *Context, name string, args AppRouteArgs, opts ...ResourceOption) (*AppRoute, error)
    public AppRoute(string name, AppRouteArgs args, CustomResourceOptions? opts = null)
    public AppRoute(String name, AppRouteArgs args)
public AppRoute(String name, AppRouteArgs args, CustomResourceOptions options)

    type: ibm:AppRoute
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 AppRouteArgs
    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 AppRouteArgs
    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 AppRouteArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppRouteArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AppRouteArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var appRouteResource = new Ibm.AppRoute("appRouteResource", new()
{
    DomainGuid = "string",
    SpaceGuid = "string",
    AppRouteId = "string",
    Host = "string",
    Path = "string",
    Port = 0,
    Tags = new[]
    {
        "string",
    },
});

    example, err := ibm.NewAppRoute(ctx, "appRouteResource", &ibm.AppRouteArgs{
	DomainGuid: pulumi.String("string"),
	SpaceGuid:  pulumi.String("string"),
	AppRouteId: pulumi.String("string"),
	Host:       pulumi.String("string"),
	Path:       pulumi.String("string"),
	Port:       pulumi.Float64(0),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var appRouteResource = new AppRoute("appRouteResource", AppRouteArgs.builder()
    .domainGuid("string")
    .spaceGuid("string")
    .appRouteId("string")
    .host("string")
    .path("string")
    .port(0)
    .tags("string")
    .build());

    app_route_resource = ibm.AppRoute("appRouteResource",
    domain_guid="string",
    space_guid="string",
    app_route_id="string",
    host="string",
    path="string",
    port=0,
    tags=["string"])

    const appRouteResource = new ibm.AppRoute("appRouteResource", {
    domainGuid: "string",
    spaceGuid: "string",
    appRouteId: "string",
    host: "string",
    path: "string",
    port: 0,
    tags: ["string"],
});

    type: ibm:AppRoute
properties:
    appRouteId: string
    domainGuid: string
    host: string
    path: string
    port: 0
    spaceGuid: string
    tags:
        - string

    AppRoute 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 AppRoute resource accepts the following input properties:

    DomainGuid string
    The guid of the associated domain
    SpaceGuid string
    The guid of the associated space
    AppRouteId string
    Host string
    The host portion of the route. Required for shared-domains.
    Path string
    The path for a route as raw text.Paths must be between 2 and 128 characters.Paths must start with a forward slash '/'.Paths must not contain a '?'
    Port double
    The port of the route. Supported for domains of TCP router groups only.
    Tags List<string>
    DomainGuid string
    The guid of the associated domain
    SpaceGuid string
    The guid of the associated space
    AppRouteId string
    Host string
    The host portion of the route. Required for shared-domains.
    Path string
    The path for a route as raw text.Paths must be between 2 and 128 characters.Paths must start with a forward slash '/'.Paths must not contain a '?'
    Port float64
    The port of the route. Supported for domains of TCP router groups only.
    Tags []string
    domainGuid String
    The guid of the associated domain
    spaceGuid String
    The guid of the associated space
    appRouteId String
    host String
    The host portion of the route. Required for shared-domains.
    path String
    The path for a route as raw text.Paths must be between 2 and 128 characters.Paths must start with a forward slash '/'.Paths must not contain a '?'
    port Double
    The port of the route. Supported for domains of TCP router groups only.
    tags List<String>
    domainGuid string
    The guid of the associated domain
    spaceGuid string
    The guid of the associated space
    appRouteId string
    host string
    The host portion of the route. Required for shared-domains.
    path string
    The path for a route as raw text.Paths must be between 2 and 128 characters.Paths must start with a forward slash '/'.Paths must not contain a '?'
    port number
    The port of the route. Supported for domains of TCP router groups only.
    tags string[]
    domain_guid str
    The guid of the associated domain
    space_guid str
    The guid of the associated space
    app_route_id str
    host str
    The host portion of the route. Required for shared-domains.
    path str
    The path for a route as raw text.Paths must be between 2 and 128 characters.Paths must start with a forward slash '/'.Paths must not contain a '?'
    port float
    The port of the route. Supported for domains of TCP router groups only.
    tags Sequence[str]
    domainGuid String
    The guid of the associated domain
    spaceGuid String
    The guid of the associated space
    appRouteId String
    host String
    The host portion of the route. Required for shared-domains.
    path String
    The path for a route as raw text.Paths must be between 2 and 128 characters.Paths must start with a forward slash '/'.Paths must not contain a '?'
    port Number
    The port of the route. Supported for domains of TCP router groups only.
    tags List<String>

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AppRoute Resource

    Get an existing AppRoute resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AppRouteState, opts?: CustomResourceOptions): AppRoute
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_route_id: Optional[str] = None,
        domain_guid: Optional[str] = None,
        host: Optional[str] = None,
        path: Optional[str] = None,
        port: Optional[float] = None,
        space_guid: Optional[str] = None,
        tags: Optional[Sequence[str]] = None) -> AppRoute
    func GetAppRoute(ctx *Context, name string, id IDInput, state *AppRouteState, opts ...ResourceOption) (*AppRoute, error)
    public static AppRoute Get(string name, Input<string> id, AppRouteState? state, CustomResourceOptions? opts = null)
    public static AppRoute get(String name, Output<String> id, AppRouteState state, CustomResourceOptions options)
    resources:  _:    type: ibm:AppRoute    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AppRouteId string
    DomainGuid string
    The guid of the associated domain
    Host string
    The host portion of the route. Required for shared-domains.
    Path string
    The path for a route as raw text.Paths must be between 2 and 128 characters.Paths must start with a forward slash '/'.Paths must not contain a '?'
    Port double
    The port of the route. Supported for domains of TCP router groups only.
    SpaceGuid string
    The guid of the associated space
    Tags List<string>
    AppRouteId string
    DomainGuid string
    The guid of the associated domain
    Host string
    The host portion of the route. Required for shared-domains.
    Path string
    The path for a route as raw text.Paths must be between 2 and 128 characters.Paths must start with a forward slash '/'.Paths must not contain a '?'
    Port float64
    The port of the route. Supported for domains of TCP router groups only.
    SpaceGuid string
    The guid of the associated space
    Tags []string
    appRouteId String
    domainGuid String
    The guid of the associated domain
    host String
    The host portion of the route. Required for shared-domains.
    path String
    The path for a route as raw text.Paths must be between 2 and 128 characters.Paths must start with a forward slash '/'.Paths must not contain a '?'
    port Double
    The port of the route. Supported for domains of TCP router groups only.
    spaceGuid String
    The guid of the associated space
    tags List<String>
    appRouteId string
    domainGuid string
    The guid of the associated domain
    host string
    The host portion of the route. Required for shared-domains.
    path string
    The path for a route as raw text.Paths must be between 2 and 128 characters.Paths must start with a forward slash '/'.Paths must not contain a '?'
    port number
    The port of the route. Supported for domains of TCP router groups only.
    spaceGuid string
    The guid of the associated space
    tags string[]
    app_route_id str
    domain_guid str
    The guid of the associated domain
    host str
    The host portion of the route. Required for shared-domains.
    path str
    The path for a route as raw text.Paths must be between 2 and 128 characters.Paths must start with a forward slash '/'.Paths must not contain a '?'
    port float
    The port of the route. Supported for domains of TCP router groups only.
    space_guid str
    The guid of the associated space
    tags Sequence[str]
    appRouteId String
    domainGuid String
    The guid of the associated domain
    host String
    The host portion of the route. Required for shared-domains.
    path String
    The path for a route as raw text.Paths must be between 2 and 128 characters.Paths must start with a forward slash '/'.Paths must not contain a '?'
    port Number
    The port of the route. Supported for domains of TCP router groups only.
    spaceGuid String
    The guid of the associated space
    tags List<String>

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm