pulumi-gcp 7.12.0a1709365001__py3-none-any.whl → 7.13.0a1709814369__py3-none-any.whl

pulumi_gcp/firebase/app_check_recaptcha_enterprise_config.py

@@ -0,0 +1,474 @@
+# coding=utf-8
+# *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import copy
+import warnings
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+from .. import _utilities
+
+__all__ = ['AppCheckRecaptchaEnterpriseConfigArgs', 'AppCheckRecaptchaEnterpriseConfig']
+
+@pulumi.input_type
+class AppCheckRecaptchaEnterpriseConfigArgs:
+    def __init__(__self__, *,
+                 app_id: pulumi.Input[str],
+                 site_key: pulumi.Input[str],
+                 project: Optional[pulumi.Input[str]] = None,
+                 token_ttl: Optional[pulumi.Input[str]] = None):
+        """
+        The set of arguments for constructing a AppCheckRecaptchaEnterpriseConfig resource.
+        :param pulumi.Input[str] app_id: The ID of an
+               [Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id).
+               
+               
+               - - -
+        :param pulumi.Input[str] site_key: The score-based site key created in reCAPTCHA Enterprise used to invoke reCAPTCHA and generate the reCAPTCHA tokens for your application.
+               **Important**: This is not the siteSecret (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key.
+        :param pulumi.Input[str] project: The ID of the project in which the resource belongs.
+               If it is not provided, the provider project is used.
+        :param pulumi.Input[str] token_ttl: Specifies the duration for which App Check tokens exchanged from reCAPTCHA Enterprise artifacts will be valid.
+               If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive.
+               A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
+        """
+        pulumi.set(__self__, "app_id", app_id)
+        pulumi.set(__self__, "site_key", site_key)
+        if project is not None:
+            pulumi.set(__self__, "project", project)
+        if token_ttl is not None:
+            pulumi.set(__self__, "token_ttl", token_ttl)
+
+    @property
+    @pulumi.getter(name="appId")
+    def app_id(self) -> pulumi.Input[str]:
+        """
+        The ID of an
+        [Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id).
+
+
+        - - -
+        """
+        return pulumi.get(self, "app_id")
+
+    @app_id.setter
+    def app_id(self, value: pulumi.Input[str]):
+        pulumi.set(self, "app_id", value)
+
+    @property
+    @pulumi.getter(name="siteKey")
+    def site_key(self) -> pulumi.Input[str]:
+        """
+        The score-based site key created in reCAPTCHA Enterprise used to invoke reCAPTCHA and generate the reCAPTCHA tokens for your application.
+        **Important**: This is not the siteSecret (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key.
+        """
+        return pulumi.get(self, "site_key")
+
+    @site_key.setter
+    def site_key(self, value: pulumi.Input[str]):
+        pulumi.set(self, "site_key", value)
+
+    @property
+    @pulumi.getter
+    def project(self) -> Optional[pulumi.Input[str]]:
+        """
+        The ID of the project in which the resource belongs.
+        If it is not provided, the provider project is used.
+        """
+        return pulumi.get(self, "project")
+
+    @project.setter
+    def project(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "project", value)
+
+    @property
+    @pulumi.getter(name="tokenTtl")
+    def token_ttl(self) -> Optional[pulumi.Input[str]]:
+        """
+        Specifies the duration for which App Check tokens exchanged from reCAPTCHA Enterprise artifacts will be valid.
+        If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive.
+        A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
+        """
+        return pulumi.get(self, "token_ttl")
+
+    @token_ttl.setter
+    def token_ttl(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "token_ttl", value)
+
+
+@pulumi.input_type
+class _AppCheckRecaptchaEnterpriseConfigState:
+    def __init__(__self__, *,
+                 app_id: Optional[pulumi.Input[str]] = None,
+                 name: Optional[pulumi.Input[str]] = None,
+                 project: Optional[pulumi.Input[str]] = None,
+                 site_key: Optional[pulumi.Input[str]] = None,
+                 token_ttl: Optional[pulumi.Input[str]] = None):
+        """
+        Input properties used for looking up and filtering AppCheckRecaptchaEnterpriseConfig resources.
+        :param pulumi.Input[str] app_id: The ID of an
+               [Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id).
+               
+               
+               - - -
+        :param pulumi.Input[str] name: The relative resource name of the reCAPTCHA Enterprise configuration object
+        :param pulumi.Input[str] project: The ID of the project in which the resource belongs.
+               If it is not provided, the provider project is used.
+        :param pulumi.Input[str] site_key: The score-based site key created in reCAPTCHA Enterprise used to invoke reCAPTCHA and generate the reCAPTCHA tokens for your application.
+               **Important**: This is not the siteSecret (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key.
+        :param pulumi.Input[str] token_ttl: Specifies the duration for which App Check tokens exchanged from reCAPTCHA Enterprise artifacts will be valid.
+               If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive.
+               A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
+        """
+        if app_id is not None:
+            pulumi.set(__self__, "app_id", app_id)
+        if name is not None:
+            pulumi.set(__self__, "name", name)
+        if project is not None:
+            pulumi.set(__self__, "project", project)
+        if site_key is not None:
+            pulumi.set(__self__, "site_key", site_key)
+        if token_ttl is not None:
+            pulumi.set(__self__, "token_ttl", token_ttl)
+
+    @property
+    @pulumi.getter(name="appId")
+    def app_id(self) -> Optional[pulumi.Input[str]]:
+        """
+        The ID of an
+        [Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id).
+
+
+        - - -
+        """
+        return pulumi.get(self, "app_id")
+
+    @app_id.setter
+    def app_id(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "app_id", value)
+
+    @property
+    @pulumi.getter
+    def name(self) -> Optional[pulumi.Input[str]]:
+        """
+        The relative resource name of the reCAPTCHA Enterprise configuration object
+        """
+        return pulumi.get(self, "name")
+
+    @name.setter
+    def name(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "name", value)
+
+    @property
+    @pulumi.getter
+    def project(self) -> Optional[pulumi.Input[str]]:
+        """
+        The ID of the project in which the resource belongs.
+        If it is not provided, the provider project is used.
+        """
+        return pulumi.get(self, "project")
+
+    @project.setter
+    def project(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "project", value)
+
+    @property
+    @pulumi.getter(name="siteKey")
+    def site_key(self) -> Optional[pulumi.Input[str]]:
+        """
+        The score-based site key created in reCAPTCHA Enterprise used to invoke reCAPTCHA and generate the reCAPTCHA tokens for your application.
+        **Important**: This is not the siteSecret (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key.
+        """
+        return pulumi.get(self, "site_key")
+
+    @site_key.setter
+    def site_key(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "site_key", value)
+
+    @property
+    @pulumi.getter(name="tokenTtl")
+    def token_ttl(self) -> Optional[pulumi.Input[str]]:
+        """
+        Specifies the duration for which App Check tokens exchanged from reCAPTCHA Enterprise artifacts will be valid.
+        If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive.
+        A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
+        """
+        return pulumi.get(self, "token_ttl")
+
+    @token_ttl.setter
+    def token_ttl(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "token_ttl", value)
+
+
+class AppCheckRecaptchaEnterpriseConfig(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 app_id: Optional[pulumi.Input[str]] = None,
+                 project: Optional[pulumi.Input[str]] = None,
+                 site_key: Optional[pulumi.Input[str]] = None,
+                 token_ttl: Optional[pulumi.Input[str]] = None,
+                 __props__=None):
+        """
+        An app's reCAPTCHA Enterprise configuration object.
+
+        To get more information about RecaptchaEnterpriseConfig, see:
+
+        * [API documentation](https://firebase.google.com/docs/reference/appcheck/rest/v1/projects.apps.recaptchaEnterpriseConfig)
+        * How-to Guides
+            * [Official Documentation](https://firebase.google.com/docs/app-check)
+
+        ## Example Usage
+        ### Firebase App Check Recaptcha Enterprise Config Basic
+
+        ```python
+        import pulumi
+        import pulumi_gcp as gcp
+        import pulumi_time as time
+
+        default = gcp.firebase.WebApp("default",
+            project="my-project-name",
+            display_name="Web App for reCAPTCHA Enterprise")
+        # It takes a while for App Check to recognize the new app
+        # If your app already exists, you don't have to wait 30 seconds.
+        wait30s = time.index.Sleep("wait_30s", create_duration=30s)
+        default_app_check_recaptcha_enterprise_config = gcp.firebase.AppCheckRecaptchaEnterpriseConfig("default",
+            project="my-project-name",
+            app_id=default.app_id,
+            site_key="6LdpMXIpAAAAANkwWQPgEdjEhal7ugkH9RK9ytuw",
+            token_ttl="7200s")
+        ```
+
+        ## Import
+
+        RecaptchaEnterpriseConfig can be imported using any of these accepted formats:
+
+         * `projects/{{project}}/apps/{{app_id}}/recaptchaEnterpriseConfig`
+
+         * `{{project}}/{{app_id}}`
+
+         * `{{app_id}}`
+
+         When using the `pulumi import` command, RecaptchaEnterpriseConfig can be imported using one of the formats above. For example:
+
+        ```sh
+        $ pulumi import gcp:firebase/appCheckRecaptchaEnterpriseConfig:AppCheckRecaptchaEnterpriseConfig default projects/{{project}}/apps/{{app_id}}/recaptchaEnterpriseConfig
+        ```
+
+        ```sh
+        $ pulumi import gcp:firebase/appCheckRecaptchaEnterpriseConfig:AppCheckRecaptchaEnterpriseConfig default {{project}}/{{app_id}}
+        ```
+
+        ```sh
+        $ pulumi import gcp:firebase/appCheckRecaptchaEnterpriseConfig:AppCheckRecaptchaEnterpriseConfig default {{app_id}}
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[str] app_id: The ID of an
+               [Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id).
+               
+               
+               - - -
+        :param pulumi.Input[str] project: The ID of the project in which the resource belongs.
+               If it is not provided, the provider project is used.
+        :param pulumi.Input[str] site_key: The score-based site key created in reCAPTCHA Enterprise used to invoke reCAPTCHA and generate the reCAPTCHA tokens for your application.
+               **Important**: This is not the siteSecret (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key.
+        :param pulumi.Input[str] token_ttl: Specifies the duration for which App Check tokens exchanged from reCAPTCHA Enterprise artifacts will be valid.
+               If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive.
+               A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: AppCheckRecaptchaEnterpriseConfigArgs,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        An app's reCAPTCHA Enterprise configuration object.
+
+        To get more information about RecaptchaEnterpriseConfig, see:
+
+        * [API documentation](https://firebase.google.com/docs/reference/appcheck/rest/v1/projects.apps.recaptchaEnterpriseConfig)
+        * How-to Guides
+            * [Official Documentation](https://firebase.google.com/docs/app-check)
+
+        ## Example Usage
+        ### Firebase App Check Recaptcha Enterprise Config Basic
+
+        ```python
+        import pulumi
+        import pulumi_gcp as gcp
+        import pulumi_time as time
+
+        default = gcp.firebase.WebApp("default",
+            project="my-project-name",
+            display_name="Web App for reCAPTCHA Enterprise")
+        # It takes a while for App Check to recognize the new app
+        # If your app already exists, you don't have to wait 30 seconds.
+        wait30s = time.index.Sleep("wait_30s", create_duration=30s)
+        default_app_check_recaptcha_enterprise_config = gcp.firebase.AppCheckRecaptchaEnterpriseConfig("default",
+            project="my-project-name",
+            app_id=default.app_id,
+            site_key="6LdpMXIpAAAAANkwWQPgEdjEhal7ugkH9RK9ytuw",
+            token_ttl="7200s")
+        ```
+
+        ## Import
+
+        RecaptchaEnterpriseConfig can be imported using any of these accepted formats:
+
+         * `projects/{{project}}/apps/{{app_id}}/recaptchaEnterpriseConfig`
+
+         * `{{project}}/{{app_id}}`
+
+         * `{{app_id}}`
+
+         When using the `pulumi import` command, RecaptchaEnterpriseConfig can be imported using one of the formats above. For example:
+
+        ```sh
+        $ pulumi import gcp:firebase/appCheckRecaptchaEnterpriseConfig:AppCheckRecaptchaEnterpriseConfig default projects/{{project}}/apps/{{app_id}}/recaptchaEnterpriseConfig
+        ```
+
+        ```sh
+        $ pulumi import gcp:firebase/appCheckRecaptchaEnterpriseConfig:AppCheckRecaptchaEnterpriseConfig default {{project}}/{{app_id}}
+        ```
+
+        ```sh
+        $ pulumi import gcp:firebase/appCheckRecaptchaEnterpriseConfig:AppCheckRecaptchaEnterpriseConfig default {{app_id}}
+        ```
+
+        :param str resource_name: The name of the resource.
+        :param AppCheckRecaptchaEnterpriseConfigArgs args: The arguments to use to populate this resource's properties.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        """
+        ...
+    def __init__(__self__, resource_name: str, *args, **kwargs):
+        resource_args, opts = _utilities.get_resource_args_opts(AppCheckRecaptchaEnterpriseConfigArgs, pulumi.ResourceOptions, *args, **kwargs)
+        if resource_args is not None:
+            __self__._internal_init(resource_name, opts, **resource_args.__dict__)
+        else:
+            __self__._internal_init(resource_name, *args, **kwargs)
+
+    def _internal_init(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 app_id: Optional[pulumi.Input[str]] = None,
+                 project: Optional[pulumi.Input[str]] = None,
+                 site_key: Optional[pulumi.Input[str]] = None,
+                 token_ttl: Optional[pulumi.Input[str]] = None,
+                 __props__=None):
+        opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
+        if not isinstance(opts, pulumi.ResourceOptions):
+            raise TypeError('Expected resource options to be a ResourceOptions instance')
+        if opts.id is None:
+            if __props__ is not None:
+                raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
+            __props__ = AppCheckRecaptchaEnterpriseConfigArgs.__new__(AppCheckRecaptchaEnterpriseConfigArgs)
+
+            if app_id is None and not opts.urn:
+                raise TypeError("Missing required property 'app_id'")
+            __props__.__dict__["app_id"] = app_id
+            __props__.__dict__["project"] = project
+            if site_key is None and not opts.urn:
+                raise TypeError("Missing required property 'site_key'")
+            __props__.__dict__["site_key"] = site_key
+            __props__.__dict__["token_ttl"] = token_ttl
+            __props__.__dict__["name"] = None
+        super(AppCheckRecaptchaEnterpriseConfig, __self__).__init__(
+            'gcp:firebase/appCheckRecaptchaEnterpriseConfig:AppCheckRecaptchaEnterpriseConfig',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None,
+            app_id: Optional[pulumi.Input[str]] = None,
+            name: Optional[pulumi.Input[str]] = None,
+            project: Optional[pulumi.Input[str]] = None,
+            site_key: Optional[pulumi.Input[str]] = None,
+            token_ttl: Optional[pulumi.Input[str]] = None) -> 'AppCheckRecaptchaEnterpriseConfig':
+        """
+        Get an existing AppCheckRecaptchaEnterpriseConfig resource's state with the given name, id, and optional extra
+        properties used to qualify the lookup.
+
+        :param str resource_name: The unique name of the resulting resource.
+        :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[str] app_id: The ID of an
+               [Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id).
+               
+               
+               - - -
+        :param pulumi.Input[str] name: The relative resource name of the reCAPTCHA Enterprise configuration object
+        :param pulumi.Input[str] project: The ID of the project in which the resource belongs.
+               If it is not provided, the provider project is used.
+        :param pulumi.Input[str] site_key: The score-based site key created in reCAPTCHA Enterprise used to invoke reCAPTCHA and generate the reCAPTCHA tokens for your application.
+               **Important**: This is not the siteSecret (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key.
+        :param pulumi.Input[str] token_ttl: Specifies the duration for which App Check tokens exchanged from reCAPTCHA Enterprise artifacts will be valid.
+               If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive.
+               A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = _AppCheckRecaptchaEnterpriseConfigState.__new__(_AppCheckRecaptchaEnterpriseConfigState)
+
+        __props__.__dict__["app_id"] = app_id
+        __props__.__dict__["name"] = name
+        __props__.__dict__["project"] = project
+        __props__.__dict__["site_key"] = site_key
+        __props__.__dict__["token_ttl"] = token_ttl
+        return AppCheckRecaptchaEnterpriseConfig(resource_name, opts=opts, __props__=__props__)
+
+    @property
+    @pulumi.getter(name="appId")
+    def app_id(self) -> pulumi.Output[str]:
+        """
+        The ID of an
+        [Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id).
+
+
+        - - -
+        """
+        return pulumi.get(self, "app_id")
+
+    @property
+    @pulumi.getter
+    def name(self) -> pulumi.Output[str]:
+        """
+        The relative resource name of the reCAPTCHA Enterprise configuration object
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter
+    def project(self) -> pulumi.Output[str]:
+        """
+        The ID of the project in which the resource belongs.
+        If it is not provided, the provider project is used.
+        """
+        return pulumi.get(self, "project")
+
+    @property
+    @pulumi.getter(name="siteKey")
+    def site_key(self) -> pulumi.Output[str]:
+        """
+        The score-based site key created in reCAPTCHA Enterprise used to invoke reCAPTCHA and generate the reCAPTCHA tokens for your application.
+        **Important**: This is not the siteSecret (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key.
+        """
+        return pulumi.get(self, "site_key")
+
+    @property
+    @pulumi.getter(name="tokenTtl")
+    def token_ttl(self) -> pulumi.Output[str]:
+        """
+        Specifies the duration for which App Check tokens exchanged from reCAPTCHA Enterprise artifacts will be valid.
+        If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive.
+        A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
+        """
+        return pulumi.get(self, "token_ttl")
+