create_load_balancer¶

ElasticLoadBalancing.Client.create_load_balancer(**kwargs)¶

Creates a Classic Load Balancer.

You can add listeners, security groups, subnets, and tags when you create your load balancer, or you can add them later using CreateLoadBalancerListeners, ApplySecurityGroupsToLoadBalancer, AttachLoadBalancerToSubnets, and AddTags.

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

You can create up to 20 load balancers per region per account. You can request an increase for the number of load balancers for your account. For more information, see Limits for Your Classic Load Balancer in the Classic Load Balancers Guide .

See also: AWS API Documentation

Request Syntax

response = client.create_load_balancer(
    LoadBalancerName='string',
    Listeners=[
        {
            'Protocol': 'string',
            'LoadBalancerPort': 123,
            'InstanceProtocol': 'string',
            'InstancePort': 123,
            'SSLCertificateId': 'string'
        },
    ],
    AvailabilityZones=[
        'string',
    ],
    Subnets=[
        'string',
    ],
    SecurityGroups=[
        'string',
    ],
    Scheme='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters

LoadBalancerName (string) --
[REQUIRED]

The name of the load balancer.

This name must be unique within your set of load balancers for the region, must have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and cannot begin or end with a hyphen.
Listeners (list) --
[REQUIRED]

The listeners.

For more information, see Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide .
- (dict) --
  Information about a listener.
  
  For information about the protocols and the ports supported by Elastic Load Balancing, see Listeners for Your Classic Load Balancer in the Classic Load Balancers Guide .
  - Protocol (string) -- [REQUIRED]
    The load balancer transport protocol to use for routing: HTTP, HTTPS, TCP, or SSL.
  - LoadBalancerPort (integer) -- [REQUIRED]
    The port on which the load balancer is listening. On EC2-VPC, you can specify any port from the range 1-65535. On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535.
  - InstanceProtocol (string) --
    The protocol to use for routing traffic to instances: HTTP, HTTPS, TCP, or SSL.
    
    If the front-end protocol is TCP or SSL, the back-end protocol must be TCP or SSL. If the front-end protocol is HTTP or HTTPS, the back-end protocol must be HTTP or HTTPS.
    
    If there is another listener with the same InstancePort whose InstanceProtocol is secure, (HTTPS or SSL), the listener's InstanceProtocol must also be secure.
    
    If there is another listener with the same InstancePort whose InstanceProtocol is HTTP or TCP, the listener's InstanceProtocol must be HTTP or TCP.
  - InstancePort (integer) -- [REQUIRED]
    The port on which the instance is listening.
  - SSLCertificateId (string) --
    The Amazon Resource Name (ARN) of the server certificate.
AvailabilityZones (list) --
One or more Availability Zones from the same region as the load balancer.

You must specify at least one Availability Zone.

You can add more Availability Zones after you create the load balancer using EnableAvailabilityZonesForLoadBalancer.
- (string) --
Subnets (list) --
The IDs of the subnets in your VPC to attach to the load balancer. Specify one subnet per Availability Zone specified in AvailabilityZones .
- (string) --
SecurityGroups (list) --
The IDs of the security groups to assign to the load balancer.
- (string) --
Scheme (string) --
The type of a load balancer. Valid only for load balancers in a VPC.

By default, Elastic Load Balancing creates an Internet-facing load balancer with a DNS name that resolves to public IP addresses. For more information about Internet-facing and Internal load balancers, see Load Balancer Scheme in the Elastic Load Balancing User Guide .

Specify internal to create a load balancer with a DNS name that resolves to private IP addresses.
Tags (list) --
A list of tags to assign to the load balancer.

For more information about tagging your load balancer, see Tag Your Classic Load Balancer in the Classic Load Balancers Guide .
- (dict) --
  Information about a tag.
  - Key (string) -- [REQUIRED]
    The key of the tag.
  - Value (string) --
    The value of the tag.

Return type

dict

Returns

Response Syntax

{
    'DNSName': 'string'
}

Response Structure

(dict) --

Contains the output for CreateLoadBalancer.
- DNSName (string) --
  
  The DNS name of the load balancer.

Exceptions

ElasticLoadBalancing.Client.exceptions.DuplicateAccessPointNameException
ElasticLoadBalancing.Client.exceptions.TooManyAccessPointsException
ElasticLoadBalancing.Client.exceptions.CertificateNotFoundException
ElasticLoadBalancing.Client.exceptions.InvalidConfigurationRequestException
ElasticLoadBalancing.Client.exceptions.SubnetNotFoundException
ElasticLoadBalancing.Client.exceptions.InvalidSubnetException
ElasticLoadBalancing.Client.exceptions.InvalidSecurityGroupException
ElasticLoadBalancing.Client.exceptions.InvalidSchemeException
ElasticLoadBalancing.Client.exceptions.TooManyTagsException
ElasticLoadBalancing.Client.exceptions.DuplicateTagKeysException
ElasticLoadBalancing.Client.exceptions.UnsupportedProtocolException
ElasticLoadBalancing.Client.exceptions.OperationNotPermittedException

Examples

This example creates a load balancer with an HTTP listener in a VPC.

response = client.create_load_balancer(
    Listeners=[
        {
            'InstancePort': 80,
            'InstanceProtocol': 'HTTP',
            'LoadBalancerPort': 80,
            'Protocol': 'HTTP',
        },
    ],
    LoadBalancerName='my-load-balancer',
    SecurityGroups=[
        'sg-a61988c3',
    ],
    Subnets=[
        'subnet-15aaab61',
    ],
)

print(response)

Expected Output:

{
    'DNSName': 'my-load-balancer-1234567890.us-west-2.elb.amazonaws.com',
    'ResponseMetadata': {
        '...': '...',
    },
}

This example creates a load balancer with an HTTP listener in EC2-Classic.

response = client.create_load_balancer(
    AvailabilityZones=[
        'us-west-2a',
    ],
    Listeners=[
        {
            'InstancePort': 80,
            'InstanceProtocol': 'HTTP',
            'LoadBalancerPort': 80,
            'Protocol': 'HTTP',
        },
    ],
    LoadBalancerName='my-load-balancer',
)

print(response)

Expected Output:

{
    'DNSName': 'my-load-balancer-123456789.us-west-2.elb.amazonaws.com',
    'ResponseMetadata': {
        '...': '...',
    },
}

This example creates a load balancer with an HTTPS listener in a VPC.

response = client.create_load_balancer(
    Listeners=[
        {
            'InstancePort': 80,
            'InstanceProtocol': 'HTTP',
            'LoadBalancerPort': 80,
            'Protocol': 'HTTP',
        },
        {
            'InstancePort': 80,
            'InstanceProtocol': 'HTTP',
            'LoadBalancerPort': 443,
            'Protocol': 'HTTPS',
            'SSLCertificateId': 'arn:aws:iam::123456789012:server-certificate/my-server-cert',
        },
    ],
    LoadBalancerName='my-load-balancer',
    SecurityGroups=[
        'sg-a61988c3',
    ],
    Subnets=[
        'subnet-15aaab61',
    ],
)

print(response)

Expected Output:

{
    'DNSName': 'my-load-balancer-1234567890.us-west-2.elb.amazonaws.com',
    'ResponseMetadata': {
        '...': '...',
    },
}

This example creates a load balancer with an HTTPS listener in EC2-Classic.

response = client.create_load_balancer(
    AvailabilityZones=[
        'us-west-2a',
    ],
    Listeners=[
        {
            'InstancePort': 80,
            'InstanceProtocol': 'HTTP',
            'LoadBalancerPort': 80,
            'Protocol': 'HTTP',
        },
        {
            'InstancePort': 80,
            'InstanceProtocol': 'HTTP',
            'LoadBalancerPort': 443,
            'Protocol': 'HTTPS',
            'SSLCertificateId': 'arn:aws:iam::123456789012:server-certificate/my-server-cert',
        },
    ],
    LoadBalancerName='my-load-balancer',
)

print(response)

Expected Output:

{
    'DNSName': 'my-load-balancer-123456789.us-west-2.elb.amazonaws.com',
    'ResponseMetadata': {
        '...': '...',
    },
}

This example creates an internal load balancer with an HTTP listener in a VPC.

response = client.create_load_balancer(
    Listeners=[
        {
            'InstancePort': 80,
            'InstanceProtocol': 'HTTP',
            'LoadBalancerPort': 80,
            'Protocol': 'HTTP',
        },
    ],
    LoadBalancerName='my-load-balancer',
    Scheme='internal',
    SecurityGroups=[
        'sg-a61988c3',
    ],
    Subnets=[
        'subnet-15aaab61',
    ],
)

print(response)

Expected Output:

{
    'DNSName': 'internal-my-load-balancer-123456789.us-west-2.elb.amazonaws.com',
    'ResponseMetadata': {
        '...': '...',
    },
}

Table Of Contents

create_load_balancer¶