You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::AppMesh::Types::Listener

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing Listener as input to an Aws::Client method, you can use a vanilla Hash:

{
  connection_pool: {
    grpc: {
      max_requests: 1, # required
    },
    http: {
      max_connections: 1, # required
      max_pending_requests: 1,
    },
    http2: {
      max_requests: 1, # required
    },
    tcp: {
      max_connections: 1, # required
    },
  },
  health_check: {
    healthy_threshold: 1, # required
    interval_millis: 1, # required
    path: "String",
    port: 1,
    protocol: "http", # required, accepts http, tcp, http2, grpc
    timeout_millis: 1, # required
    unhealthy_threshold: 1, # required
  },
  outlier_detection: {
    base_ejection_duration: { # required
      unit: "s", # accepts s, ms
      value: 1,
    },
    interval: { # required
      unit: "s", # accepts s, ms
      value: 1,
    },
    max_ejection_percent: 1, # required
    max_server_errors: 1, # required
  },
  port_mapping: { # required
    port: 1, # required
    protocol: "http", # required, accepts http, tcp, http2, grpc
  },
  timeout: {
    grpc: {
      idle: {
        unit: "s", # accepts s, ms
        value: 1,
      },
      per_request: {
        unit: "s", # accepts s, ms
        value: 1,
      },
    },
    http: {
      idle: {
        unit: "s", # accepts s, ms
        value: 1,
      },
      per_request: {
        unit: "s", # accepts s, ms
        value: 1,
      },
    },
    http2: {
      idle: {
        unit: "s", # accepts s, ms
        value: 1,
      },
      per_request: {
        unit: "s", # accepts s, ms
        value: 1,
      },
    },
    tcp: {
      idle: {
        unit: "s", # accepts s, ms
        value: 1,
      },
    },
  },
  tls: {
    certificate: { # required
      acm: {
        certificate_arn: "Arn", # required
      },
      file: {
        certificate_chain: "FilePath", # required
        private_key: "FilePath", # required
      },
    },
    mode: "STRICT", # required, accepts STRICT, PERMISSIVE, DISABLED
  },
}

An object that represents a listener for a virtual node.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#connection_pool ⇒ Types::VirtualNodeConnectionPool

The connection pool information for the listener.

Returns:

#health_check ⇒ Types::HealthCheckPolicy

The health check information for the listener.

Returns:

#outlier_detection ⇒ Types::OutlierDetection

The outlier detection information for the listener.

Returns:

#port_mapping ⇒ Types::PortMapping

The port mapping information for the listener.

Returns:

#timeout ⇒ Types::ListenerTimeout

An object that represents timeouts for different protocols.

Returns:

#tls ⇒ Types::ListenerTls

A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.

Returns:

  • (Types::ListenerTls) —

    A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.