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

Class: Aws::ElasticLoadBalancing::Types::Listener

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

Overview

Note:

When making an API call, you may pass Listener data as a hash:

{
  protocol: "Protocol", # required
  load_balancer_port: 1, # required
  instance_protocol: "Protocol",
  instance_port: 1, # required
  ssl_certificate_id: "SSLCertificateId",
}

Information about a listener.

For information about the protocols and the ports supported by Elastic Load Balancing, see Listeners for Your Classic Load Balancer in the Classic Load Balancer Guide.

Instance Attribute Summary collapse

Instance Attribute Details

#instance_portInteger

The port on which the instance is listening.

Returns:

  • (Integer)


1390
1391
1392
1393
1394
1395
1396
1397
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1390

class Listener < Struct.new(
  :protocol,
  :load_balancer_port,
  :instance_protocol,
  :instance_port,
  :ssl_certificate_id)
  include Aws::Structure
end

#instance_protocolString

The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL.

If the front-end protocol is HTTP, HTTPS, TCP, or SSL, InstanceProtocol must be at the same protocol.

If there is another listener with the same InstancePort whose InstanceProtocol is secure, (HTTPS or SSL), the listener's InstanceProtocol must also be secure.

If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be HTTP or TCP.

Returns:

  • (String)


1390
1391
1392
1393
1394
1395
1396
1397
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1390

class Listener < Struct.new(
  :protocol,
  :load_balancer_port,
  :instance_protocol,
  :instance_port,
  :ssl_certificate_id)
  include Aws::Structure
end

#load_balancer_portInteger

The port on which the load balancer is listening. On EC2-VPC, you can specify any port from the range 1-65535. On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535.

Returns:

  • (Integer)


1390
1391
1392
1393
1394
1395
1396
1397
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1390

class Listener < Struct.new(
  :protocol,
  :load_balancer_port,
  :instance_protocol,
  :instance_port,
  :ssl_certificate_id)
  include Aws::Structure
end

#protocolString

The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.

Returns:

  • (String)


1390
1391
1392
1393
1394
1395
1396
1397
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1390

class Listener < Struct.new(
  :protocol,
  :load_balancer_port,
  :instance_protocol,
  :instance_port,
  :ssl_certificate_id)
  include Aws::Structure
end

#ssl_certificate_idString

The Amazon Resource Name (ARN) of the server certificate.

Returns:

  • (String)


1390
1391
1392
1393
1394
1395
1396
1397
# File 'gems/aws-sdk-elasticloadbalancing/lib/aws-sdk-elasticloadbalancing/types.rb', line 1390

class Listener < Struct.new(
  :protocol,
  :load_balancer_port,
  :instance_protocol,
  :instance_port,
  :ssl_certificate_id)
  include Aws::Structure
end