Google Cloud Native v0.30.0, Apr 14 23

google-native.recaptchaenterprise/v1.getFirewallpolicy

Explore with Pulumi AI

Returns the specified firewall policy.

Using getFirewallpolicy

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getFirewallpolicy(args: GetFirewallpolicyArgs, opts?: InvokeOptions): Promise<GetFirewallpolicyResult>
function getFirewallpolicyOutput(args: GetFirewallpolicyOutputArgs, opts?: InvokeOptions): Output<GetFirewallpolicyResult>

def get_firewallpolicy(firewallpolicy_id: Optional[str] = None,
                       project: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetFirewallpolicyResult
def get_firewallpolicy_output(firewallpolicy_id: Optional[pulumi.Input[str]] = None,
                       project: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetFirewallpolicyResult]

func LookupFirewallpolicy(ctx *Context, args *LookupFirewallpolicyArgs, opts ...InvokeOption) (*LookupFirewallpolicyResult, error)
func LookupFirewallpolicyOutput(ctx *Context, args *LookupFirewallpolicyOutputArgs, opts ...InvokeOption) LookupFirewallpolicyResultOutput

> Note: This function is named LookupFirewallpolicy in the Go SDK.

public static class GetFirewallpolicy 
{
    public static Task<GetFirewallpolicyResult> InvokeAsync(GetFirewallpolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetFirewallpolicyResult> Invoke(GetFirewallpolicyInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetFirewallpolicyResult> getFirewallpolicy(GetFirewallpolicyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:recaptchaenterprise/v1:getFirewallpolicy
  arguments:
    # arguments dictionary

The following arguments are supported:

FirewallpolicyId string
Project string

FirewallpolicyId string
Project string

firewallpolicyId String
project String

firewallpolicyId string
project string

firewallpolicy_id str
project str

firewallpolicyId String
project String

getFirewallpolicy Result

The following output properties are available:

Actions List<Pulumi.GoogleNative.reCAPTCHAEnterprise.V1.Outputs.GoogleCloudRecaptchaenterpriseV1FirewallActionResponse>: The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.
Condition string: A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the CEL spec and its language definition. A condition has a max length of 500 characters.
Description string: A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.
Name string: The resource name for the FirewallPolicy in the format "projects/{project}/firewallpolicies/{firewallpolicy}".
Path string: The path for which this policy applies, specified as a glob pattern. For more information on glob, see the manual page. A path has a max length of 200 characters.

Actions []GoogleCloudRecaptchaenterpriseV1FirewallActionResponse: The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.
Condition string: A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the CEL spec and its language definition. A condition has a max length of 500 characters.
Description string: A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.
Name string: The resource name for the FirewallPolicy in the format "projects/{project}/firewallpolicies/{firewallpolicy}".
Path string: The path for which this policy applies, specified as a glob pattern. For more information on glob, see the manual page. A path has a max length of 200 characters.

actions List<GoogleCloudRecaptchaenterpriseV1FirewallActionResponse>: The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.
condition String: A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the CEL spec and its language definition. A condition has a max length of 500 characters.
description String: A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.
name String: The resource name for the FirewallPolicy in the format "projects/{project}/firewallpolicies/{firewallpolicy}".
path String: The path for which this policy applies, specified as a glob pattern. For more information on glob, see the manual page. A path has a max length of 200 characters.

actions GoogleCloudRecaptchaenterpriseV1FirewallActionResponse[]: The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.
condition string: A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the CEL spec and its language definition. A condition has a max length of 500 characters.
description string: A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.
name string: The resource name for the FirewallPolicy in the format "projects/{project}/firewallpolicies/{firewallpolicy}".
path string: The path for which this policy applies, specified as a glob pattern. For more information on glob, see the manual page. A path has a max length of 200 characters.

actions Sequence[GoogleCloudRecaptchaenterpriseV1FirewallActionResponse]: The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.
condition str: A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the CEL spec and its language definition. A condition has a max length of 500 characters.
description str: A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.
name str: The resource name for the FirewallPolicy in the format "projects/{project}/firewallpolicies/{firewallpolicy}".
path str: The path for which this policy applies, specified as a glob pattern. For more information on glob, see the manual page. A path has a max length of 200 characters.

actions List<Property Map>: The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions.
condition String: A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the CEL spec and its language definition. A condition has a max length of 500 characters.
description String: A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters.
name String: The resource name for the FirewallPolicy in the format "projects/{project}/firewallpolicies/{firewallpolicy}".
path String: The path for which this policy applies, specified as a glob pattern. For more information on glob, see the manual page. A path has a max length of 200 characters.

Supporting Types

GoogleCloudRecaptchaenterpriseV1FirewallActionResponse

Allow Pulumi.GoogleNative.reCAPTCHAEnterprise.V1.Inputs.GoogleCloudRecaptchaenterpriseV1FirewallActionAllowActionResponse: The user request did not match any policy and should be allowed access to the requested resource.
Block Pulumi.GoogleNative.reCAPTCHAEnterprise.V1.Inputs.GoogleCloudRecaptchaenterpriseV1FirewallActionBlockActionResponse: This action will deny access to a given page. The user will get an HTTP error code.
Redirect Pulumi.GoogleNative.reCAPTCHAEnterprise.V1.Inputs.GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectActionResponse: This action will redirect the request to a ReCaptcha interstitial to attach a token.
SetHeader Pulumi.GoogleNative.reCAPTCHAEnterprise.V1.Inputs.GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderActionResponse: This action will set a custom header but allow the request to continue to the customer backend.
Substitute Pulumi.GoogleNative.reCAPTCHAEnterprise.V1.Inputs.GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteActionResponse: This action will transparently serve a different page to an offending user.

Allow GoogleCloudRecaptchaenterpriseV1FirewallActionAllowActionResponse: The user request did not match any policy and should be allowed access to the requested resource.
Block GoogleCloudRecaptchaenterpriseV1FirewallActionBlockActionResponse: This action will deny access to a given page. The user will get an HTTP error code.
Redirect GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectActionResponse: This action will redirect the request to a ReCaptcha interstitial to attach a token.
SetHeader GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderActionResponse: This action will set a custom header but allow the request to continue to the customer backend.
Substitute GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteActionResponse: This action will transparently serve a different page to an offending user.

allow GoogleCloudRecaptchaenterpriseV1FirewallActionAllowActionResponse: The user request did not match any policy and should be allowed access to the requested resource.
block GoogleCloudRecaptchaenterpriseV1FirewallActionBlockActionResponse: This action will deny access to a given page. The user will get an HTTP error code.
redirect GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectActionResponse: This action will redirect the request to a ReCaptcha interstitial to attach a token.
setHeader GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderActionResponse: This action will set a custom header but allow the request to continue to the customer backend.
substitute GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteActionResponse: This action will transparently serve a different page to an offending user.

allow GoogleCloudRecaptchaenterpriseV1FirewallActionAllowActionResponse: The user request did not match any policy and should be allowed access to the requested resource.
block GoogleCloudRecaptchaenterpriseV1FirewallActionBlockActionResponse: This action will deny access to a given page. The user will get an HTTP error code.
redirect GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectActionResponse: This action will redirect the request to a ReCaptcha interstitial to attach a token.
setHeader GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderActionResponse: This action will set a custom header but allow the request to continue to the customer backend.
substitute GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteActionResponse: This action will transparently serve a different page to an offending user.

allow GoogleCloudRecaptchaenterpriseV1FirewallActionAllowActionResponse: The user request did not match any policy and should be allowed access to the requested resource.
block GoogleCloudRecaptchaenterpriseV1FirewallActionBlockActionResponse: This action will deny access to a given page. The user will get an HTTP error code.
redirect GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectActionResponse: This action will redirect the request to a ReCaptcha interstitial to attach a token.
set_header GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderActionResponse: This action will set a custom header but allow the request to continue to the customer backend.
substitute GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteActionResponse: This action will transparently serve a different page to an offending user.

allow Property Map: The user request did not match any policy and should be allowed access to the requested resource.
block Property Map: This action will deny access to a given page. The user will get an HTTP error code.
redirect Property Map: This action will redirect the request to a ReCaptcha interstitial to attach a token.
setHeader Property Map: This action will set a custom header but allow the request to continue to the customer backend.
substitute Property Map: This action will transparently serve a different page to an offending user.

GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderActionResponse

Key string: The header key to set in the request to the backend server.
Value string: The header value to set in the request to the backend server.

Key string: The header key to set in the request to the backend server.
Value string: The header value to set in the request to the backend server.

key String: The header key to set in the request to the backend server.
value String: The header value to set in the request to the backend server.

key string: The header key to set in the request to the backend server.
value string: The header value to set in the request to the backend server.

key str: The header key to set in the request to the backend server.
value str: The header value to set in the request to the backend server.

key String: The header key to set in the request to the backend server.
value String: The header value to set in the request to the backend server.

GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteActionResponse

Path string: The address to redirect to. The target is a relative path in the current host. Example: "/blog/404.html".

Path string: The address to redirect to. The target is a relative path in the current host. Example: "/blog/404.html".

path String: The address to redirect to. The target is a relative path in the current host. Example: "/blog/404.html".

path string: The address to redirect to. The target is a relative path in the current host. Example: "/blog/404.html".

path str: The address to redirect to. The target is a relative path in the current host. Example: "/blog/404.html".

path String: The address to redirect to. The target is a relative path in the current host. Example: "/blog/404.html".

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0