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.Lightsail.CreateLoadBalancer

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Configure your Lightsail instances for load balancing. You can create up to 5 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.

Synopsis

data CreateLoadBalancer = CreateLoadBalancer' {
- healthCheckPath :: Maybe Text
- certificateName :: Maybe Text
- certificateDomainName :: Maybe Text
- certificateAlternativeNames :: Maybe [Text]
- ipAddressType :: Maybe IpAddressType
- tags :: Maybe [Tag]
- loadBalancerName :: Text
- instancePort :: Int
}
newCreateLoadBalancer :: Text -> Int -> CreateLoadBalancer
createLoadBalancer_healthCheckPath :: Lens' CreateLoadBalancer (Maybe Text)
createLoadBalancer_certificateName :: Lens' CreateLoadBalancer (Maybe Text)
createLoadBalancer_certificateDomainName :: Lens' CreateLoadBalancer (Maybe Text)
createLoadBalancer_certificateAlternativeNames :: Lens' CreateLoadBalancer (Maybe [Text])
createLoadBalancer_ipAddressType :: Lens' CreateLoadBalancer (Maybe IpAddressType)
createLoadBalancer_tags :: Lens' CreateLoadBalancer (Maybe [Tag])
createLoadBalancer_loadBalancerName :: Lens' CreateLoadBalancer Text
createLoadBalancer_instancePort :: Lens' CreateLoadBalancer Int
data CreateLoadBalancerResponse = CreateLoadBalancerResponse' {
- operations :: Maybe [Operation]
- httpStatus :: Int
}
newCreateLoadBalancerResponse :: Int -> CreateLoadBalancerResponse
createLoadBalancerResponse_operations :: Lens' CreateLoadBalancerResponse (Maybe [Operation])
createLoadBalancerResponse_httpStatus :: Lens' CreateLoadBalancerResponse Int

Creating a Request

data CreateLoadBalancer Source #

See: newCreateLoadBalancer smart constructor.

Constructors

CreateLoadBalancer'

Fields

healthCheckPath :: Maybe Text
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 (e.g., "/").
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.
certificateName :: Maybe Text
The name of the SSL/TLS certificate.
If you specify certificateName, then certificateDomainName is required (and vice-versa).
certificateDomainName :: Maybe Text
The domain name with which your certificate is associated (e.g., example.com).
If you specify certificateDomainName, then certificateName is required (and vice-versa).
certificateAlternativeNames :: Maybe [Text]
The optional alternative domains and subdomains to use with your SSL/TLS certificate (e.g., www.example.com, example.com, m.example.com, blog.example.com).
ipAddressType :: Maybe IpAddressType
The IP address type for the load balancer.
The possible values are ipv4 for IPv4 only, and dualstack for IPv4 and IPv6.
The default value is dualstack.
tags :: Maybe [Tag]
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.
loadBalancerName :: Text
The name of your load balancer.
instancePort :: Int
The instance port where you're creating your load balancer.

Instances

Instances details

