:doc:`Lightsail <../../lightsail>` / Client / create_load_balancer

********************
create_load_balancer
********************



.. py:method:: Lightsail.Client.create_load_balancer(**kwargs)

  

  Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see `Configure your Lightsail instances for load balancing <https://docs.aws.amazon.com/lightsail/latest/userguide/configure-lightsail-instances-for-load-balancing>`__. You can create up to 10 load balancers per AWS Region in your account.

   

  When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the ``UpdateLoadBalancerAttribute`` operation.

   

  The ``create load balancer`` operation supports tag-based access control via request tags. For more information, see the `Amazon Lightsail Developer Guide <https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/lightsail-2016-11-28/CreateLoadBalancer>`_  


  **Request Syntax**
  ::

    response = client.create_load_balancer(
        loadBalancerName='string',
        instancePort=123,
        healthCheckPath='string',
        certificateName='string',
        certificateDomainName='string',
        certificateAlternativeNames=[
            'string',
        ],
        tags=[
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        ipAddressType='dualstack'|'ipv4'|'ipv6',
        tlsPolicyName='string'
    )
    
  :type loadBalancerName: string
  :param loadBalancerName: **[REQUIRED]** 

    The name of your load balancer.

    

  
  :type instancePort: integer
  :param instancePort: **[REQUIRED]** 

    The instance port where you're creating your load balancer.

    

  
  :type healthCheckPath: string
  :param healthCheckPath: 

    The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website ( ``"/"``).

     

    You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it.

    

  
  :type certificateName: string
  :param certificateName: 

    The name of the SSL/TLS certificate.

     

    If you specify ``certificateName``, then ``certificateDomainName`` is required (and vice-versa).

    

  
  :type certificateDomainName: string
  :param certificateDomainName: 

    The domain name with which your certificate is associated ( ``example.com``).

     

    If you specify ``certificateDomainName``, then ``certificateName`` is required (and vice-versa).

    

  
  :type certificateAlternativeNames: list
  :param certificateAlternativeNames: 

    The optional alternative domains and subdomains to use with your SSL/TLS certificate ( ``www.example.com``, ``example.com``, ``m.example.com``, ``blog.example.com``).

    

  
    - *(string) --* 

    

  :type tags: list
  :param tags: 

    The tag keys and optional values to add to the resource during create.

     

    Use the ``TagResource`` action to tag a resource after it's created.

    

  
    - *(dict) --* 

      Describes a tag key and optional value assigned to an Amazon Lightsail resource.

       

      For more information about tags in Lightsail, see the `Amazon Lightsail Developer Guide <https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags>`__.

      

    
      - **key** *(string) --* 

        The key of the tag.

         

        Constraints: Tag keys accept a maximum of 128 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

        

      
      - **value** *(string) --* 

        The value of the tag.

         

        Constraints: Tag values accept a maximum of 256 letters, numbers, spaces in UTF-8, or the following characters: + - = . _ : / @

        

      
    

  :type ipAddressType: string
  :param ipAddressType: 

    The IP address type for the load balancer.

     

    The possible values are ``ipv4`` for IPv4 only, ``ipv6`` for IPv6 only, and ``dualstack`` for IPv4 and IPv6.

     

    The default value is ``dualstack``.

    

  
  :type tlsPolicyName: string
  :param tlsPolicyName: 

    The name of the TLS policy to apply to the load balancer.

     

    Use the `GetLoadBalancerTlsPolicies <https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetLoadBalancerTlsPolicies.html>`__ action to get a list of TLS policy names that you can specify.

     

    For more information about load balancer TLS policies, see `Configuring TLS security policies on your Amazon Lightsail load balancers <https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configure-load-balancer-tls-security-policy>`__ in the *Amazon Lightsail Developer Guide*.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'operations': [
              {
                  'id': 'string',
                  'resourceName': 'string',
                  'resourceType': 'ContainerService'|'Instance'|'StaticIp'|'KeyPair'|'InstanceSnapshot'|'Domain'|'PeeredVpc'|'LoadBalancer'|'LoadBalancerTlsCertificate'|'Disk'|'DiskSnapshot'|'RelationalDatabase'|'RelationalDatabaseSnapshot'|'ExportSnapshotRecord'|'CloudFormationStackRecord'|'Alarm'|'ContactMethod'|'Distribution'|'Certificate'|'Bucket',
                  'createdAt': datetime(2015, 1, 1),
                  'location': {
                      'availabilityZone': 'string',
                      'regionName': 'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'eu-central-1'|'ca-central-1'|'ap-south-1'|'ap-southeast-1'|'ap-southeast-2'|'ap-northeast-1'|'ap-northeast-2'|'eu-north-1'|'ap-southeast-3'
                  },
                  'isTerminal': True|False,
                  'operationDetails': 'string',
                  'operationType': 'DeleteKnownHostKeys'|'DeleteInstance'|'CreateInstance'|'StopInstance'|'StartInstance'|'RebootInstance'|'OpenInstancePublicPorts'|'PutInstancePublicPorts'|'CloseInstancePublicPorts'|'AllocateStaticIp'|'ReleaseStaticIp'|'AttachStaticIp'|'DetachStaticIp'|'UpdateDomainEntry'|'DeleteDomainEntry'|'CreateDomain'|'DeleteDomain'|'CreateInstanceSnapshot'|'DeleteInstanceSnapshot'|'CreateInstancesFromSnapshot'|'CreateLoadBalancer'|'DeleteLoadBalancer'|'AttachInstancesToLoadBalancer'|'DetachInstancesFromLoadBalancer'|'UpdateLoadBalancerAttribute'|'CreateLoadBalancerTlsCertificate'|'DeleteLoadBalancerTlsCertificate'|'AttachLoadBalancerTlsCertificate'|'CreateDisk'|'DeleteDisk'|'AttachDisk'|'DetachDisk'|'CreateDiskSnapshot'|'DeleteDiskSnapshot'|'CreateDiskFromSnapshot'|'CreateRelationalDatabase'|'UpdateRelationalDatabase'|'DeleteRelationalDatabase'|'CreateRelationalDatabaseFromSnapshot'|'CreateRelationalDatabaseSnapshot'|'DeleteRelationalDatabaseSnapshot'|'UpdateRelationalDatabaseParameters'|'StartRelationalDatabase'|'RebootRelationalDatabase'|'StopRelationalDatabase'|'EnableAddOn'|'DisableAddOn'|'PutAlarm'|'GetAlarms'|'DeleteAlarm'|'TestAlarm'|'CreateContactMethod'|'GetContactMethods'|'SendContactMethodVerification'|'DeleteContactMethod'|'CreateDistribution'|'UpdateDistribution'|'DeleteDistribution'|'ResetDistributionCache'|'AttachCertificateToDistribution'|'DetachCertificateFromDistribution'|'UpdateDistributionBundle'|'SetIpAddressType'|'CreateCertificate'|'DeleteCertificate'|'CreateContainerService'|'UpdateContainerService'|'DeleteContainerService'|'CreateContainerServiceDeployment'|'CreateContainerServiceRegistryLogin'|'RegisterContainerImage'|'DeleteContainerImage'|'CreateBucket'|'DeleteBucket'|'CreateBucketAccessKey'|'DeleteBucketAccessKey'|'UpdateBucketBundle'|'UpdateBucket'|'SetResourceAccessForBucket'|'UpdateInstanceMetadataOptions'|'StartGUISession'|'StopGUISession'|'SetupInstanceHttps',
                  'status': 'NotStarted'|'Started'|'Failed'|'Completed'|'Succeeded',
                  'statusChangedAt': datetime(2015, 1, 1),
                  'errorCode': 'string',
                  'errorDetails': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **operations** *(list) --* 

        An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.

        
        

        - *(dict) --* 

          Describes the API operation.

          
          

          - **id** *(string) --* 

            The ID of the operation.

            
          

          - **resourceName** *(string) --* 

            The resource name.

            
          

          - **resourceType** *(string) --* 

            The resource type.

            
          

          - **createdAt** *(datetime) --* 

            The timestamp when the operation was initialized ( ``1479816991.349``).

            
          

          - **location** *(dict) --* 

            The Amazon Web Services Region and Availability Zone.

            
            

            - **availabilityZone** *(string) --* 

              The Availability Zone. Follows the format ``us-east-2a`` (case-sensitive).

              
            

            - **regionName** *(string) --* 

              The Amazon Web Services Region name.

              
        
          

          - **isTerminal** *(boolean) --* 

            A Boolean value indicating whether the operation is terminal.

            
          

          - **operationDetails** *(string) --* 

            Details about the operation ( ``Debian-1GB-Ohio-1``).

            
          

          - **operationType** *(string) --* 

            The type of operation.

            
          

          - **status** *(string) --* 

            The status of the operation.

            
          

          - **statusChangedAt** *(datetime) --* 

            The timestamp when the status was changed ( ``1479816991.349``).

            
          

          - **errorCode** *(string) --* 

            The error code.

            
          

          - **errorDetails** *(string) --* 

            The error details.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`Lightsail.Client.exceptions.ServiceException`

  
  *   :py:class:`Lightsail.Client.exceptions.InvalidInputException`

  
  *   :py:class:`Lightsail.Client.exceptions.NotFoundException`

  
  *   :py:class:`Lightsail.Client.exceptions.OperationFailureException`

  
  *   :py:class:`Lightsail.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Lightsail.Client.exceptions.AccountSetupInProgressException`

  
  *   :py:class:`Lightsail.Client.exceptions.RegionSetupInProgressException`

  
  *   :py:class:`Lightsail.Client.exceptions.UnauthenticatedException`

  