Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ELBV2.CreateLoadBalancer

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

data CreateLoadBalancer = CreateLoadBalancer' {
- subnetMappings :: Maybe [SubnetMapping]
- securityGroups :: Maybe [Text]
- subnets :: Maybe [Text]
- customerOwnedIpv4Pool :: Maybe Text
- ipAddressType :: Maybe IpAddressType
- scheme :: Maybe LoadBalancerSchemeEnum
- type' :: Maybe LoadBalancerTypeEnum
- tags :: Maybe (NonEmpty Tag)
- name :: Text
}
newCreateLoadBalancer :: Text -> CreateLoadBalancer
createLoadBalancer_subnetMappings :: Lens' CreateLoadBalancer (Maybe [SubnetMapping])
createLoadBalancer_securityGroups :: Lens' CreateLoadBalancer (Maybe [Text])
createLoadBalancer_subnets :: Lens' CreateLoadBalancer (Maybe [Text])
createLoadBalancer_customerOwnedIpv4Pool :: Lens' CreateLoadBalancer (Maybe Text)
createLoadBalancer_ipAddressType :: Lens' CreateLoadBalancer (Maybe IpAddressType)
createLoadBalancer_scheme :: Lens' CreateLoadBalancer (Maybe LoadBalancerSchemeEnum)
createLoadBalancer_type :: Lens' CreateLoadBalancer (Maybe LoadBalancerTypeEnum)
createLoadBalancer_tags :: Lens' CreateLoadBalancer (Maybe (NonEmpty Tag))
createLoadBalancer_name :: Lens' CreateLoadBalancer Text
data CreateLoadBalancerResponse = CreateLoadBalancerResponse' {
- loadBalancers :: Maybe [LoadBalancer]
- httpStatus :: Int
}
newCreateLoadBalancerResponse :: Int -> CreateLoadBalancerResponse
createLoadBalancerResponse_loadBalancers :: Lens' CreateLoadBalancerResponse (Maybe [LoadBalancer])
createLoadBalancerResponse_httpStatus :: Lens' CreateLoadBalancerResponse Int

Creating a Request

data CreateLoadBalancer Source #

See: newCreateLoadBalancer smart constructor.

Constructors

CreateLoadBalancer'

Fields

subnetMappings :: Maybe [SubnetMapping]
The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.
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.
securityGroups :: Maybe [Text]
Application Load Balancers
The IDs of the security groups for the load balancer.
subnets :: Maybe [Text]
The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.
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.
customerOwnedIpv4Pool :: Maybe Text
Application Load Balancers on Outposts
The ID of the customer-owned address pool (CoIP pool).
ipAddressType :: Maybe IpAddressType
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). Internal load balancers must use ipv4.
scheme :: Maybe LoadBalancerSchemeEnum
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.
type' :: Maybe LoadBalancerTypeEnum
The type of load balancer. The default is application.
tags :: Maybe (NonEmpty Tag)
The tags to assign to the load balancer.
name :: Text
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-".

Instances

Instances details

