pulumi-gcp 9.0.0a1__py3-none-any.whl → 9.0.0a1758219982__py3-none-any.whl

pulumi_gcp/firebase/get_apple_app_config.py

@@ -92,7 +92,14 @@ def get_apple_app_config(app_id: Optional[_builtins.str] = None,
                          project: Optional[_builtins.str] = None,
                          opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetAppleAppConfigResult:
     """
-    Use this data source to access information about an existing resource.
+    A Google Cloud Firebase Apple application configuration
+
+    To get more information about iosApp, see:
+
+    * [API documentation](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.iosApps)
+    * How-to Guides
+        * [Official Documentation](https://firebase.google.com/)
+
 
     :param _builtins.str app_id: The id of the Firebase iOS App.
            
@@ -116,7 +123,14 @@ def get_apple_app_config_output(app_id: Optional[pulumi.Input[_builtins.str]] =
                                 project: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
                                 opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetAppleAppConfigResult]:
     """
-    Use this data source to access information about an existing resource.
+    A Google Cloud Firebase Apple application configuration
+
+    To get more information about iosApp, see:
+
+    * [API documentation](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.iosApps)
+    * How-to Guides
+        * [Official Documentation](https://firebase.google.com/)
+
 
     :param _builtins.str app_id: The id of the Firebase iOS App.
            

pulumi_gcp/firebase/get_hosting_channel.py

@@ -137,7 +137,8 @@ def get_hosting_channel(channel_id: Optional[_builtins.str] = None,
                         site_id: Optional[_builtins.str] = None,
                         opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetHostingChannelResult:
     """
-    Use this data source to access information about an existing resource.
+    A Google Cloud Firebase Hosting Channel instance
+
 
     :param _builtins.str channel_id: The ID of the channel. Use `channel_id = "live"` for the default channel of a site.
     :param _builtins.str site_id: The ID of the site this channel belongs to.
@@ -163,7 +164,8 @@ def get_hosting_channel_output(channel_id: Optional[pulumi.Input[_builtins.str]]
                                site_id: Optional[pulumi.Input[_builtins.str]] = None,
                                opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetHostingChannelResult]:
     """
-    Use this data source to access information about an existing resource.
+    A Google Cloud Firebase Hosting Channel instance
+
 
     :param _builtins.str channel_id: The ID of the channel. Use `channel_id = "live"` for the default channel of a site.
     :param _builtins.str site_id: The ID of the site this channel belongs to.

pulumi_gcp/firebase/hosting_channel.py

@@ -316,6 +316,16 @@ class HostingChannel(pulumi.CustomResource):
                  ttl: Optional[pulumi.Input[_builtins.str]] = None,
                  __props__=None):
         """
+        A `Channel` represents a stream of releases for a site. All sites have a default
+        `live` channel that serves content to the Firebase-provided subdomains and any
+        connected custom domains.
+
+        To get more information about Channel, see:
+
+        * [API documentation](https://firebase.google.com/docs/reference/hosting/rest/v1beta1/sites.channels)
+        * How-to Guides
+            * [Official Documentation](https://firebase.google.com/docs/hosting)
+
         ## Example Usage
 
         ### Firebasehosting Channel Basic
@@ -391,6 +401,16 @@ class HostingChannel(pulumi.CustomResource):
                  args: HostingChannelArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
+        A `Channel` represents a stream of releases for a site. All sites have a default
+        `live` channel that serves content to the Firebase-provided subdomains and any
+        connected custom domains.
+
+        To get more information about Channel, see:
+
+        * [API documentation](https://firebase.google.com/docs/reference/hosting/rest/v1beta1/sites.channels)
+        * How-to Guides
+            * [Official Documentation](https://firebase.google.com/docs/hosting)
+
         ## Example Usage
 
         ### Firebasehosting Channel Basic

pulumi_gcp/firebase/hosting_custom_domain.py

@@ -582,6 +582,16 @@ class HostingCustomDomain(pulumi.CustomResource):
                  wait_dns_verification: Optional[pulumi.Input[_builtins.bool]] = None,
                  __props__=None):
         """
+        Manages Custom Domains for Firebase Hosting. Custom Domains link your
+        domain names with Firebase Hosting sites, allowing Hosting to serve content
+        on those domain names.
+
+        To get more information about CustomDomain, see:
+
+        * [API documentation](https://firebase.google.com/docs/reference/hosting/rest/v1beta1/projects.sites.customDomains)
+        * How-to Guides
+            * [Official Documentation](https://firebase.google.com/docs/hosting)
+
         ## Example Usage
 
         ### Firebasehosting Customdomain Basic
@@ -706,6 +716,16 @@ class HostingCustomDomain(pulumi.CustomResource):
                  args: HostingCustomDomainArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
+        Manages Custom Domains for Firebase Hosting. Custom Domains link your
+        domain names with Firebase Hosting sites, allowing Hosting to serve content
+        on those domain names.
+
+        To get more information about CustomDomain, see:
+
+        * [API documentation](https://firebase.google.com/docs/reference/hosting/rest/v1beta1/projects.sites.customDomains)
+        * How-to Guides
+            * [Official Documentation](https://firebase.google.com/docs/hosting)
+
         ## Example Usage
 
         ### Firebasehosting Customdomain Basic

pulumi_gcp/firebase/hosting_release.py

@@ -276,6 +276,14 @@ class HostingRelease(pulumi.CustomResource):
                  version_name: Optional[pulumi.Input[_builtins.str]] = None,
                  __props__=None):
         """
+        A Release is a particular collection of configurations that is set to be public at a particular time.
+
+        To get more information about Release, see:
+
+        * [API documentation](https://firebase.google.com/docs/reference/hosting/rest/v1beta1/sites.releases)
+        * How-to Guides
+            * [Official Documentation](https://firebase.google.com/docs/hosting)
+
         ## Example Usage
 
         ### Firebasehosting Release In Site
@@ -397,6 +405,14 @@ class HostingRelease(pulumi.CustomResource):
                  args: HostingReleaseArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
+        A Release is a particular collection of configurations that is set to be public at a particular time.
+
+        To get more information about Release, see:
+
+        * [API documentation](https://firebase.google.com/docs/reference/hosting/rest/v1beta1/sites.releases)
+        * How-to Guides
+            * [Official Documentation](https://firebase.google.com/docs/hosting)
+
         ## Example Usage
 
         ### Firebasehosting Release In Site

pulumi_gcp/firebase/hosting_site.py

@@ -215,6 +215,14 @@ class HostingSite(pulumi.CustomResource):
                  site_id: Optional[pulumi.Input[_builtins.str]] = None,
                  __props__=None):
         """
+        A `Site` represents a Firebase Hosting site.
+
+        To get more information about Site, see:
+
+        * [API documentation](https://firebase.google.com/docs/reference/hosting/rest/v1beta1/projects.sites)
+        * How-to Guides
+            * [Official Documentation](https://firebase.google.com/docs/hosting)
+
         ## Example Usage
 
         ### Firebasehosting Site Basic
@@ -299,6 +307,14 @@ class HostingSite(pulumi.CustomResource):
                  args: Optional[HostingSiteArgs] = None,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
+        A `Site` represents a Firebase Hosting site.
+
+        To get more information about Site, see:
+
+        * [API documentation](https://firebase.google.com/docs/reference/hosting/rest/v1beta1/projects.sites)
+        * How-to Guides
+            * [Official Documentation](https://firebase.google.com/docs/hosting)
+
         ## Example Usage
 
         ### Firebasehosting Site Basic

pulumi_gcp/firebase/hosting_version.py

@@ -145,6 +145,14 @@ class HostingVersion(pulumi.CustomResource):
                  site_id: Optional[pulumi.Input[_builtins.str]] = None,
                  __props__=None):
         """
+        A `Version` is a configuration which determine how a site is displayed. Static files are not supported at the moment.
+
+        To get more information about Version, see:
+
+        * [API documentation](https://firebase.google.com/docs/reference/hosting/rest/v1beta1/sites.versions)
+        * How-to Guides
+            * [Official Documentation](https://firebase.google.com/docs/hosting)
+
         ## Example Usage
 
         ### Firebasehosting Version Redirect
@@ -359,6 +367,14 @@ class HostingVersion(pulumi.CustomResource):
                  args: HostingVersionArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
+        A `Version` is a configuration which determine how a site is displayed. Static files are not supported at the moment.
+
+        To get more information about Version, see:
+
+        * [API documentation](https://firebase.google.com/docs/reference/hosting/rest/v1beta1/sites.versions)
+        * How-to Guides
+            * [Official Documentation](https://firebase.google.com/docs/hosting)
+
         ## Example Usage
 
         ### Firebasehosting Version Redirect

pulumi_gcp/firebase/storage_bucket.py

@@ -126,6 +126,15 @@ class StorageBucket(pulumi.CustomResource):
                  project: Optional[pulumi.Input[_builtins.str]] = None,
                  __props__=None):
         """
+        An association between a Firebase project and a Google Cloud Storage bucket.
+        This association enables integration of Cloud Storage buckets with Firebase such as Firebase SDKS, Authentication, and Security Rules.
+
+        To get more information about Bucket, see:
+
+        * [API documentation](https://firebase.google.com/docs/reference/rest/storage/rest/v1beta/projects.buckets)
+        * How-to Guides
+            * [Official Documentation](https://firebase.google.com/docs/storage/)
+
         ## Example Usage
 
         ### Firebasestorage Bucket Basic
@@ -180,6 +189,15 @@ class StorageBucket(pulumi.CustomResource):
                  args: Optional[StorageBucketArgs] = None,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
+        An association between a Firebase project and a Google Cloud Storage bucket.
+        This association enables integration of Cloud Storage buckets with Firebase such as Firebase SDKS, Authentication, and Security Rules.
+
+        To get more information about Bucket, see:
+
+        * [API documentation](https://firebase.google.com/docs/reference/rest/storage/rest/v1beta/projects.buckets)
+        * How-to Guides
+            * [Official Documentation](https://firebase.google.com/docs/storage/)
+
         ## Example Usage
 
         ### Firebasestorage Bucket Basic

pulumi_gcp/firestore/index.py

@@ -28,7 +28,8 @@ class IndexArgs:
                  density: Optional[pulumi.Input[_builtins.str]] = None,
                  multikey: Optional[pulumi.Input[_builtins.bool]] = None,
                  project: Optional[pulumi.Input[_builtins.str]] = None,
-                 query_scope: Optional[pulumi.Input[_builtins.str]] = None):
+                 query_scope: Optional[pulumi.Input[_builtins.str]] = None,
+                 unique: Optional[pulumi.Input[_builtins.bool]] = None):
         """
         The set of arguments for constructing a Index resource.
         :param pulumi.Input[_builtins.str] collection: The collection being indexed.
@@ -51,6 +52,7 @@ class IndexArgs:
         :param pulumi.Input[_builtins.str] query_scope: The scope at which a query is run.
                Default value is `COLLECTION`.
                Possible values are: `COLLECTION`, `COLLECTION_GROUP`, `COLLECTION_RECURSIVE`.
+        :param pulumi.Input[_builtins.bool] unique: Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents.
         """
         pulumi.set(__self__, "collection", collection)
         pulumi.set(__self__, "fields", fields)
@@ -66,6 +68,8 @@ class IndexArgs:
             pulumi.set(__self__, "project", project)
         if query_scope is not None:
             pulumi.set(__self__, "query_scope", query_scope)
+        if unique is not None:
+            pulumi.set(__self__, "unique", unique)
 
     @_builtins.property
     @pulumi.getter
@@ -175,6 +179,18 @@ class IndexArgs:
     def query_scope(self, value: Optional[pulumi.Input[_builtins.str]]):
         pulumi.set(self, "query_scope", value)
 
+    @_builtins.property
+    @pulumi.getter
+    def unique(self) -> Optional[pulumi.Input[_builtins.bool]]:
+        """
+        Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents.
+        """
+        return pulumi.get(self, "unique")
+
+    @unique.setter
+    def unique(self, value: Optional[pulumi.Input[_builtins.bool]]):
+        pulumi.set(self, "unique", value)
+
 
 @pulumi.input_type
 class _IndexState:
@@ -187,7 +203,8 @@ class _IndexState:
                  multikey: Optional[pulumi.Input[_builtins.bool]] = None,
                  name: Optional[pulumi.Input[_builtins.str]] = None,
                  project: Optional[pulumi.Input[_builtins.str]] = None,
-                 query_scope: Optional[pulumi.Input[_builtins.str]] = None):
+                 query_scope: Optional[pulumi.Input[_builtins.str]] = None,
+                 unique: Optional[pulumi.Input[_builtins.bool]] = None):
         """
         Input properties used for looking up and filtering Index resources.
         :param pulumi.Input[_builtins.str] api_scope: The API scope at which a query is run.
@@ -212,6 +229,7 @@ class _IndexState:
         :param pulumi.Input[_builtins.str] query_scope: The scope at which a query is run.
                Default value is `COLLECTION`.
                Possible values are: `COLLECTION`, `COLLECTION_GROUP`, `COLLECTION_RECURSIVE`.
+        :param pulumi.Input[_builtins.bool] unique: Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents.
         """
         if api_scope is not None:
             pulumi.set(__self__, "api_scope", api_scope)
@@ -231,6 +249,8 @@ class _IndexState:
             pulumi.set(__self__, "project", project)
         if query_scope is not None:
             pulumi.set(__self__, "query_scope", query_scope)
+        if unique is not None:
+            pulumi.set(__self__, "unique", unique)
 
     @_builtins.property
     @pulumi.getter(name="apiScope")
@@ -353,6 +373,18 @@ class _IndexState:
     def query_scope(self, value: Optional[pulumi.Input[_builtins.str]]):
         pulumi.set(self, "query_scope", value)
 
+    @_builtins.property
+    @pulumi.getter
+    def unique(self) -> Optional[pulumi.Input[_builtins.bool]]:
+        """
+        Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents.
+        """
+        return pulumi.get(self, "unique")
+
+    @unique.setter
+    def unique(self, value: Optional[pulumi.Input[_builtins.bool]]):
+        pulumi.set(self, "unique", value)
+
 
 @pulumi.type_token("gcp:firestore/index:Index")
 class Index(pulumi.CustomResource):
@@ -368,6 +400,7 @@ class Index(pulumi.CustomResource):
                  multikey: Optional[pulumi.Input[_builtins.bool]] = None,
                  project: Optional[pulumi.Input[_builtins.str]] = None,
                  query_scope: Optional[pulumi.Input[_builtins.str]] = None,
+                 unique: Optional[pulumi.Input[_builtins.bool]] = None,
                  __props__=None):
         """
         Cloud Firestore indexes enable simple and complex queries against documents in a database.
@@ -572,6 +605,40 @@ class Index(pulumi.CustomResource):
                 },
             ])
         ```
+        ### Firestore Index Unique
+
+        ```python
+        import pulumi
+        import pulumi_gcp as gcp
+
+        database = gcp.firestore.Database("database",
+            project="my-project-name",
+            name="database-id-unique",
+            location_id="nam5",
+            type="FIRESTORE_NATIVE",
+            database_edition="ENTERPRISE",
+            delete_protection_state="DELETE_PROTECTION_DISABLED",
+            deletion_policy="DELETE")
+        my_index = gcp.firestore.Index("my-index",
+            project="my-project-name",
+            database=database.name,
+            collection="atestcollection",
+            api_scope="MONGODB_COMPATIBLE_API",
+            query_scope="COLLECTION_GROUP",
+            multikey=True,
+            density="DENSE",
+            unique=True,
+            fields=[
+                {
+                    "field_path": "name",
+                    "order": "ASCENDING",
+                },
+                {
+                    "field_path": "description",
+                    "order": "DESCENDING",
+                },
+            ])
+        ```
 
         ## Import
 
@@ -607,6 +674,7 @@ class Index(pulumi.CustomResource):
         :param pulumi.Input[_builtins.str] query_scope: The scope at which a query is run.
                Default value is `COLLECTION`.
                Possible values are: `COLLECTION`, `COLLECTION_GROUP`, `COLLECTION_RECURSIVE`.
+        :param pulumi.Input[_builtins.bool] unique: Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents.
         """
         ...
     @overload
@@ -817,6 +885,40 @@ class Index(pulumi.CustomResource):
                 },
             ])
         ```
+        ### Firestore Index Unique
+
+        ```python
+        import pulumi
+        import pulumi_gcp as gcp
+
+        database = gcp.firestore.Database("database",
+            project="my-project-name",
+            name="database-id-unique",
+            location_id="nam5",
+            type="FIRESTORE_NATIVE",
+            database_edition="ENTERPRISE",
+            delete_protection_state="DELETE_PROTECTION_DISABLED",
+            deletion_policy="DELETE")
+        my_index = gcp.firestore.Index("my-index",
+            project="my-project-name",
+            database=database.name,
+            collection="atestcollection",
+            api_scope="MONGODB_COMPATIBLE_API",
+            query_scope="COLLECTION_GROUP",
+            multikey=True,
+            density="DENSE",
+            unique=True,
+            fields=[
+                {
+                    "field_path": "name",
+                    "order": "ASCENDING",
+                },
+                {
+                    "field_path": "description",
+                    "order": "DESCENDING",
+                },
+            ])
+        ```
 
         ## Import
 
@@ -853,6 +955,7 @@ class Index(pulumi.CustomResource):
                  multikey: Optional[pulumi.Input[_builtins.bool]] = None,
                  project: Optional[pulumi.Input[_builtins.str]] = None,
                  query_scope: Optional[pulumi.Input[_builtins.str]] = None,
+                 unique: Optional[pulumi.Input[_builtins.bool]] = None,
                  __props__=None):
         opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
         if not isinstance(opts, pulumi.ResourceOptions):
@@ -874,6 +977,7 @@ class Index(pulumi.CustomResource):
             __props__.__dict__["multikey"] = multikey
             __props__.__dict__["project"] = project
             __props__.__dict__["query_scope"] = query_scope
+            __props__.__dict__["unique"] = unique
             __props__.__dict__["name"] = None
         super(Index, __self__).__init__(
             'gcp:firestore/index:Index',
@@ -893,7 +997,8 @@ class Index(pulumi.CustomResource):
             multikey: Optional[pulumi.Input[_builtins.bool]] = None,
             name: Optional[pulumi.Input[_builtins.str]] = None,
             project: Optional[pulumi.Input[_builtins.str]] = None,
-            query_scope: Optional[pulumi.Input[_builtins.str]] = None) -> 'Index':
+            query_scope: Optional[pulumi.Input[_builtins.str]] = None,
+            unique: Optional[pulumi.Input[_builtins.bool]] = None) -> 'Index':
         """
         Get an existing Index resource's state with the given name, id, and optional extra
         properties used to qualify the lookup.
@@ -923,6 +1028,7 @@ class Index(pulumi.CustomResource):
         :param pulumi.Input[_builtins.str] query_scope: The scope at which a query is run.
                Default value is `COLLECTION`.
                Possible values are: `COLLECTION`, `COLLECTION_GROUP`, `COLLECTION_RECURSIVE`.
+        :param pulumi.Input[_builtins.bool] unique: Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents.
         """
         opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
 
@@ -937,6 +1043,7 @@ class Index(pulumi.CustomResource):
         __props__.__dict__["name"] = name
         __props__.__dict__["project"] = project
         __props__.__dict__["query_scope"] = query_scope
+        __props__.__dict__["unique"] = unique
         return Index(resource_name, opts=opts, __props__=__props__)
 
     @_builtins.property
@@ -1024,3 +1131,11 @@ class Index(pulumi.CustomResource):
         """
         return pulumi.get(self, "query_scope")
 
+    @_builtins.property
+    @pulumi.getter
+    def unique(self) -> pulumi.Output[_builtins.bool]:
+        """
+        Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents.
+        """
+        return pulumi.get(self, "unique")
+

pulumi_gcp/folder/service_identity.py

@@ -144,6 +144,19 @@ class ServiceIdentity(pulumi.CustomResource):
                  service: Optional[pulumi.Input[_builtins.str]] = None,
                  __props__=None):
         """
+        Generate folder service identity for a service.
+
+        > **Note:** Once created, this resource cannot be updated or destroyed. These
+        actions are a no-op.
+
+        > **Note:** This resource can be used to retrieve the emails of the [Google-managed folder service accounts](https://cloud.google.com/iam/docs/service-agents)
+        of the APIs that Google has configured with a Service Identity. You can run `gcloud beta services identity create --service SERVICE_NAME.googleapis.com --folder FOLDER` to
+        verify if an API supports this.
+
+        To get more information about Service Identity, see:
+
+        * [API documentation](https://cloud.google.com/service-usage/docs/reference/rest/v1beta1/services/generateServiceIdentity)
+
         ## Example Usage
 
         ### Folder Service Identity Basic
@@ -182,6 +195,19 @@ class ServiceIdentity(pulumi.CustomResource):
                  args: ServiceIdentityArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
+        Generate folder service identity for a service.
+
+        > **Note:** Once created, this resource cannot be updated or destroyed. These
+        actions are a no-op.
+
+        > **Note:** This resource can be used to retrieve the emails of the [Google-managed folder service accounts](https://cloud.google.com/iam/docs/service-agents)
+        of the APIs that Google has configured with a Service Identity. You can run `gcloud beta services identity create --service SERVICE_NAME.googleapis.com --folder FOLDER` to
+        verify if an API supports this.
+
+        To get more information about Service Identity, see:
+
+        * [API documentation](https://cloud.google.com/service-usage/docs/reference/rest/v1beta1/services/generateServiceIdentity)
+
         ## Example Usage
 
         ### Folder Service Identity Basic

pulumi_gcp/gkehub/membership_rbac_role_binding.py

@@ -353,6 +353,14 @@ class MembershipRbacRoleBinding(pulumi.CustomResource):
                  user: Optional[pulumi.Input[_builtins.str]] = None,
                  __props__=None):
         """
+        RBACRoleBinding represents a rbacrolebinding across the Fleet.
+
+        To get more information about MembershipRBACRoleBinding, see:
+
+        * [API documentation](https://cloud.google.com/anthos/fleet-management/docs/reference/rest/v1/projects.locations.memberships)
+        * How-to Guides
+            * [Registering a Cluster](https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster#register_cluster)
+
         ## Example Usage
 
         ### Gkehub Membership Rbac Role Binding Basic
@@ -433,6 +441,14 @@ class MembershipRbacRoleBinding(pulumi.CustomResource):
                  args: MembershipRbacRoleBindingArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
+        RBACRoleBinding represents a rbacrolebinding across the Fleet.
+
+        To get more information about MembershipRBACRoleBinding, see:
+
+        * [API documentation](https://cloud.google.com/anthos/fleet-management/docs/reference/rest/v1/projects.locations.memberships)
+        * How-to Guides
+            * [Registering a Cluster](https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster#register_cluster)
+
         ## Example Usage
 
         ### Gkehub Membership Rbac Role Binding Basic