Skip to content

CreateLoadBalancerRequest

Source code in docs_src/capo_lightsail/types/create_load_balancer_request.py
class CreateLoadBalancerRequest(TypedDict, closed=True):
    load_balancer_name: "capo_lightsail.types.resource_name.ResourceName"
    """<p>The name of your load balancer.</p>"""
    instance_port: "capo_lightsail.types.port.Port"
    """<p>The instance port where you're creating your load balancer.</p>"""
    health_check_path: NotRequired["capo_lightsail.types.string.string"]
    """<p>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 (<code>"/"</code>).</p> <p>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.</p>"""
    certificate_name: NotRequired["capo_lightsail.types.resource_name.ResourceName"]
    """<p>The name of the SSL/TLS certificate.</p> <p>If you specify <code>certificateName</code>, then <code>certificateDomainName</code> is required (and vice-versa).</p>"""
    certificate_domain_name: NotRequired["capo_lightsail.types.domain_name.DomainName"]
    """<p>The domain name with which your certificate is associated (<code>example.com</code>).</p> <p>If you specify <code>certificateDomainName</code>, then <code>certificateName</code> is required (and vice-versa).</p>"""
    certificate_alternative_names: NotRequired[
        "capo_lightsail.types.domain_name_list.DomainNameList"
    ]
    """<p>The optional alternative domains and subdomains to use with your SSL/TLS certificate (<code>www.example.com</code>, <code>example.com</code>, <code>m.example.com</code>, <code>blog.example.com</code>).</p>"""
    tags: NotRequired["capo_lightsail.types.tag_list.TagList"]
    """<p>The tag keys and optional values to add to the resource during create.</p> <p>Use the <code>TagResource</code> action to tag a resource after it's created.</p>"""
    ip_address_type: NotRequired["capo_lightsail.types.ip_address_type.IpAddressType"]
    """<p>The IP address type for the load balancer.</p> <p>The possible values are <code>ipv4</code> for IPv4 only, <code>ipv6</code> for IPv6 only, and <code>dualstack</code> for IPv4 and IPv6.</p> <p>The default value is <code>dualstack</code>.</p>"""
    tls_policy_name: NotRequired["capo_lightsail.types.string.string"]
    """<p>The name of the TLS policy to apply to the load balancer.</p> <p>Use the <a href="https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetLoadBalancerTlsPolicies.html">GetLoadBalancerTlsPolicies</a> action to get a list of TLS policy names that you can specify.</p> <p>For more information about load balancer TLS policies, see <a href="https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configure-load-balancer-tls-security-policy">Configuring TLS security policies on your Amazon Lightsail load balancers</a> in the <i>Amazon Lightsail Developer Guide</i>.</p>"""

certificate_alternative_names instance-attribute

certificate_alternative_names: NotRequired[DomainNameList]

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

certificate_domain_name instance-attribute

certificate_domain_name: NotRequired[DomainName]

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

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

certificate_name instance-attribute

certificate_name: NotRequired[ResourceName]

The name of the SSL/TLS certificate.

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

health_check_path instance-attribute

health_check_path: NotRequired[string]

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

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.

instance_port instance-attribute

instance_port: Port

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

ip_address_type instance-attribute

ip_address_type: NotRequired[IpAddressType]

The IP address type for the load balancer.

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

The default value is dualstack.

load_balancer_name instance-attribute

load_balancer_name: ResourceName

The name of your load balancer.

tags instance-attribute

tags: NotRequired[TagList]

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.

tls_policy_name instance-attribute

tls_policy_name: NotRequired[string]

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.