Eq CreateLoadBalancer Source #
Instance details Defined in Amazonka.ELBV2.CreateLoadBalancer Methods (==) :: CreateLoadBalancer -> CreateLoadBalancer -> Bool # (/=) :: CreateLoadBalancer -> CreateLoadBalancer -> Bool #
Read CreateLoadBalancer Source #
Instance details Defined in Amazonka.ELBV2.CreateLoadBalancer Methods readsPrec :: Int -> ReadS CreateLoadBalancer # readList :: ReadS [CreateLoadBalancer] # readPrec :: ReadPrec CreateLoadBalancer # readListPrec :: ReadPrec [CreateLoadBalancer] #
Show CreateLoadBalancer Source #
Instance details Defined in Amazonka.ELBV2.CreateLoadBalancer Methods showsPrec :: Int -> CreateLoadBalancer -> ShowS # show :: CreateLoadBalancer -> String # showList :: [CreateLoadBalancer] -> ShowS #
Generic CreateLoadBalancer Source #
Instance details Defined in Amazonka.ELBV2.CreateLoadBalancer Associated Types type Rep CreateLoadBalancer :: Type -> Type # Methods from :: CreateLoadBalancer -> Rep CreateLoadBalancer x # to :: Rep CreateLoadBalancer x -> CreateLoadBalancer #
NFData CreateLoadBalancer Source #
Instance details Defined in Amazonka.ELBV2.CreateLoadBalancer Methods rnf :: CreateLoadBalancer -> () #
Hashable CreateLoadBalancer Source #
Instance details Defined in Amazonka.ELBV2.CreateLoadBalancer Methods hashWithSalt :: Int -> CreateLoadBalancer -> Int # hash :: CreateLoadBalancer -> Int #
AWSRequest CreateLoadBalancer Source #
Instance details Defined in Amazonka.ELBV2.CreateLoadBalancer Associated Types type AWSResponse CreateLoadBalancer # Methods request :: CreateLoadBalancer -> Request CreateLoadBalancer # response :: MonadResource m => Logger -> Service -> Proxy CreateLoadBalancer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateLoadBalancer))) #
ToHeaders CreateLoadBalancer Source #
Instance details Defined in Amazonka.ELBV2.CreateLoadBalancer Methods toHeaders :: CreateLoadBalancer -> [Header] #
ToPath CreateLoadBalancer Source #
Instance details Defined in Amazonka.ELBV2.CreateLoadBalancer Methods toPath :: CreateLoadBalancer -> ByteString #
ToQuery CreateLoadBalancer Source #
Instance details Defined in Amazonka.ELBV2.CreateLoadBalancer Methods toQuery :: CreateLoadBalancer -> QueryString #
type Rep CreateLoadBalancer Source #
Instance details Defined in Amazonka.ELBV2.CreateLoadBalancer type Rep CreateLoadBalancer = D1 ('MetaData "CreateLoadBalancer" "Amazonka.ELBV2.CreateLoadBalancer" "libZSservicesZSamazonka-elbv2ZSamazonka-elbv2" 'False) (C1 ('MetaCons "CreateLoadBalancer'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "subnetMappings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SubnetMapping])) :: S1 ('MetaSel ('Just "securityGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "subnets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "customerOwnedIpv4Pool") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "ipAddressType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpAddressType)) :: S1 ('MetaSel ('Just "scheme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoadBalancerSchemeEnum))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoadBalancerTypeEnum)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse CreateLoadBalancer Source #
Instance details Defined in Amazonka.ELBV2.CreateLoadBalancer type AWSResponse CreateLoadBalancer = CreateLoadBalancerResponse

newCreateLoadBalancer Source #

Arguments

:: Text	`$sel:name:CreateLoadBalancer'`
-> CreateLoadBalancer

Create a value of CreateLoadBalancer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:subnetMappings:CreateLoadBalancer', createLoadBalancer_subnetMappings - The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

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.

$sel:securityGroups:CreateLoadBalancer', createLoadBalancer_securityGroups - [Application Load Balancers] The IDs of the security groups for the load balancer.

$sel:subnets:CreateLoadBalancer', createLoadBalancer_subnets - The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

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.

$sel:customerOwnedIpv4Pool:CreateLoadBalancer', createLoadBalancer_customerOwnedIpv4Pool - [Application Load Balancers on Outposts] The ID of the customer-owned address pool (CoIP pool).

$sel:ipAddressType:CreateLoadBalancer', createLoadBalancer_ipAddressType - 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). Internal load balancers must use ipv4.

$sel:scheme:CreateLoadBalancer', createLoadBalancer_scheme - 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.

$sel:type':CreateLoadBalancer', createLoadBalancer_type - The type of load balancer. The default is application.

$sel:tags:CreateLoadBalancer', createLoadBalancer_tags - The tags to assign to the load balancer.

$sel:name:CreateLoadBalancer', createLoadBalancer_name - 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-".

Request Lenses

createLoadBalancer_subnetMappings :: Lens' CreateLoadBalancer (Maybe [SubnetMapping]) Source #

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

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.

createLoadBalancer_securityGroups :: Lens' CreateLoadBalancer (Maybe [Text]) Source #

Application Load Balancers: The IDs of the security groups for the load balancer.

createLoadBalancer_subnets :: Lens' CreateLoadBalancer (Maybe [Text]) Source #

The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings.

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.

createLoadBalancer_customerOwnedIpv4Pool :: Lens' CreateLoadBalancer (Maybe Text) Source #

Application Load Balancers on Outposts: The ID of the customer-owned address pool (CoIP pool).

createLoadBalancer_ipAddressType :: Lens' CreateLoadBalancer (Maybe IpAddressType) Source #

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). Internal load balancers must use ipv4.

