import * as pulumi from "@pulumi/pulumi"; /** * 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}} * ``` */ export declare 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: string, id: pulumi.Input, state?: CustomConstraintState, opts?: pulumi.CustomResourceOptions): CustomConstraint; /** * 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: any): obj is CustomConstraint; /** * The action to take if the condition is met. * Possible values are: `ALLOW`, `DENY`. */ readonly actionType: pulumi.Output; /** * A CEL condition that refers to a supported service resource, for example `resource.management.autoUpgrade == false`. For details about CEL usage, see [Common Expression Language](https://cloud.google.com/resource-manager/docs/organization-policy/creating-managing-custom-constraints#common_expression_language). */ readonly condition: pulumi.Output; /** * A human-friendly description of the constraint to display as an error message when the policy is violated. */ readonly description: pulumi.Output; /** * A human-friendly name for the constraint. */ readonly displayName: pulumi.Output; /** * A list of RESTful methods for which to enforce the constraint. Can be `CREATE`, `UPDATE`, or both. Not all Google Cloud services support both methods. To see supported methods for each service, find the service in [Supported services](https://cloud.google.com/resource-manager/docs/organization-policy/custom-constraint-supported-services). */ readonly methodTypes: pulumi.Output; /** * Immutable. The name of the custom constraint. This is unique within the organization. */ readonly name: pulumi.Output; /** * The parent of the resource, an organization. Format should be `organizations/{organization_id}`. * * * - - - */ readonly parent: pulumi.Output; /** * Immutable. The fully qualified name of the Google Cloud REST resource containing the object and field you want to restrict. For example, `container.googleapis.com/NodePool`. */ readonly resourceTypes: pulumi.Output; /** * Output only. The timestamp representing when the constraint was last updated. */ readonly updateTime: pulumi.Output; /** * Create a CustomConstraint resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: CustomConstraintArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering CustomConstraint resources. */ export interface CustomConstraintState { /** * The action to take if the condition is met. * Possible values are: `ALLOW`, `DENY`. */ actionType?: pulumi.Input; /** * A CEL condition that refers to a supported service resource, for example `resource.management.autoUpgrade == false`. For details about CEL usage, see [Common Expression Language](https://cloud.google.com/resource-manager/docs/organization-policy/creating-managing-custom-constraints#common_expression_language). */ condition?: pulumi.Input; /** * A human-friendly description of the constraint to display as an error message when the policy is violated. */ description?: pulumi.Input; /** * A human-friendly name for the constraint. */ displayName?: pulumi.Input; /** * A list of RESTful methods for which to enforce the constraint. Can be `CREATE`, `UPDATE`, or both. Not all Google Cloud services support both methods. To see supported methods for each service, find the service in [Supported services](https://cloud.google.com/resource-manager/docs/organization-policy/custom-constraint-supported-services). */ methodTypes?: pulumi.Input[]>; /** * Immutable. The name of the custom constraint. This is unique within the organization. */ name?: pulumi.Input; /** * The parent of the resource, an organization. Format should be `organizations/{organization_id}`. * * * - - - */ parent?: pulumi.Input; /** * Immutable. The fully qualified name of the Google Cloud REST resource containing the object and field you want to restrict. For example, `container.googleapis.com/NodePool`. */ resourceTypes?: pulumi.Input[]>; /** * Output only. The timestamp representing when the constraint was last updated. */ updateTime?: pulumi.Input; } /** * The set of arguments for constructing a CustomConstraint resource. */ export interface CustomConstraintArgs { /** * The action to take if the condition is met. * Possible values are: `ALLOW`, `DENY`. */ actionType: pulumi.Input; /** * A CEL condition that refers to a supported service resource, for example `resource.management.autoUpgrade == false`. For details about CEL usage, see [Common Expression Language](https://cloud.google.com/resource-manager/docs/organization-policy/creating-managing-custom-constraints#common_expression_language). */ condition: pulumi.Input; /** * A human-friendly description of the constraint to display as an error message when the policy is violated. */ description?: pulumi.Input; /** * A human-friendly name for the constraint. */ displayName?: pulumi.Input; /** * A list of RESTful methods for which to enforce the constraint. Can be `CREATE`, `UPDATE`, or both. Not all Google Cloud services support both methods. To see supported methods for each service, find the service in [Supported services](https://cloud.google.com/resource-manager/docs/organization-policy/custom-constraint-supported-services). */ methodTypes: pulumi.Input[]>; /** * Immutable. The name of the custom constraint. This is unique within the organization. */ name?: pulumi.Input; /** * The parent of the resource, an organization. Format should be `organizations/{organization_id}`. * * * - - - */ parent: pulumi.Input; /** * Immutable. The fully qualified name of the Google Cloud REST resource containing the object and field you want to restrict. For example, `container.googleapis.com/NodePool`. */ resourceTypes: pulumi.Input[]>; }