lazyninjas.gcp.gc_storage_object (0.9.7) — module

Install collection

Install with ansible-galaxy collection install lazyninjas.gcp:==0.9.7

Add to requirements.yml

  collections:
    - name: lazyninjas.gcp
      version: 0.9.7

Description

Upload or download a file from a GCS bucket.

Requirements

• python >= 2.6
• requests >= 2.18.4
• google-auth >= 1.3.0
• google-cloud-storage >= 1.2..0

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: create a object
  google.cloud.gc_storage_object:
    action: download
    bucket: ansible-bucket
    src: modules.zip
    dest: "~/modules.zip"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Inputs

    
src:
    description:
    - Source location of file (may be local machine or cloud depending on action). Cloud
      locations need to be urlencoded including slashes.
    required: false
    type: path

dest:
    description:
    - Destination location of file (may be local machine or cloud depending on action).
      Cloud location need to be urlencoded including slashes.
    required: false
    type: path

action:
    choices:
    - download
    - upload
    - delete
    description:
    - The actions to be taken on this object.
    - You can download the object, upload the object, or delete it.
    required: false
    type: str

bucket:
    description:
    - The name of the bucket.
    required: false
    type: str

scopes:
    description:
    - Array of scopes to be used
    elements: str
    type: list

project:
    description:
    - The Google Cloud Platform project to use.
    type: str

env_type:
    description:
    - 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.
    type: str

auth_kind:
    choices:
    - application
    - machineaccount
    - serviceaccount
    description:
    - The type of credential used.
    required: true
    type: str

service_account_file:
    description:
    - The path of a Service Account JSON file if serviceaccount is selected as type.
    type: path

service_account_email:
    description:
    - An optional service account email address if machineaccount is selected and the
      user does not wish to use the default email.
    type: str

service_account_contents:
    description:
    - The contents of a Service Account JSON file, either in a dictionary or as a JSON
      string that represents it.
    type: jsonarg

Outputs

bucket:
  description:
  - The bucket where the object is contained.
  returned: download, upload
  type: str
cache_control:
  description:
  - HTTP 'Cache-Control' header for this object
  returned: download, upload
  type: str
chunk_size:
  description:
  - Get the blob's default chunk size
  returned: download, upload
  type: str
media_link:
  description:
  - The link for the media
  returned: download, upload
  type: str
self_link:
  description:
  - The self_link for the media.
  returned: download, upload
  type: str
storage_class:
  description:
  - The storage class for the object.
  returned: download, upload
  type: str