AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateListener operation. Creates a listener for the specified Application Load Balancer or Network Load Balancer.

You can create up to 10 listeners per load balancer.

To update a listener, use ModifyListener. When you are finished with a listener, you can delete it using DeleteListener. If you are finished with both the listener and the load balancer, you can delete them both using DeleteLoadBalancer.

For more information, see Listeners for Your Application Load Balancers in the Application Load Balancers Guide and Listeners for Your Network Load Balancers in the Network Load Balancers Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ElasticLoadBalancingV2.AmazonElasticLoadBalancingV2Request
      Amazon.ElasticLoadBalancingV2.Model.CreateListenerRequest

Namespace: Amazon.ElasticLoadBalancingV2.Model
Assembly: AWSSDK.ElasticLoadBalancingV2.dll
Version: 3.x.y.z

Syntax

C#
public class CreateListenerRequest : AmazonElasticLoadBalancingV2Request
         IAmazonWebServiceRequest

The CreateListenerRequest type exposes the following members

Constructors

NameDescription
Public Method CreateListenerRequest()

Properties

NameTypeDescription
Public Property Certificates System.Collections.Generic.List<Amazon.ElasticLoadBalancingV2.Model.Certificate>

Gets and sets the property Certificates.

[HTTPS listeners] The SSL server certificate. You must provide exactly one certificate.

Public Property DefaultActions System.Collections.Generic.List<Amazon.ElasticLoadBalancingV2.Model.Action>

Gets and sets the property DefaultActions.

The default action for the listener. For Application Load Balancers, the protocol of the specified target group must be HTTP or HTTPS. For Network Load Balancers, the protocol of the specified target group must be TCP.

Public Property LoadBalancerArn System.String

Gets and sets the property LoadBalancerArn.

The Amazon Resource Name (ARN) of the load balancer.

Public Property Port System.Int32

Gets and sets the property Port.

The port on which the load balancer is listening.

Public Property Protocol Amazon.ElasticLoadBalancingV2.ProtocolEnum

Gets and sets the property Protocol.

The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocol is TCP.

Public Property SslPolicy System.String

Gets and sets the property SslPolicy.

[HTTPS listeners] The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.

Examples

This example creates an HTTP listener for the specified load balancer that forwards requests to the specified target group.

To create an HTTP listener


var response = client.CreateListener(new CreateListenerRequest 
{
    DefaultActions = new List {
        new Action {
            TargetGroupArn = "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
            Type = "forward"
        }
    },
    LoadBalancerArn = "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
    Port = 80,
    Protocol = "HTTP"
});

List listeners = response.Listeners;

            

This example creates an HTTPS listener for the specified load balancer that forwards requests to the specified target group. Note that you must specify an SSL certificate for an HTTPS listener. You can create and manage certificates using AWS Certificate Manager (ACM). Alternatively, you can create a certificate using SSL/TLS tools, get the certificate signed by a certificate authority (CA), and upload the certificate to AWS Identity and Access Management (IAM).

To create an HTTPS listener


var response = client.CreateListener(new CreateListenerRequest 
{
    Certificates = new List {
        new Certificate { CertificateArn = "arn:aws:iam::123456789012:server-certificate/my-server-cert" }
    },
    DefaultActions = new List {
        new Action {
            TargetGroupArn = "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
            Type = "forward"
        }
    },
    LoadBalancerArn = "arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188",
    Port = 443,
    Protocol = "HTTPS",
    SslPolicy = "ELBSecurityPolicy-2015-05"
});

List listeners = response.Listeners;

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms