Skip to content

googleAccessContextManagerAccessLevel

An AccessLevel is a label that can be applied to requests to GCP services, along with a list of requirements necessary for the label to be applied.

To get more information about AccessLevel, see:

\~> Warning: If you are using User ADCs (Application Default Credentials) with this resource, you must specify a billingProject and set userProjectOverride to true in the provider configuration. Otherwise the ACM API will return a 403 error. Your account must have the serviceusageServicesUse permission on the billingProject you defined.

Example Usage - Access Context Manager Access Level Basic

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as google from "./.gen/providers/google";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: google.
For a more precise conversion please use the --provider flag in convert.*/
const googleAccessContextManagerAccessPolicyAccessPolicy =
  new google.accessContextManagerAccessPolicy.AccessContextManagerAccessPolicy(
    this,
    "access-policy",
    {
      parent: "organizations/123456789",
      title: "my policy",
    }
  );
new google.accessContextManagerAccessLevel.AccessContextManagerAccessLevel(
  this,
  "access-level",
  {
    basic: [
      {
        conditions: [
          {
            device_policy: [
              {
                os_constraints: [
                  {
                    os_type: "DESKTOP_CHROME_OS",
                  },
                ],
                require_screen_lock: true,
              },
            ],
            regions: ["CH", "IT", "US"],
          },
        ],
      },
    ],
    name: `accessPolicies/\${${googleAccessContextManagerAccessPolicyAccessPolicy.name}}/accessLevels/chromeos_no_lock`,
    parent: `accessPolicies/\${${googleAccessContextManagerAccessPolicyAccessPolicy.name}}`,
    title: "chromeos_no_lock",
  }
);

Argument Reference

The following arguments are supported:

  • title - (Required) Human readable title. Must be unique within the Policy.

  • parent - (Required) The AccessPolicy this AccessLevel lives in. Format: accessPolicies/{policy_id}

  • name - (Required) Resource name for the Access Level. The short_name component must begin with a letter and only include alphanumeric and '_'. Format: accessPolicies/{policy_id}/accessLevels/{short_name}

  • description - (Optional) Description of the AccessLevel and its use. Does not affect behavior.

  • basic - (Optional) A set of predefined conditions for the access level and a combining function. Structure is documented below.

  • custom - (Optional) Custom access level conditions are set using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request. See CEL spec at: https://github.com/google/cel-spec. Structure is documented below.

The basic block supports:

  • combiningFunction - (Optional) How the conditions list should be combined to determine if a request is granted this AccessLevel. If AND is used, each Condition in conditions must be satisfied for the AccessLevel to be applied. If OR is used, at least one Condition in conditions must be satisfied for the AccessLevel to be applied. Default value is and. Possible values are and and or.

  • conditions - (Required) A set of requirements for the AccessLevel to be granted. Structure is documented below.

The conditions block supports:

  • ipSubnetworks - (Optional) A list of CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed.

  • requiredAccessLevels - (Optional) A list of other access levels defined in the same Policy, referenced by resource name. Referencing an AccessLevel which does not exist is an error. All access levels listed must be granted for the Condition to be true. Format: accessPolicies/{policy_id}/accessLevels/{short_name}

  • members - (Optional) An allowed list of members (users, service accounts). Using groups is not supported yet. The signed-in user originating the request must be a part of one of the provided members. If not specified, a request may come from any user (logged in/not logged in, not present in any groups, etc.). Formats: user:{emailid}, serviceAccount:{emailid}

  • negate - (Optional) Whether to negate the Condition. If true, the Condition becomes a NAND over its non-empty fields, each field must be false for the Condition overall to be satisfied. Defaults to false.

  • devicePolicy - (Optional) Device specific restrictions, all restrictions must hold for the Condition to be true. If not specified, all devices are allowed. Structure is documented below.

  • regions - (Optional) The request must originate from one of the provided countries/regions. Format: A valid ISO 3166-1 alpha-2 code.

The devicePolicy block supports:

  • requireScreenLock - (Optional) Whether or not screenlock is required for the DevicePolicy to be true. Defaults to false.

  • allowedEncryptionStatuses - (Optional) A list of allowed encryptions statuses. An empty list allows all statuses. Each value may be one of encryptionUnspecified, encryptionUnsupported, unencrypted, and encrypted.

  • allowedDeviceManagementLevels - (Optional) A list of allowed device management levels. An empty list allows all management levels. Each value may be one of managementUnspecified, none, basic, and complete.

  • osConstraints - (Optional) A list of allowed OS versions. An empty list allows all types and all versions. Structure is documented below.

  • requireAdminApproval - (Optional) Whether the device needs to be approved by the customer admin.

  • requireCorpOwned - (Optional) Whether the device needs to be corp owned.

The osConstraints block supports:

  • minimumVersion - (Optional) The minimum allowed OS version. If not set, any version of this OS satisfies the constraint. Format: "major.minor.patch" such as "10.5.301", "9.2.1".

  • requireVerifiedChromeOs - (Optional) If you specify DESKTOP_CHROME_OS for osType, you can optionally include requireVerifiedChromeOs to require Chrome Verified Access.

  • osType - (Required) The operating system type of the device. Possible values are osUnspecified, desktopMac, desktopWindows, desktopLinux, desktopChromeOs, android, and ios.

The custom block supports:

  • expr - (Required) Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. This page details the objects and attributes that are used to the build the CEL expressions for custom access levels - https://cloud.google.com/access-context-manager/docs/custom-access-level-spec. Structure is documented below.

The expr block supports:

  • expression - (Required) Textual representation of an expression in Common Expression Language syntax.

  • title - (Optional) Title for the expression, i.e. a short string describing its purpose.

  • description - (Optional) Description of the expression

  • location - (Optional) String indicating the location of the expression for error reporting, e.g. a file name and a position in the file

Attributes Reference

In addition to the arguments listed above, the following computed attributes are exported:

  • id - an identifier for the resource with format {{name}}

Timeouts

This resource provides the following Timeouts configuration options:

  • create - Default is 20 minutes.
  • update - Default is 20 minutes.
  • delete - Default is 20 minutes.

Import

AccessLevel can be imported using any of these accepted formats:

$ terraform import google_access_context_manager_access_level.default {{name}}