Модуль amazon.aws.elb_application_lb — управление балансировщиком нагрузки приложений

access_key

aliases: aws_access_key_id, aws_access_key

string

Идентификатор ключа доступа AWS.

Дополнительную информацию о токенах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные среды AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY в порядке убывания приоритета.

Параметры aws_access_key и profile являются взаимоисключающими.

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.

access_logs_enabled

boolean

Включить ли журналы доступа.

Если задано значение, необходимо также задать access_logs_s3_bucket.

Варианты:

• false
• true

access_logs_s3_bucket

string

Имя бакета S3 для журналов доступа.

Бакет должен находиться в том же регионе, что и балансировщик нагрузки, и иметь политику, предоставляющую Elastic Load Balancing разрешение на запись в бакет.

Обязательный параметр, если включено сохранение журналов доступа в Amazon S3.

Если задано значение, необходимо также задать access_logs_enabled.

access_logs_s3_prefix

string

Префикс пути к журналам в бакете S3.

Если префикс не указан, журналы доступа сохраняются в корне бакета.

Не может начинаться или заканчиваться косой чертой.

aws_ca_bundle

path

Путь к пакету CA, используемому для проверки сертификатов SSL.

Также можно использовать переменную среды AWS_CA_BUNDLE.

aws_config

dictionary

Словарь для изменения конфигурации botocore.

Параметры описаны в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

boolean

Использовать регистратор botocore.endpoint для анализа уникальных (а не общего количества) вызовов API "resource:action", выполненных во время задачи, и выводить набор в ключ resource_actions результатов задачи. Используйте callback aws_resource_action, чтобы вывести общий список вызовов, выполненных в ходе плейбука.

Также можно использовать переменную среды ANSIBLE_DEBUG_BOTOCORE_LOGS.

Варианты:

• false ← (по умолчанию)
• true

deletion_protection

boolean

Указывает, включена ли защита ALB от удаления.

По умолчанию используется false.

Варианты:

• false
• true

endpoint_url

aliases: aws_endpoint_url

string

URL для подключения вместо конечных точек AWS по умолчанию. Хотя его можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS.

Также можно использовать переменную среды AWS_URL.

http2

boolean

Указывает, следует ли включить маршрутизацию HTTP2.

По умолчанию используется True.

Варианты:

• false
• true

http_desync_mitigation_mode

string

добавлено в community.aws 3.2.0

Определяет, как балансировщик нагрузки обрабатывает запросы, которые могут представлять угрозу безопасности приложения.

По умолчанию используется defensive.

Варианты:

• "monitor"
• "defensive"
• "strictest"

http_drop_invalid_header_fields

boolean

добавлено в community.aws 3.2.0

Указывает, удаляются ли балансировщиком нагрузки HTTP-заголовки с недопустимыми полями true или направляются целям false.

По умолчанию используется false.

Варианты:

• false
• true

http_x_amzn_tls_version_and_cipher_suite

boolean

добавлено в community.aws 3.2.0

Указывает, добавляются ли два заголовка к запросу клиента перед его отправкой цели.

По умолчанию используется false.

Варианты:

• false
• true

http_xff_client_port

boolean

добавлено в community.aws 3.2.0

Указывает, должен ли заголовок X-Forwarded-For сохранять исходный порт, который клиент использовал для подключения к балансировщику нагрузки.

По умолчанию используется false.

Варианты:

• false
• true

idle_timeout

integer

Количество секунд ожидания перед закрытием неактивного соединения.

ip_address_type

string

Задает тип IP-адресов, используемых подсетями указанного Application Load Balancer.

Варианты:

• "ipv4"
• "dualstack"

listeners

list / elements=dictionary

Список словарей, содержащих прослушиватели для подключения к ALB. Подробное описание требуемого словаря см. в примерах. Обратите внимание, что ключи прослушивателей записываются в CamelCase.

Certificates

list / elements=dictionary

Сертификат SSL-сервера.

CertificateArn

string

Имя ресурса Amazon (ARN) сертификата.

DefaultActions

list / elements=dictionary / обязательный

