community.general.gcp_spanner_database_info (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

Gather info for GCP Database

Requirements

• python >= 2.6
• requests >= 2.18.4
• google-auth >= 1.3.0

Usage examples

Scanned by Steampunk Spotter

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

- name: get info on a database
  gcp_spanner_database_info:
    instance: "{{ instance }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"

Inputs

    
scopes:
    description:
    - Array of scopes to be used
    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

instance:
    description:
    - The instance to create the database on.
    - 'This field represents a link to a Instance 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_spanner_instance
      task and then set this instance field to "{{ name-of-resource }}"'
    required: true
    type: dict

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

resources:
  contains:
    extraStatements:
      description:
      - 'An optional list of DDL statements to run inside the newly created database.
        Statements can create tables, indexes, etc. These statements execute atomically
        with the creation of the database: if there is an error in any statement,
        the database is not created.'
      returned: success
      type: list
    instance:
      description:
      - The instance to create the database on.
      returned: success
      type: dict
    name:
      description:
      - A unique identifier for the database, which cannot be changed after the instance
        is created. Values are of the form [a-z][-a-z0-9]*[a-z0-9].
      returned: success
      type: str
  description: List of resources
  returned: always
  type: complex