createLoadBalancer_scheme :: Lens' CreateLoadBalancer (Maybe LoadBalancerSchemeEnum) Source #

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.

createLoadBalancer_type :: Lens' CreateLoadBalancer (Maybe LoadBalancerTypeEnum) Source #

The type of load balancer. The default is application.

createLoadBalancer_tags :: Lens' CreateLoadBalancer (Maybe (NonEmpty Tag)) Source #

The tags to assign to the load balancer.

createLoadBalancer_name :: Lens' CreateLoadBalancer Text Source #

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

Destructuring the Response

data CreateLoadBalancerResponse Source #

See: newCreateLoadBalancerResponse smart constructor.

Constructors

CreateLoadBalancerResponse'
Fields loadBalancers :: Maybe [LoadBalancer] Information about the load balancer. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateLoadBalancerResponse Source #
Instance details Defined in Amazonka.ELBV2.CreateLoadBalancer Methods (==) :: CreateLoadBalancerResponse -> CreateLoadBalancerResponse -> Bool # (/=) :: CreateLoadBalancerResponse -> CreateLoadBalancerResponse -> Bool #
Read CreateLoadBalancerResponse Source #
Instance details Defined in Amazonka.ELBV2.CreateLoadBalancer Methods readsPrec :: Int -> ReadS CreateLoadBalancerResponse # readList :: ReadS [CreateLoadBalancerResponse] # readPrec :: ReadPrec CreateLoadBalancerResponse # readListPrec :: ReadPrec [CreateLoadBalancerResponse] #
Show CreateLoadBalancerResponse Source #
Instance details Defined in Amazonka.ELBV2.CreateLoadBalancer Methods showsPrec :: Int -> CreateLoadBalancerResponse -> ShowS # show :: CreateLoadBalancerResponse -> String # showList :: [CreateLoadBalancerResponse] -> ShowS #
Generic CreateLoadBalancerResponse Source #
Instance details Defined in Amazonka.ELBV2.CreateLoadBalancer Associated Types type Rep CreateLoadBalancerResponse :: Type -> Type # Methods from :: CreateLoadBalancerResponse -> Rep CreateLoadBalancerResponse x # to :: Rep CreateLoadBalancerResponse x -> CreateLoadBalancerResponse #
NFData CreateLoadBalancerResponse Source #
Instance details Defined in Amazonka.ELBV2.CreateLoadBalancer Methods rnf :: CreateLoadBalancerResponse -> () #
type Rep CreateLoadBalancerResponse Source #
Instance details Defined in Amazonka.ELBV2.CreateLoadBalancer type Rep CreateLoadBalancerResponse = D1 ('MetaData "CreateLoadBalancerResponse" "Amazonka.ELBV2.CreateLoadBalancer" "libZSservicesZSamazonka-elbv2ZSamazonka-elbv2" 'False) (C1 ('MetaCons "CreateLoadBalancerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "loadBalancers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LoadBalancer])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateLoadBalancerResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateLoadBalancerResponse'`
-> CreateLoadBalancerResponse

Create a value of CreateLoadBalancerResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:loadBalancers:CreateLoadBalancerResponse', createLoadBalancerResponse_loadBalancers - Information about the load balancer.

$sel:httpStatus:CreateLoadBalancerResponse', createLoadBalancerResponse_httpStatus - The response's http status code.

Response Lenses

createLoadBalancerResponse_loadBalancers :: Lens' CreateLoadBalancerResponse (Maybe [LoadBalancer]) Source #

Information about the load balancer.

createLoadBalancerResponse_httpStatus :: Lens' CreateLoadBalancerResponse Int Source #

The response's http status code.