Struct URLMapArgsBuilder

pub struct URLMapArgsBuilder<S: State = Empty> { /* private fields */ }

Use builder syntax to set the inputs and finish with build_struct().

Implementations

impl<S: State> URLMapArgsBuilder<S>

pub fn build_struct(self) -> URLMapArgs

where S: IsComplete,

Finish building and return the requested object

pub fn default_custom_error_response_policy( self, value: impl Into<Output<Option<UrlMapDefaultCustomErrorResponsePolicy>>>, ) -> URLMapArgsBuilder<SetDefaultCustomErrorResponsePolicy<S>>

where S::DefaultCustomErrorResponsePolicy: IsUnset,

Optional (Some / Option setters). Default:

<pulumi_wasm_rust::Output<
    Option<super::super::types::compute::UrlMapDefaultCustomErrorResponsePolicy>,
> as Default>::default()

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.

pub fn maybe_default_custom_error_response_policy( self, value: Option<impl Into<Output<Option<UrlMapDefaultCustomErrorResponsePolicy>>>>, ) -> URLMapArgsBuilder<SetDefaultCustomErrorResponsePolicy<S>>

where S::DefaultCustomErrorResponsePolicy: IsUnset,

Optional (Some / Option setters). Default:

<pulumi_wasm_rust::Output<
    Option<super::super::types::compute::UrlMapDefaultCustomErrorResponsePolicy>,
> as Default>::default()

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.

pub fn default_route_action( self, value: impl Into<Output<Option<UrlMapDefaultRouteAction>>>, ) -> URLMapArgsBuilder<SetDefaultRouteAction<S>>

where S::DefaultRouteAction: IsUnset,

Optional (Some / Option setters). Default:

<pulumi_wasm_rust::Output<
    Option<super::super::types::compute::UrlMapDefaultRouteAction>,
> as Default>::default()

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.

pub fn maybe_default_route_action( self, value: Option<impl Into<Output<Option<UrlMapDefaultRouteAction>>>>, ) -> URLMapArgsBuilder<SetDefaultRouteAction<S>>

where S::DefaultRouteAction: IsUnset,

Optional (Some / Option setters). Default:

<pulumi_wasm_rust::Output<
    Option<super::super::types::compute::UrlMapDefaultRouteAction>,
> as Default>::default()

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.

pub fn default_service( self, value: impl Into<Output<Option<String>>>, ) -> URLMapArgsBuilder<SetDefaultService<S>>

where S::DefaultService: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

pub fn maybe_default_service( self, value: Option<impl Into<Output<Option<String>>>>, ) -> URLMapArgsBuilder<SetDefaultService<S>>

where S::DefaultService: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

pub fn default_url_redirect( self, value: impl Into<Output<Option<UrlMapDefaultUrlRedirect>>>, ) -> URLMapArgsBuilder<SetDefaultUrlRedirect<S>>

where S::DefaultUrlRedirect: IsUnset,

Optional (Some / Option setters). Default:

<pulumi_wasm_rust::Output<
    Option<super::super::types::compute::UrlMapDefaultUrlRedirect>,
> as Default>::default()

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.

pub fn maybe_default_url_redirect( self, value: Option<impl Into<Output<Option<UrlMapDefaultUrlRedirect>>>>, ) -> URLMapArgsBuilder<SetDefaultUrlRedirect<S>>

where S::DefaultUrlRedirect: IsUnset,

Optional (Some / Option setters). Default:

<pulumi_wasm_rust::Output<
    Option<super::super::types::compute::UrlMapDefaultUrlRedirect>,
> as Default>::default()

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.

pub fn description( self, value: impl Into<Output<Option<String>>>, ) -> URLMapArgsBuilder<SetDescription<S>>

where S::Description: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

An optional description of this resource. Provide this property when you create the resource.

pub fn maybe_description( self, value: Option<impl Into<Output<Option<String>>>>, ) -> URLMapArgsBuilder<SetDescription<S>>

where S::Description: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

An optional description of this resource. Provide this property when you create the resource.

