IAmazonElasticLoadBalancingV2.ModifyListener Method (ModifyListenerRequest)

Replaces the specified properties of the specified listener. Any properties that you do not specify remain unchanged.

Changing the protocol from HTTPS to HTTP, or from TLS to TCP, removes the security policy and default certificate properties. If you change the protocol from HTTP to HTTPS, or from TCP to TLS, you must add the security policy and default certificate properties.

To add an item to a list, remove an item from a list, or update an item in a list, you must provide the entire list. For example, to add an action, specify a list with the current actions plus the new action.

Note:

For .NET Core 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

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

Type: ModifyListenerResponse

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

Exceptions

Exception	Condition
ALPNPolicyNotSupportedException	The specified ALPN policy is not supported.
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.
InvalidLoadBalancerActionException	The requested action 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.
TooManyActionsException	You've reached the limit on the number of actions per rule.
TooManyCertificatesException	You've reached the limit on the number of certificates per load balancer.
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.
TooManyUniqueTargetGroupsPerLoadBalancerException	You've reached the limit on the number of unique target groups per load balancer across all listeners. If a target group is used by multiple actions for a load balancer, it is counted as only one use.
TrustStoreNotFoundException	The specified trust store does not exist.
TrustStoreNotReadyException	The specified trust store is not active.
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 client = new AmazonElasticLoadBalancingV2Client();
var response = client.ModifyListener(new ModifyListenerRequest 
{
    DefaultActions = new List<Action> {
        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<Listener> listeners = response.Listeners;

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

To change the server certificate


var client = new AmazonElasticLoadBalancingV2Client();
var response = client.ModifyListener(new ModifyListenerRequest 
{
    Certificates = new List<Certificate> {
        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<Listener> listeners = response.Listeners;

Version Information

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

IAmazonElasticLoadBalancingV2.ModifyListener (ModifyListenerRequest)

Method