Class: Ansible::Ruby::Modules::Gcp_storage_bucket_access_control

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/google/gcp_storage_bucket_access_control.rb

Overview

The BucketAccessControls resource represents the Access Control Lists (ACLs) for buckets within Google Cloud Storage. ACLs let you specify who has access to your data and to what extent. There are three roles that can be assigned to an entity: READERs can get the bucket, though no acl property will be returned, and list the bucket’s objects. WRITERs are READERs, and they can insert objects into the bucket and delete the bucket’s objects. OWNERs are WRITERs, and they can get the acl property of a bucket, update a bucket, and call all BucketAccessControls methods on the bucket. For more information, see Access Control, with the caveat that this API uses READER, WRITER, and OWNER instead of READ, WRITE, and FULL_CONTROL.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#bucket ⇒ String

Returns The name of the bucket.

Returns:

  • (String) —

    The name of the bucket.



17
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_storage_bucket_access_control.rb', line 17

attribute :bucket

#entity ⇒ String

Returns The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user [email protected] would be [email protected].,The group [email protected] would be [email protected].,To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.

Returns:

  • (String) —

    The entity holding the permission, in one of the following forms: user-userId user-email group-groupId group-email domain-domain project-team-projectId allUsers allAuthenticatedUsers Examples: The user [email protected] would be [email protected].,The group [email protected] would be [email protected].,To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.



21
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_storage_bucket_access_control.rb', line 21

attribute :entity

#entity_id ⇒ Object?

Returns The ID for the entity.

Returns:

  • (Object, nil) —

    The ID for the entity.



25
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_storage_bucket_access_control.rb', line 25

attribute :entity_id

#project_team ⇒ Object?

Returns The project team associated with the entity.

Returns:

  • (Object, nil) —

    The project team associated with the entity.



28
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_storage_bucket_access_control.rb', line 28

attribute :project_team

#role ⇒ :OWNER, ...

Returns The access permission for the entity.

Returns:

  • (:OWNER, :READER, :WRITER, nil) —

    The access permission for the entity.



31
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_storage_bucket_access_control.rb', line 31

attribute :role

#state ⇒ :present, ...

Returns Whether the given object should exist in GCP.

Returns:

  • (:present, :absent, nil) —

    Whether the given object should exist in GCP



13
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_storage_bucket_access_control.rb', line 13

attribute :state