@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
171 lines • 6.71 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.OrganizationPolicy = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Allows management of Organization Policies for a Google Cloud Project.
*
* > **Warning:** This resource has been superseded by `gcp.orgpolicy.Policy`. `gcp.orgpolicy.Policy` uses Organization Policy API V2 instead of Cloud Resource Manager API V1 and it supports additional features such as tags and conditions.
*
* To get more information about Organization Policies, see:
*
* * [API documentation](https://cloud.google.com/resource-manager/reference/rest/v1/projects/setOrgPolicy)
* * How-to Guides
* * [Introduction to the Organization Policy Service](https://cloud.google.com/resource-manager/docs/organization-policy/overview)
*
* ## Example Usage
*
* To set policy with a [boolean constraint](https://cloud.google.com/resource-manager/docs/organization-policy/quickstart-boolean-constraints):
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const serialPortPolicy = new gcp.projects.OrganizationPolicy("serial_port_policy", {
* project: "your-project-id",
* constraint: "compute.disableSerialPortAccess",
* booleanPolicy: {
* enforced: true,
* },
* });
* ```
*
* To set a policy with a [list constraint](https://cloud.google.com/resource-manager/docs/organization-policy/quickstart-list-constraints):
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const servicesPolicy = new gcp.projects.OrganizationPolicy("services_policy", {
* project: "your-project-id",
* constraint: "serviceuser.services",
* listPolicy: {
* allow: {
* all: true,
* },
* },
* });
* ```
*
* Or to deny some services, use the following instead:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const servicesPolicy = new gcp.projects.OrganizationPolicy("services_policy", {
* project: "your-project-id",
* constraint: "serviceuser.services",
* listPolicy: {
* suggestedValue: "compute.googleapis.com",
* deny: {
* values: ["cloudresourcemanager.googleapis.com"],
* },
* },
* });
* ```
*
* To restore the default project organization policy, use the following instead:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const servicesPolicy = new gcp.projects.OrganizationPolicy("services_policy", {
* project: "your-project-id",
* constraint: "serviceuser.services",
* restorePolicy: {
* "default": true,
* },
* });
* ```
*
* ## Import
*
* Project organization policies can be imported using any of the follow formats:
*
* * `projects/{{project_id}}:constraints/{{constraint}}`
*
* * `{{project_id}}:constraints/{{constraint}}`
*
* * `{{project_id}}:{{constraint}}`
*
* When using the `pulumi import` command, project organization policies can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:projects/organizationPolicy:OrganizationPolicy default projects/{{project_id}}:constraints/{{constraint}}
* ```
*
* ```sh
* $ pulumi import gcp:projects/organizationPolicy:OrganizationPolicy default {{project_id}}:constraints/{{constraint}}
* ```
*
* ```sh
* $ pulumi import gcp:projects/organizationPolicy:OrganizationPolicy default {{project_id}}:{{constraint}}
* ```
*/
class OrganizationPolicy extends pulumi.CustomResource {
/**
* Get an existing OrganizationPolicy resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, state, opts) {
return new OrganizationPolicy(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of OrganizationPolicy. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === OrganizationPolicy.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["booleanPolicy"] = state?.booleanPolicy;
resourceInputs["constraint"] = state?.constraint;
resourceInputs["etag"] = state?.etag;
resourceInputs["listPolicy"] = state?.listPolicy;
resourceInputs["project"] = state?.project;
resourceInputs["restorePolicy"] = state?.restorePolicy;
resourceInputs["updateTime"] = state?.updateTime;
resourceInputs["version"] = state?.version;
}
else {
const args = argsOrState;
if (args?.constraint === undefined && !opts.urn) {
throw new Error("Missing required property 'constraint'");
}
if (args?.project === undefined && !opts.urn) {
throw new Error("Missing required property 'project'");
}
resourceInputs["booleanPolicy"] = args?.booleanPolicy;
resourceInputs["constraint"] = args?.constraint;
resourceInputs["listPolicy"] = args?.listPolicy;
resourceInputs["project"] = args?.project;
resourceInputs["restorePolicy"] = args?.restorePolicy;
resourceInputs["version"] = args?.version;
resourceInputs["etag"] = undefined /*out*/;
resourceInputs["updateTime"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(OrganizationPolicy.__pulumiType, name, resourceInputs, opts);
}
}
exports.OrganizationPolicy = OrganizationPolicy;
/** @internal */
OrganizationPolicy.__pulumiType = 'gcp:projects/organizationPolicy:OrganizationPolicy';
//# sourceMappingURL=organizationPolicy.js.map