Syntax

A google_access_context_manager_service_perimeter is used to test a Google ServicePerimeter resource

Examples


describe.one do
  google_access_context_manager_access_policies(org_id: '190694428152').names.each do |policy_name|
    describe google_access_context_manager_service_perimeter(policy_name: policy_name, name: 'restrict_all') do
      it { should exist }
      its('title') { should cmp 'restrict_all' }
      its('status.restricted_services') { should include 'storage.googleapis.com' }
    end
  end
end

Properties

Properties that can be accessed from the google_access_context_manager_service_perimeter resource:

  • title: Human readable title. Must be unique within the Policy.

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

  • create_time: Time the AccessPolicy was created in UTC.

  • update_time: Time the AccessPolicy was updated in UTC.

  • perimeter_type: 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. Possible values:

    • PERIMETERTYPEREGULAR
    • PERIMETERTYPEBRIDGE

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

    • resources: A list of GCP resources that are inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}
    • access_levels: 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/{policyid}/accessLevels/{accesslevel_name}
    • restricted_services: 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.
    • vpc_accessible_services: Specifies how APIs are allowed to communicate within the Service Perimeter.
      • enable_restriction: Whether to restrict API calls within the Service Perimeter to the list of APIs specified in ‘allowedServices’.
      • allowed_services: The list of APIs usable within the Service Perimeter. Must be empty unless enableRestriction is True.

  • spec: 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.

    • resources: A list of GCP resources that are inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}
    • access_levels: 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/{policyid}/accessLevels/{accesslevel_name}
    • restricted_services: 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.
    • vpc_accessible_services: Specifies how APIs are allowed to communicate within the Service Perimeter.
      • enable_restriction: Whether to restrict API calls within the Service Perimeter to the list of APIs specified in ‘allowedServices’.
      • allowed_services: The list of APIs usable within the Service Perimeter. Must be empty unless enableRestriction is True.

  • use_explicit_dry_run_spec: 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.

  • parent: The AccessPolicy this ServicePerimeter lives in. Format: accessPolicies/{policy_id}

  • name: Resource name for the ServicePerimeter. The shortname component must begin with a letter and only include alphanumeric and ‘’. Format: accessPolicies/{policyid}/servicePerimeters/{shortname}

GCP Permissions