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 ModifyListener operation. Modifies the specified properties of the specified listener.

Any properties that you do not specify retain their current values. However, changing the protocol from HTTPS to HTTP removes the security policy and SSL certificate properties. If you change the protocol from HTTP to HTTPS, you must add the security policy and server certificate.

Inheritance Hierarchy


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


public class ModifyListenerRequest : AmazonElasticLoadBalancingV2Request

The ModifyListenerRequest type exposes the following members


Public Method ModifyListenerRequest()


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

Gets and sets the property Certificates.

[HTTPS listeners] The default SSL server certificate. You must provide exactly one default certificate. To create a certificate list, use AddListenerCertificates.

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

Gets and sets the property DefaultActions.

The actions for the default rule. The rule must include one forward action or one or more fixed-response actions.

If the action type is forward, you can specify a single target group. The protocol of the target group must be HTTP or HTTPS for an Application Load Balancer or TCP for a Network Load Balancer.

[HTTPS listener] If the action type is authenticate-oidc, you can use an identity provider that is OpenID Connect (OIDC) compliant to authenticate users as they access your application.

[HTTPS listener] If the action type is authenticate-cognito, you can use Amazon Cognito to authenticate users as they access your application.

[Application Load Balancer] If the action type is redirect, you can redirect HTTP and HTTPS requests.

[Application Load Balancer] If the action type is fixed-response, you can return a custom HTTP response.

Public Property ListenerArn System.String

Gets and sets the property ListenerArn.

The Amazon Resource Name (ARN) of the listener.

Public Property Port System.Int32

Gets and sets the property Port.

The port for connections from clients to the load balancer.

Public Property Protocol Amazon.ElasticLoadBalancingV2.ProtocolEnum

Gets and sets the property Protocol.

The protocol for connections from clients to the load balancer. Application Load Balancers support HTTP and HTTPS and Network Load Balancers support TCP.

Public Property SslPolicy System.String

Gets and sets the property SslPolicy.

[HTTPS listeners] The security policy that defines which protocols and ciphers are supported. For more information, see Security Policies in the Application Load Balancers Guide.


This example changes the default action for the specified listener.

To change the default action for a listener

var response = client.ModifyListener(new ModifyListenerRequest 
    DefaultActions = new List {
        new Action {
            TargetGroupArn = "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-new-targets/2453ed029918f21f",
            Type = "forward"
    ListenerArn = "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/f2f7dc8efc522ab2"

List listeners = response.Listeners;


This example changes the server certificate for the specified HTTPS listener.

To change the server certificate

var response = client.ModifyListener(new ModifyListenerRequest 
    Certificates = new List {
        new Certificate { CertificateArn = "arn:aws:iam::123456789012:server-certificate/my-new-server-cert" }
    ListenerArn = "arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/my-load-balancer/50dc6c495c0c9188/0467ef3c8400ae65"

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