Top / Google Cloud Platform / Google Access Context Manager (VPC Service Controls) / Service Perimeter

Google Access Context Manager (VPC Service Controls) Service Perimeter

This page shows how to write Terraform for Access Context Manager (VPC Service Controls) Service Perimeter and write them securely.

Review your .tf file for Google best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

google_access_context_manager_service_perimeter (Terraform)

The Service Perimeter in Access Context Manager (VPC Service Controls) can be configured in Terraform with the resource name google_access_context_manager_service_perimeter. The following sections describe 1 example of how to use the resource and its parameters.

Example Usage from GitHub

jralmaraz/terraform-utils

egress_policy.tf#L6

resource "google_access_context_manager_service_perimeter" "test-access" {
  count = length(local.bq_permissions)
  parent         = "accessPolicies/123456"
  name           = "accessPolicies/123456/servicePerimeters/test_jose"
  title          = "BigQuery policy via terraform"
  status {

Find out how to use this setting securely with Shisho Cloud

Review your Terraform file for Google best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

create_time optional computed - string

Time the AccessPolicy was created in UTC.

description optional - string

Description of the ServicePerimeter and its use. Does not affect behavior.

id optional computed - string
name required - string

Resource name for the ServicePerimeter. The shortname component must begin with a letter and only include alphanumeric and ''. Format: accessPolicies/[policy_id]/servicePerimeters/[short_name]

parent required - string

The AccessPolicy this ServicePerimeter lives in. Format: accessPolicies/[policy_id]

perimeter_type optional - string

Specifies the type of the Perimeter. There are two types: regular and bridge. Regular Service Perimeter contains resources, access levels, and restricted services. Every resource can be in at most ONE regular Service Perimeter. In addition to being in a regular service perimeter, a resource can also be in zero or more perimeter bridges. A perimeter bridge only contains resources. Cross project operations are permitted if all effected resources share some perimeter (whether bridge or regular). Perimeter Bridge does not contain access levels or services: those are governed entirely by the regular perimeter that resource is in. Perimeter Bridges are typically useful when building more complex topologies with many independent perimeters that need to share some data with a common perimeter, but should not be able to share data among themselves. Default value: "PERIMETER_TYPE_REGULAR" Possible values: ["PERIMETER_TYPE_REGULAR", "PERIMETER_TYPE_BRIDGE"]

title required - string

Human readable title. Must be unique within the Policy.

update_time optional computed - string

Time the AccessPolicy was updated in UTC.

use_explicit_dry_run_spec optional - bool

Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly exists for all Service Perimeters, and that spec is identical to the status for those Service Perimeters. When this flag is set, it inhibits the generation of the implicit spec, thereby allowing the user to explicitly provide a configuration ("spec") to use in a dry-run version of the Service Perimeter. This allows the user to test changes to the enforced config ("status") without actually enforcing them. This testing is done through analyzing the differences between currently enforced and suggested restrictions. useExplicitDryRunSpec must bet set to True if any of the fields in the spec are set to non-default values.

spec list block
- access_levels optional - list of string
A list of AccessLevel resource names that allow resources within the ServicePerimeter to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel is a syntax error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via GCP calls with request origins within the perimeter. For Service Perimeter Bridge, must be empty. Format: accessPolicies/[policy_id]/accessLevels/[access_level_name]
- resources optional - list of string
A list of GCP resources that are inside of the service perimeter. Currently only projects are allowed. Format: projects/[project_number]
- restricted_services optional - list of string
GCP services that are subject to the Service Perimeter restrictions. Must contain a list of services. For example, if 'storage.googleapis.com' is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions.
- egress_policies list block
  - egress_from list block
    - identities optional - list of string
    A list of identities that are allowed access through this 'EgressPolicy'. Should be in the format of email address. The email address should represent individual user or service account only.
    - identity_type optional - string
    Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of 'identities' field will be allowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"]
  - egress_to list block
    - resources optional - list of string
    A list of resources, currently only projects in the form 'projects/<projectnumber>', that match this to stanza. A request matches if it contains a resource in this list. If * is specified for resources, then this 'EgressTo' rule will authorize access to all resources outside the perimeter.
    - operations list block
      - service_name optional - string
      The name of the API whose methods or permissions the 'IngressPolicy' or 'EgressPolicy' want to allow. A single 'ApiOperation' with serviceName field set to '*' will allow all methods AND permissions for all services.
      - method_selectors list block
        method optional - string
        Value for 'method' should be a valid method name for the corresponding 'serviceName' in 'ApiOperation'. If '*' used as value for method, then ALL methods and permissions are allowed.
        permission optional - string
        Value for permission should be a valid Cloud IAM permission for the corresponding 'serviceName' in 'ApiOperation'.
- ingress_policies list block
  - ingress_from list block
    - identities optional - list of string
    A list of identities that are allowed access through this ingress policy. Should be in the format of email address. The email address should represent individual user or service account only.
    - identity_type optional - string
    Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of 'identities' field will be allowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"]
    - sources list block
      - access_level optional - string
      An 'AccessLevel' resource name that allow resources within the 'ServicePerimeters' to be accessed from the internet. 'AccessLevels' listed must be in the same policy as this 'ServicePerimeter'. Referencing a nonexistent 'AccessLevel' will cause an error. If no 'AccessLevel' names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example 'accessPolicies/MY_POLICY/accessLevels/MY_LEVEL.' If * is specified, then all IngressSources will be allowed.
      - resource optional - string
      A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects are allowed. Format 'projects/[project_number]' The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. '*' is not allowed, the case of allowing all Google Cloud resources only is not supported.
  - ingress_to list block
    - resources optional - list of string
    A list of resources, currently only projects in the form 'projects/<projectnumber>', protected by this 'ServicePerimeter' that are allowed to be accessed by sources defined in the corresponding 'IngressFrom'. A request matches if it contains a resource in this list. If '*' is specified for resources, then this 'IngressTo' rule will authorize access to all resources inside the perimeter, provided that the request also matches the 'operations' field.
    - operations list block
      - service_name optional - string
      The name of the API whose methods or permissions the 'IngressPolicy' or 'EgressPolicy' want to allow. A single 'ApiOperation' with 'serviceName' field set to '*' will allow all methods AND permissions for all services.
      - method_selectors list block
        method optional - string
        Value for method should be a valid method name for the corresponding serviceName in 'ApiOperation'. If '*' used as value for 'method', then ALL methods and permissions are allowed.
        permission optional - string
        Value for permission should be a valid Cloud IAM permission for the corresponding 'serviceName' in 'ApiOperation'.
- vpc_accessible_services list block
  - allowed_services optional - list of string
  The list of APIs usable within the Service Perimeter. Must be empty unless 'enableRestriction' is True.
  - enable_restriction optional - bool
  Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowedServices'.
status list block
- access_levels optional - list of string
A list of AccessLevel resource names that allow resources within the ServicePerimeter to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel is a syntax error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via GCP calls with request origins within the perimeter. For Service Perimeter Bridge, must be empty. Format: accessPolicies/[policy_id]/accessLevels/[access_level_name]
- resources optional - list of string
A list of GCP resources that are inside of the service perimeter. Currently only projects are allowed. Format: projects/[project_number]
- restricted_services optional - set of string
GCP services that are subject to the Service Perimeter restrictions. Must contain a list of services. For example, if 'storage.googleapis.com' is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions.
- egress_policies list block
  - egress_from list block
    - identities optional - list of string
    A list of identities that are allowed access through this 'EgressPolicy'. Should be in the format of email address. The email address should represent individual user or service account only.
    - identity_type optional - string
    Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of 'identities' field will be allowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"]
  - egress_to list block
    - resources optional - list of string
    A list of resources, currently only projects in the form 'projects/<projectnumber>', that match this to stanza. A request matches if it contains a resource in this list. If * is specified for resources, then this 'EgressTo' rule will authorize access to all resources outside the perimeter.
    - operations list block
      - service_name optional - string
      The name of the API whose methods or permissions the 'IngressPolicy' or 'EgressPolicy' want to allow. A single 'ApiOperation' with serviceName field set to '*' will allow all methods AND permissions for all services.
      - method_selectors list block
        method optional - string
        Value for 'method' should be a valid method name for the corresponding 'serviceName' in 'ApiOperation'. If '*' used as value for method, then ALL methods and permissions are allowed.
        permission optional - string
        Value for permission should be a valid Cloud IAM permission for the corresponding 'serviceName' in 'ApiOperation'.
- ingress_policies list block
  - ingress_from list block
    - identities optional - list of string
    A list of identities that are allowed access through this ingress policy. Should be in the format of email address. The email address should represent individual user or service account only.
    - identity_type optional - string
    Specifies the type of identities that are allowed access from outside the perimeter. If left unspecified, then members of 'identities' field will be allowed access. Possible values: ["IDENTITY_TYPE_UNSPECIFIED", "ANY_IDENTITY", "ANY_USER_ACCOUNT", "ANY_SERVICE_ACCOUNT"]
    - sources list block
      - access_level optional - string
      An 'AccessLevel' resource name that allow resources within the 'ServicePerimeters' to be accessed from the internet. 'AccessLevels' listed must be in the same policy as this 'ServicePerimeter'. Referencing a nonexistent 'AccessLevel' will cause an error. If no 'AccessLevel' names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example 'accessPolicies/MY_POLICY/accessLevels/MY_LEVEL.' If * is specified, then all IngressSources will be allowed.
      - resource optional - string
      A Google Cloud resource that is allowed to ingress the perimeter. Requests from these resources will be allowed to access perimeter data. Currently only projects are allowed. Format 'projects/[project_number]' The project may be in any Google Cloud organization, not just the organization that the perimeter is defined in. '*' is not allowed, the case of allowing all Google Cloud resources only is not supported.
  - ingress_to list block
    - resources optional - list of string
    A list of resources, currently only projects in the form 'projects/<projectnumber>', protected by this 'ServicePerimeter' that are allowed to be accessed by sources defined in the corresponding 'IngressFrom'. A request matches if it contains a resource in this list. If '*' is specified for resources, then this 'IngressTo' rule will authorize access to all resources inside the perimeter, provided that the request also matches the 'operations' field.
    - operations list block
      - service_name optional - string
      The name of the API whose methods or permissions the 'IngressPolicy' or 'EgressPolicy' want to allow. A single 'ApiOperation' with 'serviceName' field set to '*' will allow all methods AND permissions for all services.
      - method_selectors list block
        method optional - string
        Value for method should be a valid method name for the corresponding serviceName in 'ApiOperation'. If '*' used as value for 'method', then ALL methods and permissions are allowed.
        permission optional - string
        Value for permission should be a valid Cloud IAM permission for the corresponding 'serviceName' in 'ApiOperation'.
- vpc_accessible_services list block
  - allowed_services optional - set of string
  The list of APIs usable within the Service Perimeter. Must be empty unless 'enableRestriction' is True.
  - enable_restriction optional - bool
  Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowedServices'.
timeouts single block
- create optional - string
- delete optional - string
- update optional - string

>> from Terraform Registry

Explanation in Terraform Registry

ServicePerimeter describes a set of GCP resources which can freely import and export data amongst themselves, but not export outside of the ServicePerimeter. If a request with a source within this ServicePerimeter has a target outside of the ServicePerimeter, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter
Regular and Bridge. Regular Service Perimeters cannot overlap, a single GCP project can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only GCP projects as members, a single GCP project may belong to multiple Service Perimeter Bridges. To get more information about ServicePerimeter, see:
API documentation
How-to Guides
Service Perimeter Quickstart
Warning: If you are using User ADCs (Application Default Credentials) with this resource, you must specify a billing_project and set user_project_override to true in the provider configuration. Otherwise the ACM API will return a 403 error. Your account must have the serviceusage.services.use permission on the billing_project you defined.

>> from Terraform Registry

The Other Related Google Access Context Manager (VPC Service Controls) Resources

Google Access Context Manager (VPC Service Controls) Access Level

Google Access Context Manager (VPC Service Controls) Access Level Condition

Google Access Context Manager (VPC Service Controls) Access Levels

Google Access Context Manager (VPC Service Controls) Access Policy

Google Access Context Manager (VPC Service Controls) GCP User Access Binding

Google Access Context Manager (VPC Service Controls) Service Perimeter Resource

Google Access Context Manager (VPC Service Controls) Service Perimeters

Frequently asked questions

What is Google Access Context Manager (VPC Service Controls) Service Perimeter?

Google Access Context Manager (VPC Service Controls) Service Perimeter is a resource for Access Context Manager (VPC Service Controls) of Google Cloud Platform. Settings can be wrote in Terraform.

Where can I find the example code for the Google Access Context Manager (VPC Service Controls) Service Perimeter?

For Terraform, the jralmaraz/terraform-utils source code example is useful. See the Terraform Example section for further details.

Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.

google_access_context_manager_service_perimeter
Frequently asked questions