Access Context Manager V1 API - Class Google::Identity::AccessContextManager::V1::AccessPolicy (v0.8.2)

Reference documentation and code samples for the Access Context Manager V1 API class Google::Identity::AccessContextManager::V1::AccessPolicy.

AccessPolicy is a container for AccessLevels (which define the necessary attributes to use Google Cloud services) and ServicePerimeters (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#create_time=

def create_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#etag

def etag() -> ::String
Returns
  • (::String) — Output only. An opaque identifier for the current version of the AccessPolicy. This will always be a strongly validated etag, meaning that two Access Polices will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.

#etag=

def etag=(value) -> ::String
Parameter
  • value (::String) — Output only. An opaque identifier for the current version of the AccessPolicy. This will always be a strongly validated etag, meaning that two Access Polices will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.
Returns
  • (::String) — Output only. An opaque identifier for the current version of the AccessPolicy. This will always be a strongly validated etag, meaning that two Access Polices will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.

#name

def name() -> ::String
Returns
  • (::String) — Output only. Resource name of the AccessPolicy. Format: accessPolicies/{access_policy}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Output only. Resource name of the AccessPolicy. Format: accessPolicies/{access_policy}
Returns
  • (::String) — Output only. Resource name of the AccessPolicy. Format: accessPolicies/{access_policy}

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The parent of this AccessPolicy in the Cloud Resource Hierarchy. Currently immutable once created. Format: organizations/{organization_id}

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The parent of this AccessPolicy in the Cloud Resource Hierarchy. Currently immutable once created. Format: organizations/{organization_id}
Returns
  • (::String) — Required. The parent of this AccessPolicy in the Cloud Resource Hierarchy. Currently immutable once created. Format: organizations/{organization_id}

#scopes

def scopes() -> ::Array<::String>
Returns
  • (::Array<::String>) —

    The scopes of a policy define which resources an ACM policy can restrict, and where ACM resources can be referenced. For example, a policy with scopes=["folders/123"] has the following behavior:

    • vpcsc perimeters can only restrict projects within folders/123
    • access levels can only be referenced by resources within folders/123. If empty, there are no limitations on which resources can be restricted by an ACM policy, and there are no limitations on where ACM resources can be referenced. Only one policy can include a given scope (attempting to create a second policy which includes "folders/123" will result in an error). Currently, scopes cannot be modified after a policy is created. Currently, policies can only have a single scope. Format: list of folders/{folder_number} or projects/{project_number}

#scopes=

def scopes=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) —

    The scopes of a policy define which resources an ACM policy can restrict, and where ACM resources can be referenced. For example, a policy with scopes=["folders/123"] has the following behavior:

    • vpcsc perimeters can only restrict projects within folders/123
    • access levels can only be referenced by resources within folders/123. If empty, there are no limitations on which resources can be restricted by an ACM policy, and there are no limitations on where ACM resources can be referenced. Only one policy can include a given scope (attempting to create a second policy which includes "folders/123" will result in an error). Currently, scopes cannot be modified after a policy is created. Currently, policies can only have a single scope. Format: list of folders/{folder_number} or projects/{project_number}
Returns
  • (::Array<::String>) —

    The scopes of a policy define which resources an ACM policy can restrict, and where ACM resources can be referenced. For example, a policy with scopes=["folders/123"] has the following behavior:

    • vpcsc perimeters can only restrict projects within folders/123
    • access levels can only be referenced by resources within folders/123. If empty, there are no limitations on which resources can be restricted by an ACM policy, and there are no limitations on where ACM resources can be referenced. Only one policy can include a given scope (attempting to create a second policy which includes "folders/123" will result in an error). Currently, scopes cannot be modified after a policy is created. Currently, policies can only have a single scope. Format: list of folders/{folder_number} or projects/{project_number}

#title

def title() -> ::String
Returns
  • (::String) — Required. Human readable title. Does not affect behavior.

#title=

def title=(value) -> ::String
Parameter
  • value (::String) — Required. Human readable title. Does not affect behavior.
Returns
  • (::String) — Required. Human readable title. Does not affect behavior.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns

#update_time=

def update_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns