google.cloud.gcp_compute_region_target_http_proxy – Creates a GCP RegionTargetHttpProxy
Note
This plugin is part of the google.cloud collection (version 1.0.2).
To install it use: ansible-galaxy collection install google.cloud.
To use it in a playbook, specify: google.cloud.gcp_compute_region_target_http_proxy.
Synopsis
- Represents a RegionTargetHttpProxy resource, which is used by one or more forwarding rules to route incoming HTTP requests to a URL map.
 
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
 - requests >= 2.18.4
 - google-auth >= 1.3.0
 
Parameters
| Parameter | Choices/Defaults | Comments | 
|---|---|---|
|   auth_kind    string / required    |   
  |    The type of credential used.   |  
|   description    string    |    An optional description of this resource.   |  |
|   env_type    string    |    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.   |  |
|   name    string / 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    string    |    The Google Cloud Platform project to use.   |  |
|   region    string / required    |    The region where the regional proxy resides.   |  |
|   scopes    list / elements=string    |    Array of scopes to be used   |  |
|   service_account_contents    jsonarg    |    The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.   |  |
|   service_account_email    string    |    An optional service account email address if machineaccount is selected and the user does not wish to use the default email.   |  |
|   service_account_file    path    |    The path of a Service Account JSON file if serviceaccount is selected as type.   |  |
|   state    string    |   
  |    Whether the given object should exist in GCP   |  
|   url_map    dictionary / required    |    A reference to the RegionUrlMap resource that defines the mapping from URL to the BackendService.  This field represents a link to a RegionUrlMap resource in GCP. It can be specified in two ways. First, you can place a dictionary with key 'selfLink' and value of your resource's selfLink Alternatively, you can add `register: name-of-resource` to a gcp_compute_region_url_map task and then set this url_map field to "{{ name-of-resource }}"   |  
Notes
Note
- API Reference: https://cloud.google.com/compute/docs/reference/rest/v1/regionTargetHttpProxies
 - Official Documentation: https://cloud.google.com/compute/docs/load-balancing/http/target-proxies
 - for authentication, you can set service_account_file using the 
gcp_service_account_fileenv variable. - for authentication, you can set service_account_contents using the 
GCP_SERVICE_ACCOUNT_CONTENTSenv variable. - For authentication, you can set service_account_email using the 
GCP_SERVICE_ACCOUNT_EMAILenv variable. - For authentication, you can set auth_kind using the 
GCP_AUTH_KINDenv variable. - For authentication, you can set scopes using the 
GCP_SCOPESenv variable. - Environment variables values will only be used if the playbook values are not set.
 - The service_account_email and service_account_file options are mutually exclusive.
 
Examples
- name: create a instance group
  google.cloud.gcp_compute_instance_group:
    name: instancegroup-targethttpproxy
    zone: us-central1-a
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: instancegroup
- name: create a HTTP health check
  google.cloud.gcp_compute_http_health_check:
    name: httphealthcheck-targethttpproxy
    healthy_threshold: 10
    port: 8080
    timeout_sec: 2
    unhealthy_threshold: 5
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: healthcheck
- name: create a backend service
  google.cloud.gcp_compute_backend_service:
    name: backendservice-targethttpproxy
    backends:
    - group: "{{ instancegroup.selfLink }}"
    health_checks:
    - "{{ healthcheck.selfLink }}"
    enable_cdn: 'true'
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: backendservice
- name: create a URL map
  google.cloud.gcp_compute_url_map:
    name: urlmap-targethttpproxy
    default_service: "{{ backendservice }}"
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: urlmap
- name: create a region target HTTP proxy
  google.cloud.gcp_compute_region_target_http_proxy:
    name: test_object
    region: us-central1
    url_map: "{{ urlmap }}"
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present
   Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | 
|---|---|---|
|   creationTimestamp    string    |  success |   Creation timestamp in RFC3339 text format.   |  
|   description    string    |  success |   An optional description of this resource.   |  
|   id    integer    |  success |   The unique identifier for the resource.   |  
|   name    string    |  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.   |  
|   region    string    |  success |   The region where the regional proxy resides.   |  
|   urlMap    dictionary    |  success |   A reference to the RegionUrlMap resource that defines the mapping from URL to the BackendService.   |  
Authors
- Google Inc. (@googlecloudplatform)
 
    © 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
    https://docs.ansible.com/ansible/2.11/collections/google/cloud/gcp_compute_region_target_http_proxy_module.html