amazon.aws.elb_application_lb module – Manage an Application Load Balancer
Note
This module is part of the amazon.aws collection (version 8.2.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install amazon.aws
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: amazon.aws.elb_application_lb
.
New in amazon.aws 5.0.0
Synopsis
Manage an AWS Application Elastic Load Balancer. See https://aws.amazon.com/blogs/aws/new-aws-application-load-balancer/ for details.
This module was originally added to
community.aws
in release 1.0.0.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0
Parameters
Parameter |
Comments |
---|---|
AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Whether or not to enable access logs. When set, Choices:
|
|
The name of the S3 bucket for the access logs. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permission to write to the bucket. Required if access logs in Amazon S3 are enabled. When set, |
|
The prefix for the log location in the S3 bucket. If you don’t specify a prefix, the access logs are stored in the root of the bucket. Cannot begin or end with a slash. |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
Use a The Choices:
|
|
Indicates whether deletion protection for the ALB is enabled. Defaults to Choices:
|
|
URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. The The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Indicates whether to enable HTTP2 routing. Defaults to Choices:
|
|
Determines how the load balancer handles requests that might pose a security risk to an application. Defaults to Choices:
|
|
Indicates whether HTTP headers with invalid header fields are removed by the load balancer Defaults to Choices:
|
|
Indicates whether the two headers are added to the client request before sending it to the target. Defaults to Choices:
|
|
Indicates whether the X-Forwarded-For header should preserve the source port that the client used to connect to the load balancer. Defaults to Choices:
|
|
The number of seconds to wait before an idle connection is closed. |
|
Sets the type of IP addresses used by the subnets of the specified Application Load Balancer. Choices:
|
|
A list of dicts containing listeners to attach to the ALB. See examples for detail of the dict required. Note that listener keys are CamelCased. |
|
The SSL server certificate. |
|
The Amazon Resource Name (ARN) of the certificate. |
|
The default actions for the listener. |
|
The Amazon Resource Name (ARN) of the target group. Mutually exclusive with |
|
The name of the target group. Mutually exclusive with |
|
The type of action. |
|
The port on which the load balancer is listening. |
|
The protocol for connections from clients to the load balancer. |
|
A list of ALB Listener Rules. For the complete documentation of possible Conditions and Actions please see the boto3 documentation: Keep in mind that AWS uses default values for parameters that are not requested. For example for |
|
Actions to apply if all of the rule’s conditions are met. |
|
Conditions which must be met for the actions to be applied. |
|
The rule priority. |
|
The security policy that defines which ciphers and protocols are supported. |
|
The name of the load balancer. This name must be unique within your AWS account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen. |
|
A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
When set to Choices:
|
|
If purge_tags=true and tags is set, existing tags will be purged from the resource to match exactly what is defined by tags parameter. If the tags parameter is not set then tags will not be modified, even if purge_tags=True. Tag keys beginning with Choices:
|
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
Internet-facing or internal load balancer. An ALB scheme can not be modified after creation. Choices:
|
|
AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
A list of the names or IDs of the security groups to assign to the load balancer. Required if If |
|
AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Create or destroy the load balancer. Choices:
|
|
A list of the IDs of the subnets to attach to the load balancer. You can specify only one subnet per Availability Zone. You must specify subnets from at least two Availability Zones. Required if |
|
A dictionary representing the tags to be applied to the resource. If the tags parameter is not set then tags will not be modified. |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
|
Indicates whether to allow a AWS WAF-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF. Defaults to Choices:
|
|
Wait for the load balancer to have a state of ‘active’ before completing. A status check is performed every 15 seconds until a successful state is reached. An error is returned after 40 failed checks. Choices:
|
|
The time in seconds to use in conjunction with |
Notes
Note
Listeners are matched based on port. If a listener’s port is changed then a new listener will be created.
Listener rules are matched based on priority. If a rule’s priority is changed then a new rule will be created.
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials
). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Examples
# Note: These examples do not set authentication details, see the AWS Guide for details.
# Create an ALB and attach a listener
- amazon.aws.elb_application_lb:
name: myalb
security_groups:
- sg-12345678
- my-sec-group
subnets:
- subnet-012345678
- subnet-abcdef000
listeners:
- Protocol: HTTP # Required. The protocol for connections from clients to the load balancer (HTTP or HTTPS) (case-sensitive).
Port: 80 # Required. The port on which the load balancer is listening.
# The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.
SslPolicy: ELBSecurityPolicy-2015-05
Certificates: # The ARN of the certificate
- CertificateArn: arn:aws:iam::123456789012:server-certificate/test.domain.com
DefaultActions:
- Type: forward # Required.
TargetGroupName: # Required. The name of the target group
state: present
# Create an ALB and attach a listener with logging enabled
- amazon.aws.elb_application_lb:
access_logs_enabled: true
access_logs_s3_bucket: mybucket
access_logs_s3_prefix: "logs"
name: myalb
security_groups:
- sg-12345678
- my-sec-group
subnets:
- subnet-012345678
- subnet-abcdef000
listeners:
- Protocol: HTTP # Required. The protocol for connections from clients to the load balancer (HTTP or HTTPS) (case-sensitive).
Port: 80 # Required. The port on which the load balancer is listening.
# The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.
SslPolicy: ELBSecurityPolicy-2015-05
Certificates: # The ARN of the certificate
- CertificateArn: arn:aws:iam::123456789012:server-certificate/test.domain.com
DefaultActions:
- Type: forward # Required.
TargetGroupName: # Required. The name of the target group
state: present
# Create an ALB with listeners and rules
- amazon.aws.elb_application_lb:
name: test-alb
subnets:
- subnet-12345678
- subnet-87654321
security_groups:
- sg-12345678
scheme: internal
listeners:
- Protocol: HTTPS
Port: 443
DefaultActions:
- Type: forward
TargetGroupName: test-target-group
Certificates:
- CertificateArn: arn:aws:iam::123456789012:server-certificate/test.domain.com
SslPolicy: ELBSecurityPolicy-2015-05
Rules:
- Conditions:
- Field: path-pattern
Values:
- '/test'
Priority: '1'
Actions:
- TargetGroupName: test-target-group
Type: forward
- Conditions:
- Field: path-pattern
Values:
- "/redirect-path/*"
Priority: '2'
Actions:
- Type: redirect
RedirectConfig:
Host: "#{host}"
Path: "/example/redir" # or /#{path}
Port: "#{port}"
Protocol: "#{protocol}"
Query: "#{query}"
StatusCode: "HTTP_302" # or HTTP_301
- Conditions:
- Field: path-pattern
Values:
- "/fixed-response-path/"
Priority: '3'
Actions:
- Type: fixed-response
FixedResponseConfig:
ContentType: "text/plain"
MessageBody: "This is the page you're looking for"
StatusCode: "200"
- Conditions:
- Field: host-header
Values:
- "hostname.domain.com"
- "alternate.domain.com"
Priority: '4'
Actions:
- TargetGroupName: test-target-group
Type: forward
state: present
# Create an ALB with a listener having multiple listener certificates
- amazon.aws.elb_application_lb:
name: myalb
security_groups:
- sg-12345678
- my-sec-group
subnets:
- subnet-012345678
- subnet-abcdef000
listeners:
- Protocol: HTTP # Required. The protocol for connections from clients to the load balancer (HTTP or HTTPS) (case-sensitive).
Port: 80 # Required. The port on which the load balancer is listening.
# The security policy that defines which ciphers and protocols are supported. The default is the current predefined security policy.
SslPolicy: ELBSecurityPolicy-2015-05
Certificates: # The ARN of the certificate (first certificate in the list will be set as default certificate)
- CertificateArn: arn:aws:iam::123456789012:server-certificate/test.domain.com
- CertificateArn: arn:aws:iam::123456789012:server-certificate/secondtest.domain.com
- CertificateArn: arn:aws:iam::123456789012:server-certificate/thirdtest.domain.com
DefaultActions:
- Type: forward # Required.
TargetGroupName: # Required. The name of the target group
state: present
# Remove an ALB
- amazon.aws.elb_application_lb:
name: myalb
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Indicates whether access logs stored in Amazon S3 are enabled. Returned: when Sample: |
|
The Availability Zones for the load balancer. Returned: when Sample: |
|
Information about static IP addresses for a load balancer. Returned: when |
|
The allocation ID of the Elastic IP address for an internal-facing load balancer. Returned: when |
|
The static IP address. Returned: when |
|
The IPv6 address. Returned: when |
|
The private IPv4 address for an internal load balancer. Returned: when |
|
The ID of the subnet. Returned: when |
|
The name of the Availability Zone. Returned: when |
|
The ID of the Amazon Route 53 hosted zone associated with the load balancer. Returned: when Sample: |
|
Whether an ALB was created/updated/deleted. Returned: always Sample: |
|
The prefix for the location in the S3 bucket for the connection logs. Returned: when Sample: |
|
The date and time the load balancer was created. Returned: when Sample: |
|
The public DNS name of the load balancer. Returned: when Sample: |
|
The type of IP addresses used by the subnets for the load balancer. Returned: when Sample: |
|
Locks internet gateway (IGW) access to the load balancer. Returned: when Sample: |
|
Information about the listeners. Returned: when |
|
The SSL server certificate. Returned: when |
|
The Amazon Resource Name (ARN) of the certificate. Returned: when Sample: |
|
The default actions for the listener. Returned: when Sample: |
|
Information for creating an action that distributes requests among one or more target groups. Returned: when |
|
The target group stickiness for the rule. Returned: when |
|
Indicates whether target group stickiness is enabled. Returned: when |
|
The target groups. Returned: when |
|
The Amazon Resource Name (ARN) of the target group. Returned: when |
|
The weight. Returned: when |
|
The Amazon Resource Name (ARN) of the target group. Returned: when Sample: |
|
The Amazon Resource Name (ARN) of the listener. Returned: when Sample: |
|
The Amazon Resource Name (ARN) of the load balancer. Returned: when Sample: |
|
The protocol for connections from clients to the load balancer. Returned: when Sample: |
|
List of listener rules. Returned: when |
|
The actions. Returned: when Sample: |
|
Information for creating an action that distributes requests among one or more target groups. Returned: when |
|
The target group stickiness for the rule. Returned: when |
|
Indicates whether target group stickiness is enabled. Returned: when |
|
The target groups. Returned: when |
|
The Amazon Resource Name (ARN) of the target group. Returned: when |
|
The weight. Returned: when |
|
The Amazon Resource Name (ARN) of the target group. Returned: when |
|
The type of action. Returned: when |
|
The security policy that defines which ciphers and protocols are supported. Returned: when Sample: |
|
The Amazon Resource Name (ARN) of the load balancer. Returned: when Sample: |
|
Determines how the load balancer handles requests that might pose a security risk to an application. Returned: when Sample: |
|
Indicates whether HTTP headers with invalid header fields are removed by the load balancer (true) or routed to targets (false). Returned: when Sample: |
|
Indicates whether the Application Load Balancer should preserve the Host header in the HTTP request and send it to the target without any change. Returned: when Sample: |
|
Indicates whether the two headers are added to the client request before sending it to the target. Returned: when Sample: |
|
Indicates whether the X-Forwarded-For header should preserve the source port that the client used to connect to the load balancer. Returned: when Sample: |
|
Enables you to modify, preserve, or remove the X-Forwarded-For header in the HTTP request before the Application Load Balancer sends the request to the target. Returned: when Sample: |
|
The IDs of the security groups for the load balancer. Returned: when Sample: |
|
The state code. Returned: success |
|
A description of the state. Returned: when available |
|
Indicates whether to allow a AWS WAF-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF. Returned: when Sample: |