Class: Google::Apis::CloudkmsV1::Policy

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudkms_v1/classes.rb,
generated/google/apis/cloudkms_v1/representations.rb,
generated/google/apis/cloudkms_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. 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"] ] For a description of IAM and its features, see the IAM developer's guide.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Policy

Returns a new instance of Policy



340
341
342
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 340

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#audit_configs ⇒ Array<Google::Apis::CloudkmsV1::AuditConfig>

Specifies cloud audit logging configuration for this policy. Corresponds to the JSON property auditConfigs

Returns:



299
300
301
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 299

def audit_configs
  @audit_configs
end

#bindings ⇒ Array<Google::Apis::CloudkmsV1::Binding>

Associates a list of members to a role. bindings with no members will result in an error. Corresponds to the JSON property bindings

Returns:



305
306
307
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 305

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.

Returns:

  • (String) 


319
320
321
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 319

def etag
  @etag
end

#iam_owned ⇒ Boolean Also known as: iam_owned?

Corresponds to the JSON property iamOwned

Returns:

  • (Boolean) 


324
325
326
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 324

def iam_owned
  @iam_owned
end

#rules ⇒ Array<Google::Apis::CloudkmsV1::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

Returns:



338
339
340
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 338

def rules
  @rules
end

#version ⇒ Fixnum

Version of the Policy. The default version is 0. Corresponds to the JSON property version

Returns:

  • (Fixnum) 


294
295
296
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 294

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



345
346
347
348
349
350
351
352
 
# File 'generated/google/apis/cloudkms_v1/classes.rb', line 345

def update!(**args)
  @version = args[:version] if args.key?(:version)
  @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)
end