Class: Google::Apis::ComputeV1::Policy
- Inherits:
-
Object
- Object
- Google::Apis::ComputeV1::Policy
- Defined in:
- generated/google/apis/compute_v1/classes.rb,
generated/google/apis/compute_v1/representations.rb,
generated/google/apis/compute_v1/representations.rb
Overview
Defines an Identity and Access Management (IAM) policy. It is used to specify
access control policies for Cloud Platform resources.
A Policy
consists of a list of bindings
. A binding
binds a list of
members
to a role
, where the members can be user accounts, Google groups,
Google domains, and service accounts. A role
is a named list of permissions
defined by IAM.
JSON Example
"bindings": [
"role": "roles/owner", "members": [ "user:mike@example.com",
"group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@
appspot.gserviceaccount.com" ] ,
"role": "roles/viewer", "members": ["user:
sean@example.com"] ]
YAML Example
bindings: - members: - user:mike@example.com - group:admins@example.com -
domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com
role: roles/owner - members: - user:sean@example.com role: roles/viewer
For a description of IAM and its features, see the IAM developer's guide.
Instance Attribute Summary collapse
-
#audit_configs ⇒ Array<Google::Apis::ComputeV1::AuditConfig>
Specifies cloud audit logging configuration for this policy.
-
#bindings ⇒ Array<Google::Apis::ComputeV1::Binding>
Associates a list of
members
to arole
. -
#etag ⇒ String
etag
is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. -
#iam_owned ⇒ Boolean
(also: #iam_owned?)
Corresponds to the JSON property
iamOwned
. -
#rules ⇒ Array<Google::Apis::ComputeV1::Rule>
If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied.
-
#version ⇒ Fixnum
Deprecated.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Policy
constructor
A new instance of Policy.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Policy
Returns a new instance of Policy
16617 16618 16619 |
# File 'generated/google/apis/compute_v1/classes.rb', line 16617 def initialize(**args) update!(**args) end |
Instance Attribute Details
#audit_configs ⇒ Array<Google::Apis::ComputeV1::AuditConfig>
Specifies cloud audit logging configuration for this policy.
Corresponds to the JSON property auditConfigs
16573 16574 16575 |
# File 'generated/google/apis/compute_v1/classes.rb', line 16573 def audit_configs @audit_configs end |
#bindings ⇒ Array<Google::Apis::ComputeV1::Binding>
Associates a list of members
to a role
. bindings
with no members will
result in an error.
Corresponds to the JSON property bindings
16579 16580 16581 |
# File 'generated/google/apis/compute_v1/classes.rb', line 16579 def bindings @bindings end |
#etag ⇒ String
etag
is used for optimistic concurrency control as a way to help prevent
simultaneous updates of a policy from overwriting each other. It is strongly
suggested that systems make use of the etag
in the read-modify-write cycle
to perform policy updates in order to avoid race conditions: An etag
is
returned in the response to getIamPolicy
, and systems are expected to put
that etag in the request to setIamPolicy
to ensure that their change will be
applied to the same version of the policy.
If no etag
is provided in the call to setIamPolicy
, then the existing
policy is overwritten blindly.
Corresponds to the JSON property etag
NOTE: Values are automatically base64 encoded/decoded in the client library.
16593 16594 16595 |
# File 'generated/google/apis/compute_v1/classes.rb', line 16593 def etag @etag end |
#iam_owned ⇒ Boolean Also known as: iam_owned?
Corresponds to the JSON property iamOwned
16598 16599 16600 |
# File 'generated/google/apis/compute_v1/classes.rb', line 16598 def iam_owned @iam_owned end |
#rules ⇒ Array<Google::Apis::ComputeV1::Rule>
If more than one rule is specified, the rules are applied in the following
manner: - All matching LOG rules are always applied. - If any DENY/
DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if
one or more matching rule requires logging. - Otherwise, if any ALLOW/
ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if
one or more matching rule requires logging. - Otherwise, if no rule applies,
permission is denied.
Corresponds to the JSON property rules
16610 16611 16612 |
# File 'generated/google/apis/compute_v1/classes.rb', line 16610 def rules @rules end |
#version ⇒ Fixnum
Deprecated.
Corresponds to the JSON property version
16615 16616 16617 |
# File 'generated/google/apis/compute_v1/classes.rb', line 16615 def version @version end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
16622 16623 16624 16625 16626 16627 16628 16629 |
# File 'generated/google/apis/compute_v1/classes.rb', line 16622 def update!(**args) @audit_configs = args[:audit_configs] if args.key?(:audit_configs) @bindings = args[:bindings] if args.key?(:bindings) @etag = args[:etag] if args.key?(:etag) @iam_owned = args[:iam_owned] if args.key?(:iam_owned) @rules = args[:rules] if args.key?(:rules) @version = args[:version] if args.key?(:version) end |