mirror of
https://github.com/ansible-collections/google.cloud.git
synced 2025-04-23 03:11:22 -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,65 +43,42 @@ 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
|
||||
quic_override:
|
||||
description:
|
||||
- Specifies the QUIC override policy for this resource. This determines whether
|
||||
the load balancer will attempt to negotiate QUIC with clients or not. Can specify
|
||||
one of NONE, ENABLE, or DISABLE. If NONE is specified, uses the QUIC policy
|
||||
with no user overrides, which is equivalent to DISABLE. Not specifying this
|
||||
field is equivalent to specifying NONE.
|
||||
required: false
|
||||
version_added: 2.7
|
||||
choices:
|
||||
- NONE
|
||||
- ENABLE
|
||||
- DISABLE
|
||||
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 TargetHttpsProxy
|
||||
resource. If not set, the TargetHttpsProxy 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
|
||||
url_map:
|
||||
description:
|
||||
- A reference to the UrlMap resource that defines the mapping from URL to the
|
||||
BackendService.
|
||||
- 'This field represents a link to a UrlMap 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_url_map task and then set this url_map field to "{{ name-of-resource
|
||||
}}"'
|
||||
required: true
|
||||
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
|
||||
quic_override:
|
||||
description:
|
||||
- Specifies the QUIC override policy for this resource. This determines whether the
|
||||
load balancer will attempt to negotiate QUIC with clients or not. Can specify one
|
||||
of NONE, ENABLE, or DISABLE. If NONE is specified, uses the QUIC policy with no
|
||||
user overrides, which is equivalent to DISABLE. Not specifying this field is equivalent
|
||||
to specifying NONE.
|
||||
required: false
|
||||
version_added: 2.7
|
||||
choices: ['NONE', 'ENABLE', 'DISABLE']
|
||||
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
|
||||
url_map:
|
||||
description:
|
||||
- A reference to the UrlMap resource that defines the mapping from URL to the BackendService.
|
||||
- 'This field represents a link to a UrlMap resource in GCP. It can be specified in
|
||||
two ways. You can add `register: name-of-resource` to a gcp_compute_url_map task
|
||||
and then set this url_map field to "{{ name-of-resource }}" Alternatively, you can
|
||||
set this url_map to a dictionary with the selfLink key where the value is the selfLink
|
||||
of your UrlMap.'
|
||||
required: true
|
||||
extends_documentation_fragment: gcp
|
||||
notes:
|
||||
- 'API Reference: U(https://cloud.google.com/compute/docs/reference/v1/targetHttpsProxies)'
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue