paws.compute (version 0.1.0)

lightsail_create_load_balancer: Creates a Lightsail load balancer

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.

Usage

lightsail_create_load_balancer(loadBalancerName, instancePort,
  healthCheckPath, certificateName, certificateDomainName,
  certificateAlternativeNames, tags)

Arguments

loadBalancerName

[required] The name of your load balancer.

instancePort

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

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.

certificateName

The name of the SSL/TLS certificate.

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

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

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

tags

The tag keys and optional values to add to the resource during create.

To tag a resource after it has been created, see the tag resource operation.

Request syntax

svc$create_load_balancer(
  loadBalancerName = "string",
  instancePort = 123,
  healthCheckPath = "string",
  certificateName = "string",
  certificateDomainName = "string",
  certificateAlternativeNames = list(
    "string"
  ),
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  )
)

Details

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 Lightsail Dev Guide.