Skip to main content

load_balancer

Gets an individual load_balancer resource

Overview

Nameload_balancer
TypeResource
Descriptionload_balancer
Idawscc.lightsail.load_balancer

Fields

NameDatatypeDescription
load_balancer_namestringThe name of your load balancer.
load_balancer_arnstring
instance_portintegerThe instance port where you're creating your load balancer.
ip_address_typestringThe 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.
attached_instancesarrayThe names of the instances attached to the load balancer.
health_check_pathstringThe 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., "/").
session_stickiness_enabledbooleanConfiguration option to enable session stickiness.
session_stickiness_lb_cookie_duration_secondsstringConfiguration option to adjust session stickiness cookie duration parameter.
tls_policy_namestringThe name of the TLS policy to apply to the load balancer.
tagsarrayAn array of key-value pairs to apply to this resource.
regionstringAWS region.

Methods

Currently only SELECT is supported for this resource resource.

Example

SELECT
region,
load_balancer_name,
load_balancer_arn,
instance_port,
ip_address_type,
attached_instances,
health_check_path,
session_stickiness_enabled,
session_stickiness_lb_cookie_duration_seconds,
tls_policy_name,
tags
FROM awscc.lightsail.load_balancer
WHERE data__Identifier = '<LoadBalancerName>';

Permissions

To operate on the load_balancer resource, the following permissions are required:

Read

lightsail:GetLoadBalancer,
lightsail:GetLoadBalancers

Update

lightsail:GetLoadBalancer,
lightsail:GetLoadBalancers,
lightsail:GetInstance,
lightsail:AttachInstancesToLoadBalancer,
lightsail:DetachInstancesFromLoadBalancer,
lightsail:UpdateLoadBalancerAttribute,
lightsail:TagResource,
lightsail:UntagResource

Delete

lightsail:DeleteLoadBalancer,
lightsail:GetLoadBalancer,
lightsail:GetLoadBalancers