Google Cloud Native v0.30.0, Apr 14 23

google-native.recaptchaenterprise/v1.Firewallpolicy

Explore with Pulumi AI

Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies.

Create Firewallpolicy Resource

new Firewallpolicy(name: string, args?: FirewallpolicyArgs, opts?: CustomResourceOptions);

@overload
def Firewallpolicy(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   actions: Optional[Sequence[GoogleCloudRecaptchaenterpriseV1FirewallActionArgs]] = None,
                   condition: Optional[str] = None,
                   description: Optional[str] = None,
                   name: Optional[str] = None,
                   path: Optional[str] = None,
                   project: Optional[str] = None)
@overload
def Firewallpolicy(resource_name: str,
                   args: Optional[FirewallpolicyArgs] = None,
                   opts: Optional[ResourceOptions] = None)

func NewFirewallpolicy(ctx *Context, name string, args *FirewallpolicyArgs, opts ...ResourceOption) (*Firewallpolicy, error)

public Firewallpolicy(string name, FirewallpolicyArgs? args = null, CustomResourceOptions? opts = null)

public Firewallpolicy(String name, FirewallpolicyArgs args)
public Firewallpolicy(String name, FirewallpolicyArgs args, CustomResourceOptions options)

type: google-native:recaptchaenterprise/v1:Firewallpolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args FirewallpolicyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args FirewallpolicyArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args FirewallpolicyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args FirewallpolicyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args FirewallpolicyArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Firewallpolicy Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Firewallpolicy resource accepts the following input properties:

Actions List<Pulumi.GoogleNative.reCAPTCHAEnterprise.V1.Inputs.GoogleCloudRecaptchaenterpriseV1FirewallActionArgs>: 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.
Project string

Actions []GoogleCloudRecaptchaenterpriseV1FirewallActionArgs: 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.
Project string

actions List<GoogleCloudRecaptchaenterpriseV1FirewallActionArgs>: 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.
project String

actions GoogleCloudRecaptchaenterpriseV1FirewallActionArgs[]: 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.
project string

actions Sequence[GoogleCloudRecaptchaenterpriseV1FirewallActionArgs]: 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.
project str

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.
project String

Outputs

All input properties are implicitly available as output properties. Additionally, the Firewallpolicy resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Supporting Types

GoogleCloudRecaptchaenterpriseV1FirewallAction

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

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

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

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

allow GoogleCloudRecaptchaenterpriseV1FirewallActionAllowAction: The user request did not match any policy and should be allowed access to the requested resource.
block GoogleCloudRecaptchaenterpriseV1FirewallActionBlockAction: This action will deny access to a given page. The user will get an HTTP error code.
redirect GoogleCloudRecaptchaenterpriseV1FirewallActionRedirectAction: This action will redirect the request to a ReCaptcha interstitial to attach a token.
set_header GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction: This action will set a custom header but allow the request to continue to the customer backend.
substitute GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction: 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.

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.

GoogleCloudRecaptchaenterpriseV1FirewallActionSetHeaderAction

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.

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.

GoogleCloudRecaptchaenterpriseV1FirewallActionSubstituteAction

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".

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