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, Network Load Balancer, or Gateway Load Balancer.
For more information, see the following:
This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple listeners with the same settings, each call succeeds.
Namespace: Amazon.ElasticLoadBalancingV2.Model
Assembly: AWSSDK.ElasticLoadBalancingV2.dll
Version: 3.x.y.z
public class CreateListenerRequest : AmazonElasticLoadBalancingV2Request IAmazonWebServiceRequest
The CreateListenerRequest type exposes the following members
Name | Description | |
---|---|---|
CreateListenerRequest() |
Name | Type | Description | |
---|---|---|---|
AlpnPolicy | System.Collections.Generic.List<System.String> |
Gets and sets the property AlpnPolicy. [TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy. You can specify one policy name. The following are the possible values:
For more information, see ALPN policies in the Network Load Balancers Guide. |
|
Certificates | System.Collections.Generic.List<Amazon.ElasticLoadBalancingV2.Model.Certificate> |
Gets and sets the property Certificates.
[HTTPS and TLS listeners] The default certificate for the listener. You must provide
exactly one certificate. Set |
|
DefaultActions | System.Collections.Generic.List<Amazon.ElasticLoadBalancingV2.Model.Action> |
Gets and sets the property DefaultActions. The actions for the default rule. |
|
LoadBalancerArn | System.String |
Gets and sets the property LoadBalancerArn. The Amazon Resource Name (ARN) of the load balancer. |
|
MutualAuthentication | Amazon.ElasticLoadBalancingV2.Model.MutualAuthenticationAttributes |
Gets and sets the property MutualAuthentication. The mutual authentication configuration information. |
|
Port | System.Int32 |
Gets and sets the property Port. The port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer. |
|
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 protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer. |
|
SslPolicy | System.String |
Gets and sets the property SslPolicy. [HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. For more information, see Security policies in the Application Load Balancers Guide and Security policies in the Network Load Balancers Guide. |
|
Tags | System.Collections.Generic.List<Amazon.ElasticLoadBalancingV2.Model.Tag> |
Gets and sets the property Tags. The tags to assign to the listener. |
This example creates an HTTP listener for the specified load balancer that forwards requests to the specified target group.
var client = new AmazonElasticLoadBalancingV2Client(); var response = client.CreateListener(new CreateListenerRequest { DefaultActions = new List<Action> { 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<Listener> 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).
var client = new AmazonElasticLoadBalancingV2Client(); var response = client.CreateListener(new CreateListenerRequest { Certificates = new List<Certificate> { new Certificate { CertificateArn = "arn:aws:iam::123456789012:server-certificate/my-server-cert" } }, DefaultActions = new List<Action> { 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<Listener> listeners = response.Listeners;
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5