mirror of
https://github.com/ansible-collections/google.cloud.git
synced 2025-07-25 22:30:29 -07:00
Better documentation for how a resourceref works (#96)
<!-- This change is generated by MagicModules. --> /cc @rambleraptor
This commit is contained in:
parent
6aa571c1b8
commit
e87c2e837c
31 changed files with 1669 additions and 1213 deletions
|
@ -43,59 +43,38 @@ requirements:
|
|||
options:
|
||||
state:
|
||||
description:
|
||||
- Whether the given object should exist in GCP
|
||||
choices:
|
||||
- present
|
||||
- absent
|
||||
default: present
|
||||
description:
|
||||
description:
|
||||
- An optional description of this resource.
|
||||
required: false
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
required: true
|
||||
proxy_header:
|
||||
description:
|
||||
- Specifies the type of proxy header to append before sending data to the backend,
|
||||
either NONE or PROXY_V1. The default is NONE.
|
||||
required: false
|
||||
choices:
|
||||
- NONE
|
||||
- PROXY_V1
|
||||
service:
|
||||
description:
|
||||
- A reference to the BackendService resource.
|
||||
- 'This field represents a link to a BackendService 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_backend_service task and then set this service
|
||||
field to "{{ name-of-resource }}"'
|
||||
required: true
|
||||
ssl_certificates:
|
||||
description:
|
||||
- A list of SslCertificate resources that are used to authenticate connections
|
||||
between users and the load balancer. Currently, exactly one SSL certificate
|
||||
must be specified.
|
||||
required: true
|
||||
ssl_policy:
|
||||
description:
|
||||
- A reference to the SslPolicy resource that will be associated with the TargetSslProxy
|
||||
resource. If not set, the TargetSslProxy resource will not have any SSL policy
|
||||
configured.
|
||||
- 'This field represents a link to a SslPolicy 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_ssl_policy task and then set this ssl_policy field to "{{ name-of-resource
|
||||
}}"'
|
||||
required: false
|
||||
version_added: 2.8
|
||||
description:
|
||||
- An optional description of this resource.
|
||||
required: false
|
||||
name:
|
||||
description:
|
||||
- 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.
|
||||
required: true
|
||||
proxy_header:
|
||||
description:
|
||||
- Specifies the type of proxy header to append before sending data to the backend,
|
||||
either NONE or PROXY_V1. The default is NONE.
|
||||
required: false
|
||||
choices: ['NONE', 'PROXY_V1']
|
||||
service:
|
||||
description:
|
||||
- A reference to the BackendService resource.
|
||||
- 'This field represents a link to a BackendService resource in GCP. It can be specified
|
||||
in two ways. You can add `register: name-of-resource` to a gcp_compute_backend_service
|
||||
task and then set this service field to "{{ name-of-resource }}" Alternatively,
|
||||
you can set this service to a dictionary with the selfLink key where the value is
|
||||
the selfLink of your BackendService.'
|
||||
required: true
|
||||
ssl_certificates:
|
||||
description:
|
||||
- A list of SslCertificate resources that are used to authenticate connections between
|
||||
users and the load balancer. Currently, exactly one SSL certificate must be specified.
|
||||
required: true
|
||||
extends_documentation_fragment: gcp
|
||||
notes:
|
||||
- 'API Reference: U(https://cloud.google.com/compute/docs/reference/v1/targetSslProxies)'
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue