| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Lightsail.CreateLoadBalancer
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' {}
- newCreateLoadBalancer :: Text -> Int -> CreateLoadBalancer
- createLoadBalancer_certificateAlternativeNames :: Lens' CreateLoadBalancer (Maybe [Text])
- createLoadBalancer_certificateDomainName :: Lens' CreateLoadBalancer (Maybe Text)
- createLoadBalancer_certificateName :: Lens' CreateLoadBalancer (Maybe Text)
- createLoadBalancer_healthCheckPath :: Lens' CreateLoadBalancer (Maybe Text)
- createLoadBalancer_ipAddressType :: Lens' CreateLoadBalancer (Maybe IpAddressType)
- createLoadBalancer_tags :: Lens' CreateLoadBalancer (Maybe [Tag])
- createLoadBalancer_tlsPolicyName :: Lens' CreateLoadBalancer (Maybe Text)
- 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
| |
Instances
newCreateLoadBalancer Source #
Arguments
| :: Text | |
| -> Int | |
| -> 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: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: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).
CreateLoadBalancer, createLoadBalancer_certificateName - The name of the SSL/TLS certificate.
If you specify certificateName, then certificateDomainName is
required (and vice-versa).
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.
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.
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.
CreateLoadBalancer, createLoadBalancer_tlsPolicyName - The name of the TLS policy to apply to the load balancer.
Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can specify.
For more information about load balancer TLS policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.
CreateLoadBalancer, createLoadBalancer_loadBalancerName - The name of your load balancer.
CreateLoadBalancer, createLoadBalancer_instancePort - The instance port where you're creating your load balancer.
Request Lenses
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_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_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_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_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_tlsPolicyName :: Lens' CreateLoadBalancer (Maybe Text) Source #
The name of the TLS policy to apply to the load balancer.
Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can specify.
For more information about load balancer TLS policies, see Configuring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide.
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
| |
Instances
newCreateLoadBalancerResponse Source #
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.