Действия по умолчанию для прослушивателя.

TargetGroupArn

string

Имя ресурса Amazon (ARN) целевой группы.

Взаимоисключающий параметр с listeners.DefaultActions.TargetGroupName.

TargetGroupName

string

Имя целевой группы.

Взаимоисключающий параметр с listeners.DefaultActions.TargetGroupArn.

Type

string

Тип действия.

Port

integer / обязательный

Порт, на котором прослушивает балансировщик нагрузки.

Protocol

string / обязательный

Протокол соединений между клиентами и балансировщиком нагрузки.

Rules

list / elements=dictionary

Список правил прослушивателя ALB.

Полное описание возможных условий и действий см. в документации boto3:

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/elbv2.html#ElasticLoadBalancingv2.Client.create_rule

Помните, что AWS использует значения по умолчанию для параметров, которые не заданы. Например, для Scope и SessionTimeout, если тип действия — authenticate-oidc.

Actions

list / elements=dictionary

Действия, которые нужно выполнить, если выполнены все условия правила.

Conditions

list / elements=dictionary

Условия, которые должны быть выполнены для применения действий.

Priority

integer

Приоритет правила.

SslPolicy

string

Политика безопасности, определяющая поддерживаемые шифры и протоколы.

name

string / обязательный

Имя балансировщика нагрузки. Это имя должно быть уникальным в учетной записи AWS, содержать не более 32 символов, включать только буквенно-цифровые символы или дефисы и не начинаться и не заканчиваться дефисом.

profile

aliases: aws_profile

string

Именованный профиль AWS, используемый для аутентификации.

Дополнительную информацию об именованных профилях см. в документации AWS https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

Также можно использовать переменную среды AWS_PROFILE.

Параметр profile является взаимоисключающим с параметрами aws_access_key, aws_secret_key и session_token.

purge_listeners

boolean

Если true, существующие прослушиватели будут удалены из ALB, чтобы их набор точно соответствовал определенному параметром listeners.

Если параметр listeners не задан, прослушиватели не будут изменены.

Варианты:

• false
• true ← (по умолчанию)

purge_rules

boolean

Если задано значение false, существующие правила балансировщика нагрузки сохраняются. Правила будут изменены и добавлены, но не удалены.

Варианты:

• false
• true ← (по умолчанию)

purge_tags

boolean

Если purge_tags=true и задан параметр tags, существующие теги ресурса будут удалены, чтобы их набор точно соответствовал определенному параметром tags.

Если параметр tags не задан, теги не будут изменены, даже если purge_tags=True.

Ключи тегов, начинающиеся с aws:, зарезервированы Amazon и не могут быть изменены. Поэтому они игнорируются при обработке параметра purge_tags. Дополнительную информацию см. в документации Amazon https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions.

Варианты:

• false
• true ← (по умолчанию)

region

aliases: aws_region

string

Используемый регион AWS.

Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется.

Также можно использовать переменную среды AWS_REGION.

Дополнительную информацию см. в документации Amazon AWS http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

scheme

string

Внешний или внутренний балансировщик нагрузки. Схему ALB нельзя изменить после создания.

Варианты:

• "internet-facing" ← (по умолчанию)
• "internal"

secret_key

aliases: aws_secret_access_key, aws_secret_key

string

Секретный ключ доступа AWS.

Дополнительную информацию о токенах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменные среды AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY в порядке убывания приоритета.

Параметры secret_key и profile являются взаимоисключающими.

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS botocore SDK.

security_groups

list / elements=string

Список имен или идентификаторов групп безопасности, назначаемых балансировщику нагрузки.

Обязательный параметр, если state=present.

Если [], будет использоваться группа безопасности VPC по умолчанию.

session_token

aliases: aws_session_token

string

Токен сеанса AWS STS для использования с временными учетными данными.

Дополнительную информацию о токенах доступа см. в документации AWS https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

Также можно использовать переменную среды AWS_SESSION_TOKEN.

Параметры session_token и profile являются взаимоисключающими.

state

string

Создать или удалить балансировщик нагрузки.

Варианты:

