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.

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.

Note:

For PCL this operation is only available in asynchronous form. Please refer to ModifyListenerAsync.

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

Syntax

C#
public abstract ModifyListenerResponse ModifyListener(
         ModifyListenerRequest request
)
Parameters
request
Type: Amazon.ElasticLoadBalancingV2.Model.ModifyListenerRequest

Container for the necessary parameters to execute the ModifyListener service method.

Return Value
The response from the ModifyListener service method, as returned by ElasticLoadBalancingV2.

Exceptions

ExceptionCondition
CertificateNotFoundException The specified certificate does not exist.
DuplicateListenerException A listener with the specified port already exists.
IncompatibleProtocolsException The specified configuration is not valid with this protocol.
InvalidConfigurationRequestException The requested configuration is not valid.
ListenerNotFoundException The specified listener does not exist.
SSLPolicyNotFoundException The specified SSL policy does not exist.
TargetGroupAssociationLimitException You've reached the limit on the number of load balancers per target group.
TargetGroupNotFoundException The specified target group does not exist.
TooManyCertificatesException You've reached the limit on the number of certificates per listener.
TooManyListenersException You've reached the limit on the number of listeners per load balancer.
TooManyRegistrationsForTargetIdException You've reached the limit on the number of times a target can be registered with a load balancer.
TooManyTargetsException You've reached the limit on the number of targets.
UnsupportedProtocolException The specified protocol is not supported.

Examples

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 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

See Also