pub fn header_action( self, value: impl Into<Output<Option<UrlMapHeaderAction>>>, ) -> URLMapArgsBuilder<SetHeaderAction<S>>

where S::HeaderAction: IsUnset,

Optional (Some / Option setters). Default:

<pulumi_wasm_rust::Output<
    Option<super::super::types::compute::UrlMapHeaderAction>,
> as Default>::default()

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.

pub fn maybe_header_action( self, value: Option<impl Into<Output<Option<UrlMapHeaderAction>>>>, ) -> URLMapArgsBuilder<SetHeaderAction<S>>

where S::HeaderAction: IsUnset,

Optional (Some / Option setters). Default:

<pulumi_wasm_rust::Output<
    Option<super::super::types::compute::UrlMapHeaderAction>,
> as Default>::default()

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.

pub fn host_rules( self, value: impl Into<Output<Option<Vec<UrlMapHostRule>>>>, ) -> URLMapArgsBuilder<SetHostRules<S>>

where S::HostRules: IsUnset,

Optional (Some / Option setters). Default:

<pulumi_wasm_rust::Output<
    Option<Vec<super::super::types::compute::UrlMapHostRule>>,
> as Default>::default()

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

pub fn maybe_host_rules( self, value: Option<impl Into<Output<Option<Vec<UrlMapHostRule>>>>>, ) -> URLMapArgsBuilder<SetHostRules<S>>

where S::HostRules: IsUnset,

Optional (Some / Option setters). Default:

<pulumi_wasm_rust::Output<
    Option<Vec<super::super::types::compute::UrlMapHostRule>>,
> as Default>::default()

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

pub fn name( self, value: impl Into<Output<Option<String>>>, ) -> URLMapArgsBuilder<SetName<S>>

where S::Name: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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.

---

pub fn maybe_name( self, value: Option<impl Into<Output<Option<String>>>>, ) -> URLMapArgsBuilder<SetName<S>>

where S::Name: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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.

---

pub fn path_matchers( self, value: impl Into<Output<Option<Vec<UrlMapPathMatcher>>>>, ) -> URLMapArgsBuilder<SetPathMatchers<S>>

where S::PathMatchers: IsUnset,

Optional (Some / Option setters). Default:

<pulumi_wasm_rust::Output<
    Option<Vec<super::super::types::compute::UrlMapPathMatcher>>,
> as Default>::default()

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

pub fn maybe_path_matchers( self, value: Option<impl Into<Output<Option<Vec<UrlMapPathMatcher>>>>>, ) -> URLMapArgsBuilder<SetPathMatchers<S>>

where S::PathMatchers: IsUnset,

Optional (Some / Option setters). Default:

<pulumi_wasm_rust::Output<
    Option<Vec<super::super::types::compute::UrlMapPathMatcher>>,
> as Default>::default()

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

pub fn project( self, value: impl Into<Output<Option<String>>>, ) -> URLMapArgsBuilder<SetProject<S>>

where S::Project: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

pub fn maybe_project( self, value: Option<impl Into<Output<Option<String>>>>, ) -> URLMapArgsBuilder<SetProject<S>>

where S::Project: IsUnset,

Optional (Some / Option setters). Default: <pulumi_wasm_rust::Output<Option<String>> as Default>::default().

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

pub fn tests( self, value: impl Into<Output<Option<Vec<UrlMapTest>>>>, ) -> URLMapArgsBuilder<SetTests<S>>

where S::Tests: IsUnset,

Optional (Some / Option setters). Default:

<pulumi_wasm_rust::Output<
    Option<Vec<super::super::types::compute::UrlMapTest>>,
> as Default>::default()

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.

pub fn maybe_tests( self, value: Option<impl Into<Output<Option<Vec<UrlMapTest>>>>>, ) -> URLMapArgsBuilder<SetTests<S>>

where S::Tests: IsUnset,

Optional (Some / Option setters). Default:

<pulumi_wasm_rust::Output<
    Option<Vec<super::super::types::compute::UrlMapTest>>,
> as Default>::default()

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.