boto3_elbv2

Connection module for Amazon Elastic Load Balancing v2 using boto3.

Renamed from boto_elbv2 to boto3_elbv2 and rewritten to use the boto3 elbv2 client APIs directly via saltext.boto3.utils.boto3mod. The legacy boto2 code path (object-style access, retry loops) has been removed.

depends:

  • boto3 >= 1.28.0

  • botocore >= 1.31.0

configuration:

This module accepts explicit Elastic Load Balancer (ELB) 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 at:

http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html

If IAM roles are not used you need to specify them either in the minion’s config file or as a profile. For example, to specify them in the minion’s config file:

elb.keyid: GKTADJGHEIQSXMKKRBJ08H
elb.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs

A region may also be specified in the configuration:

elb.region: us-east-1

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

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

Added in version 1.0.0.

saltext.boto3.modules.boto3_elbv2.__virtual__()[source]

Only load if boto3 is available.

saltext.boto3.modules.boto3_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)[source]

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:

salt myminion boto3_elbv2.create_target_group learn1give1 protocol=HTTP port=54006 vpc_id=vpc-deadbeef
saltext.boto3.modules.boto3_elbv2.delete_target_group(name, region=None, key=None, keyid=None, profile=None)[source]

Delete target group.

name

(string) - Target Group Name or Amazon Resource Name (ARN).

returns

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

CLI Example:

salt myminion boto3_elbv2.delete_target_group arn:aws:elasticloadbalancing:us-west-2:644138682826:targetgroup/learn1give1-api/414788a16b5cf163
saltext.boto3.modules.boto3_elbv2.target_group_exists(name, region=None, key=None, keyid=None, profile=None)[source]

Check to see if an target group exists.

CLI Example:

salt myminion boto3_elbv2.target_group_exists arn:aws:elasticloadbalancing:us-west-2:644138682826:targetgroup/learn1give1-api/414788a16b5cf163
saltext.boto3.modules.boto3_elbv2.describe_target_health(name, targets=None, region=None, key=None, keyid=None, profile=None)[source]

Get the curret health check status for targets in a target group.

CLI Example:

salt myminion boto3_elbv2.describe_target_health arn:aws:elasticloadbalancing:us-west-2:644138682826:targetgroup/learn1give1-api/414788a16b5cf163 targets=["i-isdf23ifjf"]
saltext.boto3.modules.boto3_elbv2.register_targets(name, targets, region=None, key=None, keyid=None, profile=None)[source]

Register targets to a target froup of an ALB. targets is either a instance id string or a list of instance id’s.

Returns:

  • True: instance(s) registered successfully

  • False: instance(s) failed to be registered

CLI Example:

salt myminion boto3_elbv2.register_targets myelb instance_id
salt myminion boto3_elbv2.register_targets myelb "[instance_id,instance_id]"
saltext.boto3.modules.boto3_elbv2.deregister_targets(name, targets, region=None, key=None, keyid=None, profile=None)[source]

Deregister targets to a target froup of an ALB. targets is either a instance id string or a list of instance id’s.

Returns:

  • True: instance(s) deregistered successfully

  • False: instance(s) failed to be deregistered

CLI Example:

salt myminion boto3_elbv2.deregister_targets myelb instance_id
salt myminion boto3_elbv2.deregister_targets myelb "[instance_id,instance_id]"