Console

To create a custom constraint, do the following:

1. In the Google Cloud console, go to theOrganization policies page.

   Go to Organization policies

2. From the project picker, select the project that you want to set the organization policy for.
3. ClickaddCustom constraint.
4. In theDisplay name box, enter a human-readable name for the constraint. This name is used in error messages and can be used for identification and debugging. Don't use PII or sensitive data in display names because this name could be exposed in error messages. This field can contain up to 200 characters.
5. In theConstraint ID box, enter the name that you want for your new custom constraint. A custom constraint can only contain letters (including upper and lowercase) or numbers, for examplecustom.disableGkeAutoUpgrade. This field can contain up to 70 characters, not counting the prefix (custom.), for example,organizations/123456789/customConstraints/custom. Don't include PII or sensitive data in your constraint ID, because it could be exposed in error messages.
6. In theDescription box, enter a human-readable description of the constraint. This description is used as an error message when the policy is violated. Include details about why the policy violation occurred and how to resolve the policy violation. Don't include PII or sensitive data in your description, because it could be exposed in error messages. This field can contain up to 2000 characters.
7. In theResource type box, select the name of the Google Cloud REST resource containing the object and field that you want to restrict—for example,container.googleapis.com/NodePool. Most resource types support up to 20 custom constraints. If you attempt to create more custom constraints, the operation fails.
8. UnderEnforcement method, select whether to enforce the constraint on a RESTCREATE method or on bothCREATE andUPDATE methods. If you enforce the constraint with theUPDATE method on a resource that violates the constraint, changes to that resource are blocked by the organization policy unless the change resolves the violation.

Not all Google Cloud services support both methods. To see supported methods for each service, find the service in Supported services.

9. To define a condition, clickeditEdit condition.
1. In theAdd condition panel, create a CEL condition that refers to a supported service resource, for example,resource.management.autoUpgrade == false. This field can contain up to 1000 characters. For details about CEL usage, see Common Expression Language. For more information about the service resources you can use in your custom constraints, see Custom constraint supported services.
2. ClickSave.
10. UnderAction, select whether to allow or deny the evaluated method if the condition is met.

The deny action means that the operation to create or update the resource is blocked if the condition evaluates to true.

The allow action means that the operation to create or update the resource is permitted only if the condition evaluates to true. Every other case except ones explicitly listed in the condition is blocked.

11. ClickCreate constraint.

When you have entered a value into each field, the equivalent YAML configuration for this custom constraint appears on the right.

gcloud

1. To create a custom constraint, create a YAML file using the following format:

name:organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAMEresourceTypes:-RESOURCE_NAMEmethodTypes:-CREATE
- UPDATEcondition:"CONDITION"actionType:ACTIONdisplayName:DISPLAY_NAMEdescription:DESCRIPTION

Replace the following:

• ORGANIZATION_ID: your organization ID, such as123456789.
• CONSTRAINT_NAME: the name that you want for your new custom constraint. A custom constraint can only contain letters (including upper and lowercase) or numbers, for example,custom.restrictDatastreamStreamDisplayName. This field can contain up to 70 characters.
• RESOURCE_NAME: the fully qualified name of the Google Cloud resource containing the object and field that you want to restrict. For example,datastream.googleapis.com/Stream.
• CONDITION: a CEL condition that is written against a representation of a supported service resource. This field can contain up to 1000 characters. For example,"!resource.displayName.startsWith('test-')".

For more information about the resources available to write conditions against, seeSupported resources.

• ACTION: the action to take if thecondition is met. Possible values areALLOW andDENY.

The allow action means that if the condition evaluates to true, the operation to create or update the resource is permitted. This also means that every other case except the one explicitly listed in the condition is blocked.

The deny action means that if the condition evaluates to true, the operation to create or update the resource is blocked.

• DISPLAY_NAME: a human-friendly name for the constraint. This field can contain up to 200 characters.
• DESCRIPTION: a human-friendly description of the constraint to display as an error message when the policy is violated. This field can contain up to 2000 characters.
2. After you have created the YAML file for a new custom constraint, you must set it up to make it available for organization policies in your organization. To set up a custom constraint, use thegcloud org-policies set-custom-constraint command:

gcloudorg-policiesset-custom-constraintCONSTRAINT_PATH

ReplaceCONSTRAINT_PATH with the full path to your custom constraint file. For example,/home/user/customconstraint.yaml.

After this operation is complete, your custom constraints are available as organization policies in your list of Google Cloud organization policies.

3. To verify that the custom constraint exists, use thegcloud org-policies list-custom-constraints command:

gcloudorg-policieslist-custom-constraints--organization=ORGANIZATION_ID

ReplaceORGANIZATION_ID with the ID of your organization resource.

For more information, see Viewing organization policies.

Console

1. In the Google Cloud console, go to theOrganization policies page.

   Go to Organization policies

2. From the project picker, select the project that you want to set the organization policy for.
3. From the list on theOrganization policies page, select your constraint to view thePolicy details page for that constraint.
4. To configure the organization policy for this resource, clickManage policy.
5. On theEdit policy page, selectOverride parent's policy.
6. ClickAdd a rule.
7. In theEnforcement section, select whether this organization policy is enforced or not.
8. Optional: To make the organization policy conditional on a tag, clickAdd condition. Note that if you add a conditional rule to an organization policy, you must add at least one unconditional rule or the policy cannot be saved. For more information, see Setting an organization policy with tags.
9. ClickTest changes to simulate the effect of the organization policy. For more information, see Test organization policy changes with Policy Simulator.
10. To enforce the organization policy in dry-run mode, clickSet dry run policy. For more information, see Create an organization policy in dry-run mode.
11. After you verify that the organization policy in dry-run mode works as intended, set the live policy by clickingSet policy.

gcloud

1. To create an organization policy with boolean rules, create a policy YAML file that references the constraint:

name:projects/PROJECT_ID/policies/CONSTRAINT_NAMEspec:rules:-enforce:truedryRunSpec:rules:-enforce:true

Replace the following:

• PROJECT_ID: the project that you want to enforce your constraint on.
• CONSTRAINT_NAME: the name you defined for your custom constraint. For example,custom.restrictDatastreamStreamDisplayName.
2. To enforce the organization policy indry-run mode, run the following command with thedryRunSpec flag:

gcloudorg-policiesset-policyPOLICY_PATH\--update-mask=dryRunSpec

ReplacePOLICY_PATH with the full path to your organization policy YAML file. The policy requires up to 15 minutes to take effect.

3. After you verify that the organization policy in dry-run mode works as intended, set the live policy with theorg-policies set-policy command and thespec flag:

gcloudorg-policiesset-policyPOLICY_PATH\--update-mask=spec

ReplacePOLICY_PATH with the full path to your organization policy YAML file. The policy requires up to 15 minutes to take effect.