delowan.googlecloud.gcp_serviceusage_service (1.0.2) — module

Creates a GCP Service

Authors: Google Inc. (@googlecloudplatform)

preview | supported by community

Install collection

Install with ansible-galaxy collection install delowan.googlecloud:==1.0.2


Add to requirements.yml

  collections:
    - name: delowan.googlecloud
      version: 1.0.2

Description

A service that is available for use .


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: create a service
  google.cloud.gcp_serviceusage_service:
    name: spanner.googleapis.com
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Inputs

    
name:
    description:
    - The resource name of the service .
    required: true
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Whether the given object should exist in GCP
    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

disable_dependent_services:
    description:
    - Indicates if dependent services should also be disabled. Can only be turned on if
      service is disabled.
    required: false
    type: bool

Outputs

config:
  contains:
    apis:
      contains:
        name:
          description:
          - Name of the API.
          returned: success
          type: str
        version:
          description:
          - The version of the API.
          returned: success
          type: str
      description:
      - The list of API interfaces exported by this service.
      returned: success
      type: complex
    name:
      description:
      - The DNS address at which this service is available.
      returned: success
      type: str
    title:
      description:
      - The product title for this service.
      returned: success
      type: str
  description:
  - The service configuration of the available service.
  returned: success
  type: complex
disableDependentServices:
  description:
  - Indicates if dependent services should also be disabled. Can only be turned on
    if service is disabled.
  returned: success
  type: bool
name:
  description:
  - The resource name of the service .
  returned: success
  type: str
parent:
  description:
  - The name of the parent of this service. For example 'projects/123' .
  returned: success
  type: str
state:
  description:
  - Whether or not the service has been enabled for use by the consumer.
  returned: success
  type: str