New in version 2.6.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
auth_kind
required |
|
The type of credential used.
|
|
bucket
required |
The name of the bucket.
|
||
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 liz@example.com would be user-liz@example.com.
The group example@googlegroups.com would be group-example@googlegroups.com.
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 |
Default: None
|
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 |
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 |
|
Whether the given object should exist in GCP
|
Note
GCP_SERVICE_ACCOUNT_FILE
env variable.GCP_SERVICE_ACCOUNT_EMAIL
env variable.GCP_AUTH_KIND
env variable.GCP_SCOPES
env variable.- name: create a bucket
gcp_storage_bucket:
name: "bucket-bac"
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: bucket
- name: create a bucket access control
gcp_storage_bucket_access_control:
bucket: "{{ bucket }}"
entity: user-alexstephen@google.com
role: WRITER
project: "test_project"
auth_kind: "service_account"
service_account_file: "/tmp/auth.pem"
state: present
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
bucket
dict
|
success |
The name of the bucket.
|
|
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 liz@example.com would be user-liz@example.com.
The group example@googlegroups.com would be group-example@googlegroups.com.
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.
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.