• "present" ← (по умолчанию)
• "absent"

subnets

list / elements=string

Список идентификаторов подсетей, подключаемых к балансировщику нагрузки. Можно указать только одну подсеть для каждой зоны доступности. Необходимо указать подсети как минимум из двух зон доступности.

Обязательный параметр, если state=present.

tags

aliases: resource_tags

dictionary

Словарь тегов, применяемых к ресурсу.

Если параметр tags не задан, теги не будут изменены.

validate_certs

boolean

Если задано значение false, сертификаты SSL не будут проверяться при обмене данными с API AWS.

Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность задать aws_ca_bundle.

Варианты:

• false
• true ← (по умолчанию)

waf_fail_open

boolean

добавлено в community.aws 3.2.0

Указывает, следует ли разрешить балансировщику нагрузки с включённым AWS WAF направлять запросы к целевым объектам, если он не может переслать запрос в AWS WAF.

По умолчанию false.

Варианты:

• false
• true

wait

boolean

Ожидать, пока состояние балансировщика нагрузки не станет «active», прежде чем завершить выполнение. Проверка состояния выполняется каждые 15 секунд до достижения успешного состояния. После 40 неудачных проверок возвращается ошибка.

Варианты:

• false ← (по умолчанию)
• true

wait_timeout

integer

Время в секундах, используемое совместно с wait.

access_logs_s3_bucket

string

Имя бакета S3 для журналов доступа.

Возвращается: когда state=present

Пример: "mys3bucket"

access_logs_s3_enabled

string

Указывает, включено ли хранение журналов доступа в Amazon S3.

Возвращается: когда state=present

Пример: "true"

access_logs_s3_prefix

string

Префикс расположения в бакете S3.

Возвращается: когда state=present

Пример: "my/logs"

availability_zones

list / elements=dictionary

Зоны доступности для балансировщика нагрузки.

Возвращается: когда state=present

Пример: [{"load_balancer_addresses": [], "subnet_id": "subnet-aabbccddff", "zone_name": "ap-southeast-2a"}]

load_balancer_addresses

list / elements=dictionary

Сведения о статических IP-адресах балансировщика нагрузки.

Возвращается: когда state=present

allocation_id

string

Идентификатор выделения эластичного IP-адреса для внутреннего балансировщика нагрузки.

Возвращается: когда state=present

ip_address

string

Статический IP-адрес.

Возвращается: когда state=present

ipv6_address

string

IPv6-адрес.

Возвращается: когда state=present

private_ipv4_address

string

Частный IPv4-адрес внутреннего балансировщика нагрузки.

Возвращается: когда state=present

subnet_id

string

Идентификатор подсети.

Возвращается: когда state=present

zone_name

string

Название зоны доступности.

Возвращается: когда state=present

canonical_hosted_zone_id

string

Идентификатор размещённой зоны Amazon Route 53, связанной с балансировщиком нагрузки.

Возвращается: когда state=present

Пример: "ABCDEF12345678"

changed

boolean

Указывает, был ли ALB создан, обновлён или удалён.

Возвращается: всегда

Пример: true

client_keep_alive_seconds

string

Значение времени поддержания активности клиента в секундах.

Возвращается: когда state=present

Пример: "3600"

connection_logs_s3_bucket

string

Имя бакета S3 для журналов подключений.

Возвращается: когда state=present

Пример: ""

connection_logs_s3_enabled

string

Указывает, включено ли ведение журналов подключений.

Возвращается: когда state=present

Пример: "false"

connection_logs_s3_prefix

string

Префикс расположения журналов подключений в бакете S3.

Возвращается: когда state=present

Пример: ""

created_time

string

Дата и время создания балансировщика нагрузки.

Возвращается: когда state=present

Пример: "2015-02-12T02:14:02+00:00"

deletion_protection_enabled

string

Указывает, включена ли защита от удаления.

Возвращается: когда state=present

Пример: "true"

dns_name

string

Общедоступное DNS-имя балансировщика нагрузки.

Возвращается: когда state=present

Пример: "internal-my-elb-123456789.ap-southeast-2.elb.amazonaws.com"

