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_name
required |
Cloud Storage bucket name.
|
|
description |
An optional textual description of the resource; provided by the client when the resource is created.
|
|
enable_cdn
bool |
|
If true, enable Cloud CDN for this BackendBucket.
|
name
required |
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
|
|
project |
Default: None
|
The Google Cloud Platform project to use.
|
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-backendbucket"
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
state: present
register: bucket
- name: create a backend bucket
gcp_compute_backend_bucket:
name: "test_object"
bucket_name: "{{ bucket.name }}"
description: A BackendBucket to connect LNB w/ Storage Bucket
enable_cdn: true
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_name
str
|
success |
Cloud Storage bucket name.
|
creation_timestamp
str
|
success |
Creation timestamp in RFC3339 text format.
|
description
str
|
success |
An optional textual description of the resource; provided by the client when the resource is created.
|
enable_cdn
bool
|
success |
If true, enable Cloud CDN for this BackendBucket.
|
id
int
|
success |
Unique identifier for the resource.
|
name
str
|
success |
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
|
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.