otcextensions.sdk.waf.v1.domain¶
The WAF Domain Class¶
The Domain
class inherits from
Resource
.
- class otcextensions.sdk.waf.v1.domain.Domain(_synchronized=False, connection=None, **attrs)¶
WAF Domain Resource
The base resource
- Parameters:
_synchronized (bool) – This is not intended to be used directly. See
new()
andexisting()
.connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connection
in Resource code should protect itself with a check for None.
- resources_key: ty.Optional[str] = 'items'¶
Plural form of key for resource.
- base_path: str = '/waf/instance'¶
The base part of the URI for this resource.
- allow_create = True¶
Allow create operation for this resource.
- allow_list = True¶
Allow list operation for this resource.
- allow_fetch = True¶
Allow get operation for this resource.
- allow_delete = True¶
Allow delete operation for this resource.
- allow_commit = True¶
Allow update operation for this resource.
- access_status¶
Properties Specifies whether a domain name is connected to WAF
- certificate_id¶
Certificate ID. This parameter is mandatory when client_protocol is set to HTTPS.
- cname¶
CNAME
- name: ty.Union[Body, URI]¶
domain name
- policy_id¶
Specifies the policy ID.
- protocol¶
protocol type of the client. The options are HTTP, HTTPS, and HTTP,HTTPS.
- protect_status¶
WAF mode.
- proxy¶
Specifies whether a proxy is configured.
- server¶
Specifies the origin server information, including the client_protocol, server_protocol, address, and port fields.
- sip_header_name¶
source IP header. This parameter is required only when proxy is set to true. The options are as follows: default, cloudflare, akamai, and custom.
- sip_header_list¶
Specifies the HTTP request header for identifying the real source IP address. This parameter is required only when proxy is set to true. - If sip_header_name is default, sip_header_list is [“X-Forwarded-For”]. - If sip_header_name is cloudflare, sip_header_list is [“CF-Connecting-IP”, “X-Forwarded-For”]. - If sip_header_name is akamai, sip_header_list is [“True-Client-IP”]. - If sip_header_name is custom, you can customize a value.
- subdomain¶
subdomain name. This parameter is returned only when proxy is set to true.
- timestamp¶
Certificate uploading timestamp
- txt_record¶
TXT record. This parameter is returned only when proxy is set to true.