Class: Google::Apis::ComputeAlpha::Policy
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::Policy
- Defined in:
- generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/google/apis/compute_alpha/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
is a collection of bindings
. A binding
binds one or more
members
to a single role
. Members can be user accounts, service accounts,
Google groups, and domains (such as G Suite). A role
is a named list of
permissions (defined by IAM or configured by users). A binding
can
optionally specify a condition
, which is a logic expression that further
constrains the role binding based on attributes about the request and/or
target resource.
JSON Example
"bindings": [
"role": "roles/resourcemanager.organizationAdmin", "members":
[ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "
serviceAccount:my-project-id@appspot.gserviceaccount.com" ] ,
"role": "
roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"],
"condition": "title": "expirable access", "description": "Does not grant
access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:
00:00.000Z')",
]
YAML Example
bindings: - members: - user:mike@example.com - group:admins@example.com -
domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com
role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.
com role: roles/resourcemanager.organizationViewer condition: title: expirable
access description: Does not grant access after Sep 2020 expression: request.
time < timestamp('2020-10-01T00:00:00.000Z')
For a description of IAM and its features, see the IAM developer's guide.
Instance Attribute Summary collapse
-
#audit_configs ⇒ Array<Google::Apis::ComputeAlpha::AuditConfig>
Specifies cloud audit logging configuration for this policy.
-
#bindings ⇒ Array<Google::Apis::ComputeAlpha::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::ComputeAlpha::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
Specifies the format of the policy.
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
23717 23718 23719 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 23717 def initialize(**args) update!(**args) end |
Instance Attribute Details
#audit_configs ⇒ Array<Google::Apis::ComputeAlpha::AuditConfig>
Specifies cloud audit logging configuration for this policy.
Corresponds to the JSON property auditConfigs
23661 23662 23663 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 23661 def audit_configs @audit_configs end |
#bindings ⇒ Array<Google::Apis::ComputeAlpha::Binding>
Associates a list of members
to a role
. Optionally may specify a
condition
that determines when binding is in effect. bindings
with no
members will result in an error.
Corresponds to the JSON property bindings
23668 23669 23670 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 23668 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. Due to blind-set semantics of an etag-less policy, '
setIamPolicy' will not fail even if either of incoming or stored policy does
not meet the version requirements.
Corresponds to the JSON property etag
NOTE: Values are automatically base64 encoded/decoded in the client library.
23684 23685 23686 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 23684 def etag @etag end |
#iam_owned ⇒ Boolean Also known as: iam_owned?
Corresponds to the JSON property iamOwned
23689 23690 23691 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 23689 def iam_owned @iam_owned end |
#rules ⇒ Array<Google::Apis::ComputeAlpha::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
23701 23702 23703 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 23701 def rules @rules end |
#version ⇒ Fixnum
Specifies the format of the policy.
Valid values are 0, 1, and 3. Requests specifying an invalid value will be
rejected.
Operations affecting conditional bindings must specify version 3. This can be
either setting a conditional policy, modifying a conditional binding, or
removing a conditional binding from the stored conditional policy. Operations
on non-conditional policies may specify any valid value or leave the field
unset.
If no etag is provided in the call to setIamPolicy
, any version compliance
checks on the incoming and/or stored policy is skipped.
Corresponds to the JSON property version
23715 23716 23717 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 23715 def version @version end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
23722 23723 23724 23725 23726 23727 23728 23729 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 23722 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 |