Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
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.
- createLoadBalancer :: Text -> Natural -> CreateLoadBalancer
- data CreateLoadBalancer
- clbHealthCheckPath :: Lens' CreateLoadBalancer (Maybe Text)
- clbCertificateName :: Lens' CreateLoadBalancer (Maybe Text)
- clbCertificateDomainName :: Lens' CreateLoadBalancer (Maybe Text)
- clbCertificateAlternativeNames :: Lens' CreateLoadBalancer [Text]
- clbLoadBalancerName :: Lens' CreateLoadBalancer Text
- clbInstancePort :: Lens' CreateLoadBalancer Natural
- createLoadBalancerResponse :: Int -> CreateLoadBalancerResponse
- data CreateLoadBalancerResponse
- clbrsOperations :: Lens' CreateLoadBalancerResponse [Operation]
- clbrsResponseStatus :: Lens' CreateLoadBalancerResponse Int
Creating a Request
Creates a value of CreateLoadBalancer
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
clbHealthCheckPath
- 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.clbCertificateName
- The name of the SSL/TLS certificate. If you specifycertificateName
, thencertificateDomainName
is required (and vice-versa).clbCertificateDomainName
- The domain name with which your certificate is associated (e.g.,example.com
). If you specifycertificateDomainName
, thencertificateName
is required (and vice-versa).clbCertificateAlternativeNames
- 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
).clbLoadBalancerName
- The name of your load balancer.clbInstancePort
- The instance port where you're creating your load balancer.
data CreateLoadBalancer Source #
See: createLoadBalancer
smart constructor.
Request Lenses
clbHealthCheckPath :: 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.
clbCertificateName :: Lens' CreateLoadBalancer (Maybe Text) Source #
The name of the SSL/TLS certificate. If you specify certificateName
, then certificateDomainName
is required (and vice-versa).
clbCertificateDomainName :: 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).
clbCertificateAlternativeNames :: Lens' CreateLoadBalancer [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
).
clbLoadBalancerName :: Lens' CreateLoadBalancer Text Source #
The name of your load balancer.
clbInstancePort :: Lens' CreateLoadBalancer Natural Source #
The instance port where you're creating your load balancer.
Destructuring the Response
createLoadBalancerResponse Source #
Creates a value of CreateLoadBalancerResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
clbrsOperations
- An object containing information about the API operations.clbrsResponseStatus
- -- | The response status code.
data CreateLoadBalancerResponse Source #
See: createLoadBalancerResponse
smart constructor.
Response Lenses
clbrsOperations :: Lens' CreateLoadBalancerResponse [Operation] Source #
An object containing information about the API operations.
clbrsResponseStatus :: Lens' CreateLoadBalancerResponse Int Source #
- - | The response status code.