Class URLMap

UrlMaps are used to route requests to a backend service based on rules that you define for the host and path of an incoming URL.

To get more information about UrlMap, see:

API documentation

Inheritance

System.Object

Resource

CustomResource

URLMap

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.Compute

Assembly: Pulumi.Gcp.dll

Syntax

public class URLMap : CustomResource

Constructors

View Source

URLMap(String, URLMapArgs, CustomResourceOptions)

Create a URLMap resource with the given unique name, arguments, and options.

Declaration

public URLMap(string name, URLMapArgs args = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
URLMapArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

View Source

CreationTimestamp

Creation timestamp in RFC3339 text format.

Declaration

public Output<string> CreationTimestamp { get; }

Property Value

Type	Description
Output<System.String>

View Source

DefaultService

The backend service or backend bucket to use when none of the given paths match.

Declaration

public Output<string> DefaultService { get; }

Property Value

Type	Description
Output<System.String>

View Source

DefaultUrlRedirect

When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below.

Declaration

public Output<URLMapDefaultUrlRedirect> DefaultUrlRedirect { get; }

Property Value

Type	Description
Output<URLMapDefaultUrlRedirect>

View Source

Description

Description of this test case.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

View Source

Fingerprint

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.

Declaration

public Output<string> Fingerprint { get; }

Property Value

Type	Description
Output<System.String>

View Source

HeaderAction

Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below.

Declaration

public Output<URLMapHeaderAction> HeaderAction { get; }

Property Value

Type	Description
Output<URLMapHeaderAction>

View Source

HostRules

The list of HostRules to use against the URL. Structure is documented below.

Declaration

public Output<ImmutableArray<URLMapHostRule>> HostRules { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<URLMapHostRule>>

View Source

MapId

The unique identifier for the resource.

Declaration

public Output<int> MapId { get; }

Property Value

Type	Description
Output<System.Int32>

View Source

Name

The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

View Source

PathMatchers

The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.

Declaration

public Output<ImmutableArray<URLMapPathMatcher>> PathMatchers { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<URLMapPathMatcher>>

View Source

Project

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Declaration

public Output<string> Project { get; }

Property Value

Type	Description
Output<System.String>

View Source

SelfLink

The URI of the created resource.

Declaration

public Output<string> SelfLink { get; }

Property Value

Type	Description
Output<System.String>

View Source

Tests

The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap. Structure is documented below.

Declaration

public Output<ImmutableArray<URLMapTest>> Tests { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<URLMapTest>>

Methods

View Source

Get(String, Input<String>, URLMapState, CustomResourceOptions)

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

Declaration

public static URLMap Get(string name, Input<string> id, URLMapState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
URLMapState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
URLMap