Google Cloud Organization Policy Service gives you centralized, programmatic
control over your organization's resources. As the
[organization policy administrator](https://docs.cloud.google.com/resource-manager/docs/organization-policy/using-constraints#add-org-policy-admin), you can define an organization policy,
which is a set of restrictions called constraints that apply to
Google Cloud resources and descendants of those resources in the
[Google Cloud resource hierarchy](https://docs.cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy.md.txt). You can enforce organization policies at
the organization, folder, or project level.

Organization Policy provides [predefined constraints](https://docs.cloud.google.com/resource-manager/docs/organization-policy/org-policy-constraints) for various
Google Cloud services. However, if you want more granular, customizable
control over the specific fields that are restricted in your organization
policies, you can also create custom organization policies.

By implementing a custom organization policy, you enforce consistent
configurations and restrictions. This enforcement helps ensure that your
AlloyDB for PostgreSQL clusters, instances, and backups adhere to security best
practices and regulatory requirements.

If you attempt to create or update a cluster, instance, or backup while the
custom constraint is enforced and noncompliant with the constraint, then the
operation fails. Any project added to the organization or folder that uses a
custom organization policy inherits the constraints of that policy.

## Policy inheritance

By default, organization policies are inherited by the descendants of the
resources on which you enforce the policy. For example, if you enforce a policy
on a folder, Google Cloud enforces the policy on all projects in the
folder. To learn more about this behavior and how to change it, see
[Hierarchy evaluation rules](https://docs.cloud.google.com/resource-manager/docs/organization-policy/understanding-hierarchy#inheritance).

## Pricing

Organization Policy, including predefined and custom organization policies, is
offered at no charge.

## Limitations

Like all organization policy constraints, policy changes don't apply
retroactively to existing AlloyDB clusters, instances, and
backups.

- A new policy doesn't impact existing cluster, instance, or backup
  configurations.

- An existing cluster, instance, or backup configuration remains valid, unless
  you change the cluster, instance, or backup configuration from a compliance to
  non-compliance state by using the Google Cloud console, Google Cloud CLI, or RPC.

- A scheduled maintenance update doesn't cause a policy enforcement, because
  maintenance doesn't change the configuration of the cluster, instance, or
  backup.

- Backups created by using the continuous backup and recovery and the automated
  backups features aren't constrained by the policies themselves.

## Before you begin

1. **Set up your project.**
   1. Verify that you know your [organization ID](https://docs.cloud.google.com/resource-manager/docs/creating-managing-organization.md.txt#retrieving_your_organization_id).

### Required roles

<br />


To get the permissions that
you need to manage organization policies,

ask your administrator to grant you the
following IAM roles:

- [Organization Policy Administrator](https://docs.cloud.google.com/iam/docs/roles-permissions/orgpolicy.md.txt#orgpolicy.policyAdmin) (`roles/orgpolicy.policyAdmin`) on the organization resource
- To create or update an AlloyDB cluster: [](https://docs.cloud.google.com/iam/docs/roles-permissions/alloydb.md.txt#alloydb.admin)[AlloyDB Admin](https://docs.cloud.google.com/alloydb/docs/reference/iam-roles-permissions.md.txt) (`roles/alloydb.admin`) on the project resource


For more information about granting roles, see [Manage access to projects, folders, and organizations](https://docs.cloud.google.com/iam/docs/granting-changing-revoking-access.md.txt).


You might also be able to get
the required permissions through [custom
roles](https://docs.cloud.google.com/iam/docs/creating-custom-roles) or other [predefined
roles](https://docs.cloud.google.com/iam/docs/roles-overview#predefined).

## Create 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 are
enforcing the organization policy. Conditions for your custom constraints are
defined using
[Common Expression Language (CEL)](https://github.com/google/cel-spec/blob/master/doc/intro.md). For more information about how to build
conditions in custom constraints using CEL, see the CEL section of
[Creating and managing custom constraints](https://docs.cloud.google.com/resource-manager/docs/organization-policy/creating-managing-custom-constraints#cel).

Organization policies are defined by the values set for each constraint. An
organization policy administrator can create custom constraints to restrict
public IP configurations of AlloyDB at the project, folder, or
organization level.

You can create a custom constraint---for example,
`customConstraints/custom.restrictPublicIP`---to limit public IP access
on AlloyDB instances. This boolean constraint restricts
configuring public IP on AlloyDB instances where this constraint
is set. This constraint isn't retroactive. AlloyDB instances with
existing public IP access still work even after this constraint is enforced.

By default, public IP access to AlloyDB instances is allowed.

Create a YAML file for a custom constraint as follows:

```yaml
name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes:
- alloydb.googleapis.com/RESOURCE_NAME
methodTypes:
- CREATE
- UPDATE
condition: "CONDITION"
actionType: ACTION
displayName: DISPLAY_NAME
description: DESCRIPTION
```

Replace the following:

- `ORGANIZATION_ID`: your organization ID, such as
  `123456789`.

- `CONSTRAINT_NAME`: the name you want for your new
  custom constraint. A custom constraint must start with `custom.`, and can
  only include uppercase letters, lowercase letters, or numbers, for
  example, `custom.restrictPublicIP`. The maximum length of this field is 70
  characters, not counting the prefix, for example,
  `organizations/123456789/customConstraints/custom`.

- `RESOURCE_NAME`: the name (not the URI) of the
  AlloyDB REST resource containing the object and field
  you want to restrict. For example, `Instance`.

- `CONDITION`: a [CEL condition](https://docs.cloud.google.com/resource-manager/docs/organization-policy/creating-managing-custom-constraints#cel) that is written against
  a representation of a supported service resource. This
  field has a maximum length of 1,500 characters. See
  [Supported custom constraints and operations](https://docs.cloud.google.com/alloydb/docs/alloydb-custom-constraints.md.txt#supported-custom-constraints-operations)
  for more information about the resources available to write conditions
  against. For example, `"resource.networkConfig.enablePublicIp == true"`.

- `ACTION`: the action to take if the `condition` is
  met. This can be either `ALLOW` or `DENY`.

- `DISPLAY_NAME`: a human-friendly name for the
  constraint. This field has a maximum length of 200 characters.

- `DESCRIPTION`: a human-friendly description of the
  constraint to display as an error message when the policy is violated. This
  field has a maximum length of 2000 characters.

For more information about how to create a custom constraint, see
[Defining custom constraints](https://docs.cloud.google.com/resource-manager/docs/organization-policy/creating-managing-custom-constraints#create-custom-constraint).

## Set up a custom constraint

### Console


To create a custom constraint, do the following:

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

   [Go to Organization policies](https://console.cloud.google.com/iam-admin/orgpolicies)
2. From the project picker, select the project that you want to set the organization policy for.
3. Click **Custom constraint**.
4. In the **Display 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 personally identifiable information (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 the **Constraint ID** box, enter the ID that you want for your new custom constraint. A custom constraint can only contain letters (including upper and lowercase) or numbers, for example `custom.restrictPublicIP`. 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 the **Description** 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 the **Resource 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/Cluster`. Most resource types support up to 20 custom constraints. If you attempt to create more custom constraints, the operation fails.
8. This constraint can only be enforced on the REST `CREATE` method.
9. To see supported methods for each service, find the service in [Services that support custom constraints](https://docs.cloud.google.com/organization-policy/reference/custom-constraint-supported-services.md.txt).
10. To define a condition, click **Edit condition**.
    1. In the **Add condition** panel, create a CEL condition that refers to a supported service resource, for example, `resource.autopilot.enabled == false`. This field can contain up to 1,500 characters. For details about CEL usage, see [Common Expression Language](https://docs.cloud.google.com/resource-manager/docs/organization-policy/creating-managing-custom-constraints#common_expression_language). For more information about the service resources you can use in your custom constraints, see [Custom constraint supported services](https://docs.cloud.google.com/resource-manager/docs/organization-policy/custom-constraint-supported-services).
    2. Click **Save**.
11. Under **Action**, select whether to allow or deny the evaluated method if the condition is met.
12. The deny action means that the operation to create or update the resource is blocked if the condition evaluates to true.
13. 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 those explicitly listed in the condition is blocked.
14. Click **Create constraint**.
15. 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:

```yaml
name: organizations/ORGANIZATION_ID/customConstraints/CONSTRAINT_NAME
resourceTypes: RESOURCE_NAME
methodTypes:
  - CREATE
condition: "CONDITION"
actionType: ACTION
displayName: DISPLAY_NAME
description: DESCRIPTION
```
2. Replace the following:
   - `ORGANIZATION_ID`: your organization ID, such as `123456789`.
   - `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.restrictPublicIP`. 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.
   - `RESOURCE_NAME`: the fully qualified name of the Google Cloud resource containing the object and field that you want to restrict. For example, `alloydb.googleapis.com/Instance`. Most resource types support up to 20 custom constraints. If you attempt to create more custom constraints, the operation fails.
   - `methodTypes`: the REST methods that the constraint is enforced on. Can only be `CREATE`.
   - To see the supported methods for each service, find the service in [Services that support custom constraints](https://docs.cloud.google.com/organization-policy/reference/custom-constraint-supported-services.md.txt).
   - `CONDITION`: a [CEL condition](https://docs.cloud.google.com/resource-manager/docs/organization-policy/creating-managing-custom-constraints#common_expression_language) that is written against a representation of a supported service resource. This field can contain up to 1,500 characters. For example, `"resource.networkConfig.enablePublicIp == true"`.
   - For more information about the resources available to write conditions against, see [Supported resources](https://docs.cloud.google.com/alloydb/docs/alloydb-custom-constraints.md.txt#supported_resources).
   - `ACTION`: the action to take if the `condition` is met. Can only be `ALLOW`.
   - 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.
   - `DISPLAY_NAME`: 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.
   - `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.
3. 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 the [`gcloud org-policies set-custom-constraint`](https://docs.cloud.google.com/sdk/gcloud/reference/org-policies/set-custom-constraint) command:

```bash
gcloud org-policies set-custom-constraint CONSTRAINT_PATH
```
4. Replace `CONSTRAINT_PATH` with the full path to your custom constraint file. For example, `/home/user/customconstraint.yaml`.
5. After this operation is complete, your custom constraints are available as organization policies in your list of Google Cloud organization policies.
6. To verify that the custom constraint exists, use the [`gcloud org-policies list-custom-constraints`](https://docs.cloud.google.com/sdk/gcloud/reference/org-policies/list-custom-constraints) command:

```bash
gcloud org-policies list-custom-constraints --organization=ORGANIZATION_ID
```
7. Replace `ORGANIZATION_ID` with the ID of your organization resource.
8. For more information, see [Viewing organization policies](https://docs.cloud.google.com/resource-manager/docs/organization-policy/creating-managing-policies#viewing_organization_policies).

## Enforce a custom organization policy

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

### Console

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

   [Go to Organization policies](https://console.cloud.google.com/iam-admin/orgpolicies)
2. From the project picker, select the project that you want to set the organization policy for.
3. From the list on the **Organization policies** page, select your constraint to view the **Policy details** page for that constraint.
4. To configure the organization policy for this resource, click **Manage policy**.
5. On the **Edit policy** page, select **Override parent's policy**.
6. Click **Add a rule**.
7. In the **Enforcement** section, select whether this organization policy is enforced or not.
8. Optional: To make the organization policy conditional on a tag, click **Add 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 [Scope organization policies with tags](https://docs.cloud.google.com/organization-policy/scope-policies.md.txt).
9. Click **Test changes** to simulate the effect of the organization policy. For more information, see [Test organization policy changes with Policy Simulator](https://docs.cloud.google.com/policy-intelligence/docs/test-organization-policies.md.txt).
10. To enforce the organization policy in dry-run mode, click **Set dry run policy** . For more information, see [Test organization policies](https://docs.cloud.google.com/organization-policy/test-policies.md.txt).
11. After you verify that the organization policy in dry-run mode works as intended, set the live policy by clicking **Set policy**.

### gcloud

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

```yaml
name: projects/PROJECT_ID/policies/CONSTRAINT_NAME
spec:
  rules:
  - enforce: true

dryRunSpec:
  rules:
  - enforce: true
```
2. 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.restrictPublicIP`.
3. To enforce the organization policy in [dry-run mode](https://docs.cloud.google.com/organization-policy/test-policies.md.txt), run the following command with the `dryRunSpec` flag:

```bash
gcloud org-policies set-policy POLICY_PATH --update-mask=dryRunSpec
```
4. Replace `POLICY_PATH` with the full path to your organization policy YAML file. The policy requires up to 15 minutes to take effect.
5. After you verify that the organization policy in dry-run mode works as intended, set the live policy with the `org-policies set-policy` command and the `spec` flag:

```bash
gcloud org-policies set-policy POLICY_PATH --update-mask=spec
```
6. Replace `POLICY_PATH` with the full path to your organization policy YAML file. The policy requires up to 15 minutes to take effect.

## Supported custom constraints and operations

You can enforce custom constraints on AlloyDB
instance, cluster, and backup resources. All v1 fields on the
AlloyDB
[instance](https://docs.cloud.google.com/alloydb/docs/reference/rest/v1/projects.locations.clusters.instances.md.txt#Instance),
[cluster](https://docs.cloud.google.com/alloydb/docs/reference/rest/v1/projects.locations.clusters.md.txt#Cluster),
and
[backup](https://docs.cloud.google.com/alloydb/docs/reference/rest/v1/projects.locations.backups.md.txt#Backup)
resources are supported for custom constraints:

| Supported resource type (`resourceTypes`) | Supported method types (`methodTypes`) | Supported fields reference |
|---|---|---|
| `alloydb.googleapis.com/Instance` | `CREATE`, `UPDATE` | [`Instance` resource fields](https://docs.cloud.google.com/alloydb/docs/reference/rest/v1/projects.locations.clusters.instances.md.txt#Instance) |
| `alloydb.googleapis.com/Cluster` | `CREATE`, `UPDATE`, `GOVERN_TAGS` | [`Cluster` resource fields](https://docs.cloud.google.com/alloydb/docs/reference/rest/v1/projects.locations.clusters.md.txt#Cluster) |
| `alloydb.googleapis.com/Backup` | `CREATE`, `GOVERN_TAGS` | [`Backup` resource fields](https://docs.cloud.google.com/alloydb/docs/reference/rest/v1/projects.locations.backups.md.txt#Backup) |

You can enforce custom constraints
during the following AlloyDB operations:

- Instance creation
- Instance update
- Cluster creation
- Cluster update
- Backup creation

This section provides examples of the following common custom constraints:

- Restrict public IP access using organization policies

- Limit the CIDR range of authorized networks

- Limit the number of authorized networks

- Enforce mandatory tags using organization policies

- Enforce continuous backups for all clusters

- Restrict on-demand backup for specific clusters

### Restrict public IP access using organization policies

```yaml
    name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictPublicIP
    resourceTypes:
    - alloydb.googleapis.com/Instance
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.networkConfig.enablePublicIp == true"
    actionType: DENY
    displayName: Restrict public IP access on AlloyDB instances
    description: Prevent users from enabling public IP on instance creation and update.
```

Replace `ORGANIZATION_ID` with the organization ID.

Supported operations:

- Instance creation
- Instance update

### Limit the CIDR range of authorized networks

```yaml
    name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictCidrRange
    resourceTypes:
      - alloydb.googleapis.com/Instance
    methodTypes:
      - CREATE
      - UPDATE
    condition: "resource.networkConfig.authorizedExternalNetworks.exists(net, ['/0', '/1', '/2', '/n'].exists(ending, net.cidrRange.endsWith(ending)))"
    actionType: DENY
    displayName: "Restrict large CIDR ranges for AlloyDB Authorized Networks"
    description: "Prevents AlloyDB instances from being created or updated with an authorized network CIDR range larger than /n (i.e., a prefix length less than n, e.g., 16)."
```

Replace `ORGANIZATION_ID` with the organization ID.

Supported operations:

- Instance creation
- Instance update

### Limit the number of authorized networks

```yaml
    name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictAuthorizedNetworksCount
    resourceTypes:
      - alloydb.googleapis.com/Instance
    methodTypes:
      - CREATE
      - UPDATE
    condition: "resource.networkConfig.authorizedExternalNetworks.size() > 1"
    actionType: DENY
    displayName: "Limit the number of AlloyDB Authorized Networks"
    description: "Prevents AlloyDB instances from being created or updated with more than a specified number of Authorized Networks."
```

Replace `ORGANIZATION_ID` with the organization ID.

Supported operations:

- Instance creation
- Instance update

### Enforce mandatory tags using organization policies

```yaml
    name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceMandatoryTags
    resourceTypes:
    - alloydb.googleapis.com/Cluster
    methodTypes:
    - GOVERN_TAGS
    condition: "resource.hasDirectTagKey('TAG_NAME')"
    actionType: ALLOW
    displayName: Enforce mandatory tags on AlloyDB cluster resource.
    description: Prevent users from creating a cluster if mandatory tags aren't provided.
```

Replace the following:

- `ORGANIZATION_ID`: the organization ID.

- `TAG_NAME`: the tag name.

Supported operations:

- Cluster creation
- Backup creation (when you include `alloydb.googleapis.com/Backup` in `resourceTypes`)

### Enforce continuous backups for all clusters

```yaml
    name: organizations/ORGANIZATION_ID/customConstraints/custom.enforceContBackupConfig
    resourceTypes:
    - alloydb.googleapis.com/Cluster
    methodTypes:
    - CREATE
    - UPDATE
    condition: "resource.continuousBackupConfig.enabled == false"
    actionType: DENY
    displayName: Enforce continuous backup configuration on AlloyDB clusters
    description: Prevent users from disabling continuous backup configuration on cluster creation and update.
```

Replace `ORGANIZATION_ID` with the organization ID.

Supported operations:

- Cluster creation
- Cluster update

### Restrict on-demand backup for specific clusters

```yaml
    name: organizations/ORGANIZATION_ID/customConstraints/custom.restrictOnDemandBackup
    resourceTypes:
    - alloydb.googleapis.com/Backup
    methodTypes:
    - CREATE
    condition: "resource.type == 'ON_DEMAND' && resource.clusterName.contains('CLUSTER_NAME')"
    actionType: DENY
    displayName: Restrict taking on-demand backup of certain clusters
    description: Prevent users from taking on-demand backups for certain clusters.
```

Replace the following:

- `ORGANIZATION_ID`: the organization ID.

- `CLUSTER_NAME`: the cluster name.

Supported operation:

- Backup creation

## What's next

- See [Introduction to the Organization Policy Service](https://docs.cloud.google.com/resource-manager/docs/organization-policy/overview) to learn more about organization policies.
- Learn more about how to [create and manage organization policies](https://docs.cloud.google.com/resource-manager/docs/organization-policy/using-constraints).
- See the full list of predefined [Organization policy constraints](https://docs.cloud.google.com/resource-manager/docs/organization-policy/org-policy-constraints).
- [Connect using a public IP](https://docs.cloud.google.com/alloydb/docs/connect-public-ip.md.txt).
- [Create a primary instance](https://docs.cloud.google.com/alloydb/docs/instance-primary-create.md.txt).