ansible.builtin.gcspanner (v2.3.2.0-1) — module

Create and Delete Instances/Databases on Spanner.

| "added in version" 2.3 of ansible.builtin"

Authors: Tom Melendez (@supertom) <tom@supertom.com>

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.3.2.0.post1

Description

Create and Delete Instances/Databases on Spanner. See U(https://cloud.google.com/spanner/docs) for an overview.


Requirements

Inputs

    
state:
    default: present
    description: State of the instance or database (absent, present). Applies to the most
      granular resource. If a database_name is specified we remove it.  If only instance_id
      is specified, that is what is removed.
    required: false

node_count:
    description:
    - Number of nodes in the instance.  If not specified while creating an instance, node_count
      will be set to 1.
    required: false

instance_id:
    description:
    - GCP spanner instance name.
    required: true

configuration:
    description:
    - Configuration the instance should use. Examples are us-central1, asia-east1 and
      europe-west1.
    required: true

database_name:
    description:
    - Name of database contained on the instance.
    required: false

force_instance_delete:
    default: false
    description:
    - To delete an instance, this argument must exist and be true (along with state being
      equal to absent).
    required: false

instance_display_name:
    description:
    - Name of Instance to display.  If not specified, instance_id will be used instead.
    required: false

Outputs

database_name:
  description: Name of database.
  returned: When database name is specified
  sample: mydatabase
  type: str
instance_id:
  description: Name of instance.
  returned: Always
  sample: myinstance
  type: str
previous_values:
  description: List of dictionaries containing previous values prior to update.
  returned: When an instance update has occurred and a field has been modified.
  sample: '''previous_values'': { ''instance'': { ''instance_display_name'': ''my-instance'',
    ''node_count'': 1 } }'
  type: dict
state:
  description: The state of the instance or database. Value will be either 'absent'
    or 'present'.
  returned: Always
  sample: present
  type: str
updated:
  description: Boolean field to denote an update has occurred.
  returned: When an update has occurred.
  sample: true
  type: bool