ElasticLoadBalancingv2 / Client / create_load_balancer

create_load_balancer#

ElasticLoadBalancingv2.Client.create_load_balancer(**kwargs)#

Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.

For more information, see the following:

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.

Request Syntax

response = client.create_load_balancer(
    Name='string',
    Subnets=[
        'string',
    ],
    SubnetMappings=[
        {
            'SubnetId': 'string',
            'AllocationId': 'string',
            'PrivateIPv4Address': 'string',
            'IPv6Address': 'string'
        },
    ],
    SecurityGroups=[
        'string',
    ],
    Scheme='internet-facing'|'internal',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    Type='application'|'network'|'gateway',
    IpAddressType='ipv4'|'dualstack',
    CustomerOwnedIpv4Pool='string'
)

Parameters:

Name (string) –
[REQUIRED]

The name of the load balancer.

This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with “internal-“.
Subnets (list) –
The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets.

[Application Load Balancers] You must specify subnets from at least two Availability Zones.

[Application Load Balancers on Outposts] You must specify one Outpost subnet.

[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.

[Network Load Balancers] You can specify subnets from one or more Availability Zones.

[Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
- (string) –
SubnetMappings (list) –
The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both.

[Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets.

[Application Load Balancers on Outposts] You must specify one Outpost subnet.

[Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones.

[Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet.

[Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets.
- (dict) –
  
  Information about a subnet mapping.
  - SubnetId (string) –
    
    The ID of the subnet.
  - AllocationId (string) –
    
    [Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer.
  - PrivateIPv4Address (string) –
    
    [Network Load Balancers] The private IPv4 address for an internal load balancer.
  - IPv6Address (string) –
    
    [Network Load Balancers] The IPv6 address.
SecurityGroups (list) –
[Application Load Balancers] The IDs of the security groups for the load balancer.
- (string) –
Scheme (string) –
The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.

The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.

The default is an Internet-facing load balancer.

You cannot specify a scheme for a Gateway Load Balancer.
Tags (list) –
The tags to assign to the load balancer.
- (dict) –
  
  Information about a tag.
  - Key (string) – [REQUIRED]
    
    The key of the tag.
  - Value (string) –
    
    The value of the tag.
Type (string) – The type of load balancer. The default is application.
IpAddressType (string) – The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
CustomerOwnedIpv4Pool (string) – [Application Load Balancers on Outposts] The ID of the customer-owned address pool (CoIP pool).

Return type:

dict

Returns:

Response Syntax

{
    'LoadBalancers': [
        {
            'LoadBalancerArn': 'string',
            'DNSName': 'string',
            'CanonicalHostedZoneId': 'string',
            'CreatedTime': datetime(2015, 1, 1),
            'LoadBalancerName': 'string',
            'Scheme': 'internet-facing'|'internal',
            'VpcId': 'string',
            'State': {
                'Code': 'active'|'provisioning'|'active_impaired'|'failed',
                'Reason': 'string'
            },
            'Type': 'application'|'network'|'gateway',
            'AvailabilityZones': [
                {
                    'ZoneName': 'string',
                    'SubnetId': 'string',
                    'OutpostId': 'string',
                    'LoadBalancerAddresses': [
                        {
                            'IpAddress': 'string',
                            'AllocationId': 'string',
                            'PrivateIPv4Address': 'string',
                            'IPv6Address': 'string'
                        },
                    ]
                },
            ],
            'SecurityGroups': [
                'string',
            ],
            'IpAddressType': 'ipv4'|'dualstack',
            'CustomerOwnedIpv4Pool': 'string'
        },
    ]
}

Response Structure

(dict) –
- LoadBalancers (list) –
  
  Information about the load balancer.
  - (dict) –
    
    Information about a load balancer.
    - LoadBalancerArn (string) –
      
      The Amazon Resource Name (ARN) of the load balancer.
    - DNSName (string) –
      
      The public DNS name of the load balancer.
    - CanonicalHostedZoneId (string) –
      
      The ID of the Amazon Route 53 hosted zone associated with the load balancer.
    - CreatedTime (datetime) –
      
      The date and time the load balancer was created.
    - LoadBalancerName (string) –
      
      The name of the load balancer.
    - Scheme (string) –
      
      The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet.
      
      The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer.
    - VpcId (string) –
      
      The ID of the VPC for the load balancer.
    - State (dict) –
      
      The state of the load balancer.
      - Code (string) –
        
        The state code. The initial state of the load balancer is provisioning. After the load balancer is fully set up and ready to route traffic, its state is active. If load balancer is routing traffic but does not have the resources it needs to scale, its state is active_impaired. If the load balancer could not be set up, its state is failed.
      - Reason (string) –
        
        A description of the state.
    - Type (string) –
      
      The type of load balancer.
    - AvailabilityZones (list) –
      
      The subnets for the load balancer.
      - (dict) –
        
        Information about an Availability Zone.
        
        ZoneName (string) –
        
        The name of the Availability Zone.
        
        SubnetId (string) –
        
        The ID of the subnet. You can specify one subnet per Availability Zone.
        
        OutpostId (string) –
        
        [Application Load Balancers on Outposts] The ID of the Outpost.
        
        LoadBalancerAddresses (list) –
        
        [Network Load Balancers] If you need static IP addresses for your load balancer, you can specify one Elastic IP address per Availability Zone when you create an internal-facing load balancer. For internal load balancers, you can specify a private IP address from the IPv4 range of the subnet.
        
        (dict) –
        
        Information about a static IP address for a load balancer.
        
        IpAddress (string) –
        
        The static IP address.
        
        AllocationId (string) –
        
        [Network Load Balancers] The allocation ID of the Elastic IP address for an internal-facing load balancer.
        
        PrivateIPv4Address (string) –
        
        [Network Load Balancers] The private IPv4 address for an internal load balancer.
        
        IPv6Address (string) –
        
        [Network Load Balancers] The IPv6 address.
    - SecurityGroups (list) –
      
      The IDs of the security groups for the load balancer.
      - (string) –
    - IpAddressType (string) –
      
      The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
    - CustomerOwnedIpv4Pool (string) –
      
      [Application Load Balancers on Outposts] The ID of the customer-owned address pool.

Exceptions

ElasticLoadBalancingv2.Client.exceptions.DuplicateLoadBalancerNameException
ElasticLoadBalancingv2.Client.exceptions.TooManyLoadBalancersException
ElasticLoadBalancingv2.Client.exceptions.InvalidConfigurationRequestException
ElasticLoadBalancingv2.Client.exceptions.SubnetNotFoundException
ElasticLoadBalancingv2.Client.exceptions.InvalidSubnetException
ElasticLoadBalancingv2.Client.exceptions.InvalidSecurityGroupException
ElasticLoadBalancingv2.Client.exceptions.InvalidSchemeException
ElasticLoadBalancingv2.Client.exceptions.TooManyTagsException
ElasticLoadBalancingv2.Client.exceptions.DuplicateTagKeysException
ElasticLoadBalancingv2.Client.exceptions.ResourceInUseException
ElasticLoadBalancingv2.Client.exceptions.AllocationIdNotFoundException
ElasticLoadBalancingv2.Client.exceptions.AvailabilityZoneNotSupportedException
ElasticLoadBalancingv2.Client.exceptions.OperationNotPermittedException

Examples

This example creates an Internet-facing load balancer and enables the Availability Zones for the specified subnets.

response = client.create_load_balancer(
    Name='my-load-balancer',
    Subnets=[
        'subnet-b7d581c0',
        'subnet-8360a9e7',
    ],
)

print(response)

Expected Output:

{
    'LoadBalancers': [
        {
            'AvailabilityZones': [
                {
                    'SubnetId': 'subnet-8360a9e7',
                    'ZoneName': 'us-west-2a',
                },
                {
                    'SubnetId': 'subnet-b7d581c0',
                    'ZoneName': 'us-west-2b',
                },
            ],
            'CanonicalHostedZoneId': 'Z2P70J7EXAMPLE',
            'CreatedTime': datetime(2016, 3, 25, 21, 26, 12, 4, 85, 0),
            'DNSName': 'my-load-balancer-424835706.us-west-2.elb.amazonaws.com',
            'LoadBalancerArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188',
            'LoadBalancerName': 'my-load-balancer',
            'Scheme': 'internet-facing',
            'SecurityGroups': [
                'sg-5943793c',
            ],
            'State': {
                'Code': 'provisioning',
            },
            'Type': 'application',
            'VpcId': 'vpc-3ac0fb5f',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}

This example creates an internal load balancer and enables the Availability Zones for the specified subnets.

response = client.create_load_balancer(
    Name='my-internal-load-balancer',
    Scheme='internal',
    SecurityGroups=[
    ],
    Subnets=[
        'subnet-b7d581c0',
        'subnet-8360a9e7',
    ],
)

print(response)

Expected Output:

{
    'LoadBalancers': [
        {
            'AvailabilityZones': [
                {
                    'SubnetId': 'subnet-8360a9e7',
                    'ZoneName': 'us-west-2a',
                },
                {
                    'SubnetId': 'subnet-b7d581c0',
                    'ZoneName': 'us-west-2b',
                },
            ],
            'CanonicalHostedZoneId': 'Z2P70J7EXAMPLE',
            'CreatedTime': datetime(2016, 3, 25, 21, 29, 48, 4, 85, 0),
            'DNSName': 'internal-my-internal-load-balancer-1529930873.us-west-2.elb.amazonaws.com',
            'LoadBalancerArn': 'arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-internal-load-balancer/5b49b8d4303115c2',
            'LoadBalancerName': 'my-internal-load-balancer',
            'Scheme': 'internal',
            'SecurityGroups': [
                'sg-5943793c',
            ],
            'State': {
                'Code': 'provisioning',
            },
            'Type': 'application',
            'VpcId': 'vpc-3ac0fb5f',
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}