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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb

Overview

Note:

When making an API call, you may pass Listener data as a 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#connection_poolTypes::VirtualNodeConnectionPool

The connection pool information for the listener.



4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4275

class Listener < Struct.new(
  :connection_pool,
  :health_check,
  :outlier_detection,
  :port_mapping,
  :timeout,
  :tls)
  SENSITIVE = []
  include Aws::Structure
end

#health_checkTypes::HealthCheckPolicy

The health check information for the listener.



4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4275

class Listener < Struct.new(
  :connection_pool,
  :health_check,
  :outlier_detection,
  :port_mapping,
  :timeout,
  :tls)
  SENSITIVE = []
  include Aws::Structure
end

#outlier_detectionTypes::OutlierDetection

The outlier detection information for the listener.



4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4275

class Listener < Struct.new(
  :connection_pool,
  :health_check,
  :outlier_detection,
  :port_mapping,
  :timeout,
  :tls)
  SENSITIVE = []
  include Aws::Structure
end

#port_mappingTypes::PortMapping

The port mapping information for the listener.

Returns:



4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4275

class Listener < Struct.new(
  :connection_pool,
  :health_check,
  :outlier_detection,
  :port_mapping,
  :timeout,
  :tls)
  SENSITIVE = []
  include Aws::Structure
end

#timeoutTypes::ListenerTimeout

An object that represents timeouts for different protocols.



4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4275

class Listener < Struct.new(
  :connection_pool,
  :health_check,
  :outlier_detection,
  :port_mapping,
  :timeout,
  :tls)
  SENSITIVE = []
  include Aws::Structure
end

#tlsTypes::ListenerTls

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

Returns:



4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4275

class Listener < Struct.new(
  :connection_pool,
  :health_check,
  :outlier_detection,
  :port_mapping,
  :timeout,
  :tls)
  SENSITIVE = []
  include Aws::Structure
end