AWSElasticLoadBalancing

Objective-C

@interface AWSElasticLoadBalancing

Swift

class AWSElasticLoadBalancing

Elastic Load Balancing

A load balancer distributes incoming traffic across targets, such as your EC2 instances. This enables you to increase the availability of your application. The load balancer also monitors the health of its registered targets and ensures that it routes traffic only to healthy targets. You configure your load balancer to accept incoming traffic by specifying one or more listeners, which are configured with a protocol and port number for connections from clients to the load balancer. You configure a target group with a protocol and port number for connections from the load balancer to the targets, and with health check settings to be used when checking the health status of the targets.

Elastic Load Balancing supports the following types of load balancers: Application Load Balancers, Network Load Balancers, and Classic Load Balancers. This reference covers Application Load Balancers and Network Load Balancers.

An Application Load Balancer makes routing and load balancing decisions at the application layer (HTTP/HTTPS). A Network Load Balancer makes routing and load balancing decisions at the transport layer (TCP/TLS). Both Application Load Balancers and Network Load Balancers can route requests to one or more ports on each EC2 instance or container instance in your virtual private cloud (VPC). For more information, see the Elastic Load Balancing User Guide.

All Elastic Load Balancing operations are idempotent, which means that they complete at most one time. If you repeat an operation, it succeeds.

  • The service configuration used to instantiate this service client.

    Warning

    Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration

    Swift

    var configuration: UnsafeMutablePointer<Int32> { get }
  • Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with defaultServiceConfiguration from [AWSServiceManager defaultServiceManager]. The reference to this object is maintained by the SDK, and you do not need to retain it manually.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
       let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
       let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider)
       AWSServiceManager.default().defaultServiceConfiguration = configuration
    
       return true
    

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
         AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                         identityPoolId:@"YourIdentityPoolId"];
         AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1
                                                                              credentialsProvider:credentialsProvider];
         [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration;
    
         return YES;
     }
    

    Then call the following to get the default service client:

    Swift

    let ElasticLoadBalancing = AWSElasticLoadBalancing.default()
    

    Objective-C

    AWSElasticLoadBalancing *ElasticLoadBalancing = [AWSElasticLoadBalancing defaultElasticLoadBalancing];
    

    Declaration

    Objective-C

    + (nonnull instancetype)defaultElasticLoadBalancing;

    Swift

    class func `default`() -> Self

    Return Value

    The default service client.

  • Creates a service client with the given service configuration and registers it for the key.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
       let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
       let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
       AWSElasticLoadBalancing.register(with: configuration!, forKey: "USWest2ElasticLoadBalancing")
    
       return true
    

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
        AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                        identityPoolId:@"YourIdentityPoolId"];
        AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                             credentialsProvider:credentialsProvider];
    
        [AWSElasticLoadBalancing registerElasticLoadBalancingWithConfiguration:configuration forKey:@"USWest2ElasticLoadBalancing"];
    
        return YES;
    }
    

    Then call the following to get the service client:

    Swift

    let ElasticLoadBalancing = AWSElasticLoadBalancing(forKey: "USWest2ElasticLoadBalancing")
    

    Objective-C

    AWSElasticLoadBalancing *ElasticLoadBalancing = [AWSElasticLoadBalancing ElasticLoadBalancingForKey:@"USWest2ElasticLoadBalancing"];
    

    Warning

    After calling this method, do not modify the configuration object. It may cause unspecified behaviors.

    Declaration

    Objective-C

    + (void)registerElasticLoadBalancingWithConfiguration:(id)configuration
                                                   forKey:(nonnull NSString *)key;

    Swift

    class func register(withConfiguration configuration: Any!, forKey key: String)

    Parameters

    configuration

    A service configuration object.

    key

    A string to identify the service client.

  • Retrieves the service client associated with the key. You need to call + registerElasticLoadBalancingWithConfiguration:forKey: before invoking this method.

    For example, set the default service configuration in - application:didFinishLaunchingWithOptions:

    Swift

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
       let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId")
       let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider)
       AWSElasticLoadBalancing.register(with: configuration!, forKey: "USWest2ElasticLoadBalancing")
    
       return true
    

    }

    Objective-C

    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
        AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1
                                                                                                        identityPoolId:@"YourIdentityPoolId"];
        AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2
                                                                             credentialsProvider:credentialsProvider];
    
        [AWSElasticLoadBalancing registerElasticLoadBalancingWithConfiguration:configuration forKey:@"USWest2ElasticLoadBalancing"];
    
        return YES;
    }
    

    Then call the following to get the service client:

    Swift

    let ElasticLoadBalancing = AWSElasticLoadBalancing(forKey: "USWest2ElasticLoadBalancing")
    

    Objective-C

    AWSElasticLoadBalancing *ElasticLoadBalancing = [AWSElasticLoadBalancing ElasticLoadBalancingForKey:@"USWest2ElasticLoadBalancing"];
    

    Declaration

    Objective-C

    + (nonnull instancetype)ElasticLoadBalancingForKey:(nonnull NSString *)key;

    Swift

    convenience init(forKey key: String)

    Parameters

    key

    A string to identify the service client.

    Return Value

    An instance of the service client.

  • Removes the service client associated with the key and release it.

    Warning

    Before calling this method, make sure no method is running on this client.

    Declaration

    Objective-C

    + (void)removeElasticLoadBalancingForKey:(nonnull NSString *)key;

    Swift

    class func remove(forKey key: String)

    Parameters

    key

    A string to identify the service client.

  • Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener.

    If the certificate in already in the certificate list, the call is successful but the certificate is not added again.

    To get the certificate list for a listener, use DescribeListenerCertificates. To remove certificates from the certificate list for a listener, use RemoveListenerCertificates. To replace the default certificate for a listener, use ModifyListener.

    For more information, see SSL Certificates in the Application Load Balancers Guide.

    See

    AWSElasticLoadBalancingAddListenerCertificatesInput

    See

    AWSElasticLoadBalancingAddListenerCertificatesOutput

    Declaration

    Objective-C

    - (id)addListenerCertificates:
        (nonnull AWSElasticLoadBalancingAddListenerCertificatesInput *)request;

    Swift

    func addListenerCertificates(_ request: AWSElasticLoadBalancingAddListenerCertificatesInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the AddListenerCertificates service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingAddListenerCertificatesOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorListenerNotFound, AWSElasticLoadBalancingErrorTooManyCertificates, AWSElasticLoadBalancingErrorCertificateNotFound.

  • Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener.

    If the certificate in already in the certificate list, the call is successful but the certificate is not added again.

    To get the certificate list for a listener, use DescribeListenerCertificates. To remove certificates from the certificate list for a listener, use RemoveListenerCertificates. To replace the default certificate for a listener, use ModifyListener.

    For more information, see SSL Certificates in the Application Load Balancers Guide.

    See

    AWSElasticLoadBalancingAddListenerCertificatesInput

    See

    AWSElasticLoadBalancingAddListenerCertificatesOutput

    Declaration

    Objective-C

    - (void)addListenerCertificates:
                (nonnull AWSElasticLoadBalancingAddListenerCertificatesInput *)
                    request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSElasticLoadBalancingAddListenerCertificatesOutput
                              *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func addListenerCertificates(_ request: AWSElasticLoadBalancingAddListenerCertificatesInput, completionHandler: ((AWSElasticLoadBalancingAddListenerCertificatesOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the AddListenerCertificates service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorListenerNotFound, AWSElasticLoadBalancingErrorTooManyCertificates, AWSElasticLoadBalancingErrorCertificateNotFound.

  • Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, target groups, listeners, and rules.

    Each tag consists of a key and an optional value. If a resource already has a tag with the same key, AddTags updates its value.

    To list the current tags for your resources, use DescribeTags. To remove tags from your resources, use RemoveTags.

    See

    AWSElasticLoadBalancingAddTagsInput

    See

    AWSElasticLoadBalancingAddTagsOutput

    Declaration

    Objective-C

    - (id)addTags:(nonnull AWSElasticLoadBalancingAddTagsInput *)request;

    Swift

    func addTags(_ request: AWSElasticLoadBalancingAddTagsInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the AddTags service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingAddTagsOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorDuplicateTagKeys, AWSElasticLoadBalancingErrorTooManyTags, AWSElasticLoadBalancingErrorLoadBalancerNotFound, AWSElasticLoadBalancingErrorTargetGroupNotFound.

  • Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your Application Load Balancers, Network Load Balancers, target groups, listeners, and rules.

    Each tag consists of a key and an optional value. If a resource already has a tag with the same key, AddTags updates its value.

    To list the current tags for your resources, use DescribeTags. To remove tags from your resources, use RemoveTags.

    See

    AWSElasticLoadBalancingAddTagsInput

    See

    AWSElasticLoadBalancingAddTagsOutput

    Declaration

    Objective-C

    - (void)addTags:(nonnull AWSElasticLoadBalancingAddTagsInput *)request
        completionHandler:
            (void (^_Nullable)(AWSElasticLoadBalancingAddTagsOutput *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func addTags(_ request: AWSElasticLoadBalancingAddTagsInput, completionHandler: ((AWSElasticLoadBalancingAddTagsOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the AddTags service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorDuplicateTagKeys, AWSElasticLoadBalancingErrorTooManyTags, AWSElasticLoadBalancingErrorLoadBalancerNotFound, AWSElasticLoadBalancingErrorTargetGroupNotFound.

  • Creates a listener for the specified Application Load Balancer or Network 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.

    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.

    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.

    See

    AWSElasticLoadBalancingCreateListenerInput

    See

    AWSElasticLoadBalancingCreateListenerOutput

    Declaration

    Objective-C

    - (id)createListener:
        (nonnull AWSElasticLoadBalancingCreateListenerInput *)request;

    Swift

    func createListener(_ request: AWSElasticLoadBalancingCreateListenerInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateListener service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingCreateListenerOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorDuplicateListener, AWSElasticLoadBalancingErrorTooManyListeners, AWSElasticLoadBalancingErrorTooManyCertificates, AWSElasticLoadBalancingErrorLoadBalancerNotFound, AWSElasticLoadBalancingErrorTargetGroupNotFound, AWSElasticLoadBalancingErrorTargetGroupAssociationLimit, AWSElasticLoadBalancingErrorInvalidConfigurationRequest, AWSElasticLoadBalancingErrorIncompatibleProtocols, AWSElasticLoadBalancingErrorSSLPolicyNotFound, AWSElasticLoadBalancingErrorCertificateNotFound, AWSElasticLoadBalancingErrorUnsupportedProtocol, AWSElasticLoadBalancingErrorTooManyRegistrationsForTargetId, AWSElasticLoadBalancingErrorTooManyTargets, AWSElasticLoadBalancingErrorTooManyActions, AWSElasticLoadBalancingErrorInvalidLoadBalancerAction, AWSElasticLoadBalancingErrorTooManyUniqueTargetGroupsPerLoadBalancer, AWSElasticLoadBalancingErrorALPNPolicyNotSupported, AWSElasticLoadBalancingErrorTooManyTags.

  • Creates a listener for the specified Application Load Balancer or Network 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.

    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.

    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.

    See

    AWSElasticLoadBalancingCreateListenerInput

    See

    AWSElasticLoadBalancingCreateListenerOutput

    Declaration

    Objective-C

    - (void)createListener:
                (nonnull AWSElasticLoadBalancingCreateListenerInput *)request
         completionHandler:
             (void (^_Nullable)(
                 AWSElasticLoadBalancingCreateListenerOutput *_Nullable,
                 NSError *_Nullable))completionHandler;

    Swift

    func createListener(_ request: AWSElasticLoadBalancingCreateListenerInput, completionHandler: ((AWSElasticLoadBalancingCreateListenerOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the CreateListener service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorDuplicateListener, AWSElasticLoadBalancingErrorTooManyListeners, AWSElasticLoadBalancingErrorTooManyCertificates, AWSElasticLoadBalancingErrorLoadBalancerNotFound, AWSElasticLoadBalancingErrorTargetGroupNotFound, AWSElasticLoadBalancingErrorTargetGroupAssociationLimit, AWSElasticLoadBalancingErrorInvalidConfigurationRequest, AWSElasticLoadBalancingErrorIncompatibleProtocols, AWSElasticLoadBalancingErrorSSLPolicyNotFound, AWSElasticLoadBalancingErrorCertificateNotFound, AWSElasticLoadBalancingErrorUnsupportedProtocol, AWSElasticLoadBalancingErrorTooManyRegistrationsForTargetId, AWSElasticLoadBalancingErrorTooManyTargets, AWSElasticLoadBalancingErrorTooManyActions, AWSElasticLoadBalancingErrorInvalidLoadBalancerAction, AWSElasticLoadBalancingErrorTooManyUniqueTargetGroupsPerLoadBalancer, AWSElasticLoadBalancingErrorALPNPolicyNotSupported, AWSElasticLoadBalancingErrorTooManyTags.

  • Creates an Application Load Balancer or a Network Load Balancer.

    When you create a load balancer, you can specify security groups, public subnets, IP address type, and tags. Otherwise, you could do so later using SetSecurityGroups, SetSubnets, SetIpAddressType, and AddTags.

    To create listeners for your load balancer, use CreateListener. To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer.

    For limit information, see Limits for Your Application Load Balancer in the Application Load Balancers Guide and Limits for Your Network Load Balancer in the Network Load Balancers Guide.

    This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds.

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

    See

    AWSElasticLoadBalancingCreateLoadBalancerInput

    See

    AWSElasticLoadBalancingCreateLoadBalancerOutput

    Declaration

    Objective-C

    - (id)createLoadBalancer:
        (nonnull AWSElasticLoadBalancingCreateLoadBalancerInput *)request;

    Swift

    func createLoadBalancer(_ request: AWSElasticLoadBalancingCreateLoadBalancerInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateLoadBalancer service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingCreateLoadBalancerOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorDuplicateLoadBalancerName, AWSElasticLoadBalancingErrorTooManyLoadBalancers, AWSElasticLoadBalancingErrorInvalidConfigurationRequest, AWSElasticLoadBalancingErrorSubnetNotFound, AWSElasticLoadBalancingErrorInvalidSubnet, AWSElasticLoadBalancingErrorInvalidSecurityGroup, AWSElasticLoadBalancingErrorInvalidScheme, AWSElasticLoadBalancingErrorTooManyTags, AWSElasticLoadBalancingErrorDuplicateTagKeys, AWSElasticLoadBalancingErrorResourceInUse, AWSElasticLoadBalancingErrorAllocationIdNotFound, AWSElasticLoadBalancingErrorAvailabilityZoneNotSupported, AWSElasticLoadBalancingErrorOperationNotPermitted.

  • Creates an Application Load Balancer or a Network Load Balancer.

    When you create a load balancer, you can specify security groups, public subnets, IP address type, and tags. Otherwise, you could do so later using SetSecurityGroups, SetSubnets, SetIpAddressType, and AddTags.

    To create listeners for your load balancer, use CreateListener. To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer.

    For limit information, see Limits for Your Application Load Balancer in the Application Load Balancers Guide and Limits for Your Network Load Balancer in the Network Load Balancers Guide.

    This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds.

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

    See

    AWSElasticLoadBalancingCreateLoadBalancerInput

    See

    AWSElasticLoadBalancingCreateLoadBalancerOutput

    Declaration

    Objective-C

    - (void)createLoadBalancer:
                (nonnull AWSElasticLoadBalancingCreateLoadBalancerInput *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSElasticLoadBalancingCreateLoadBalancerOutput *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func createLoadBalancer(_ request: AWSElasticLoadBalancingCreateLoadBalancerInput, completionHandler: ((AWSElasticLoadBalancingCreateLoadBalancerOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the CreateLoadBalancer service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorDuplicateLoadBalancerName, AWSElasticLoadBalancingErrorTooManyLoadBalancers, AWSElasticLoadBalancingErrorInvalidConfigurationRequest, AWSElasticLoadBalancingErrorSubnetNotFound, AWSElasticLoadBalancingErrorInvalidSubnet, AWSElasticLoadBalancingErrorInvalidSecurityGroup, AWSElasticLoadBalancingErrorInvalidScheme, AWSElasticLoadBalancingErrorTooManyTags, AWSElasticLoadBalancingErrorDuplicateTagKeys, AWSElasticLoadBalancingErrorResourceInUse, AWSElasticLoadBalancingErrorAllocationIdNotFound, AWSElasticLoadBalancingErrorAvailabilityZoneNotSupported, AWSElasticLoadBalancingErrorOperationNotPermitted.

  • Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer.

    Each rule consists of a priority, one or more actions, and one or more conditions. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener Rules in the Application Load Balancers Guide.

    To view your current rules, use DescribeRules. To update a rule, use ModifyRule. To set the priorities of your rules, use SetRulePriorities. To delete a rule, use DeleteRule.

    See

    AWSElasticLoadBalancingCreateRuleInput

    See

    AWSElasticLoadBalancingCreateRuleOutput

    Declaration

    Objective-C

    - (id)createRule:(nonnull AWSElasticLoadBalancingCreateRuleInput *)request;

    Swift

    func createRule(_ request: AWSElasticLoadBalancingCreateRuleInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateRule service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingCreateRuleOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorPriorityInUse, AWSElasticLoadBalancingErrorTooManyTargetGroups, AWSElasticLoadBalancingErrorTooManyRules, AWSElasticLoadBalancingErrorTargetGroupAssociationLimit, AWSElasticLoadBalancingErrorIncompatibleProtocols, AWSElasticLoadBalancingErrorListenerNotFound, AWSElasticLoadBalancingErrorTargetGroupNotFound, AWSElasticLoadBalancingErrorInvalidConfigurationRequest, AWSElasticLoadBalancingErrorTooManyRegistrationsForTargetId, AWSElasticLoadBalancingErrorTooManyTargets, AWSElasticLoadBalancingErrorUnsupportedProtocol, AWSElasticLoadBalancingErrorTooManyActions, AWSElasticLoadBalancingErrorInvalidLoadBalancerAction, AWSElasticLoadBalancingErrorTooManyUniqueTargetGroupsPerLoadBalancer, AWSElasticLoadBalancingErrorTooManyTags.

  • Creates a rule for the specified listener. The listener must be associated with an Application Load Balancer.

    Each rule consists of a priority, one or more actions, and one or more conditions. Rules are evaluated in priority order, from the lowest value to the highest value. When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, the actions for the default rule are performed. For more information, see Listener Rules in the Application Load Balancers Guide.

    To view your current rules, use DescribeRules. To update a rule, use ModifyRule. To set the priorities of your rules, use SetRulePriorities. To delete a rule, use DeleteRule.

    See

    AWSElasticLoadBalancingCreateRuleInput

    See

    AWSElasticLoadBalancingCreateRuleOutput

    Declaration

    Objective-C

    - (void)createRule:(nonnull AWSElasticLoadBalancingCreateRuleInput *)request
        completionHandler:
            (void (^_Nullable)(AWSElasticLoadBalancingCreateRuleOutput *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func createRule(_ request: AWSElasticLoadBalancingCreateRuleInput, completionHandler: ((AWSElasticLoadBalancingCreateRuleOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the CreateRule service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorPriorityInUse, AWSElasticLoadBalancingErrorTooManyTargetGroups, AWSElasticLoadBalancingErrorTooManyRules, AWSElasticLoadBalancingErrorTargetGroupAssociationLimit, AWSElasticLoadBalancingErrorIncompatibleProtocols, AWSElasticLoadBalancingErrorListenerNotFound, AWSElasticLoadBalancingErrorTargetGroupNotFound, AWSElasticLoadBalancingErrorInvalidConfigurationRequest, AWSElasticLoadBalancingErrorTooManyRegistrationsForTargetId, AWSElasticLoadBalancingErrorTooManyTargets, AWSElasticLoadBalancingErrorUnsupportedProtocol, AWSElasticLoadBalancingErrorTooManyActions, AWSElasticLoadBalancingErrorInvalidLoadBalancerAction, AWSElasticLoadBalancingErrorTooManyUniqueTargetGroupsPerLoadBalancer, AWSElasticLoadBalancingErrorTooManyTags.

  • Creates a target group.

    To register targets with the target group, use RegisterTargets. To update the health check settings for the target group, use ModifyTargetGroup. To monitor the health of targets in the target group, use DescribeTargetHealth.

    To route traffic to the targets in a target group, specify the target group in an action using CreateListener or CreateRule.

    To delete a target group, use DeleteTargetGroup.

    This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds.

    For more information, see Target Groups for Your Application Load Balancers in the Application Load Balancers Guide or Target Groups for Your Network Load Balancers in the Network Load Balancers Guide.

    See

    AWSElasticLoadBalancingCreateTargetGroupInput

    See

    AWSElasticLoadBalancingCreateTargetGroupOutput

    Declaration

    Objective-C

    - (id)createTargetGroup:
        (nonnull AWSElasticLoadBalancingCreateTargetGroupInput *)request;

    Swift

    func createTargetGroup(_ request: AWSElasticLoadBalancingCreateTargetGroupInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateTargetGroup service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingCreateTargetGroupOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorDuplicateTargetGroupName, AWSElasticLoadBalancingErrorTooManyTargetGroups, AWSElasticLoadBalancingErrorInvalidConfigurationRequest, AWSElasticLoadBalancingErrorTooManyTags.

  • Creates a target group.

    To register targets with the target group, use RegisterTargets. To update the health check settings for the target group, use ModifyTargetGroup. To monitor the health of targets in the target group, use DescribeTargetHealth.

    To route traffic to the targets in a target group, specify the target group in an action using CreateListener or CreateRule.

    To delete a target group, use DeleteTargetGroup.

    This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple target groups with the same settings, each call succeeds.

    For more information, see Target Groups for Your Application Load Balancers in the Application Load Balancers Guide or Target Groups for Your Network Load Balancers in the Network Load Balancers Guide.

    See

    AWSElasticLoadBalancingCreateTargetGroupInput

    See

    AWSElasticLoadBalancingCreateTargetGroupOutput

    Declaration

    Objective-C

    - (void)createTargetGroup:
                (nonnull AWSElasticLoadBalancingCreateTargetGroupInput *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSElasticLoadBalancingCreateTargetGroupOutput *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func createTargetGroup(_ request: AWSElasticLoadBalancingCreateTargetGroupInput, completionHandler: ((AWSElasticLoadBalancingCreateTargetGroupOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the CreateTargetGroup service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorDuplicateTargetGroupName, AWSElasticLoadBalancingErrorTooManyTargetGroups, AWSElasticLoadBalancingErrorInvalidConfigurationRequest, AWSElasticLoadBalancingErrorTooManyTags.

  • Deletes the specified listener.

    Alternatively, your listener is deleted when you delete the load balancer to which it is attached, using DeleteLoadBalancer.

    See

    AWSElasticLoadBalancingDeleteListenerInput

    See

    AWSElasticLoadBalancingDeleteListenerOutput

    Declaration

    Objective-C

    - (id)deleteListener:
        (nonnull AWSElasticLoadBalancingDeleteListenerInput *)request;

    Swift

    func deleteListener(_ request: AWSElasticLoadBalancingDeleteListenerInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteListener service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingDeleteListenerOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorListenerNotFound.

  • Deletes the specified listener.

    Alternatively, your listener is deleted when you delete the load balancer to which it is attached, using DeleteLoadBalancer.

    See

    AWSElasticLoadBalancingDeleteListenerInput

    See

    AWSElasticLoadBalancingDeleteListenerOutput

    Declaration

    Objective-C

    - (void)deleteListener:
                (nonnull AWSElasticLoadBalancingDeleteListenerInput *)request
         completionHandler:
             (void (^_Nullable)(
                 AWSElasticLoadBalancingDeleteListenerOutput *_Nullable,
                 NSError *_Nullable))completionHandler;

    Swift

    func deleteListener(_ request: AWSElasticLoadBalancingDeleteListenerInput, completionHandler: ((AWSElasticLoadBalancingDeleteListenerOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DeleteListener service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorListenerNotFound.

  • Deletes the specified Application Load Balancer or Network Load Balancer and its attached listeners.

    You can’t delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds.

    Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them.

    See

    AWSElasticLoadBalancingDeleteLoadBalancerInput

    See

    AWSElasticLoadBalancingDeleteLoadBalancerOutput

    Declaration

    Objective-C

    - (id)deleteLoadBalancer:
        (nonnull AWSElasticLoadBalancingDeleteLoadBalancerInput *)request;

    Swift

    func deleteLoadBalancer(_ request: AWSElasticLoadBalancingDeleteLoadBalancerInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteLoadBalancer service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingDeleteLoadBalancerOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorLoadBalancerNotFound, AWSElasticLoadBalancingErrorOperationNotPermitted, AWSElasticLoadBalancingErrorResourceInUse.

  • Deletes the specified Application Load Balancer or Network Load Balancer and its attached listeners.

    You can’t delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds.

    Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them.

    See

    AWSElasticLoadBalancingDeleteLoadBalancerInput

    See

    AWSElasticLoadBalancingDeleteLoadBalancerOutput

    Declaration

    Objective-C

    - (void)deleteLoadBalancer:
                (nonnull AWSElasticLoadBalancingDeleteLoadBalancerInput *)request
             completionHandler:
                 (void (^_Nullable)(
                     AWSElasticLoadBalancingDeleteLoadBalancerOutput *_Nullable,
                     NSError *_Nullable))completionHandler;

    Swift

    func deleteLoadBalancer(_ request: AWSElasticLoadBalancingDeleteLoadBalancerInput, completionHandler: ((AWSElasticLoadBalancingDeleteLoadBalancerOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DeleteLoadBalancer service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorLoadBalancerNotFound, AWSElasticLoadBalancingErrorOperationNotPermitted, AWSElasticLoadBalancingErrorResourceInUse.

  • Deletes the specified rule.

    You can’t delete the default rule.

    See

    AWSElasticLoadBalancingDeleteRuleInput

    See

    AWSElasticLoadBalancingDeleteRuleOutput

    Declaration

    Objective-C

    - (id)deleteRule:(nonnull AWSElasticLoadBalancingDeleteRuleInput *)request;

    Swift

    func deleteRule(_ request: AWSElasticLoadBalancingDeleteRuleInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteRule service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingDeleteRuleOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorRuleNotFound, AWSElasticLoadBalancingErrorOperationNotPermitted.

  • Deletes the specified rule.

    You can’t delete the default rule.

    See

    AWSElasticLoadBalancingDeleteRuleInput

    See

    AWSElasticLoadBalancingDeleteRuleOutput

    Declaration

    Objective-C

    - (void)deleteRule:(nonnull AWSElasticLoadBalancingDeleteRuleInput *)request
        completionHandler:
            (void (^_Nullable)(AWSElasticLoadBalancingDeleteRuleOutput *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func deleteRule(_ request: AWSElasticLoadBalancingDeleteRuleInput, completionHandler: ((AWSElasticLoadBalancingDeleteRuleOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DeleteRule service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorRuleNotFound, AWSElasticLoadBalancingErrorOperationNotPermitted.

  • Deletes the specified target group.

    You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks.

    See

    AWSElasticLoadBalancingDeleteTargetGroupInput

    See

    AWSElasticLoadBalancingDeleteTargetGroupOutput

    Declaration

    Objective-C

    - (id)deleteTargetGroup:
        (nonnull AWSElasticLoadBalancingDeleteTargetGroupInput *)request;

    Swift

    func deleteTargetGroup(_ request: AWSElasticLoadBalancingDeleteTargetGroupInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteTargetGroup service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingDeleteTargetGroupOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorResourceInUse.

  • Deletes the specified target group.

    You can delete a target group if it is not referenced by any actions. Deleting a target group also deletes any associated health checks.

    See

    AWSElasticLoadBalancingDeleteTargetGroupInput

    See

    AWSElasticLoadBalancingDeleteTargetGroupOutput

    Declaration

    Objective-C

    - (void)deleteTargetGroup:
                (nonnull AWSElasticLoadBalancingDeleteTargetGroupInput *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSElasticLoadBalancingDeleteTargetGroupOutput *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func deleteTargetGroup(_ request: AWSElasticLoadBalancingDeleteTargetGroupInput, completionHandler: ((AWSElasticLoadBalancingDeleteTargetGroupOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DeleteTargetGroup service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorResourceInUse.

  • Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.

    See

    AWSElasticLoadBalancingDeregisterTargetsInput

    See

    AWSElasticLoadBalancingDeregisterTargetsOutput

    Declaration

    Objective-C

    - (id)deregisterTargets:
        (nonnull AWSElasticLoadBalancingDeregisterTargetsInput *)request;

    Swift

    func deregisterTargets(_ request: AWSElasticLoadBalancingDeregisterTargetsInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeregisterTargets service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingDeregisterTargetsOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorTargetGroupNotFound, AWSElasticLoadBalancingErrorInvalidTarget.

  • Deregisters the specified targets from the specified target group. After the targets are deregistered, they no longer receive traffic from the load balancer.

    See

    AWSElasticLoadBalancingDeregisterTargetsInput

    See

    AWSElasticLoadBalancingDeregisterTargetsOutput

    Declaration

    Objective-C

    - (void)deregisterTargets:
                (nonnull AWSElasticLoadBalancingDeregisterTargetsInput *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSElasticLoadBalancingDeregisterTargetsOutput *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func deregisterTargets(_ request: AWSElasticLoadBalancingDeregisterTargetsInput, completionHandler: ((AWSElasticLoadBalancingDeregisterTargetsOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DeregisterTargets service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorTargetGroupNotFound, AWSElasticLoadBalancingErrorInvalidTarget.

  • Describes the current Elastic Load Balancing resource limits for your AWS account.

    For more information, see Limits for Your Application Load Balancers in the Application Load Balancer Guide or Limits for Your Network Load Balancers in the Network Load Balancers Guide.

    See

    AWSElasticLoadBalancingDescribeAccountLimitsInput

    See

    AWSElasticLoadBalancingDescribeAccountLimitsOutput

    Declaration

    Objective-C

    - (id)describeAccountLimits:
        (nonnull AWSElasticLoadBalancingDescribeAccountLimitsInput *)request;

    Swift

    func describeAccountLimits(_ request: AWSElasticLoadBalancingDescribeAccountLimitsInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeAccountLimits service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingDescribeAccountLimitsOutput.

  • Describes the current Elastic Load Balancing resource limits for your AWS account.

    For more information, see Limits for Your Application Load Balancers in the Application Load Balancer Guide or Limits for Your Network Load Balancers in the Network Load Balancers Guide.

    See

    AWSElasticLoadBalancingDescribeAccountLimitsInput

    See

    AWSElasticLoadBalancingDescribeAccountLimitsOutput

    Declaration

    Objective-C

    - (void)
        describeAccountLimits:
            (nonnull AWSElasticLoadBalancingDescribeAccountLimitsInput *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSElasticLoadBalancingDescribeAccountLimitsOutput *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func describeAccountLimits(_ request: AWSElasticLoadBalancingDescribeAccountLimitsInput, completionHandler: ((AWSElasticLoadBalancingDescribeAccountLimitsOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeAccountLimits service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful.

  • Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.

    If the default certificate is also in the certificate list, it appears twice in the results (once with IsDefault set to true and once with IsDefault set to false).

    For more information, see SSL Certificates in the Application Load Balancers Guide.

    See

    AWSElasticLoadBalancingDescribeListenerCertificatesInput

    See

    AWSElasticLoadBalancingDescribeListenerCertificatesOutput

    Declaration

    Objective-C

    - (id)describeListenerCertificates:
        (nonnull AWSElasticLoadBalancingDescribeListenerCertificatesInput *)request;

    Swift

    func describeListenerCertificates(_ request: AWSElasticLoadBalancingDescribeListenerCertificatesInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeListenerCertificates service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingDescribeListenerCertificatesOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorListenerNotFound.

  • Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.

    If the default certificate is also in the certificate list, it appears twice in the results (once with IsDefault set to true and once with IsDefault set to false).

    For more information, see SSL Certificates in the Application Load Balancers Guide.

    See

    AWSElasticLoadBalancingDescribeListenerCertificatesInput

    See

    AWSElasticLoadBalancingDescribeListenerCertificatesOutput

    Declaration

    Objective-C

    - (void)
        describeListenerCertificates:
            (nonnull AWSElasticLoadBalancingDescribeListenerCertificatesInput *)
                request
                   completionHandler:
                       (void (^_Nullable)(
                           AWSElasticLoadBalancingDescribeListenerCertificatesOutput
                               *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func describeListenerCertificates(_ request: AWSElasticLoadBalancingDescribeListenerCertificatesInput, completionHandler: ((AWSElasticLoadBalancingDescribeListenerCertificatesOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeListenerCertificates service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorListenerNotFound.

  • Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load Balancer. You must specify either a load balancer or one or more listeners.

    For an HTTPS or TLS listener, the output includes the default certificate for the listener. To describe the certificate list for the listener, use DescribeListenerCertificates.

    See

    AWSElasticLoadBalancingDescribeListenersInput

    See

    AWSElasticLoadBalancingDescribeListenersOutput

    Declaration

    Objective-C

    - (id)describeListeners:
        (nonnull AWSElasticLoadBalancingDescribeListenersInput *)request;

    Swift

    func describeListeners(_ request: AWSElasticLoadBalancingDescribeListenersInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeListeners service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingDescribeListenersOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorListenerNotFound, AWSElasticLoadBalancingErrorLoadBalancerNotFound, AWSElasticLoadBalancingErrorUnsupportedProtocol.

  • Describes the specified listeners or the listeners for the specified Application Load Balancer or Network Load Balancer. You must specify either a load balancer or one or more listeners.

    For an HTTPS or TLS listener, the output includes the default certificate for the listener. To describe the certificate list for the listener, use DescribeListenerCertificates.

    See

    AWSElasticLoadBalancingDescribeListenersInput

    See

    AWSElasticLoadBalancingDescribeListenersOutput

    Declaration

    Objective-C

    - (void)describeListeners:
                (nonnull AWSElasticLoadBalancingDescribeListenersInput *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSElasticLoadBalancingDescribeListenersOutput *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func describeListeners(_ request: AWSElasticLoadBalancingDescribeListenersInput, completionHandler: ((AWSElasticLoadBalancingDescribeListenersOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeListeners service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorListenerNotFound, AWSElasticLoadBalancingErrorLoadBalancerNotFound, AWSElasticLoadBalancingErrorUnsupportedProtocol.

  • Describes the attributes for the specified Application Load Balancer or Network Load Balancer.

    For more information, see Load Balancer Attributes in the Application Load Balancers Guide or Load Balancer Attributes in the Network Load Balancers Guide.

    See

    AWSElasticLoadBalancingDescribeLoadBalancerAttributesInput

    See

    AWSElasticLoadBalancingDescribeLoadBalancerAttributesOutput

    Declaration

    Objective-C

    - (id)describeLoadBalancerAttributes:
        (nonnull AWSElasticLoadBalancingDescribeLoadBalancerAttributesInput *)
            request;

    Swift

    func describeLoadBalancerAttributes(_ request: AWSElasticLoadBalancingDescribeLoadBalancerAttributesInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeLoadBalancerAttributes service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingDescribeLoadBalancerAttributesOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorLoadBalancerNotFound.

  • Describes the attributes for the specified Application Load Balancer or Network Load Balancer.

    For more information, see Load Balancer Attributes in the Application Load Balancers Guide or Load Balancer Attributes in the Network Load Balancers Guide.

    See

    AWSElasticLoadBalancingDescribeLoadBalancerAttributesInput

    See

    AWSElasticLoadBalancingDescribeLoadBalancerAttributesOutput

    Declaration

    Objective-C

    - (void)
        describeLoadBalancerAttributes:
            (nonnull AWSElasticLoadBalancingDescribeLoadBalancerAttributesInput *)
                request
                     completionHandler:
                         (void (^_Nullable)(
                             AWSElasticLoadBalancingDescribeLoadBalancerAttributesOutput
                                 *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func describeLoadBalancerAttributes(_ request: AWSElasticLoadBalancingDescribeLoadBalancerAttributesInput, completionHandler: ((AWSElasticLoadBalancingDescribeLoadBalancerAttributesOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeLoadBalancerAttributes service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorLoadBalancerNotFound.

  • Describes the specified load balancers or all of your load balancers.

    To describe the listeners for a load balancer, use DescribeListeners. To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes.

    See

    AWSElasticLoadBalancingDescribeLoadBalancersInput

    See

    AWSElasticLoadBalancingDescribeLoadBalancersOutput

    Declaration

    Objective-C

    - (id)describeLoadBalancers:
        (nonnull AWSElasticLoadBalancingDescribeLoadBalancersInput *)request;

    Swift

    func describeLoadBalancers(_ request: AWSElasticLoadBalancingDescribeLoadBalancersInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeLoadBalancers service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingDescribeLoadBalancersOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorLoadBalancerNotFound.

  • Describes the specified load balancers or all of your load balancers.

    To describe the listeners for a load balancer, use DescribeListeners. To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes.

    See

    AWSElasticLoadBalancingDescribeLoadBalancersInput

    See

    AWSElasticLoadBalancingDescribeLoadBalancersOutput

    Declaration

    Objective-C

    - (void)
        describeLoadBalancers:
            (nonnull AWSElasticLoadBalancingDescribeLoadBalancersInput *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSElasticLoadBalancingDescribeLoadBalancersOutput *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func describeLoadBalancers(_ request: AWSElasticLoadBalancingDescribeLoadBalancersInput, completionHandler: ((AWSElasticLoadBalancingDescribeLoadBalancersOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeLoadBalancers service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorLoadBalancerNotFound.

  • Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.

    See

    AWSElasticLoadBalancingDescribeRulesInput

    See

    AWSElasticLoadBalancingDescribeRulesOutput

    Declaration

    Objective-C

    - (id)describeRules:
        (nonnull AWSElasticLoadBalancingDescribeRulesInput *)request;

    Swift

    func describeRules(_ request: AWSElasticLoadBalancingDescribeRulesInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeRules service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingDescribeRulesOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorListenerNotFound, AWSElasticLoadBalancingErrorRuleNotFound, AWSElasticLoadBalancingErrorUnsupportedProtocol.

  • Describes the specified rules or the rules for the specified listener. You must specify either a listener or one or more rules.

    See

    AWSElasticLoadBalancingDescribeRulesInput

    See

    AWSElasticLoadBalancingDescribeRulesOutput

    Declaration

    Objective-C

    - (void)describeRules:
                (nonnull AWSElasticLoadBalancingDescribeRulesInput *)request
        completionHandler:(void (^_Nullable)(
                              AWSElasticLoadBalancingDescribeRulesOutput *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func describeRules(_ request: AWSElasticLoadBalancingDescribeRulesInput, completionHandler: ((AWSElasticLoadBalancingDescribeRulesOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeRules service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorListenerNotFound, AWSElasticLoadBalancingErrorRuleNotFound, AWSElasticLoadBalancingErrorUnsupportedProtocol.

  • Describes the specified policies or all policies used for SSL negotiation.

    For more information, see Security Policies in the Application Load Balancers Guide.

    See

    AWSElasticLoadBalancingDescribeSSLPoliciesInput

    See

    AWSElasticLoadBalancingDescribeSSLPoliciesOutput

    Declaration

    Objective-C

    - (id)describeSSLPolicies:
        (nonnull AWSElasticLoadBalancingDescribeSSLPoliciesInput *)request;

    Swift

    func describeSSLPolicies(_ request: AWSElasticLoadBalancingDescribeSSLPoliciesInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeSSLPolicies service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingDescribeSSLPoliciesOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorSSLPolicyNotFound.

  • Describes the specified policies or all policies used for SSL negotiation.

    For more information, see Security Policies in the Application Load Balancers Guide.

    See

    AWSElasticLoadBalancingDescribeSSLPoliciesInput

    See

    AWSElasticLoadBalancingDescribeSSLPoliciesOutput

    Declaration

    Objective-C

    - (void)describeSSLPolicies:
                (nonnull AWSElasticLoadBalancingDescribeSSLPoliciesInput *)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSElasticLoadBalancingDescribeSSLPoliciesOutput *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func describeSSLPolicies(_ request: AWSElasticLoadBalancingDescribeSSLPoliciesInput, completionHandler: ((AWSElasticLoadBalancingDescribeSSLPoliciesOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeSSLPolicies service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorSSLPolicyNotFound.

  • Describes the tags for the specified Elastic Load Balancing resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, target groups, listeners, or rules.

    See

    AWSElasticLoadBalancingDescribeTagsInput

    See

    AWSElasticLoadBalancingDescribeTagsOutput

    Declaration

    Objective-C

    - (id)describeTags:(nonnull AWSElasticLoadBalancingDescribeTagsInput *)request;

    Swift

    func describeTags(_ request: AWSElasticLoadBalancingDescribeTagsInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeTags service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingDescribeTagsOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorLoadBalancerNotFound, AWSElasticLoadBalancingErrorTargetGroupNotFound, AWSElasticLoadBalancingErrorListenerNotFound, AWSElasticLoadBalancingErrorRuleNotFound.

  • Describes the tags for the specified Elastic Load Balancing resources. You can describe the tags for one or more Application Load Balancers, Network Load Balancers, target groups, listeners, or rules.

    See

    AWSElasticLoadBalancingDescribeTagsInput

    See

    AWSElasticLoadBalancingDescribeTagsOutput

    Declaration

    Objective-C

    - (void)describeTags:(nonnull AWSElasticLoadBalancingDescribeTagsInput *)request
        completionHandler:
            (void (^_Nullable)(AWSElasticLoadBalancingDescribeTagsOutput *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func describeTags(_ request: AWSElasticLoadBalancingDescribeTagsInput, completionHandler: ((AWSElasticLoadBalancingDescribeTagsOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeTags service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorLoadBalancerNotFound, AWSElasticLoadBalancingErrorTargetGroupNotFound, AWSElasticLoadBalancingErrorListenerNotFound, AWSElasticLoadBalancingErrorRuleNotFound.

  • Describes the attributes for the specified target group.

    For more information, see Target Group Attributes in the Application Load Balancers Guide or Target Group Attributes in the Network Load Balancers Guide.

    See

    AWSElasticLoadBalancingDescribeTargetGroupAttributesInput

    See

    AWSElasticLoadBalancingDescribeTargetGroupAttributesOutput

    Declaration

    Objective-C

    - (id)describeTargetGroupAttributes:
        (nonnull AWSElasticLoadBalancingDescribeTargetGroupAttributesInput *)
            request;

    Swift

    func describeTargetGroupAttributes(_ request: AWSElasticLoadBalancingDescribeTargetGroupAttributesInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeTargetGroupAttributes service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingDescribeTargetGroupAttributesOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorTargetGroupNotFound.

  • Describes the attributes for the specified target group.

    For more information, see Target Group Attributes in the Application Load Balancers Guide or Target Group Attributes in the Network Load Balancers Guide.

    See

    AWSElasticLoadBalancingDescribeTargetGroupAttributesInput

    See

    AWSElasticLoadBalancingDescribeTargetGroupAttributesOutput

    Declaration

    Objective-C

    - (void)
        describeTargetGroupAttributes:
            (nonnull AWSElasticLoadBalancingDescribeTargetGroupAttributesInput *)
                request
                    completionHandler:
                        (void (^_Nullable)(
                            AWSElasticLoadBalancingDescribeTargetGroupAttributesOutput
                                *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func describeTargetGroupAttributes(_ request: AWSElasticLoadBalancingDescribeTargetGroupAttributesInput, completionHandler: ((AWSElasticLoadBalancingDescribeTargetGroupAttributesOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeTargetGroupAttributes service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorTargetGroupNotFound.

  • Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.

    To describe the targets for a target group, use DescribeTargetHealth. To describe the attributes of a target group, use DescribeTargetGroupAttributes.

    See

    AWSElasticLoadBalancingDescribeTargetGroupsInput

    See

    AWSElasticLoadBalancingDescribeTargetGroupsOutput

    Declaration

    Objective-C

    - (id)describeTargetGroups:
        (nonnull AWSElasticLoadBalancingDescribeTargetGroupsInput *)request;

    Swift

    func describeTargetGroups(_ request: AWSElasticLoadBalancingDescribeTargetGroupsInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeTargetGroups service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingDescribeTargetGroupsOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorLoadBalancerNotFound, AWSElasticLoadBalancingErrorTargetGroupNotFound.

  • Describes the specified target groups or all of your target groups. By default, all target groups are described. Alternatively, you can specify one of the following to filter the results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of one or more target groups.

    To describe the targets for a target group, use DescribeTargetHealth. To describe the attributes of a target group, use DescribeTargetGroupAttributes.

    See

    AWSElasticLoadBalancingDescribeTargetGroupsInput

    See

    AWSElasticLoadBalancingDescribeTargetGroupsOutput

    Declaration

    Objective-C

    - (void)describeTargetGroups:
                (nonnull AWSElasticLoadBalancingDescribeTargetGroupsInput *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSElasticLoadBalancingDescribeTargetGroupsOutput *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func describeTargetGroups(_ request: AWSElasticLoadBalancingDescribeTargetGroupsInput, completionHandler: ((AWSElasticLoadBalancingDescribeTargetGroupsOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeTargetGroups service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorLoadBalancerNotFound, AWSElasticLoadBalancingErrorTargetGroupNotFound.

  • Describes the health of the specified targets or all of your targets.

    See

    AWSElasticLoadBalancingDescribeTargetHealthInput

    See

    AWSElasticLoadBalancingDescribeTargetHealthOutput

    Declaration

    Objective-C

    - (id)describeTargetHealth:
        (nonnull AWSElasticLoadBalancingDescribeTargetHealthInput *)request;

    Swift

    func describeTargetHealth(_ request: AWSElasticLoadBalancingDescribeTargetHealthInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeTargetHealth service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingDescribeTargetHealthOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorInvalidTarget, AWSElasticLoadBalancingErrorTargetGroupNotFound, AWSElasticLoadBalancingErrorHealthUnavailable.

  • Describes the health of the specified targets or all of your targets.

    See

    AWSElasticLoadBalancingDescribeTargetHealthInput

    See

    AWSElasticLoadBalancingDescribeTargetHealthOutput

    Declaration

    Objective-C

    - (void)describeTargetHealth:
                (nonnull AWSElasticLoadBalancingDescribeTargetHealthInput *)request
               completionHandler:
                   (void (^_Nullable)(
                       AWSElasticLoadBalancingDescribeTargetHealthOutput *_Nullable,
                       NSError *_Nullable))completionHandler;

    Swift

    func describeTargetHealth(_ request: AWSElasticLoadBalancingDescribeTargetHealthInput, completionHandler: ((AWSElasticLoadBalancingDescribeTargetHealthOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the DescribeTargetHealth service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorInvalidTarget, AWSElasticLoadBalancingErrorTargetGroupNotFound, AWSElasticLoadBalancingErrorHealthUnavailable.

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

    See

    AWSElasticLoadBalancingModifyListenerInput

    See

    AWSElasticLoadBalancingModifyListenerOutput

    Declaration

    Objective-C

    - (id)modifyListener:
        (nonnull AWSElasticLoadBalancingModifyListenerInput *)request;

    Swift

    func modifyListener(_ request: AWSElasticLoadBalancingModifyListenerInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ModifyListener service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingModifyListenerOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorDuplicateListener, AWSElasticLoadBalancingErrorTooManyListeners, AWSElasticLoadBalancingErrorTooManyCertificates, AWSElasticLoadBalancingErrorListenerNotFound, AWSElasticLoadBalancingErrorTargetGroupNotFound, AWSElasticLoadBalancingErrorTargetGroupAssociationLimit, AWSElasticLoadBalancingErrorIncompatibleProtocols, AWSElasticLoadBalancingErrorSSLPolicyNotFound, AWSElasticLoadBalancingErrorCertificateNotFound, AWSElasticLoadBalancingErrorInvalidConfigurationRequest, AWSElasticLoadBalancingErrorUnsupportedProtocol, AWSElasticLoadBalancingErrorTooManyRegistrationsForTargetId, AWSElasticLoadBalancingErrorTooManyTargets, AWSElasticLoadBalancingErrorTooManyActions, AWSElasticLoadBalancingErrorInvalidLoadBalancerAction, AWSElasticLoadBalancingErrorTooManyUniqueTargetGroupsPerLoadBalancer, AWSElasticLoadBalancingErrorALPNPolicyNotSupported.

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

    See

    AWSElasticLoadBalancingModifyListenerInput

    See

    AWSElasticLoadBalancingModifyListenerOutput

    Declaration

    Objective-C

    - (void)modifyListener:
                (nonnull AWSElasticLoadBalancingModifyListenerInput *)request
         completionHandler:
             (void (^_Nullable)(
                 AWSElasticLoadBalancingModifyListenerOutput *_Nullable,
                 NSError *_Nullable))completionHandler;

    Swift

    func modifyListener(_ request: AWSElasticLoadBalancingModifyListenerInput, completionHandler: ((AWSElasticLoadBalancingModifyListenerOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ModifyListener service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorDuplicateListener, AWSElasticLoadBalancingErrorTooManyListeners, AWSElasticLoadBalancingErrorTooManyCertificates, AWSElasticLoadBalancingErrorListenerNotFound, AWSElasticLoadBalancingErrorTargetGroupNotFound, AWSElasticLoadBalancingErrorTargetGroupAssociationLimit, AWSElasticLoadBalancingErrorIncompatibleProtocols, AWSElasticLoadBalancingErrorSSLPolicyNotFound, AWSElasticLoadBalancingErrorCertificateNotFound, AWSElasticLoadBalancingErrorInvalidConfigurationRequest, AWSElasticLoadBalancingErrorUnsupportedProtocol, AWSElasticLoadBalancingErrorTooManyRegistrationsForTargetId, AWSElasticLoadBalancingErrorTooManyTargets, AWSElasticLoadBalancingErrorTooManyActions, AWSElasticLoadBalancingErrorInvalidLoadBalancerAction, AWSElasticLoadBalancingErrorTooManyUniqueTargetGroupsPerLoadBalancer, AWSElasticLoadBalancingErrorALPNPolicyNotSupported.

  • Modifies the specified attributes of the specified Application Load Balancer or Network Load Balancer.

    If any of the specified attributes can’t be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values.

    See

    AWSElasticLoadBalancingModifyLoadBalancerAttributesInput

    See

    AWSElasticLoadBalancingModifyLoadBalancerAttributesOutput

    Declaration

    Objective-C

    - (id)modifyLoadBalancerAttributes:
        (nonnull AWSElasticLoadBalancingModifyLoadBalancerAttributesInput *)request;

    Swift

    func modifyLoadBalancerAttributes(_ request: AWSElasticLoadBalancingModifyLoadBalancerAttributesInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ModifyLoadBalancerAttributes service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingModifyLoadBalancerAttributesOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorLoadBalancerNotFound, AWSElasticLoadBalancingErrorInvalidConfigurationRequest.

  • Modifies the specified attributes of the specified Application Load Balancer or Network Load Balancer.

    If any of the specified attributes can’t be modified as requested, the call fails. Any existing attributes that you do not modify retain their current values.

    See

    AWSElasticLoadBalancingModifyLoadBalancerAttributesInput

    See

    AWSElasticLoadBalancingModifyLoadBalancerAttributesOutput

    Declaration

    Objective-C

    - (void)
        modifyLoadBalancerAttributes:
            (nonnull AWSElasticLoadBalancingModifyLoadBalancerAttributesInput *)
                request
                   completionHandler:
                       (void (^_Nullable)(
                           AWSElasticLoadBalancingModifyLoadBalancerAttributesOutput
                               *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func modifyLoadBalancerAttributes(_ request: AWSElasticLoadBalancingModifyLoadBalancerAttributesInput, completionHandler: ((AWSElasticLoadBalancingModifyLoadBalancerAttributesOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ModifyLoadBalancerAttributes service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorLoadBalancerNotFound, AWSElasticLoadBalancingErrorInvalidConfigurationRequest.

  • Replaces the specified properties of the specified rule. Any properties that you do not specify are unchanged.

    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.

    To modify the actions for the default rule, use ModifyListener.

    See

    AWSElasticLoadBalancingModifyRuleInput

    See

    AWSElasticLoadBalancingModifyRuleOutput

    Declaration

    Objective-C

    - (id)modifyRule:(nonnull AWSElasticLoadBalancingModifyRuleInput *)request;

    Swift

    func modifyRule(_ request: AWSElasticLoadBalancingModifyRuleInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ModifyRule service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingModifyRuleOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorTargetGroupAssociationLimit, AWSElasticLoadBalancingErrorIncompatibleProtocols, AWSElasticLoadBalancingErrorRuleNotFound, AWSElasticLoadBalancingErrorOperationNotPermitted, AWSElasticLoadBalancingErrorTooManyRegistrationsForTargetId, AWSElasticLoadBalancingErrorTooManyTargets, AWSElasticLoadBalancingErrorTargetGroupNotFound, AWSElasticLoadBalancingErrorUnsupportedProtocol, AWSElasticLoadBalancingErrorTooManyActions, AWSElasticLoadBalancingErrorInvalidLoadBalancerAction, AWSElasticLoadBalancingErrorTooManyUniqueTargetGroupsPerLoadBalancer.

  • Replaces the specified properties of the specified rule. Any properties that you do not specify are unchanged.

    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.

    To modify the actions for the default rule, use ModifyListener.

    See

    AWSElasticLoadBalancingModifyRuleInput

    See

    AWSElasticLoadBalancingModifyRuleOutput

    Declaration

    Objective-C

    - (void)modifyRule:(nonnull AWSElasticLoadBalancingModifyRuleInput *)request
        completionHandler:
            (void (^_Nullable)(AWSElasticLoadBalancingModifyRuleOutput *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func modifyRule(_ request: AWSElasticLoadBalancingModifyRuleInput, completionHandler: ((AWSElasticLoadBalancingModifyRuleOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ModifyRule service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorTargetGroupAssociationLimit, AWSElasticLoadBalancingErrorIncompatibleProtocols, AWSElasticLoadBalancingErrorRuleNotFound, AWSElasticLoadBalancingErrorOperationNotPermitted, AWSElasticLoadBalancingErrorTooManyRegistrationsForTargetId, AWSElasticLoadBalancingErrorTooManyTargets, AWSElasticLoadBalancingErrorTargetGroupNotFound, AWSElasticLoadBalancingErrorUnsupportedProtocol, AWSElasticLoadBalancingErrorTooManyActions, AWSElasticLoadBalancingErrorInvalidLoadBalancerAction, AWSElasticLoadBalancingErrorTooManyUniqueTargetGroupsPerLoadBalancer.

  • Modifies the health checks used when evaluating the health state of the targets in the specified target group.

    To monitor the health of the targets, use DescribeTargetHealth.

    See

    AWSElasticLoadBalancingModifyTargetGroupInput

    See

    AWSElasticLoadBalancingModifyTargetGroupOutput

    Declaration

    Objective-C

    - (id)modifyTargetGroup:
        (nonnull AWSElasticLoadBalancingModifyTargetGroupInput *)request;

    Swift

    func modifyTargetGroup(_ request: AWSElasticLoadBalancingModifyTargetGroupInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ModifyTargetGroup service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingModifyTargetGroupOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorTargetGroupNotFound, AWSElasticLoadBalancingErrorInvalidConfigurationRequest.

  • Modifies the health checks used when evaluating the health state of the targets in the specified target group.

    To monitor the health of the targets, use DescribeTargetHealth.

    See

    AWSElasticLoadBalancingModifyTargetGroupInput

    See

    AWSElasticLoadBalancingModifyTargetGroupOutput

    Declaration

    Objective-C

    - (void)modifyTargetGroup:
                (nonnull AWSElasticLoadBalancingModifyTargetGroupInput *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSElasticLoadBalancingModifyTargetGroupOutput *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func modifyTargetGroup(_ request: AWSElasticLoadBalancingModifyTargetGroupInput, completionHandler: ((AWSElasticLoadBalancingModifyTargetGroupOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ModifyTargetGroup service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorTargetGroupNotFound, AWSElasticLoadBalancingErrorInvalidConfigurationRequest.

  • Modifies the specified attributes of the specified target group.

    See

    AWSElasticLoadBalancingModifyTargetGroupAttributesInput

    See

    AWSElasticLoadBalancingModifyTargetGroupAttributesOutput

    Declaration

    Objective-C

    - (id)modifyTargetGroupAttributes:
        (nonnull AWSElasticLoadBalancingModifyTargetGroupAttributesInput *)request;

    Swift

    func modifyTargetGroupAttributes(_ request: AWSElasticLoadBalancingModifyTargetGroupAttributesInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ModifyTargetGroupAttributes service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingModifyTargetGroupAttributesOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorTargetGroupNotFound, AWSElasticLoadBalancingErrorInvalidConfigurationRequest.

  • Modifies the specified attributes of the specified target group.

    See

    AWSElasticLoadBalancingModifyTargetGroupAttributesInput

    See

    AWSElasticLoadBalancingModifyTargetGroupAttributesOutput

    Declaration

    Objective-C

    - (void)
        modifyTargetGroupAttributes:
            (nonnull AWSElasticLoadBalancingModifyTargetGroupAttributesInput *)
                request
                  completionHandler:
                      (void (^_Nullable)(
                          AWSElasticLoadBalancingModifyTargetGroupAttributesOutput
                              *_Nullable,
                          NSError *_Nullable))completionHandler;

    Swift

    func modifyTargetGroupAttributes(_ request: AWSElasticLoadBalancingModifyTargetGroupAttributesInput, completionHandler: ((AWSElasticLoadBalancingModifyTargetGroupAttributesOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the ModifyTargetGroupAttributes service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorTargetGroupNotFound, AWSElasticLoadBalancingErrorInvalidConfigurationRequest.

  • Registers the specified targets with the specified target group.

    If the target is an EC2 instance, it must be in the running state when you register it.

    By default, the load balancer routes requests to registered targets using the protocol and port for the target group. Alternatively, you can override the port for a target when you register it. You can register each EC2 instance or IP address with the same target group multiple times using different ports.

    With a Network Load Balancer, you cannot register instances by instance ID if they have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1. You can register instances of these types by IP address.

    To remove a target from a target group, use DeregisterTargets.

    See

    AWSElasticLoadBalancingRegisterTargetsInput

    See

    AWSElasticLoadBalancingRegisterTargetsOutput

    Declaration

    Objective-C

    - (id)registerTargets:
        (nonnull AWSElasticLoadBalancingRegisterTargetsInput *)request;

    Swift

    func registerTargets(_ request: AWSElasticLoadBalancingRegisterTargetsInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the RegisterTargets service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingRegisterTargetsOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorTargetGroupNotFound, AWSElasticLoadBalancingErrorTooManyTargets, AWSElasticLoadBalancingErrorInvalidTarget, AWSElasticLoadBalancingErrorTooManyRegistrationsForTargetId.

  • Registers the specified targets with the specified target group.

    If the target is an EC2 instance, it must be in the running state when you register it.

    By default, the load balancer routes requests to registered targets using the protocol and port for the target group. Alternatively, you can override the port for a target when you register it. You can register each EC2 instance or IP address with the same target group multiple times using different ports.

    With a Network Load Balancer, you cannot register instances by instance ID if they have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1. You can register instances of these types by IP address.

    To remove a target from a target group, use DeregisterTargets.

    See

    AWSElasticLoadBalancingRegisterTargetsInput

    See

    AWSElasticLoadBalancingRegisterTargetsOutput

    Declaration

    Objective-C

    - (void)registerTargets:
                (nonnull AWSElasticLoadBalancingRegisterTargetsInput *)request
          completionHandler:
              (void (^_Nullable)(
                  AWSElasticLoadBalancingRegisterTargetsOutput *_Nullable,
                  NSError *_Nullable))completionHandler;

    Swift

    func registerTargets(_ request: AWSElasticLoadBalancingRegisterTargetsInput, completionHandler: ((AWSElasticLoadBalancingRegisterTargetsOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the RegisterTargets service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorTargetGroupNotFound, AWSElasticLoadBalancingErrorTooManyTargets, AWSElasticLoadBalancingErrorInvalidTarget, AWSElasticLoadBalancingErrorTooManyRegistrationsForTargetId.

  • Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener.

    You can’t remove the default certificate for a listener. To replace the default certificate, call ModifyListener.

    To list the certificates for your listener, use DescribeListenerCertificates.

    See

    AWSElasticLoadBalancingRemoveListenerCertificatesInput

    See

    AWSElasticLoadBalancingRemoveListenerCertificatesOutput

    Declaration

    Objective-C

    - (id)removeListenerCertificates:
        (nonnull AWSElasticLoadBalancingRemoveListenerCertificatesInput *)request;

    Swift

    func removeListenerCertificates(_ request: AWSElasticLoadBalancingRemoveListenerCertificatesInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the RemoveListenerCertificates service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingRemoveListenerCertificatesOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorListenerNotFound, AWSElasticLoadBalancingErrorOperationNotPermitted.

  • Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener.

    You can’t remove the default certificate for a listener. To replace the default certificate, call ModifyListener.

    To list the certificates for your listener, use DescribeListenerCertificates.

    See

    AWSElasticLoadBalancingRemoveListenerCertificatesInput

    See

    AWSElasticLoadBalancingRemoveListenerCertificatesOutput

    Declaration

    Objective-C

    - (void)removeListenerCertificates:
                (nonnull AWSElasticLoadBalancingRemoveListenerCertificatesInput *)
                    request
                     completionHandler:
                         (void (^_Nullable)(
                             AWSElasticLoadBalancingRemoveListenerCertificatesOutput
                                 *_Nullable,
                             NSError *_Nullable))completionHandler;

    Swift

    func removeListenerCertificates(_ request: AWSElasticLoadBalancingRemoveListenerCertificatesInput, completionHandler: ((AWSElasticLoadBalancingRemoveListenerCertificatesOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the RemoveListenerCertificates service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorListenerNotFound, AWSElasticLoadBalancingErrorOperationNotPermitted.

  • Removes the specified tags from the specified Elastic Load Balancing resources. You can remove the tags for one or more Application Load Balancers, Network Load Balancers, target groups, listeners, or rules.

    To list the current tags for your resources, use DescribeTags.

    See

    AWSElasticLoadBalancingRemoveTagsInput

    See

    AWSElasticLoadBalancingRemoveTagsOutput

    Declaration

    Objective-C

    - (id)removeTags:(nonnull AWSElasticLoadBalancingRemoveTagsInput *)request;

    Swift

    func removeTags(_ request: AWSElasticLoadBalancingRemoveTagsInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the RemoveTags service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingRemoveTagsOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorLoadBalancerNotFound, AWSElasticLoadBalancingErrorTargetGroupNotFound, AWSElasticLoadBalancingErrorListenerNotFound, AWSElasticLoadBalancingErrorRuleNotFound, AWSElasticLoadBalancingErrorTooManyTags.

  • Removes the specified tags from the specified Elastic Load Balancing resources. You can remove the tags for one or more Application Load Balancers, Network Load Balancers, target groups, listeners, or rules.

    To list the current tags for your resources, use DescribeTags.

    See

    AWSElasticLoadBalancingRemoveTagsInput

    See

    AWSElasticLoadBalancingRemoveTagsOutput

    Declaration

    Objective-C

    - (void)removeTags:(nonnull AWSElasticLoadBalancingRemoveTagsInput *)request
        completionHandler:
            (void (^_Nullable)(AWSElasticLoadBalancingRemoveTagsOutput *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func removeTags(_ request: AWSElasticLoadBalancingRemoveTagsInput, completionHandler: ((AWSElasticLoadBalancingRemoveTagsOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the RemoveTags service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorLoadBalancerNotFound, AWSElasticLoadBalancingErrorTargetGroupNotFound, AWSElasticLoadBalancingErrorListenerNotFound, AWSElasticLoadBalancingErrorRuleNotFound, AWSElasticLoadBalancingErrorTooManyTags.

  • Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network Load Balancer.

    See

    AWSElasticLoadBalancingSetIpAddressTypeInput

    See

    AWSElasticLoadBalancingSetIpAddressTypeOutput

    Declaration

    Objective-C

    - (id)setIpAddressType:
        (nonnull AWSElasticLoadBalancingSetIpAddressTypeInput *)request;

    Swift

    func setIpAddressType(_ request: AWSElasticLoadBalancingSetIpAddressTypeInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the SetIpAddressType service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingSetIpAddressTypeOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorLoadBalancerNotFound, AWSElasticLoadBalancingErrorInvalidConfigurationRequest, AWSElasticLoadBalancingErrorInvalidSubnet.

  • Sets the type of IP addresses used by the subnets of the specified Application Load Balancer or Network Load Balancer.

    See

    AWSElasticLoadBalancingSetIpAddressTypeInput

    See

    AWSElasticLoadBalancingSetIpAddressTypeOutput

    Declaration

    Objective-C

    - (void)setIpAddressType:
                (nonnull AWSElasticLoadBalancingSetIpAddressTypeInput *)request
           completionHandler:
               (void (^_Nullable)(
                   AWSElasticLoadBalancingSetIpAddressTypeOutput *_Nullable,
                   NSError *_Nullable))completionHandler;

    Swift

    func setIpAddressType(_ request: AWSElasticLoadBalancingSetIpAddressTypeInput, completionHandler: ((AWSElasticLoadBalancingSetIpAddressTypeOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the SetIpAddressType service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorLoadBalancerNotFound, AWSElasticLoadBalancingErrorInvalidConfigurationRequest, AWSElasticLoadBalancingErrorInvalidSubnet.

  • Sets the priorities of the specified rules.

    You can reorder the rules as long as there are no priority conflicts in the new order. Any existing rules that you do not specify retain their current priority.

    See

    AWSElasticLoadBalancingSetRulePrioritiesInput

    See

    AWSElasticLoadBalancingSetRulePrioritiesOutput

    Declaration

    Objective-C

    - (id)setRulePriorities:
        (nonnull AWSElasticLoadBalancingSetRulePrioritiesInput *)request;

    Swift

    func setRulePriorities(_ request: AWSElasticLoadBalancingSetRulePrioritiesInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the SetRulePriorities service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingSetRulePrioritiesOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorRuleNotFound, AWSElasticLoadBalancingErrorPriorityInUse, AWSElasticLoadBalancingErrorOperationNotPermitted.

  • Sets the priorities of the specified rules.

    You can reorder the rules as long as there are no priority conflicts in the new order. Any existing rules that you do not specify retain their current priority.

    See

    AWSElasticLoadBalancingSetRulePrioritiesInput

    See

    AWSElasticLoadBalancingSetRulePrioritiesOutput

    Declaration

    Objective-C

    - (void)setRulePriorities:
                (nonnull AWSElasticLoadBalancingSetRulePrioritiesInput *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSElasticLoadBalancingSetRulePrioritiesOutput *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func setRulePriorities(_ request: AWSElasticLoadBalancingSetRulePrioritiesInput, completionHandler: ((AWSElasticLoadBalancingSetRulePrioritiesOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the SetRulePriorities service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorRuleNotFound, AWSElasticLoadBalancingErrorPriorityInUse, AWSElasticLoadBalancingErrorOperationNotPermitted.

  • Associates the specified security groups with the specified Application Load Balancer. The specified security groups override the previously associated security groups.

    You can’t specify a security group for a Network Load Balancer.

    See

    AWSElasticLoadBalancingSetSecurityGroupsInput

    See

    AWSElasticLoadBalancingSetSecurityGroupsOutput

    Declaration

    Objective-C

    - (id)setSecurityGroups:
        (nonnull AWSElasticLoadBalancingSetSecurityGroupsInput *)request;

    Swift

    func setSecurityGroups(_ request: AWSElasticLoadBalancingSetSecurityGroupsInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the SetSecurityGroups service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingSetSecurityGroupsOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorLoadBalancerNotFound, AWSElasticLoadBalancingErrorInvalidConfigurationRequest, AWSElasticLoadBalancingErrorInvalidSecurityGroup.

  • Associates the specified security groups with the specified Application Load Balancer. The specified security groups override the previously associated security groups.

    You can’t specify a security group for a Network Load Balancer.

    See

    AWSElasticLoadBalancingSetSecurityGroupsInput

    See

    AWSElasticLoadBalancingSetSecurityGroupsOutput

    Declaration

    Objective-C

    - (void)setSecurityGroups:
                (nonnull AWSElasticLoadBalancingSetSecurityGroupsInput *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSElasticLoadBalancingSetSecurityGroupsOutput *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func setSecurityGroups(_ request: AWSElasticLoadBalancingSetSecurityGroupsInput, completionHandler: ((AWSElasticLoadBalancingSetSecurityGroupsOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the SetSecurityGroups service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorLoadBalancerNotFound, AWSElasticLoadBalancingErrorInvalidConfigurationRequest, AWSElasticLoadBalancingErrorInvalidSecurityGroup.

  • Enables the Availability Zones for the specified public subnets for the specified load balancer. The specified subnets replace the previously enabled subnets.

    When you specify subnets for a Network Load Balancer, you must include all subnets that were enabled previously, with their existing configurations, plus any additional subnets.

    See

    AWSElasticLoadBalancingSetSubnetsInput

    See

    AWSElasticLoadBalancingSetSubnetsOutput

    Declaration

    Objective-C

    - (id)setSubnets:(nonnull AWSElasticLoadBalancingSetSubnetsInput *)request;

    Swift

    func setSubnets(_ request: AWSElasticLoadBalancingSetSubnetsInput) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the SetSubnets service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSElasticLoadBalancingSetSubnetsOutput. On failed execution, task.error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorLoadBalancerNotFound, AWSElasticLoadBalancingErrorInvalidConfigurationRequest, AWSElasticLoadBalancingErrorSubnetNotFound, AWSElasticLoadBalancingErrorInvalidSubnet, AWSElasticLoadBalancingErrorAllocationIdNotFound, AWSElasticLoadBalancingErrorAvailabilityZoneNotSupported.

  • Enables the Availability Zones for the specified public subnets for the specified load balancer. The specified subnets replace the previously enabled subnets.

    When you specify subnets for a Network Load Balancer, you must include all subnets that were enabled previously, with their existing configurations, plus any additional subnets.

    See

    AWSElasticLoadBalancingSetSubnetsInput

    See

    AWSElasticLoadBalancingSetSubnetsOutput

    Declaration

    Objective-C

    - (void)setSubnets:(nonnull AWSElasticLoadBalancingSetSubnetsInput *)request
        completionHandler:
            (void (^_Nullable)(AWSElasticLoadBalancingSetSubnetsOutput *_Nullable,
                               NSError *_Nullable))completionHandler;

    Swift

    func setSubnets(_ request: AWSElasticLoadBalancingSetSubnetsInput, completionHandler: ((AWSElasticLoadBalancingSetSubnetsOutput?, Error?) -> Void)? = nil)

    Parameters

    request

    A container for the necessary parameters to execute the SetSubnets service method.

    completionHandler

    The completion handler to call when the load request is complete. response - A response object, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSElasticLoadBalancingErrorDomain domain and the following error code: AWSElasticLoadBalancingErrorLoadBalancerNotFound, AWSElasticLoadBalancingErrorInvalidConfigurationRequest, AWSElasticLoadBalancingErrorSubnetNotFound, AWSElasticLoadBalancingErrorInvalidSubnet, AWSElasticLoadBalancingErrorAllocationIdNotFound, AWSElasticLoadBalancingErrorAvailabilityZoneNotSupported.