URLMapState class

Input properties used for looking up and filtering URLMap resources.

Constructors

URLMapState({Input<String?>? creationTimestamp, Input<URLMapDefaultCustomErrorResponsePolicy?>? defaultCustomErrorResponsePolicy, Input<URLMapDefaultRouteAction?>? defaultRouteAction, Input<String?>? defaultService, Input<URLMapDefaultUrlRedirect?>? defaultUrlRedirect, Input<String?>? deletionPolicy, Input<String?>? description, Input<String?>? fingerprint, Input<URLMapHeaderAction?>? headerAction, Input<List<URLMapHostRule>?>? hostRules, Input<int?>? mapId, Input<String?>? name, Input<List<URLMapPathMatcher>?>? pathMatchers, Input<String?>? project, Input<String?>? selfLink, Input<List<URLMapTest>?>? tests})
Creates a new URLMapState. creationTimestamp Creation timestamp in RFC3339 text format. defaultCustomErrorResponsePolicy defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendService or BackendBucket responds with an error. defaultRouteAction defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions defaultService The backend service or backend bucket to use when none of the given rules match. defaultUrlRedirect When none of the specified hostRules match, the request is redirected to a URL specified deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. description An optional description of this resource. Provide this property when you create fingerprint Fingerprint of this resource. A hash of the contents stored in this object. This headerAction Specifies changes to request and response headers that need to take effect for hostRules The list of HostRules to use against the URL. mapId The unique identifier for the resource. name Name of the resource. Provided by the client when the resource is created. The pathMatchers The list of named PathMatchers to use against the URL. project The ID of the project in which the resource belongs. selfLink The URI of the created resource. tests The list of expected URL mapping tests. Request to update this UrlMap will
const
URLMapState.fromMap(Map<String, dynamic> map)
factory

Properties

creationTimestamp → Input<String?>?
Creation timestamp in RFC3339 text format.
final
defaultCustomErrorResponsePolicy → Input<URLMapDefaultCustomErrorResponsePolicy?>?
defaultCustomErrorResponsePolicy specifies how the Load Balancer returns error responses when BackendService or BackendBucket responds with an error. This policy takes effect at the PathMatcher level and applies only when no policy has been defined for the error code at lower levels like RouteRule and PathRule within this PathMatcher. If an error code does not have a policy defined in defaultCustomErrorResponsePolicy, then a policy defined for the error code in UrlMap.defaultCustomErrorResponsePolicy takes effect. For example, consider a UrlMap with the following configuration: UrlMap.defaultCustomErrorResponsePolicy is configured with policies for 5xx and 4xx errors A RouteRule for /coming_soon/ is configured for the error code 404. If the request is for www.myotherdomain.com and a 404 is encountered, the policy under UrlMap.defaultCustomErrorResponsePolicy takes effect. If a 404 response is encountered for the request www.example.com/current_events/, the pathMatcher's policy takes effect. If however, the request for www.example.com/coming_soon/ encounters a 404, the policy in RouteRule.customErrorResponsePolicy takes effect. If any of the requests in this example encounter a 500 error code, the policy at UrlMap.defaultCustomErrorResponsePolicy takes effect. When used in conjunction with pathMatcher.defaultRouteAction.retryPolicy, retries take precedence. Only once all retries are exhausted, the defaultCustomErrorResponsePolicy is applied. While attempting a retry, if load balancer is successful in reaching the service, the defaultCustomErrorResponsePolicy is ignored and the response from the service is returned to the client. defaultCustomErrorResponsePolicy is supported only for global external Application Load Balancers. Structure is documented below.
final
defaultRouteAction → Input<URLMapDefaultRouteAction?>?
defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices. Only one of defaultRouteAction or defaultUrlRedirect must be set. Structure is documented below.
final
defaultService → Input<String?>?
The backend service or backend bucket to use when none of the given rules match.
final
defaultUrlRedirect → Input<URLMapDefaultUrlRedirect?>?
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.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
description → Input<String?>?
An optional description of this resource. Provide this property when you create the resource.
final
fingerprint → Input<String?>?
Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking.
final
hashCode → int
The hash code for this object.
no setterinherited
headerAction → Input<URLMapHeaderAction?>?
Specifies changes to request and response headers that need to take effect for the selected backendService. The headerAction specified here take effect after headerAction specified under pathMatcher. Structure is documented below.
final
hostRules → Input<List<URLMapHostRule>?>?
The list of HostRules to use against the URL. Structure is documented below.
final
mapId → Input<int?>?
The unique identifier for the resource.
final
name → Input<String?>?
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
final
pathMatchers → Input<List<URLMapPathMatcher>?>?
The list of named PathMatchers to use against the URL. Structure is documented below.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
The URI of the created resource.
final
tests → Input<List<URLMapTest>?>?
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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited