Skip to content

DomainEndpointOptions

Source code in docs_src/capo_elasticsearch_service/types/domain_endpoint_options.py
class DomainEndpointOptions(TypedDict, closed=True):
    enforce_https: NotRequired["capo_elasticsearch_service.types.boolean.Boolean"]
    """<p>Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.</p>"""
    tls_security_policy: NotRequired[
        "capo_elasticsearch_service.types.tls_security_policy.TLSSecurityPolicy"
    ]
    """<p>Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain. <br></br> It can be one of the following values: <ul> <li><b>Policy-Min-TLS-1-0-2019-07: </b> TLS security policy that supports TLS version 1.0 to TLS version 1.2</li> <li><b>Policy-Min-TLS-1-2-2019-07: </b> TLS security policy that supports only TLS version 1.2</li> <li><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</li> <li><b>Policy-Min-TLS-1-2-RFC9151-FIPS-2024-08: </b> TLS security policy that supports TLS version 1.3 with FIPS</li> </ul> </p>"""
    custom_endpoint_enabled: NotRequired[
        "capo_elasticsearch_service.types.boolean.Boolean"
    ]
    """<p>Specify if custom endpoint should be enabled for the Elasticsearch domain.</p>"""
    custom_endpoint: NotRequired[
        "capo_elasticsearch_service.types.domain_name_fqdn.DomainNameFqdn"
    ]
    """<p>Specify the fully qualified domain for your custom endpoint.</p>"""
    custom_endpoint_certificate_arn: NotRequired[
        "capo_elasticsearch_service.types.arn.ARN"
    ]
    """<p>Specify ACM certificate ARN for your custom endpoint.</p>"""

custom_endpoint instance-attribute

custom_endpoint: NotRequired[DomainNameFqdn]

Specify the fully qualified domain for your custom endpoint.

custom_endpoint_certificate_arn instance-attribute

custom_endpoint_certificate_arn: NotRequired[ARN]

Specify ACM certificate ARN for your custom endpoint.

custom_endpoint_enabled instance-attribute

custom_endpoint_enabled: NotRequired[Boolean]

Specify if custom endpoint should be enabled for the Elasticsearch domain.

enforce_https instance-attribute

enforce_https: NotRequired[Boolean]

Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.

tls_security_policy instance-attribute

tls_security_policy: NotRequired[TLSSecurityPolicy]

Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.

It 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