Create custom organization policy constraints

Cloud Composer 3 | Cloud Composer 2 | Cloud Composer 1

This page shows you how to use Organization Policy Service custom constraints to restrictspecific operations on the following Google Cloud resources:

  • composer.googleapis.com/Environment

To learn more about Organization Policy, seeCustom organization policies.

About organization policies and constraints

The Google Cloud Organization Policy Service gives you centralized, programmaticcontrol over your organization's resources. As theorganization policy administrator, you can define an organizationpolicy, which is a set of restrictions calledconstraints that apply toGoogle Cloud resources and descendants of those resources in theGoogle Cloud resource hierarchy. You can enforce organizationpolicies at the organization, folder, or project level.

Organization Policy provides built-inmanaged constraintsfor various Google Cloud services. However, if you want more granular,customizable control over the specific fields that are restricted in yourorganization policies, you can also createcustom constraints and use thosecustom constraints in an organization policy.

Policy inheritance

By default, organization policies are inherited by the descendants of theresources on which you enforce the policy. For example, if you enforce a policyon a folder, Google Cloud enforces the policy on all projects in thefolder. To learn more about this behavior and how to change it, refer toHierarchy evaluation rules.

Benefits

You can use custom organization policies to allow or deny specific valuesfor Cloud Composer resources. For example, if a request to create orupdate a Cloud Composer environment fails to satisfy customconstraint validation as set by your organization policy, the request failsand an error will be returned to the caller. Additionally, use of customorganization policies:

  1. Improves security. For example, you can define policies that forbid thecreation of public IPs environments, enable privately used public IPaddresses, or specify the usage of a specific network and subnetwork.

  2. Provides granular control over resources that are being created or used whencreating or updating an environment.

Limitations

Like all organization policy constraints, policy changes don't applyretroactively to existing instances.

  • A new policy doesn't impact existing instance configurations.
  • An existing instance configuration remains valid, unlessyou change it from a compliant to non-compliant value using theGoogle Cloud console, Google Cloud CLI, or RPC.

Before enforcing custom organization policies on the resource's UPDATE methodtype, make sure that existing environments are compliant with each policy.

Because one update operation can update only one field, a deadlock can occur ifseveral fields of an existing environment are violating the policies at thesame time.

To avoid the deadlock, do one of the following:

  • (Recommended) Make all existing environments compliant with a policy beforeenforcing the policy on the resources. To check which of the existingenvironments won't be compliant after the enforcement of the policy, youcan use thepolicy simulator.

  • Disable the enforcement of the policy, update existing environments to thecompliant state, and re-enforce the policy.

Before you begin

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.create permission.Learn how to grant roles.
    Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Install the Google Cloud CLI.

  5. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  6. Toinitialize the gcloud CLI, run the following command:

    gcloudinit

  7. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.create permission.Learn how to grant roles.
    Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

    Go to project selector

  8. Verify that billing is enabled for your Google Cloud project.

  9. Install the Google Cloud CLI.

  10. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

  11. Toinitialize the gcloud CLI, run the following command:

    gcloudinit
  12. Ensure that you know yourorganization ID.

Required roles

To get the permissions that you need to manage custom organization policies, ask your administrator to grant you theOrganization Policy Administrator (roles/orgpolicy.policyAdmin) IAM role on the organization resource. For more information about granting roles, seeManage access to projects, folders, and organizations.

You might also be able to get the required permissions throughcustom roles or otherpredefined roles.

Set up a custom constraint

A custom constraint is defined in a YAML file by the resources, methods,conditions, and actions that are supported by the service on which you areenforcing the organization policy. Conditions for your custom constraints aredefined usingCommon Expression Language (CEL). For more information about how to buildconditions in custom constraints using CEL, see the CEL section ofCreating and managing custom constraints.

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. ClickCustom 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.

    9. 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, clickEdit 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.

    11. 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.

    12. 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:
    2. name:organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAMEresourceTypes:-RESOURCE_NAMEmethodTypes:-CREATE
    - UPDATE    condition:"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.restrictEnvironmentSize. 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,composer.googleapis.com/Environment.
    • 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.config.environmentSize == "ENVIRONMENT_SIZE_SMALL".

      • 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:
    3. 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:
    4. gcloudorg-policieslist-custom-constraints--organization=ORGANIZATION_ID

    ReplaceORGANIZATION_ID with the ID of your organization resource.

    For more information, see Viewing organization policies.

Enforce a custom organization policy

You can enforce a constraint by creating an organization policy that references it, and thenapplying that organization policy to a Google Cloud resource.

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:
    2. 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.restrictEnvironmentSize.
  2. To enforce the organization policy indry-run mode, run the following command with thedryRunSpec flag:
    3. 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:
    4. 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.

Test the custom organization policy

The following example creates a custom constraint and policythat allows only small Cloud Composer environments.

Before you begin, you should know the following:

  • Your organization ID
  • Your project ID

