ServicePerimeter

ServicePerimeter describes a set of Google Cloud 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 Google Cloud project can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only Google Cloud projects as members, a single Google Cloud project may belong to multiple Service Perimeter Bridges.

JSON representation
{
  "name": string,
  "title": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "perimeterType": enum (PerimeterType),
  "status": {
    object (ServicePerimeterConfig)
  },
  "spec": {
    object (ServicePerimeterConfig)
  },
  "useExplicitDryRunSpec": boolean
}
Fields
name

string

Required. Resource name for the ServicePerimeter. The short_name component must begin with a letter and only include alphanumeric and '_'. Format: accessPolicies/{policyId}/servicePerimeters/{short_name}

title

string

Human readable title. Must be unique within the Policy.

description

string

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

createTime

string (Timestamp format)

Output only. time the ServicePerimeter was created in UTC.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. time the ServicePerimeter was updated in UTC.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

perimeterType

enum (PerimeterType)

Perimeter type indicator. A single project is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, the restricted service list as well as access level lists must be empty.

status

object (ServicePerimeterConfig)

Current ServicePerimeter configuration. Specifies sets of resources, restricted services and access levels that determine perimeter content and boundaries.

spec

object (ServicePerimeterConfig)

Proposed (or dry run) ServicePerimeter configuration. This configuration allows to specify and test ServicePerimeter configuration without enforcing actual access restrictions. Only allowed to be set when the "useExplicitDryRunSpec" flag is set.

useExplicitDryRunSpec

boolean

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.

ServicePerimeterConfig

ServicePerimeterConfig specifies a set of Google Cloud resources that describe specific Service Perimeter configuration.

JSON representation
{
  "resources": [
    string
  ],
  "accessLevels": [
    string
  ],
  "restrictedServices": [
    string
  ],
  "vpcAccessibleServices": {
    object (VpcAccessibleServices)
  }
}
Fields
resources[]

string

A list of Google Cloud resources that are inside of the service perimeter. Currently only projects are allowed. Format: projects/{projectNumber}

accessLevels[]

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 Google Cloud calls with request origins within the perimeter. Example: "accessPolicies/MY_POLICY/accessLevels/MY_LEVEL". For Service Perimeter Bridge, must be empty.

restrictedServices[]

string

Google Cloud services that are subject to the Service Perimeter restrictions. For example, if storage.googleapis.com is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions.

vpcAccessibleServices

object (VpcAccessibleServices)

Configuration for APIs allowed within Perimeter.

VpcAccessibleServices

Specifies how APIs are allowed to communicate within the Service Perimeter.

JSON representation
{
  "enableRestriction": boolean,
  "allowedServices": [
    string
  ]
}
Fields
enableRestriction

boolean

Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowedServices'.

allowedServices[]

string

The list of APIs usable within the Service Perimeter. Must be empty unless 'enableRestriction' is True.