@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
152 lines • 6.47 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.CustomConstraint = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Custom constraints are created by administrators to provide more granular and customizable control over the specific fields that are restricted by your organization policies.
*
* To get more information about CustomConstraint, see:
*
* * [API documentation](https://cloud.google.com/resource-manager/docs/reference/orgpolicy/rest/v2/organizations.constraints)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/resource-manager/docs/organization-policy/creating-managing-custom-constraints)
* * [Supported Services](https://cloud.google.com/resource-manager/docs/organization-policy/custom-constraint-supported-services)
*
* ## Example Usage
*
* ### Org Policy Custom Constraint Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const constraint = new gcp.orgpolicy.CustomConstraint("constraint", {
* name: "custom.disableGkeAutoUpgrade",
* parent: "organizations/123456789",
* actionType: "ALLOW",
* condition: "resource.management.autoUpgrade == false",
* methodTypes: [
* "CREATE",
* "UPDATE",
* ],
* resourceTypes: ["container.googleapis.com/NodePool"],
* });
* ```
* ### Org Policy Custom Constraint Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const constraint = new gcp.orgpolicy.CustomConstraint("constraint", {
* name: "custom.disableGkeAutoUpgrade",
* parent: "organizations/123456789",
* displayName: "Disable GKE auto upgrade",
* description: "Only allow GKE NodePool resource to be created or updated if AutoUpgrade is not enabled where this custom constraint is enforced.",
* actionType: "ALLOW",
* condition: "resource.management.autoUpgrade == false",
* methodTypes: [
* "CREATE",
* "UPDATE",
* ],
* resourceTypes: ["container.googleapis.com/NodePool"],
* });
* const bool = new gcp.orgpolicy.Policy("bool", {
* name: pulumi.interpolate`organizations/123456789/policies/${constraint.name}`,
* parent: "organizations/123456789",
* spec: {
* rules: [{
* enforce: "TRUE",
* }],
* },
* });
* ```
*
* ## Import
*
* CustomConstraint can be imported using any of these accepted formats:
*
* * `{{parent}}/customConstraints/{{name}}`
*
* When using the `pulumi import` command, CustomConstraint can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:orgpolicy/customConstraint:CustomConstraint default {{parent}}/customConstraints/{{name}}
* ```
*/
class CustomConstraint extends pulumi.CustomResource {
/**
* Get an existing CustomConstraint 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 CustomConstraint(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of CustomConstraint. 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'] === CustomConstraint.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["actionType"] = state?.actionType;
resourceInputs["condition"] = state?.condition;
resourceInputs["description"] = state?.description;
resourceInputs["displayName"] = state?.displayName;
resourceInputs["methodTypes"] = state?.methodTypes;
resourceInputs["name"] = state?.name;
resourceInputs["parent"] = state?.parent;
resourceInputs["resourceTypes"] = state?.resourceTypes;
resourceInputs["updateTime"] = state?.updateTime;
}
else {
const args = argsOrState;
if (args?.actionType === undefined && !opts.urn) {
throw new Error("Missing required property 'actionType'");
}
if (args?.condition === undefined && !opts.urn) {
throw new Error("Missing required property 'condition'");
}
if (args?.methodTypes === undefined && !opts.urn) {
throw new Error("Missing required property 'methodTypes'");
}
if (args?.parent === undefined && !opts.urn) {
throw new Error("Missing required property 'parent'");
}
if (args?.resourceTypes === undefined && !opts.urn) {
throw new Error("Missing required property 'resourceTypes'");
}
resourceInputs["actionType"] = args?.actionType;
resourceInputs["condition"] = args?.condition;
resourceInputs["description"] = args?.description;
resourceInputs["displayName"] = args?.displayName;
resourceInputs["methodTypes"] = args?.methodTypes;
resourceInputs["name"] = args?.name;
resourceInputs["parent"] = args?.parent;
resourceInputs["resourceTypes"] = args?.resourceTypes;
resourceInputs["updateTime"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(CustomConstraint.__pulumiType, name, resourceInputs, opts);
}
}
exports.CustomConstraint = CustomConstraint;
/** @internal */
CustomConstraint.__pulumiType = 'gcp:orgpolicy/customConstraint:CustomConstraint';
//# sourceMappingURL=customConstraint.js.map