Policy class

A Cloud Identity Policy binds a Setting to a PolicyQuery for a Google Workspace / Cloud Identity customer.

> Warning: This resource is in beta, and should be used with the terraform-provider-google-beta provider. See Provider Versions for more details on beta resources.

To get more information about Policy, see:

> Note: This is available only in beta

Example Usage

Cloudidentity Policy Basic

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

const primary = new gcp.cloudidentity.Policy("primary", {
    customer: "customers/C01234567",
    policyQuery: {
        orgUnit: "orgUnits/03abcxyz",
        group: "groups/0123456789",
        query: "true",
    },
    setting: {
        type: "something.googleapis.com/SettingType",
        valueJson: JSON.stringify({
            enabled: true,
        }),
    },
});

import pulumi
import json
import pulumi_gcp as gcp

primary = gcp.cloudidentity.Policy("primary",
    customer="customers/C01234567",
    policy_query={
        "org_unit": "orgUnits/03abcxyz",
        "group": "groups/0123456789",
        "query": "true",
    },
    setting={
        "type": "something.googleapis.com/SettingType",
        "value_json": json.dumps({
            "enabled": True,
        }),
    })

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

return await Deployment.RunAsync(() =>
{
    var primary = new Gcp.CloudIdentity.Policy("primary", new()
    {
        Customer = "customers/C01234567",
        PolicyQuery = new Gcp.CloudIdentity.Inputs.PolicyPolicyQueryArgs
        {
            OrgUnit = "orgUnits/03abcxyz",
            Group = "groups/0123456789",
            Query = "true",
        },
        Setting = new Gcp.CloudIdentity.Inputs.PolicySettingArgs
        {
            Type = "something.googleapis.com/SettingType",
            ValueJson = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                ["enabled"] = true,
            }),
        },
    });

});

package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/cloudidentity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]bool{
			"enabled": true,
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = cloudidentity.NewPolicy(ctx, "primary", &cloudidentity.PolicyArgs{
			Customer: pulumi.String("customers/C01234567"),
			PolicyQuery: &cloudidentity.PolicyPolicyQueryArgs{
				OrgUnit: pulumi.String("orgUnits/03abcxyz"),
				Group:   pulumi.String("groups/0123456789"),
				Query:   pulumi.String("true"),
			},
			Setting: &cloudidentity.PolicySettingArgs{
				Type:      pulumi.String("something.googleapis.com/SettingType"),
				ValueJson: pulumi.String(json0),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_cloudidentity_policy" "primary" {
  customer = "customers/C01234567"
  policy_query = {
    org_unit = "orgUnits/03abcxyz"
    group    = "groups/0123456789"
    query    = "true"
  }
  setting = {
    type = "something.googleapis.com/SettingType"
    value_json = jsonencode({
      "enabled" = true
    })
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.cloudidentity.Policy;
import com.pulumi.gcp.cloudidentity.PolicyArgs;
import com.pulumi.gcp.cloudidentity.inputs.PolicyPolicyQueryArgs;
import com.pulumi.gcp.cloudidentity.inputs.PolicySettingArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 primary = new Policy("primary", PolicyArgs.builder()
            .customer("customers/C01234567")
            .policyQuery(PolicyPolicyQueryArgs.builder()
                .orgUnit("orgUnits/03abcxyz")
                .group("groups/0123456789")
                .query("true")
                .build())
            .setting(PolicySettingArgs.builder()
                .type("something.googleapis.com/SettingType")
                .valueJson(serializeJson(
                    jsonObject(
                        jsonProperty("enabled", true)
                    )))
                .build())
            .build());

    }
}

resources:
  primary:
    type: gcp:cloudidentity:Policy
    properties:
      customer: customers/C01234567
      policyQuery:
        orgUnit: orgUnits/03abcxyz
        group: groups/0123456789
        query: 'true'
      setting:
        type: something.googleapis.com/SettingType
        valueJson:
          fn::toJSON:
            enabled: true

Import

Policy can be imported using any of these accepted formats:

policies/{{name}}
{{name}}

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

$ pulumi import gcp:cloudidentity/policy:Policy default policies/{{name}}
$ pulumi import gcp:cloudidentity/policy:Policy default {{name}}

Constructors

Policy(String name, {PolicyArgs? args, CustomResourceOptions? options}): Creates a new Policy. name The Pulumi resource name. args Arguments used to configure this Policy. The set of arguments for Policy. options Resource options controlling this resource's behavior.
Policy.reference(String urn): Creates a typed reference to an existing Policy resource.

Properties

childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
customer ↔ Output<String>: The customer that the Policy belongs to. Format: customers/{customer_id}.
latefinal
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.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>: The resource name of the Policy. Format: policies/{policy_id}.
latefinal
policyQuery ↔ Output<PolicyPolicyQuery>: The PolicyQuery the Setting applies to. Structure is documented below.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
setting ↔ Output<PolicySetting>: The Setting configured by this Policy. Structure is documented below.
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>: latefinalinherited

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, {PolicyState? state, CustomResourceOptions? options}) → Policy: Gets an existing Policy resource's state with the given name and id.