Class RegionUrlMap

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.

Inheritance

System.Object

Resource

CustomResource

RegionUrlMap

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 RegionUrlMap : CustomResource

Constructors

RegionUrlMap(String, RegionUrlMapArgs, CustomResourceOptions)

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

Declaration

public RegionUrlMap(string name, RegionUrlMapArgs args = null, CustomResourceOptions options = null)

Parameters

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

Properties

CreationTimestamp

Creation timestamp in RFC3339 text format.

Declaration

public Output<string> CreationTimestamp { get; }

Property Value

Type	Description
Output<System.String>

DefaultService

A reference to a RegionBackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL's path portion.

Declaration

public Output<string> DefaultService { get; }

Property Value

Type	Description
Output<System.String>

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<RegionUrlMapDefaultUrlRedirect> DefaultUrlRedirect { get; }

Property Value

Type	Description
Output<RegionUrlMapDefaultUrlRedirect>

Description

Description of this test case.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

Fingerprint

Fingerprint of this resource. This field is used internally during updates of this resource.

Declaration

public Output<string> Fingerprint { get; }

Property Value

Type	Description
Output<System.String>

HostRules

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

Declaration

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

Property Value

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

MapId

The unique identifier for the resource.

Declaration

public Output<int> MapId { get; }

Property Value

Type	Description
Output<System.Int32>

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>

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<RegionUrlMapPathMatcher>> PathMatchers { get; }

Property Value

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

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>

Region

The Region in which the url map should reside. If it is not provided, the provider region is used.

Declaration

public Output<string> Region { get; }

Property Value

Type	Description
Output<System.String>

SelfLink

The URI of the created resource.

Declaration

public Output<string> SelfLink { get; }

Property Value

Type	Description
Output<System.String>

Tests

The list of expected URL mappings. Requests to update this UrlMap will succeed only if all of the test cases pass. Structure is documented below.

Declaration

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

Property Value

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

Methods

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

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

Declaration

public static RegionUrlMap Get(string name, Input<string> id, RegionUrlMapState 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.
RegionUrlMapState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
RegionUrlMap