Skip to main content

custom_constraints

Overview

Namecustom_constraints
TypeResource
Idgoogle.orgpolicy.custom_constraints

Fields

NameDatatypeDescription
namestringImmutable. Name of the constraint. This is unique within the organization. Format of the name should be * organizations/{organization_id}/customConstraints/{custom_constraint_id} Example: organizations/123/customConstraints/custom.createOnlyE2TypeVms The max length is 70 characters and the minimum length is 1. Note that the prefix organizations/{organization_id}/customConstraints/ is not counted.
descriptionstringDetailed information about this custom policy constraint. The max length of the description is 2000 characters.
actionTypestringAllow or deny type.
conditionstringOrg policy condition/expression. For example: resource.instanceName.matches("[production\|test]_.*_(\d)+") or, resource.management.auto_upgrade == true The max length of the condition is 1000 characters.
displayNamestringOne line display name for the UI. The max length of the display_name is 200 characters.
methodTypesarrayAll the operations being applied for this constraint.
resourceTypesarrayImmutable. The resource instance type on which this policy applies. Format will be of the form : / Example: * compute.googleapis.com/Instance.
updateTimestringOutput only. The last time this custom constraint was updated. This represents the last time that the CreateCustomConstraint or UpdateCustomConstraint RPC was called

Methods

NameAccessible byRequired ParamsDescription
organizations_custom_constraints_getSELECTcustomConstraintsId, organizationsIdGets a custom constraint. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the custom constraint does not exist.
organizations_custom_constraints_listSELECTorganizationsIdRetrieves all of the custom constraints that exist on a particular organization resource.
organizations_custom_constraints_createINSERTorganizationsIdCreates a custom constraint. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the organization does not exist. Returns a google.rpc.Status with google.rpc.Code.ALREADY_EXISTS if the constraint already exists on the given organization.
organizations_custom_constraints_deleteDELETEcustomConstraintsId, organizationsIdDeletes a custom constraint. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint does not exist.
_organizations_custom_constraints_listEXECorganizationsIdRetrieves all of the custom constraints that exist on a particular organization resource.
organizations_custom_constraints_patchEXECcustomConstraintsId, organizationsIdUpdates a custom constraint. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint does not exist. Note: the supplied policy will perform a full overwrite of all fields.