aws_load_balancer.md
April 1, 2019 ยท View on GitHub
Document: "elasticloadbalancingv2"
LoadBalancer
aws_load_balancer {
ip_address_type => $aws_ip_address_type
load_balancer_arn => $aws_load_balancer_arn
load_balancer_arns => "LoadBalancerArns (optional)",
name => $aws_load_balancer_name
names => "Names (optional)",
page_size => $aws_page_size
scheme => $aws_load_balancer_scheme_enum
security_groups => "SecurityGroups (optional)",
subnet_mappings => "SubnetMappings (optional)",
subnets => "Subnets (optional)",
tags => "Tags (optional)",
type => $aws_load_balancer_type_enum
}
| Name | Type | Required |
|---|---|---|
| ip_address_type | IpAddressType | false |
| load_balancer_arn | LoadBalancerArn | false |
| load_balancer_arns | LoadBalancerArns | false |
| name | LoadBalancerName | false |
| names | LoadBalancerNames | false |
| page_size | PageSize | false |
| scheme | LoadBalancerSchemeEnum | false |
| security_groups | SecurityGroups | false |
| subnet_mappings | SubnetMappings | false |
| subnets | Subnets | false |
| tags | TagList | false |
| type | LoadBalancerTypeEnum | false |
CRUD operations
Here is a list of endpoints that we use to create, read, update and delete the LoadBalancer
| Operation | Path | Verb | Description | OperationID |
|---|---|---|---|---|
| Create | / | POST | Creates an Application Load Balancer or a Network Load Balancer. When you create a load balancer, you can specify security groups, public subnets, IP address type, and tags. Otherwise, you could do so later using SetSecurityGroups, SetSubnets, SetIpAddressType, and AddTags. To create listeners for your load balancer, use CreateListener. To describe your current load balancers, see DescribeLoadBalancers. When you are finished with a load balancer, you can delete it using DeleteLoadBalancer. For limit information, see Limits for Your Application Load Balancer in the Application Load Balancers Guide and Limits for Your Network Load Balancer in the Network Load Balancers Guide. This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple load balancers with the same settings, each call succeeds. For more information, see Application Load Balancers in the Application Load Balancers Guide and Network Load Balancers in the Network Load Balancers Guide. | CreateLoadBalancer |
| List - list all | / | POST | Describes the specified load balancers or all of your load balancers. To describe the listeners for a load balancer, use DescribeListeners. To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes. | DescribeLoadBalancers |
| List - get one | `` | |||
| List - get list using params | / | POST | Describes the specified load balancers or all of your load balancers. To describe the listeners for a load balancer, use DescribeListeners. To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes. | DescribeLoadBalancers |
| Update | `` | |||
| Delete | / | POST | Deletes the specified Application Load Balancer or Network Load Balancer and its attached listeners. You can't delete a load balancer if deletion protection is enabled. If the load balancer does not exist or has already been deleted, the call succeeds. Deleting a load balancer does not affect its registered targets. For example, your EC2 instances continue to run and are still registered to their target groups. If you no longer need these EC2 instances, you can stop or terminate them. | DeleteLoadBalancer |