Skip to content

DomainEndpointOptions

Source code in docs_src/capo_opensearch/types/domain_endpoint_options.py
class DomainEndpointOptions(TypedDict, closed=True):
    enforce_https: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>True to require that all traffic to the domain arrive over HTTPS.</p>"""
    tls_security_policy: NotRequired[
        "capo_opensearch.types.tls_security_policy.TLSSecurityPolicy"
    ]
    """<p>Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values:</p> <ul> <li> <p> <b>Policy-Min-TLS-1-0-2019-07:</b> TLS security policy that supports TLS version 1.0 to TLS version 1.2</p> </li> <li> <p> <b>Policy-Min-TLS-1-2-2019-07:</b> TLS security policy that supports only TLS version 1.2</p> </li> <li> <p> <b>Policy-Min-TLS-1-2-PFS-2023-10:</b> TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites</p> </li> <li> <p> <b>Policy-Min-TLS-1-2-RFC9151-FIPS-2024-08:</b> TLS security policy that supports TLS version 1.3 with FIPS</p> </li> </ul>"""
    custom_endpoint_enabled: NotRequired["capo_opensearch.types.boolean.Boolean"]
    """<p>Whether to enable a custom endpoint for the domain.</p>"""
    custom_endpoint: NotRequired[
        "capo_opensearch.types.domain_name_fqdn.DomainNameFqdn"
    ]
    """<p>The fully qualified URL for the custom endpoint.</p>"""
    custom_endpoint_certificate_arn: NotRequired["capo_opensearch.types.arn.ARN"]
    """<p>The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).</p>"""

custom_endpoint instance-attribute

custom_endpoint: NotRequired[DomainNameFqdn]

The fully qualified URL for the custom endpoint.

custom_endpoint_certificate_arn instance-attribute

custom_endpoint_certificate_arn: NotRequired[ARN]

The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

custom_endpoint_enabled instance-attribute

custom_endpoint_enabled: NotRequired[Boolean]

Whether to enable a custom endpoint for the domain.

enforce_https instance-attribute

enforce_https: NotRequired[Boolean]

True to require that all traffic to the domain arrive over HTTPS.

tls_security_policy instance-attribute

tls_security_policy: NotRequired[TLSSecurityPolicy]

Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values:

  • Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version 1.0 to TLS version 1.2

  • Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS version 1.2

  • Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites

  • Policy-Min-TLS-1-2-RFC9151-FIPS-2024-08: TLS security policy that supports TLS version 1.3 with FIPS