AppCheckResourcePolicy class

App Check enforcement policy for a specific resource of a Google service supported by App Check. Note that this policy will override the service-level configuration.

To get more information about ResourcePolicy, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Firebase App Check Resource Policy Oauth2 Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const firebaseappcheck = new gcp.projects.Service("firebaseappcheck", {
    project: "my-project-name",
    service: "firebaseappcheck.googleapis.com",
});
const _default = new gcp.firebase.AppCheckResourcePolicy("default", {
    project: "my-project-name",
    serviceId: "oauth2.googleapis.com",
    targetResource: "//oauth2.googleapis.com/projects/my-project-name/oauthClients/example-client-id",
    enforcementMode: "UNENFORCED",
}, {
    dependsOn: [firebaseappcheck],
});

import pulumi
import pulumi_gcp as gcp

firebaseappcheck = gcp.projects.Service("firebaseappcheck",
    project="my-project-name",
    service="firebaseappcheck.googleapis.com")
default = gcp.firebase.AppCheckResourcePolicy("default",
    project="my-project-name",
    service_id="oauth2.googleapis.com",
    target_resource="//oauth2.googleapis.com/projects/my-project-name/oauthClients/example-client-id",
    enforcement_mode="UNENFORCED",
    opts = pulumi.ResourceOptions(depends_on=[firebaseappcheck]))

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var firebaseappcheck = new Gcp.Projects.Service("firebaseappcheck", new()
    {
        Project = "my-project-name",
        ServiceName = "firebaseappcheck.googleapis.com",
    });

    var @default = new Gcp.Firebase.AppCheckResourcePolicy("default", new()
    {
        Project = "my-project-name",
        ServiceId = "oauth2.googleapis.com",
        TargetResource = "//oauth2.googleapis.com/projects/my-project-name/oauthClients/example-client-id",
        EnforcementMode = "UNENFORCED",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            firebaseappcheck,
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/firebase"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/projects"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		firebaseappcheck, err := projects.NewService(ctx, "firebaseappcheck", &projects.ServiceArgs{
			Project: pulumi.String("my-project-name"),
			Service: pulumi.String("firebaseappcheck.googleapis.com"),
		})
		if err != nil {
			return err
		}
		_, err = firebase.NewAppCheckResourcePolicy(ctx, "default", &firebase.AppCheckResourcePolicyArgs{
			Project:         pulumi.String("my-project-name"),
			ServiceId:       pulumi.String("oauth2.googleapis.com"),
			TargetResource:  pulumi.String("//oauth2.googleapis.com/projects/my-project-name/oauthClients/example-client-id"),
			EnforcementMode: pulumi.String("UNENFORCED"),
		}, pulumi.DependsOn([]pulumi.Resource{
			firebaseappcheck,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_projects_service" "firebaseappcheck" {
  project = "my-project-name"
  service = "firebaseappcheck.googleapis.com"
}
resource "gcp_firebase_appcheckresourcepolicy" "default" {
  depends_on       = [gcp_projects_service.firebaseappcheck]
  project          = "my-project-name"
  service_id       = "oauth2.googleapis.com"
  target_resource  = "//oauth2.googleapis.com/projects/my-project-name/oauthClients/example-client-id"
  enforcement_mode = "UNENFORCED"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.projects.Service;
import com.pulumi.gcp.projects.ServiceArgs;
import com.pulumi.gcp.firebase.AppCheckResourcePolicy;
import com.pulumi.gcp.firebase.AppCheckResourcePolicyArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var firebaseappcheck = new Service("firebaseappcheck", ServiceArgs.builder()
            .project("my-project-name")
            .service("firebaseappcheck.googleapis.com")
            .build());

        var default_ = new AppCheckResourcePolicy("default", AppCheckResourcePolicyArgs.builder()
            .project("my-project-name")
            .serviceId("oauth2.googleapis.com")
            .targetResource("//oauth2.googleapis.com/projects/my-project-name/oauthClients/example-client-id")
            .enforcementMode("UNENFORCED")
            .build(), CustomResourceOptions.builder()
                .dependsOn(firebaseappcheck)
                .build());

    }
}

resources:
  firebaseappcheck:
    type: gcp:projects:Service
    properties:
      project: my-project-name
      service: firebaseappcheck.googleapis.com
  default:
    type: gcp:firebase:AppCheckResourcePolicy
    properties:
      project: my-project-name
      serviceId: oauth2.googleapis.com
      targetResource: //oauth2.googleapis.com/projects/my-project-name/oauthClients/example-client-id
      enforcementMode: UNENFORCED
    options:
      dependsOn:
        - ${firebaseappcheck}

Import

ResourcePolicy can be imported using any of these accepted formats:

• projects/{{project}}/services/{{service_id}}/resourcePolicies/{{resource_policy_id}}
• {{project}}/{{service_id}}/{{resource_policy_id}}
• {{service_id}}/{{resource_policy_id}}

When using the pulumi import command, ResourcePolicy can be imported using one of the formats above. For example:

$ pulumi import gcp:firebase/appCheckResourcePolicy:AppCheckResourcePolicy default projects/{{project}}/services/{{service_id}}/resourcePolicies/{{resource_policy_id}}
$ pulumi import gcp:firebase/appCheckResourcePolicy:AppCheckResourcePolicy default {{project}}/{{service_id}}/{{resource_policy_id}}
$ pulumi import gcp:firebase/appCheckResourcePolicy:AppCheckResourcePolicy default {{service_id}}/{{resource_policy_id}}

Constructors

AppCheckResourcePolicy(String name, {AppCheckResourcePolicyArgs? args, CustomResourceOptions? options})

Creates a new AppCheckResourcePolicy. name The Pulumi resource name. args Arguments used to configure this AppCheckResourcePolicy. The set of arguments for AppCheckResourcePolicy. options Resource options controlling this resource's behavior.

AppCheckResourcePolicy.reference(String urn)

Creates a typed reference to an existing AppCheckResourcePolicy resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

enforcementMode ↔ Output<String?>

The App Check enforcement mode for a service supported by App Check. This will override the EnforcementMode setting on the service. Valid values are: (Unset) Firebase App Check is not enforced for the service, nor are App Check metrics collected. Though the service is not protected by App Check in this mode, other applicable protections, such as user authorization, are still enforced. An unconfigured service is in this mode by default. This is equivalent to OFF in the REST API. Deleting the Terraform resource will also switch the enforcement to OFF for this service. UNENFORCED Firebase App Check is not enforced for the service. App Check metrics are collected to help you decide when to turn on enforcement for the service. Though the service is not protected by App Check in this mode, other applicable protections, such as user authorization, are still enforced. ENFORCED Firebase App Check is enforced for the service. The service will reject any request that attempts to access your project's resources if it does not have valid App Check token attached, with some exceptions depending on the service; for example, some services will still allow requests bearing the developer's privileged service account credentials without an App Check token. App Check metrics continue to be collected to help you detect issues with your App Check integration and monitor the composition of your callers. While the service is protected by App Check, other applicable protections, such as user authorization, continue to be enforced at the same time. Use caution when choosing to enforce App Check on a Firebase service. If your users have not updated to an App Check capable version of your app, their apps will no longer be able to use your Firebase services that are enforcing App Check. App Check metrics can help you decide whether to enforce App Check on your Firebase services. If your app has not launched yet, you should enable enforcement immediately, since there are no outdated clients in use. Possible values are: UNENFORCED, ENFORCED.

late, final

etag ↔ Output<String>

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

project ↔ Output<String>

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

late, final

resourcePolicyId ↔ Output<String>

The server-generated UID for the Resource Policy.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

serviceId ↔ Output<String>

The identifier of the service to configure a Resource Policy for. Currently, the following service IDs are supported:

late, final

targetResource ↔ Output<String>

Service specific name of the resource object to which this policy applies, in the format:

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

updateTime ↔ Output<String>

Output only. Timestamp when this resource policy configuration object was most recently updated.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {AppCheckResourcePolicyState? state, CustomResourceOptions? options}) → AppCheckResourcePolicy

Gets an existing AppCheckResourcePolicy resource's state with the given name and id.