salt.states.boto_elbv2

Manage AWS Application Load Balancer

Add and remove targets from an ALB target group.

This module uses boto3, which can be installed via package, or pip.

This module accepts explicit alb credentials but can also utilize IAM roles assigned to the instance through Instance Profiles. Dynamic credentials are then automatically obtained from AWS API and no further configuration is necessary. More information available here.

If IAM roles are not used you need to specify them either in a pillar file or in the minion's config file:

elbv2.keyid: GKTADJGHEIQSXMKKRBJ08H
elbv2.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
elbv2.region: us-west-2

It's also possible to specify key, keyid and region via a profile, either passed in as a dict, or as a string to pull from pillars or minion config:

myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
    region: us-east-1

salt.states.boto_elbv2.create_target_group(name, protocol, port, vpc_id, region=None, key=None, keyid=None, profile=None, health_check_protocol='HTTP', health_check_port='traffic-port', health_check_path='/', health_check_interval_seconds=30, health_check_timeout_seconds=5, healthy_threshold_count=5, unhealthy_threshold_count=2, **kwargs)

New in version 2017.11.0.

Create target group if not present.

name

(string) - The name of the target group.

protocol

(string) - The protocol to use for routing traffic to the targets

port

(int) - The port on which the targets receive traffic. This port is used unless you specify a port override when registering the traffic.

vpc_id

(string) - The identifier of the virtual private cloud (VPC).

health_check_protocol

(string) - The protocol the load balancer uses when performing health check on targets. The default is the HTTP protocol.

health_check_port

(string) - The port the load balancer uses when performing health checks on targets. The default is 'traffic-port', which indicates the port on which each target receives traffic from the load balancer.

health_check_path

(string) - The ping path that is the destination on the targets for health checks. The default is /.

health_check_interval_seconds

(integer) - The approximate amount of time, in seconds, between health checks of an individual target. The default is 30 seconds.

health_check_timeout_seconds

(integer) - The amount of time, in seconds, during which no response from a target means a failed health check. The default is 5 seconds.

healthy_threshold_count

(integer) - The number of consecutive health checks successes required before considering an unhealthy target healthy. The default is 5.

unhealthy_threshold_count

(integer) - The number of consecutive health check failures required before considering a target unhealthy. The default is 2.

returns

(bool) - True on success, False on failure.

CLI Example:

create-target:
  boto_elb2.create_targets_group:
    - name: myALB
    - protocol: https
    - port: 443
    - vpc_id: myVPC

salt.states.boto_elbv2.delete_target_group(name, region=None, key=None, keyid=None, profile=None)

Delete target group.

name

(string) - The Amazon Resource Name (ARN) of the resource.

returns

(bool) - True on success, False on failure.

CLI Example:

check-target:
  boto_elb2.delete_targets_group:
    - name: myALB
    - protocol: https
    - port: 443
    - vpc_id: myVPC

salt.states.boto_elbv2.targets_deregistered(name, targets, region=None, key=None, keyid=None, profile=None, **kwargs)

Remove targets to an Application Load Balancer target group.

name

The ARN of the Application Load Balancer Target Group to remove targets from.

targets

A list of target IDs or a string of a single target registered to the target group to be removed

New in version 2017.7.0.

remove-targets:
  boto_elb.targets_deregistered:
    - name: arn:myloadbalancer
    - targets:
      - instance-id1
      - instance-id2

salt.states.boto_elbv2.targets_registered(name, targets, region=None, key=None, keyid=None, profile=None, **kwargs)

New in version 2017.7.0.

Add targets to an Application Load Balancer target group. This state will not remove targets.

name

The ARN of the Application Load Balancer Target Group to add targets to.

targets

A list of target IDs or a string of a single target that this target group should distribute traffic to.

add-targets:
  boto_elb.targets_registered:
    - name: arn:myloadbalancer
    - targets:
      - instance-id1
      - instance-id2