google.cloud.gcp_storage_bucket_access_control – Creates a GCP BucketAccessControl¶
Note
This plugin is part of the google.cloud collection (version 1.0.2).
To install it use: ansible-galaxy collection install google.cloud
.
To use it in a playbook, specify: google.cloud.gcp_storage_bucket_access_control
.
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
string
/ required
|
|
The type of credential used.
|
bucket
dictionary
/ required
|
The name of the bucket.
This field represents a link to a Bucket resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'name' and value of your resource's name Alternatively, you can add `register: name-of-resource` to a gcp_storage_bucket task and then set this bucket field to "{{ name-of-resource }}"
|
|
entity
string
/ 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.
|
|
env_type
string
|
Specifies which Ansible environment you're running this module within.
This should not be set unless you know what you're doing.
This only alters the User Agent string for any API requests.
|
|
project
string
|
The Google Cloud Platform project to use.
|
|
role
string
|
The access permission for the entity.
Some valid choices include: "OWNER", "READER", "WRITER"
|
|
scopes
list
/ elements=string
|
Array of scopes to be used
|
|
service_account_contents
jsonarg
|
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.
|
|
service_account_email
string
|
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
|
|
service_account_file
path
|
The path of a Service Account JSON file if serviceaccount is selected as type.
|
|
state
string
|
|
Whether the given object should exist in GCP
|
Notes¶
Note
API Reference: https://cloud.google.com/storage/docs/json_api/v1/bucketAccessControls
Official Documentation: https://cloud.google.com/storage/docs/access-control/lists
for authentication, you can set service_account_file using the
gcp_service_account_file
env variable.for authentication, you can set service_account_contents using the
GCP_SERVICE_ACCOUNT_CONTENTS
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
google.cloud.gcp_storage_bucket:
name: "{{ resource_name }}"
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: bucket
- name: create a bucket access control
google.cloud.gcp_storage_bucket_access_control:
bucket: "{{ bucket }}"
entity: [email protected]
role: WRITER
project: test_project
auth_kind: serviceaccount
service_account_file: "/tmp/auth.pem"
state: present
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |
---|---|---|---|
bucket
dictionary
|
success |
The name of the bucket.
|
|
domain
string
|
success |
The domain associated with the entity.
|
|
email
string
|
success |
The email address associated with the entity.
|
|
entity
string
|
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.
|
|
entityId
string
|
success |
The ID for the entity.
|
|
id
string
|
success |
The ID of the access-control entry.
|
|
projectTeam
complex
|
success |
The project team associated with the entity.
|
|
projectNumber
string
|
success |
The project team associated with the entity.
|
|
team
string
|
success |
The team.
|
|
role
string
|
success |
The access permission for the entity.
|
Authors¶
Google Inc. (@googlecloudplatform)