Eq CreateLoadBalancer Source #
Instance details Defined in Amazonka.Lightsail.CreateLoadBalancer Methods (==) :: CreateLoadBalancer -> CreateLoadBalancer -> Bool # (/=) :: CreateLoadBalancer -> CreateLoadBalancer -> Bool #
Read CreateLoadBalancer Source #
Instance details Defined in Amazonka.Lightsail.CreateLoadBalancer Methods readsPrec :: Int -> ReadS CreateLoadBalancer # readList :: ReadS [CreateLoadBalancer] # readPrec :: ReadPrec CreateLoadBalancer # readListPrec :: ReadPrec [CreateLoadBalancer] #
Show CreateLoadBalancer Source #
Instance details Defined in Amazonka.Lightsail.CreateLoadBalancer Methods showsPrec :: Int -> CreateLoadBalancer -> ShowS # show :: CreateLoadBalancer -> String # showList :: [CreateLoadBalancer] -> ShowS #
Generic CreateLoadBalancer Source #
Instance details Defined in Amazonka.Lightsail.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.Lightsail.CreateLoadBalancer Methods rnf :: CreateLoadBalancer -> () #
Hashable CreateLoadBalancer Source #
Instance details Defined in Amazonka.Lightsail.CreateLoadBalancer Methods hashWithSalt :: Int -> CreateLoadBalancer -> Int # hash :: CreateLoadBalancer -> Int #
ToJSON CreateLoadBalancer Source #
Instance details Defined in Amazonka.Lightsail.CreateLoadBalancer Methods toJSON :: CreateLoadBalancer -> Value # toEncoding :: CreateLoadBalancer -> Encoding # toJSONList :: [CreateLoadBalancer] -> Value # toEncodingList :: [CreateLoadBalancer] -> Encoding #
AWSRequest CreateLoadBalancer Source #
Instance details Defined in Amazonka.Lightsail.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.Lightsail.CreateLoadBalancer Methods toHeaders :: CreateLoadBalancer -> [Header] #
ToPath CreateLoadBalancer Source #
Instance details Defined in Amazonka.Lightsail.CreateLoadBalancer Methods toPath :: CreateLoadBalancer -> ByteString #
ToQuery CreateLoadBalancer Source #
Instance details Defined in Amazonka.Lightsail.CreateLoadBalancer Methods toQuery :: CreateLoadBalancer -> QueryString #
type Rep CreateLoadBalancer Source #
Instance details Defined in Amazonka.Lightsail.CreateLoadBalancer type Rep CreateLoadBalancer = D1 ('MetaData "CreateLoadBalancer" "Amazonka.Lightsail.CreateLoadBalancer" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "CreateLoadBalancer'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "healthCheckPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "certificateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "certificateDomainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "certificateAlternativeNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: ((S1 ('MetaSel ('Just "ipAddressType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IpAddressType)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :: (S1 ('MetaSel ('Just "loadBalancerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "instancePort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))
type AWSResponse CreateLoadBalancer Source #
Instance details Defined in Amazonka.Lightsail.CreateLoadBalancer type AWSResponse CreateLoadBalancer = CreateLoadBalancerResponse

newCreateLoadBalancer Source #

Arguments

:: Text	`$sel:loadBalancerName:CreateLoadBalancer'`
-> Int	`$sel:instancePort: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:healthCheckPath:CreateLoadBalancer', createLoadBalancer_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 (e.g., "/").

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.

$sel:certificateName:CreateLoadBalancer', createLoadBalancer_certificateName - The name of the SSL/TLS certificate.

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

$sel:certificateDomainName:CreateLoadBalancer', createLoadBalancer_certificateDomainName - The domain name with which your certificate is associated (e.g., example.com).

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

$sel:certificateAlternativeNames:CreateLoadBalancer', createLoadBalancer_certificateAlternativeNames - The optional alternative domains and subdomains to use with your SSL/TLS certificate (e.g., www.example.com, example.com, m.example.com, blog.example.com).

$sel:ipAddressType:CreateLoadBalancer', createLoadBalancer_ipAddressType - The IP address type for the load balancer.

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

The default value is dualstack.

$sel:tags:CreateLoadBalancer', createLoadBalancer_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.

$sel:loadBalancerName:CreateLoadBalancer', createLoadBalancer_loadBalancerName - The name of your load balancer.

$sel:instancePort:CreateLoadBalancer', createLoadBalancer_instancePort - The instance port where you're creating your load balancer.

Request Lenses

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

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 (e.g., "/").

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.

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

The name of the SSL/TLS certificate.

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

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

The domain name with which your certificate is associated (e.g., example.com).

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

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

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

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

The IP address type for the load balancer.

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

The default value is dualstack.

createLoadBalancer_tags :: Lens' CreateLoadBalancer (Maybe [Tag]) Source #

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.

createLoadBalancer_loadBalancerName :: Lens' CreateLoadBalancer Text Source #

The name of your load balancer.

createLoadBalancer_instancePort :: Lens' CreateLoadBalancer Int Source #

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

Destructuring the Response

data CreateLoadBalancerResponse Source #

See: newCreateLoadBalancerResponse smart constructor.

Constructors

CreateLoadBalancerResponse'
Fields operations :: Maybe [Operation] 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. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq CreateLoadBalancerResponse Source #
Instance details Defined in Amazonka.Lightsail.CreateLoadBalancer Methods (==) :: CreateLoadBalancerResponse -> CreateLoadBalancerResponse -> Bool # (/=) :: CreateLoadBalancerResponse -> CreateLoadBalancerResponse -> Bool #
Read CreateLoadBalancerResponse Source #
Instance details Defined in Amazonka.Lightsail.CreateLoadBalancer Methods readsPrec :: Int -> ReadS CreateLoadBalancerResponse # readList :: ReadS [CreateLoadBalancerResponse] # readPrec :: ReadPrec CreateLoadBalancerResponse # readListPrec :: ReadPrec [CreateLoadBalancerResponse] #
Show CreateLoadBalancerResponse Source #
Instance details Defined in Amazonka.Lightsail.CreateLoadBalancer Methods showsPrec :: Int -> CreateLoadBalancerResponse -> ShowS # show :: CreateLoadBalancerResponse -> String # showList :: [CreateLoadBalancerResponse] -> ShowS #
Generic CreateLoadBalancerResponse Source #
Instance details Defined in Amazonka.Lightsail.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.Lightsail.CreateLoadBalancer Methods rnf :: CreateLoadBalancerResponse -> () #
type Rep CreateLoadBalancerResponse Source #
Instance details Defined in Amazonka.Lightsail.CreateLoadBalancer type Rep CreateLoadBalancerResponse = D1 ('MetaData "CreateLoadBalancerResponse" "Amazonka.Lightsail.CreateLoadBalancer" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "CreateLoadBalancerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "operations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Operation])) :*: 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:operations:CreateLoadBalancerResponse', createLoadBalancerResponse_operations - 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.

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

Response Lenses

createLoadBalancerResponse_operations :: Lens' CreateLoadBalancerResponse (Maybe [Operation]) Source #

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.

createLoadBalancerResponse_httpStatus :: Lens' CreateLoadBalancerResponse Int Source #

The response's http status code.