Модуль community.aws.api_gateway_domain — управление пользовательскими доменами AWS API Gateway

access_key

псевдонимы: aws_access_key_id, aws_access_key

строка

Идентификатор ключа доступа 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.

aws_ca_bundle

путь

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

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

aws_config

словарь

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

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

certificate_arn

строка / обязательный

ARN TLS-сертификата AWS Certificate Manager (ACM).

debug_botocore_endpoint_logs

логическое значение

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

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

Варианты:

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

domain_mappings

список / элементы=словарь / обязательный

Сопоставляет базовые пути вашего домена с ранее созданными REST API API GW. Укажите предоставленные идентификатор настройки API и этап выпуска.

domain_mappings должен быть списком словарей с тремя ключами: base_path, rest_api_id и stage.

Пример: [{ base_path: v1, rest_api_id: abc123, stage: production }]

Если базовый путь должен быть просто /, полностью опустите параметр или задайте пустую строку.

domain_name

строка / обязательный

Имя домена, которое требуется использовать для развертывания API GW.

endpoint_type

строка

Конфигурация конечной точки API для домена. Используйте EDGE для конечной точки с оптимизацией для периферийных узлов или REGIONAL либо PRIVATE.

Варианты:

• "EDGE" ← (по умолчанию)
• "REGIONAL"
• "PRIVATE"

endpoint_url

псевдонимы: aws_endpoint_url

строка

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

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

profile

псевдонимы: aws_profile

строка

Именованный профиль 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.

region

псевдонимы: aws_region

строка

Регион AWS для использования.

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

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

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

secret_key

псевдонимы: aws_secret_access_key, aws_secret_key

строка

Секретный ключ доступа 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_policy

строка

Задает разрешенные версии TLS с помощью политик AWS. В настоящее время доступны только TLS_1_0 и TLS_1_2.

Варианты:

• "TLS_1_0"
• "TLS_1_2" ← (по умолчанию)

session_token

псевдонимы: aws_session_token

строка

Токен сеанса 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

строка

Создать или удалить настройку пользовательского домена.

Варианты:

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

validate_certs

логическое значение

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

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

Варианты:

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

response

словарь

Данные, возвращаемые методами create_domain_name (или update и delete) и create_base_path_mapping из boto3.

Возвращается: при успехе

Пример: {"domain": {"certificate_arn": "arn:aws:acm:xxxxxx", "distribution_domain_name": "xxxx.cloudfront.net", "distribution_hosted_zone_id": "ABC123123", "domain_name": "mydomain.com", "domain_name_status": "AVAILABLE", "endpoint_configuration": {"types": ["EDGE"]}, "security_policy": "TLS_1_2", "tags": {}}, "path_mappings": [{"base_path": "(empty)", "rest_api_id": "abcd123", "stage": "production"}]}