idle_timeout_timeout_seconds

string

Значение тайм-аута простоя в секундах.

Возвращается: когда state=present

Пример: "60"

ip_address_type

string

Тип IP-адресов, используемых подсетями балансировщика нагрузки.

Возвращается: когда state=present

Пример: "ipv4"

ipv6_deny_all_igw_traffic

string

Блокирует доступ интернет-шлюза (IGW) к балансировщику нагрузки.

Возвращается: когда state=present

Пример: "false"

listeners

list / elements=dictionary

Сведения о слушателях.

Возвращается: когда state=present

certificates

list / elements=dictionary

Сертификат SSL-сервера.

Возвращается: когда state=present

certificate_arn

string

Имя ресурса Amazon (ARN) сертификата.

Возвращается: когда state=present

Пример: "arn:aws:acm:us-east-1:123456789012:certificate/28d2f3d9-cb2f-4033-a9aa-e75e704125a2"

default_actions

string

Действия по умолчанию для слушателя.

Возвращается: когда state=present

Пример: "[{'forward_config': {'target_group_stickiness_config': {'enabled': False}, 'target_groups': [{'target_group_arn': 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/alb-test-2-98b7f374/bf43c68602c51c02', 'weight': 1}]}, 'target_group_arn': 'arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/alb-test-2-98b7f374/bf43c68602c51c02', 'type': 'forward'}]"

forward_config

dictionary

Сведения для создания действия, распределяющего запросы между одной или несколькими целевыми группами.

Возвращается: когда state=present

target_group_stickiness_config

dictionary

Настройки привязки к целевой группе для правила.

Возвращается: когда state=present

enabled

boolean

Указывает, включена ли привязка к целевой группе.

Возвращается: когда state=present

target_groups

dictionary

Целевые группы.

Возвращается: когда state=present

target_group_arn

string

Имя ресурса Amazon (ARN) целевой группы.

Возвращается: когда state=present

weight

integer

Вес.

Возвращается: когда state=present

target_group_arn

string

Имя ресурса Amazon (ARN) целевой группы.

Возвращается: когда state=present

Пример: "arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/alb-test-169eb5ba/09ba111f8079fb83"

type

string

Тип действия.

Возвращается: когда state=present

Пример: "forward"

listener_arn

string

Имя ресурса Amazon (ARN) слушателя.

Возвращается: когда state=present

Пример: "arn:aws:elasticloadbalancing:us-east-1:123456789012:listener/app/alb-test-169eb5ba/1659336d4100d496/8367c4262cc1d0cc"

load_balancer_arn

string

Имя ресурса Amazon (ARN) балансировщика нагрузки.

Возвращается: когда state=present

Пример: "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/alb-test-169eb5ba/1659336d4100d496"

port

integer

Порт, на котором работает слушатель балансировщика нагрузки.

Возвращается: когда state=present

Пример: 80

protocol

string

Протокол соединений между клиентами и балансировщиком нагрузки.

Возвращается: когда state=present

Пример: "HTTPS"

rules

list / elements=dictionary

Список правил слушателя.

Возвращается: когда state=present

actions

list / elements=dictionary

Действия.

Возвращается: когда state=present

Пример: [{"forward_config": {"target_group_stickiness_config": {"enabled": false}, "target_groups": [{"target_group_arn": "arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/alb-test-169eb/09ba111f8079fb83", "weight": 1}]}, "target_group_arn": "arn:aws:elasticloadbalancing:us-east-1:123456789012:targetgroup/alb-test-169eb/09ba111f8079fb83", "type": "forward"}]

forward_config

dictionary

Сведения для создания действия, распределяющего запросы между одной или несколькими целевыми группами.

Возвращается: когда state=present

target_group_stickiness_config

dictionary

Настройки привязки к целевой группе для правила.

Возвращается: когда state=present

enabled

boolean

Указывает, включена ли привязка к целевой группе.

Возвращается: когда state=present

target_groups

dictionary

Целевые группы.

Возвращается: когда state=present

target_group_arn

string

Имя ресурса Amazon (ARN) целевой группы.

