TcpVirtualNodeListenerOptions

class aws_cdk.aws_appmesh.TcpVirtualNodeListenerOptions(*, connection_pool=None, health_check=None, outlier_detection=None, port=None, timeout=None, tls=None)

Bases: object

Represent the TCP Node Listener prorperty.

Parameters
  • connection_pool (Optional[TcpConnectionPool]) – Connection pool for http listeners. Default: - None

  • health_check (Optional[HealthCheck]) – The health check information for the listener. Default: - no healthcheck

  • outlier_detection (Optional[OutlierDetection]) – Represents the configuration for enabling outlier detection. Default: - none

  • port (Union[int, float, None]) – Port to listen for connections on. Default: - 8080

  • timeout (Optional[TcpTimeout]) – Timeout for TCP protocol. Default: - None

  • tls (Optional[ListenerTlsOptions]) – Represents the configuration for enabling TLS on a listener. Default: - none

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_appmesh as appmesh
import aws_cdk.core as cdk

# health_check: appmesh.HealthCheck
# mutual_tls_validation_trust: appmesh.MutualTlsValidationTrust
# subject_alternative_names: appmesh.SubjectAlternativeNames
# tls_certificate: appmesh.TlsCertificate

tcp_virtual_node_listener_options = appmesh.TcpVirtualNodeListenerOptions(
    connection_pool=appmesh.TcpConnectionPool(
        max_connections=123
    ),
    health_check=health_check,
    outlier_detection=appmesh.OutlierDetection(
        base_ejection_duration=cdk.Duration.minutes(30),
        interval=cdk.Duration.minutes(30),
        max_ejection_percent=123,
        max_server_errors=123
    ),
    port=123,
    timeout=appmesh.TcpTimeout(
        idle=cdk.Duration.minutes(30)
    ),
    tls=appmesh.ListenerTlsOptions(
        certificate=tls_certificate,
        mode=appmesh.TlsMode.STRICT,

        # the properties below are optional
        mutual_tls_validation=appmesh.MutualTlsValidation(
            trust=mutual_tls_validation_trust,

            # the properties below are optional
            subject_alternative_names=subject_alternative_names
        )
    )
)

Attributes

connection_pool

Connection pool for http listeners.

Default
  • None

Return type

Optional[TcpConnectionPool]

health_check

The health check information for the listener.

Default
  • no healthcheck

Return type

Optional[HealthCheck]

outlier_detection

Represents the configuration for enabling outlier detection.

Default
  • none

Return type

Optional[OutlierDetection]

port

Port to listen for connections on.

Default
  • 8080

Return type

Union[int, float, None]

timeout

Timeout for TCP protocol.

Default
  • None

Return type

Optional[TcpTimeout]

tls

Represents the configuration for enabling TLS on a listener.

Default
  • none

Return type

Optional[ListenerTlsOptions]