gcp_storage_bucket_access_control - Creates a GCP BucketAccessControl
New in version 2.6.
Synopsis
- 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.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- requests >= 2.18.4
- google-auth >= 1.3.0
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
auth_kind required |
| The type of credential used. | |
bucket required | A reference to Bucket resource. | ||
entity required | 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. | ||
entity_id | The ID for the entity. | ||
project | The Google Cloud Platform project to use. | ||
project_team | The project team associated with the entity. | ||
project_number | The project team associated with the entity. | ||
team |
| The team. | |
role |
| The access permission for the entity. | |
scopes required | Array of scopes to be used. | ||
service_account_email | An optional service account email address if machineaccount is selected and the user does not wish to use the default email. | ||
service_account_file | The path of a Service Account JSON file if serviceaccount is selected as type. | ||
state required |
| Whether the given object should exist in GCP |
Notes
Note
- For authentication, you can set service_account_file using the
GCP_SERVICE_ACCOUNT_FILE
env variable. - For authentication, you can set service_account_email using the
GCP_SERVICE_ACCOUNT_EMAIL
env variable. - For authentication, you can set auth_kind using the
GCP_AUTH_KIND
env variable. - For authentication, you can set scopes using the
GCP_SCOPES
env variable. - Environment variables values will only be used if the playbook values are not set.
- The service_account_email and service_account_file options are mutually exclusive.
Examples
- name: create a bucket gcp_storage_bucket: name: 'bucket-bac' project: "{{ gcp_project }}" auth_kind: "{{ gcp_cred_kind }}" service_account_file: "{{ gcp_cred_file }}" scopes: - https://www.googleapis.com/auth/devstorage.full_control state: present register: bucket - name: create a bucket access control gcp_storage_bucket_access_control: bucket: "{{ bucket }}" entity: '[email protected]' role: 'WRITER' project: testProject auth_kind: service_account service_account_file: /tmp/auth.pem scopes: - https://www.googleapis.com/auth/devstorage.full_control state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
bucket dict | success | A reference to Bucket resource. | |
domain str | success | The domain associated with the entity. | |
email str | success | The email address associated with the entity. | |
entity str | success | 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. | |
entity_id str | success | The ID for the entity. | |
id str | success | The ID of the access-control entry. | |
project_team complex | success | The project team associated with the entity. | |
project_number str | success | The project team associated with the entity. | |
team str | success | The team. | |
role str | success | The access permission for the entity. |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Author
- Google Inc. (@googlecloudplatform)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/gcp_storage_bucket_access_control_module.html