Возвращается: когда state=present

weight

integer

Вес.

Возвращается: когда state=present

target_group_arn

string

Имя ресурса Amazon (ARN) целевой группы.

Возвращается: когда state=present

type

string

Тип действия.

Возвращается: когда state=present

conditions

list / elements=string

Условия.

Возвращается: когда state=present

Пример: []

is_default

boolean

Указывает, является ли это правилом по умолчанию.

Возвращается: когда state=present

Пример: false

priority

string

Приоритет.

Возвращается: когда state=present

Пример: "default"

rule_arn

string

Имя ресурса Amazon (ARN) правила.

Возвращается: когда state=present

Пример: ""

ssl_policy

string

Политика безопасности, определяющая поддерживаемые шифры и протоколы.

Возвращается: когда state=present

Пример: "ELBSecurityPolicy-2016-08"

load_balancer_arn

string

Имя ресурса Amazon (ARN) балансировщика нагрузки.

Возвращается: когда state=present

Пример: "arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:loadbalancer/app/my-alb/001122334455"

load_balancer_name

string

Имя балансировщика нагрузки.

Возвращается: когда state=present

Пример: "my-alb"

load_balancing_cross_zone_enabled

string

Указывает, включена ли межзональная балансировка нагрузки.

Возвращается: когда state=present

Пример: "true"

routing_http2_enabled

string

Указывает, включен ли HTTP/2.

Возвращается: когда state=present

Пример: "true"

routing_http_desync_mitigation_mode

string

Определяет, как балансировщик нагрузки обрабатывает запросы, которые могут представлять угрозу безопасности приложения.

Возвращается: когда state=present

Пример: "defensive"

routing_http_drop_invalid_header_fields_enabled

string

Указывает, удаляет ли балансировщик нагрузки HTTP-заголовки с недопустимыми полями (true) или передает их целевым объектам (false).

Возвращается: когда state=present

Пример: "false"

routing_http_preserve_host_header_enabled

string

Указывает, должен ли Application Load Balancer сохранять заголовок Host в HTTP-запросе и передавать его целевому объекту без изменений.

Возвращается: когда state=present

Пример: "false"

routing_http_x_amzn_tls_version_and_cipher_suite_enabled

string

Указывает, добавляются ли два заголовка к запросу клиента перед его отправкой целевому объекту.

Возвращается: когда state=present

Пример: "false"

routing_http_xff_client_port_enabled

string

Указывает, должен ли заголовок X-Forwarded-For сохранять исходный порт, который клиент использовал для подключения к балансировщику нагрузки.

Возвращается: когда state=present

Пример: "false"

routing_http_xff_header_processing_mode

string

Позволяет изменить, сохранить или удалить заголовок X-Forwarded-For в HTTP-запросе перед тем, как Application Load Balancer отправит запрос целевому объекту.

Возвращается: когда state=present

Пример: "append"

scheme

string

Балансировщик нагрузки, доступный из Интернета, или внутренний балансировщик нагрузки.

Возвращается: когда state=present

Пример: "internal"

security_groups

list / elements=string

Идентификаторы групп безопасности балансировщика нагрузки.

Возвращается: когда state=present

Пример: ["sg-0011223344"]

state

dictionary

Состояние балансировщика нагрузки.

Возвращается: когда state=present

Пример: {"code": "active"}

code

string

Код состояния.

Возвращается: при успешном выполнении

reason

string

Описание состояния.

Возвращается: при наличии

tags

dictionary

Теги, прикрепленные к балансировщику нагрузки.

Возвращается: когда state=present

Пример: {"Tag": "Example"}

type

string

Тип балансировщика нагрузки.

Возвращается: когда state=present

Пример: "application"

vpc_id

string

Идентификатор VPC балансировщика нагрузки.

Возвращается: когда state=present

Пример: "vpc-0011223344"

waf_fail_open_enabled

string

Указывает, разрешено ли балансировщику нагрузки с включенным AWS WAF направлять запросы целевым объектам, если он не может переслать запрос в AWS WAF.

Возвращается: когда state=present

Пример: "false"