Create the constraint

  1. Save the following file asconstraint-require-only-small-environments.yaml:

    name:organizations/ORGANIZATION_ID/customConstraints/custom.restrictEnvironmentSizeresourceTypes:-composer.googleapis.com/EnvironmentmethodTypes:-CREATEcondition:resource.config.environmentSize == "ENVIRONMENT_SIZE_SMALL"actionType:ALLOWdisplayName:Only allow small Composer environments.description:All environments must be small.

  2. Apply the constraint:

    gcloudorg-policiesset-custom-constraintconstraint-require-only-small-environments.yaml

Create the policy

  1. Save the following file aspolicy-require-only-small-environments.yaml:

    name:projects/PROJECT_ID/policies/custom.restrictEnvironmentSizespec:rules:-enforce:true

  2. Apply the policy:

    gcloudorg-policiesset-policypolicy-require-only-small-environments.yaml

After you apply the policy, wait for about two minutes for Google Cloudto start enforcing the policy.

Test the policy

gcloudcomposerenvironmentscreateENVIRONMENT_NAME\--location=LOCATION\--image-version="composer-3-airflow-2.10.5-build.23"\--environment-size=medium

This environment creation fails because of the constraint in place that requiresonly small Composer environment size.

The output is similar to the following:

You can't perform this action on a Composer environment due to Custom Organization Policy constraints set on your project. The following constraint(s) were violated: ["customConstraints/custom.restrictEnvironmentSize": All environments must be small.]

To address the previous error, create a small-sized environment. For example:

gcloudcomposerenvironmentscreateENVIRONMENT_NAME\--location=LOCATION\--image-version="composer-3-airflow-2.10.5-build.23"\--environment-size=small

The environment creation is successfully started.

Example custom organization policies for common use cases

This table provides syntax examples for some common custom constraints.

DescriptionConstraint syntax
Allow only private IP Cloud Composer environments
name:organizations/ORGANIZATION_ID/customConstraints/custom.allowOnlyPrivateIpresourceTypes:-composer.googleapis.com/EnvironmentmethodTypes:-CREATEcondition:resource.config.privateEnvironmentConfig.enablePrivateEnvironment == trueactionType:ALLOWdisplayName:Only Private IP environmentsdescription:All environments must use Private IP networking
The maximum count of the workers must be 10 or less
name:organizations/ORGANIZATION_ID/customConstraints/custom.restrictMaxWorketCountresourceTypes:-composer.googleapis.com/EnvironmentmethodTypes:-CREATE-UPDATEcondition:resource.config.workloadsConfig.worker.maxCount <= 10actionType:ALLOWdisplayName:Limit the maximum number of workersdescription:All environments must have 10 or less workers

Cloud Composer supported resources

The following table lists the Cloud Composer resources that you can referencein custom constraints.

ResourceField
composer.googleapis.com/Environmentresource.config.environmentSize
resource.config.maintenanceWindow.recurrence
resource.config.masterAuthorizedNetworksConfig.enabled
resource.config.nodeConfig.enableIpMasqAgent
resource.config.nodeConfig.network
resource.config.nodeConfig.serviceAccount
resource.config.nodeConfig.subnetwork
resource.config.privateEnvironmentConfig.cloudComposerConnectionSubnetwork
resource.config.privateEnvironmentConfig.enablePrivateBuildsOnly
resource.config.privateEnvironmentConfig.enablePrivateEnvironment
resource.config.privateEnvironmentConfig.enablePrivatelyUsedPublicIps
resource.config.privateEnvironmentConfig.networkingConfig.connectionType
resource.config.privateEnvironmentConfig.privateClusterConfig.enablePrivateEndpoint
resource.config.recoveryConfig.scheduledSnapshotsConfig.enabled
resource.config.recoveryConfig.scheduledSnapshotsConfig.snapshotCreationSchedule
resource.config.recoveryConfig.scheduledSnapshotsConfig.snapshotLocation
resource.config.recoveryConfig.scheduledSnapshotsConfig.timeZone
resource.config.resilienceMode
resource.config.softwareConfig.cloudDataLineageIntegration.enabled
resource.config.softwareConfig.imageVersion
resource.config.softwareConfig.webServerPluginsMode
resource.config.workloadsConfig.dagProcessor.count
resource.config.workloadsConfig.dagProcessor.cpu
resource.config.workloadsConfig.dagProcessor.memoryGb
resource.config.workloadsConfig.dagProcessor.storageGb
resource.config.workloadsConfig.scheduler.count
resource.config.workloadsConfig.scheduler.cpu
resource.config.workloadsConfig.scheduler.memoryGb
resource.config.workloadsConfig.scheduler.storageGb
resource.config.workloadsConfig.triggerer.count
resource.config.workloadsConfig.triggerer.cpu
resource.config.workloadsConfig.triggerer.memoryGb
resource.config.workloadsConfig.webServer.cpu
resource.config.workloadsConfig.webServer.memoryGb
resource.config.workloadsConfig.webServer.storageGb
resource.config.workloadsConfig.worker.cpu
resource.config.workloadsConfig.worker.maxCount
resource.config.workloadsConfig.worker.memoryGb
resource.config.workloadsConfig.worker.minCount
resource.config.workloadsConfig.worker.storageGb
resource.name

What's next

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-15 UTC.