Spec-Zone.ru › Ansible 2.10

community.aws.cloudfront_distribution – Создание, обновление и удаление распределений AWS CloudFront.

Примечание

Этот плагин входит в коллекцию community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в плейбуке укажите: community.aws.cloudfront_distribution.

Новое в версии 1.0.0: of community.aws

  • Обзор
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата

Обзор

  • Обеспечивает удобное создание, обновление и удаление распределений CloudFront.

Требования

Ниже приведены требования к хосту, на котором будет выполняться этот модуль.

  • boto
  • boto3 >= 1.0.0
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
alias
строка
Имя псевдонима (CNAME), используемого в распределении. Используется для эффективной ссылки на распределение по его псевдониму, поскольку псевдоним может использоваться только одним распределением на один AWS-аккаунт. Эта переменная позволяет избежать необходимости указывать distribution_id, а также e_tag или caller_reference существующего распределения.
aliases
список / элементы=строка
Список псевдонимов доменных имен (CNAME) в виде строк, используемых для распределения.
Каждый псевдоним должен быть уникальным для всех распределений в AWS-аккаунте.
aws_access_key
строка
AWS ключ доступа. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.
Если задан параметр profile, этот параметр игнорируется.
Передача параметров aws_access_key и profile одновременно устарела и будет сделана взаимоисключающей после 2022-06-01.

Псевдонимы: ec2_access_key, access_key
aws_ca_bundle
путь
Расположение файла CA Bundle для проверки SSL-сертификатов.
Используется только для модулей boto3.
Примечание: CA Bundle считывается со стороны 'модуля' и может потребоваться явное копирование из контроллера, если он не запускается локально.
aws_config
словарь
Словарь для изменения конфигурации botocore.
Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
Для модулей boto используется только ключ 'user_agent'. Дополнительную конфигурацию boto см. по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto.
aws_secret_key
строка
AWS секретный ключ. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.
Если задан параметр profile, этот параметр игнорируется.
Передача параметров aws_secret_key и profile одновременно устарела и будет сделана взаимоисключающей после 2022-06-01.

Псевдонимы: ec2_secret_key, secret_key
cache_behaviors
список / элементы=словарь
Список словарей, описывающих поведение кеша для распределения.
Порядок списка сохраняется при повторных запусках, если не включен параметр purge_cache_behaviors.
forwarded_values
словарь
Словарь, определяющий, как CloudFront обрабатывает строки запросов и куки.
allowed_methods
словарь
Словарь, контролирующий, какие HTTP-методы CloudFront обрабатывает и пересылает.
cached_methods
список / элементы=строка
Список HTTP-методов, для которых CloudFront должен применять кэширование.
Это может быть [GET,HEAD], или [GET,HEAD,OPTIONS].
items
список / элементы=строка
Список HTTP-методов, которые CloudFront должен обрабатывать и пересылать.
compress
булево
    Варианты:
  • нет
  • да
Нужно ли CloudFront автоматически сжимать файлы.
cookies
словарь
Словарь, определяющий, нужно ли CloudFront передавать куки в исходный сервер, и если нужно, какие.
forward
строка
Указывает, какие куки нужно пересылать в исходный сервер для данного поведения кеша.
Допустимые значения: all, none, или whitelist.
whitelisted_names
список / элементы=строка
Список куки, которые нужно пересылать исходному серверу для данного поведения кеша.
default_ttl
целое число
Срок хранения по умолчанию для объектов в кэше CloudFront.
field_level_encryption_id
строка
Настройка шифрования на уровне поля, которую CloudFront должен использовать для шифрования определенных полей данных.
headers
список / элементы=строка
Список заголовков для пересылки в исходный сервер для данного поведения кеша.
Для пересылки всех заголовков используйте список, содержащий единственный элемент '*' (['*'])
lambda_function_associations
список / элементы=словарь
Список ассоциаций с функциями Lambda для данного поведения кеша.
event_type
строка
Указывает тип события, который вызывает вызов функции Lambda.
Это может быть viewer-request, origin-request, origin-response или viewer-response.
lambda_function_arn
строка
ARN функции Lambda.
max_ttl
целое число
Максимальный срок хранения объектов в кэше CloudFront.
min_ttl
целое число
Минимальный срок хранения объектов в кэше CloudFront.
query_string
булево
    Варианты:
  • нет
  • да
Указывает, нужно ли CloudFront пересылать строки запроса в исходный сервер, связанный с данным поведением кеша.
query_string_cache_keys
список / элементы=строка
Список параметров строки запроса, которые CloudFront должен использовать в качестве основы для кэширования для данного поведения кеша.
smooth_streaming
булево
    Варианты:
  • нет
  • да
Нужно ли распределять медиа-файлы в формате Microsoft Smooth Streaming.
trusted_signers
словарь
Словарь, определяющий AWS-аккаунты, которым разрешено создавать подписанные URL для контента с ограниченным доступом.
enabled
булево
    Варианты:
  • нет
  • да
Нужно ли требовать от зрителей использования подписанных URL для доступа к файлам, указанным в path_pattern и target_origin_id
items
список / элементы=строка
Список доверенных подписчиков для данного поведения кеша.
viewer_protocol_policy
строка
Протокол, который могут использовать зрители для доступа к файлам в источнике, указанном в target_origin_id, когда запрос соответствует path_pattern.
Допустимые значения: allow-all, redirect-to-https и https-only.
path_pattern
строка
Шаблон, определяющий, к каким запросам следует применять данное поведение.
target_origin_id
строка
Идентификатор источника, в который CloudFront по умолчанию перенаправляет запросы.
caller_reference
string
Уникальный идентификатор для создания и обновления распределений CloudFront.
Каждое значение caller reference должно быть уникальным для всех распределений. Например, значение caller reference, используемое в веб-распределении, не может быть повторно использовано в потоковом распределении. Этот параметр может быть использован вместо distribution_id для ссылки на существующее распределение. Если не указано, по умолчанию используется временная метка в формате YYYY-MM-DDTHH:MM:SS.ffffff.
comment
string
Комментарий, описывающий распределение CloudFront.
Если не указано, по умолчанию используется общее сообщение о том, что оно было создано с помощью Ansible, и временная метка.
custom_error_responses
list / elements=dictionary
Элемент конфигурации, представляющий собой список[] сложных пользовательских ответов на ошибки, которые необходимо указать для распределения.
Этот атрибут настраивает пользовательские сообщения об ошибках HTTP, возвращаемые пользователю.
error_caching_min_ttl
integer
Время в секундах, в течение которого CloudFront будет кэшировать коды состояния.
error_code
integer
Код ошибки, для которой предназначена пользовательская страница ошибки.
response_code
integer
Код HTTP-статуса, который CloudFront должен вернуть пользователю, когда источник возвращает код HTTP-статуса, указанный в error_code.
response_page_path
string
Путь к пользовательской странице ошибки, которую CloudFront должен вернуть просмотру, когда ваш источник возвращает код HTTP-статуса, указанный в error_code.
debug_botocore_endpoint_logs
boolean
    Choices:
  • нет ←
  • да
Использовать логгер botocore.endpoint для анализа уникальных (а не общих) API-вызовов «ресурс:действие», выполняемых во время задачи, выводит набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action, чтобы вывести в полный список, созданный во время выполнения плейбука. Переменная среды ANSIBLE_DEBUG_BOTOCORE_LOGS также может быть использована.
default_cache_behavior
dictionary
Словарь, определяющий поведение кеширования по умолчанию для распределения.
Если не указано, target_origin_id определяется как target_origin_id первого допустимого cache_behavior в cache_behaviors с настройками по умолчанию.
forwarded_values
dictionary
Словарь, определяющий, как CloudFront обрабатывает строки запроса и cookie.
allowed_methods
dictionary
Словарь, контролирующий HTTP-методы, которые CloudFront обрабатывает и пересылает.
cached_methods
list / elements=string
Список HTTP-методов, к которым CloudFront должен применять кэширование.
Это может быть [GET,HEAD], или [GET,HEAD,OPTIONS].
items
list / elements=string
Список HTTP-методов, которые CloudFront должен обрабатывать и пересылать.
compress
boolean
    Choices:
  • нет
  • да
Нужно ли CloudFront автоматически сжимать файлы.
cookies
dictionary
Словарь, определяющий, хотите ли вы, чтобы CloudFront пересылал cookie источнику и, если да, какие.
forward
string
Указывает, какие cookie пересылать источнику для этого поведения кеширования.
Допустимые значения all, none, или whitelist.
whitelisted_names
list / elements=string
Список cookie, которые необходимо пересылать источнику для данного поведения кеширования.
default_ttl
integer
Время по умолчанию, в течение которого объекты должны храниться в кэшах CloudFront.
field_level_encryption_id
string
Конфигурация шифрования на уровне поля, которую вы хотите использовать CloudFront для шифрования определённых полей данных.
headers
list / elements=string
Список заголовков, которые необходимо пересылать источнику для данного поведения кеширования.
Чтобы переслать все заголовки, используйте список, содержащий один элемент '*' (['*']).
lambda_function_associations
list / elements=dictionary
Список ассоциаций с функциями Lambda, которые нужно использовать для данного поведения кеширования.
event_type
string
Указывает тип события, который запускает вызов функции Lambda.
Это может быть viewer-request, origin-request, origin-response или viewer-response.
lambda_function_arn
string
ARN функции Lambda.
max_ttl
integer
Максимальное время, в течение которого объекты должны храниться в кэшах CloudFront.
min_ttl
integer
Минимальное время, в течение которого объекты должны храниться в кэшах CloudFront.
query_string
boolean
    Choices:
  • нет
  • да
Указывает, хотите ли вы, чтобы CloudFront пересылал строки запроса источнику, связанному с этим поведением кэширования.
query_string_cache_keys
list / elements=string
Список, содержащий параметры строки запроса, которые вы хотите, чтобы CloudFront использовал в качестве основы для кэширования для поведения кэширования.
smooth_streaming
boolean
    Choices:
  • нет
  • да
Нужно ли распространять медиафайлы в формате Microsoft Smooth Streaming.
trusted_signers
dictionary
Словарь, определяющий AWS-аккаунты, которым вы хотите разрешить создавать подписанные URL-адреса для частного содержимого.
enabled
boolean
    Choices:
  • нет
  • да
Нужно ли требовать от просмотров использования подписанных URL-адресов для доступа к файлам, указанным в target_origin_id
items
list / elements=string
Список доверенных подписантов для данного поведения кэширования.
viewer_protocol_policy
string
Протокол, который просмотрщики могут использовать для доступа к файлам в источнике, указанном в target_origin_id.
Допустимые значения allow-all, redirect-to-https и https-only.
target_origin_id
string
Идентификатор источника, к которому CloudFront должен направлять запросы по умолчанию.
default_origin_domain_name
string
Доменное имя, которое нужно использовать для источника, если не указаны origins.
Должен использоваться только при первом запуске генерации распределения, а не при последующих запусках.
Не следует использовать в сочетании с distribution_id, caller_reference или alias.
default_origin_path
string
Путь к источнику по умолчанию, который нужно указать для источника, если не указаны origins. По умолчанию пустая строка, если не указано.
default_root_object
строка
Элемент конфигурации, который указывает путь к запросу, когда пользователь запрашивает источник.
Например, если указано 'index.html', это сопоставляется с www.example.com/index.html, когда пользователь обращается к www.example.com.
Это предотвращает раскрытие всего источника распространения на корневом уровне.
distribution_id
строка
Идентификатор распределения CloudFront.
Этот параметр может быть обменён с alias или caller_reference и используется совместно с e_tag.
e_tag
строка
Уникальный идентификатор изменённого или существующего распределения. Используется совместно с distribution_id.
Определяется автоматически, если не указано.
ec2_url
строка
URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задано, используется значение переменной окружения EC2_URL, если таковая имеется.

псевдонимы: aws_endpoint_url, endpoint_url
enabled
логическое
    Варианты:
  • no
  • yes
Логическое значение, указывающее, включено или выключено распределение.
По умолчанию false.
http_version
строка
Версия протокола http для использования в распределении.
AWS по умолчанию использует http2.
Допустимые значения: http1.1 и http2.
ipv6_enabled
логическое
    Варианты:
  • no
  • yes
Определяет, включена ли поддержка IPv6.
По умолчанию false.
logging
словарь
Элемент конфигурации, являющийся сложным объектом, определяющим ведение журнала для распределения.
bucket
строка
Ведро S3 для хранения журнала.
enabled
логическое
    Варианты:
  • no
  • yes
Когда enabled=true, CloudFront будет регистрировать доступ в ведро S3.
include_cookies
логическое
    Варианты:
  • no
  • yes
Когда include_cookies=true, CloudFront будет включать куки в журналы.
prefix
строка
Префикс, который следует добавить в имена объектов S3.
origins
список / элементы=словарь
Элемент конфигурации, представляющий собой список сложных объектов источника, которые необходимо указать для распределения. Используется для создания и обновления распределений.
custom_headers
список / элементы=словарь
Пользовательские заголовки, которые вы хотите добавить к запросу перед его передачей источнику.
Для получения дополнительной информации см. документацию CloudFront по адресу https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html.
header_name
строка
Имя заголовка, который вы хотите, чтобы CloudFront передавал вашему источнику.
header_value
строка
Значение заголовка, указанное в поле header_name.
custom_origin_config
словарь
Информация о подключении к источнику.
http_port
целое число
HTTP-порт, на котором прослушивает пользовательский источник.
https_port
целое число
HTTPS-порт, на котором прослушивает пользовательский источник.
origin_keepalive_timeout
целое число
Таймаут keep-alive (в секундах).
origin_protocol_policy
строка
Политика протокола источника, которую необходимо применить к вашему источнику.
origin_read_timeout
целое число
Таймаут (в секундах) при чтении из источника.
origin_ssl_protocols
список / элементы=строка
Список SSL/TLS-протоколов, которые вы хотите использовать CloudFront при общении с источником через HTTPS.
domain_name
строка
Доменное имя, которое CloudFront будет использовать в качестве источника.
Для получения дополнительной информации см. документацию CloudFront по адресу https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesDomainName
id
строка
Уникальный идентификатор источника или группы источников. id должен быть уникальным в рамках распределения.
origin_path
строка
Указывает CloudFront запросить ваш контент из каталога в вашем ведре Amazon S3 или пользовательском источнике.
s3_origin_access_identity_enabled
логическое
    Варианты:
  • no
  • yes
Используйте идентификатор доступа к источнику для настройки источника таким образом, чтобы просмотрщики могли получать доступ только к объектам в ведре Amazon S3 через CloudFront.
Автоматически создаст для вас идентификатор.
См. также https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html.
price_class
строка
Строка, определяющая класс ценообразования распределения. Согласно https://aws.amazon.com/cloudfront/pricing/
price_class=PriceClass_100 включает регионы США, Канады и Европы.
price_class=PriceClass_200 включает регионы США, Канады, Европы, Японии, Индии, Гонконга, Филиппин, Южной Кореи, Сингапура и Тайваня.
price_class=PriceClass_All включает регионы США, Канады, Европы, Японии, Индии, Южной Америки, Австралии, Гонконга, Филиппин, Южной Кореи, Сингапура и Тайваня.
AWS по умолчанию использует PriceClass_All.
Допустимые значения: PriceClass_100, PriceClass_200 и PriceClass_All.
profile
строка
Использует профиль boto. Работает только с boto >= 2.24.0.
Использование profile переопределит aws_access_key, aws_secret_key и security_token, а поддержка одновременного использования этих параметров с profile устарела.
aws_access_key, aws_secret_key и security_token станут взаимоисключающими с profile после 2022-06-01.

псевдонимы: aws_profile
purge_aliases
логическое
    Варианты:
  • no ←
  • yes
Указывает, будут ли удалены существующие псевдонимы перед добавлением новых псевдонимов.
Когда purge_aliases=yes, существующие псевдонимы удаляются, и добавляются aliases.
purge_cache_behaviors
логическое
    Варианты:
  • no ←
  • yes
Удалять ли любые правила кеширования, которые не указаны в cache_behaviors.
Этот переключатель также позволяет изменить порядок cache_behaviors.
purge_custom_error_responses
логическое
    Варианты:
  • no ←
  • yes
Удалять ли пользовательские ответы на ошибки, которые не указаны в custom_error_responses.
purge_origins
логическое
    Варианты:
  • no ←
  • yes
Удалять ли любые источники, которые не указаны в origins.
purge_tags
логическое
    Варианты:
  • no ←
  • yes
Указывает, будут ли удалены существующие теги перед добавлением новых тегов.
Когда purge_tags=yes, существующие теги удаляются, а теги tags добавляются, если указаны. Если теги не указаны, все существующие теги распределения удаляются.
Когда purge_tags=no, существующие теги сохраняются, а теги tags добавляются, если указаны.
region
string
AWS регион для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если она есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

псевдонимы: aws_region, ec2_region
restrictions
dictionary
Элемент конфигурации, являющийся сложным объектом, описывающим, как распределение должно ограничивать свой контент.
geo_restriction
dictionary
Применение ограничения на основе местоположения запросителя.
items
list / elements=string
Список двухбуквенных кодов ISO 3166-1 (Alpha 2) стран, на которые должно распространяться ограничение.
Полный список кодов см. на сайте ISO https://www.iso.org/obp/ui/#search/code/.
restriction_type
string
Метод, который вы хотите использовать для ограничения распространения контента по странам.
Допустимые значения none, whitelist, blacklist.
security_token
string
AWS STS security token. Если не задано, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.
Если параметр profile установлен, этот параметр игнорируется.
Передача параметров security_token и profile одновременно устарела и будет сделана взаимоисключающей после 2022-06-01.

псевдонимы: aws_security_token, access_token
state
string
    Выбори:
  • present ←
  • absent
Желаемое состояние распределения.
state=present создаёт новое распределение или обновляет существующее.
state=absent удаляет существующее распределение.
tags
dictionary
Должен быть введён как словарь пар ключ-значение.
Обратите внимание, что числовые ключи или значения должны быть заключены в кавычки. Например, Priority: '1'
validate_certs
boolean
    Выбори:
  • no
  • yes ←
Если установлено в «no», сертификаты SSL не будут проверяться для версий boto >= 2.6.0.
viewer_certificate
dictionary
Словарь, определяющий параметры шифрования распределения.
acm_certificate_arn
string
Идентификатор сертификата, хранящегося в ACM, который используется для HTTPS-соединений.
Если установлен параметр acm_certificate_id, необходимо также указать ssl_support_method.
cloudfront_default_certificate
boolean
    Выбори:
  • no
  • yes
Если вы используете имя домена CloudFront для своего распределения, например, 123456789abcde.cloudfront.net вы должны установить cloudfront_default_certificate=true.
Если cloudfront_default_certificate=true, не устанавливайте ssl_support_method.
iam_certificate_id
string
Идентификатор сертификата, хранящегося в IAM, который используется для HTTPS-соединений.
Если установлен параметр iam_certificate_id, необходимо также указать ssl_support_method.
minimum_protocol_version
string
Политика безопасности, которую вы хотите использовать CloudFront для HTTPS-соединений.
См. https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html для поддержки политик безопасности.
ssl_support_method
string
Способ, которым CloudFront должен предоставлять SSL-сертификаты.
Допустимые значения sni-only для SNI и vip если CloudFront настроен на использование выделенного IP-адреса для вашего контента.
wait
boolean
    Выбори:
  • no ←
  • yes
Указывает, ожидает ли модуль завершения обработки создания или обновления распределения.
wait_timeout
integer
По умолчанию:
1800
Указывает время ожидания в секундах для таймаута создания или обновления cloudfront.
web_acl_id
string
Идентификатор списка управления доступом (ACL) межсетевого экрана веб-приложений (WAF).

Примечания

Примечание

  • Если параметры не установлены в модуле, можно использовать следующие переменные окружения в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY или EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY или EC2_SECRET_KEY, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN, AWS_REGION или EC2_REGION, AWS_CA_BUNDLE
  • Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION или EC2_REGION обычно используются для указания AWS региона, когда это требуется, но это также можно настроить в файле конфигурации boto

Примеры

- name: create a basic distribution with defaults and tags
  community.aws.cloudfront_distribution:
    state: present
    default_origin_domain_name: www.my-cloudfront-origin.com
    tags:
      Name: example distribution
      Project: example project
      Priority: '1'

- name: update a distribution comment by distribution_id
  community.aws.cloudfront_distribution:
    state: present
    distribution_id: E1RP5A2MJ8073O
    comment: modified by ansible cloudfront.py

- name: update a distribution comment by caller_reference
  community.aws.cloudfront_distribution:
    state: present
    caller_reference: my cloudfront distribution 001
    comment: modified by ansible cloudfront.py

- name: update a distribution's aliases and comment using the distribution_id as a reference
  community.aws.cloudfront_distribution:
    state: present
    distribution_id: E1RP5A2MJ8073O
    comment: modified by cloudfront.py again
    aliases: [ 'www.my-distribution-source.com', 'zzz.aaa.io' ]

- name: update a distribution's aliases and comment using an alias as a reference
  community.aws.cloudfront_distribution:
    state: present
    caller_reference: my test distribution
    comment: modified by cloudfront.py again
    aliases:
      - www.my-distribution-source.com
      - zzz.aaa.io

- name: update a distribution's comment and aliases and tags and remove existing tags
  community.aws.cloudfront_distribution:
    state: present
    distribution_id: E15BU8SDCGSG57
    comment: modified by cloudfront.py again
    aliases:
      - tested.com
    tags:
      Project: distribution 1.2
    purge_tags: yes

- name: create a distribution with an origin, logging and default cache behavior
  community.aws.cloudfront_distribution:
    state: present
    caller_reference: unique test distribution ID
    origins:
        - id: 'my test origin-000111'
          domain_name: www.example.com
          origin_path: /production
          custom_headers:
            - header_name: MyCustomHeaderName
              header_value: MyCustomHeaderValue
    default_cache_behavior:
      target_origin_id: 'my test origin-000111'
      forwarded_values:
        query_string: true
        cookies:
          forward: all
        headers:
         - '*'
      viewer_protocol_policy: allow-all
      smooth_streaming: true
      compress: true
      allowed_methods:
        items:
          - GET
          - HEAD
        cached_methods:
          - GET
          - HEAD
    logging:
      enabled: true
      include_cookies: false
      bucket: mylogbucket.s3.amazonaws.com
      prefix: myprefix/
    enabled: false
    comment: this is a CloudFront distribution with logging

- name: delete a distribution
  community.aws.cloudfront_distribution:
    state: absent
    caller_reference: replaceable distribution

Значения возврата

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

Ключ Возвращаемое значение Описание
active_trusted_signers
complex
всегда
Идентификаторы пар ключей, известные CloudFront для каждого доверенного подписывающего лица.

enabled
boolean
всегда
Используются ли доверенные подписывающие лица.

items
list / elements=string
при наличии доверенных подписывающих лиц
Количество доверенных подписывающих лиц.

Пример:
['key_pair_id']
quantity
integer
всегда
Количество доверенных подписывающих лиц.

Пример:
1
aliases
complex
всегда
Псевдонимы, ссылающиеся на распределение.

items
list / elements=string
всегда
Список псевдонимов.

Пример:
['test.example.com']
quantity
integer
всегда
Количество псевдонимов.

Пример:
1
arn
string
всегда
Amazon Resource Name распределения.

Пример:
arn:aws:cloudfront::123456789012:distribution/E1234ABCDEFGHI
cache_behaviors
complex
всегда
Поведение кэша CloudFront.

items
complex
всегда
Список поведений кэша.

allowed_methods
complex
всегда
Методы, разрешенные поведением кэша.

cached_methods
complex
всегда
Методы, кэшируемые поведением кэша.

items
list / elements=string
всегда
Список кэшируемых методов.

Пример:
['HEAD', 'GET']
quantity
integer
всегда
Количество кэшируемых методов.

Пример:
2
items
list / elements=string
всегда
Список методов, разрешенных поведением кэша.

Пример:
['HEAD', 'GET']
quantity
integer
всегда
Количество методов, разрешенных поведением кэша.

Пример:
2
compress
boolean
всегда
Включена ли сжатие для данного поведения кэша.

default_ttl
integer
всегда
Значение по умолчанию для срока хранения кэша.

Пример:
86400
forwarded_values
complex
всегда
Значения, пересылаемые источнику для данного поведения кэша.

cookies
complex
всегда
Cookies, пересылаемые источнику.

forward
string
всегда
Какие cookies пересылать источнику для данного поведения кэша.

Пример:
none
whitelisted_names
complex
если forward=whitelist
Имена cookies, которые пересылать источнику для данного поведения кэша.

items
list / elements=string
когда список не пуст
Список cookies для пересылки.

Пример:
my_cookie
quantity
integer
всегда
Количество cookies для пересылки.

Пример:
1
headers
complex
всегда
Заголовки, используемые для вариации при получении данных из кэша.

items
list / elements=string
когда список не пуст
Список заголовков для вариации.

Пример:
['Host']
quantity
integer
всегда
Количество заголовков для вариации.

Пример:
1
query_string
boolean
всегда
Используется ли строка запроса при поиске в кэше.

query_string_cache_keys
complex
всегда
Ключи строки запроса, используемые при поиске в кэше.

items
list / elements=string
когда список не пуст
Список ключей строки запроса для поиска в кэше.

quantity
integer
всегда
Количество ключей строки запроса для поиска в кэше.

Пример:
1
lambda_function_associations
complex
всегда
Связывание с функциями Lambda для поведения кэша.

items
list / elements=string
когда список не пуст
Список связей с функциями Lambda.

Пример:
[{'event_type': 'viewer-response', 'lambda_function_arn': 'arn:aws:lambda:123456789012:us-east-1/lambda/lambda-function'}]
quantity
integer
всегда
Количество связей с функциями Lambda.

Пример:
1
max_ttl
integer
всегда
Максимальное время хранения.

Пример:
31536000
min_ttl
integer
всегда
Минимальное время хранения.

path_pattern
string
всегда
Шаблон пути, определяющий данное поведение кэша.

Пример:
/path/to/files/*
smooth_streaming
boolean
всегда
Включено ли плавное потоковое видео.

target_origin_id
string
всегда
Идентификатор источника, используемого данным поведением кэша.

Пример:
origin_abcd
trusted_signers
complex
всегда
Доверенные подписывающие лица.

enabled
boolean
always
Включены ли доверенные подписывающие стороны для этого поведения кэша.

quantity
integer
always
Количество доверенных подписывающих сторон.

Пример:
1
viewer_protocol_policy
string
always
Политика обработки http/https.

Пример:
redirect-to-https
quantity
integer
always
Количество поведений кэша.

Пример:
1
caller_reference
string
always
Ссылка на идентификатор операции, заданная при создании распределения CloudFront.

Пример:
1484796016700
comment
string
always
Любые комментарии, которые вы хотите добавить о распределении.

Пример:
мое первое распределение CloudFront
custom_error_responses
complex
always
Настраиваемые ответы об ошибках для обработки ошибок.

items
complex
always
Список настраиваемых ответов об ошибках.

error_caching_min_ttl
integer
always
Минимальное время кэширования этого ответа об ошибке.

Пример:
300
error_code
integer
always
Код ответа источника, который вызывает этот ответ об ошибке.

Пример:
500
response_code
string
always
Код ответа, который нужно вернуть запрошивающему.

Пример:
500
response_page_path
string
always
Путь к странице ошибки, которую нужно отобразить.

Пример:
/errors/5xx.html
quantity
integer
always
Количество элементов настраиваемого ответа об ошибке

Пример:
1
default_cache_behavior
complex
always
Поведение кэша по умолчанию.

allowed_methods
complex
always
Методы, разрешенные поведением кэша.

cached_methods
complex
always
Методы, кэшируемые поведением кэша.

items
list / elements=string
always
Список кэшируемых методов.

Пример:
['HEAD', 'GET']
quantity
integer
always
Количество кэшируемых методов.

Пример:
2
items
list / elements=string
always
Список методов, разрешенных поведением кэша.

Пример:
['HEAD', 'GET']
quantity
integer
always
Количество методов, разрешенных поведением кэша.

Пример:
2
compress
boolean
always
Включена ли компрессия для поведения кэша.

default_ttl
integer
always
Значение по умолчанию для времени жизни кэша.

Пример:
86400
forwarded_values
complex
always
Значения, пересылаемые источнику для данного поведения кэша.

cookies
complex
always
Cookies, пересылаемые источнику.

forward
string
always
Какие cookies пересылать источнику для данного поведения кэша.

Пример:
none
whitelisted_names
complex
when forward=whitelist
Имена cookies для пересылки источнику для данного поведения кэша.

items
list / elements=string
when list is not empty
Список cookies для пересылки.

Пример:
my_cookie
quantity
integer
always
Количество cookies для пересылки.

Пример:
1
headers
complex
always
Какие заголовки используются для изменения результатов извлечения из кэша.

items
list / elements=string
when list is not empty
Список заголовков для изменения.

Пример:
['Host']
quantity
integer
always
Количество заголовков для изменения.

Пример:
1
query_string
boolean
always
Используется ли строка запроса в поиске по кэшу.

query_string_cache_keys
complex
always
Какие ключи строки запроса использовать в поиске по кэшу.

items
list / elements=string
when list is not empty
Список ключей строки запроса для использования в поиске по кэшу.

quantity
integer
always
Количество ключей строки запроса для использования в поиске по кэшу.

Пример:
1
lambda_function_associations
complex
always
Ассоциации функций Lambda для поведения кэша.

items
list / elements=string
when list is not empty
Список ассоциаций функций Lambda.

Пример:
[{'event_type': 'viewer-response', 'lambda_function_arn': 'arn:aws:lambda:123456789012:us-east-1/lambda/lambda-function'}]
quantity
integer
always
Количество ассоциаций функций Lambda.

Пример:
1
max_ttl
integer
always
Максимальное время жизни.

Пример:
31536000
min_ttl
integer
always
Минимальное время жизни.

path_pattern
string
always
Шаблон пути, определяющий это поведение кэша.

Пример:
/path/to/files/*
smooth_streaming
boolean
always
Включено ли плавное потоковое вещание.

target_origin_id
string
always
Идентификатор источника, на который ссылается данное поведение кэша.

Пример:
origin_abcd
trusted_signers
complex
always
Доверенные подписывающие стороны.

enabled
boolean
always
Включены ли доверенные подписывающие стороны для данного поведения кэша.

quantity
integer
always
Количество доверенных подписывающих сторон.

Пример:
1
viewer_protocol_policy
string
always
Политика обработки http/https.

Пример:
redirect-to-https
default_root_object
string
always
Объект, который CloudFront должен запросить у вашего источника (например, index.html), когда пользователь запрашивает корневой URL для вашей распределённой системы.

diff
dictionary
always
Разница между предыдущей и новой конфигурацией.

domain_name
string
always
Доменное имя распределённой системы CloudFront.

Пример:
d1vz8pzgurxosf.cloudfront.net
enabled
boolean
always
Включена ли распределённая система CloudFront.

Пример:
True
http_version
string
always
Версия HTTP, поддерживаемая системой.

Пример:
http2
id
string
always
Идентификатор распределённой системы CloudFront.

Пример:
E123456ABCDEFG
in_progress_invalidation_batches
integer
always
Количество процессов проверки валидности в очереди.

is_ipv6_enabled
boolean
always
Включен ли IPv6.

Пример:
True
last_modified_time
string
always
Дата и время последнего изменения распределённой системы.

Пример:
2017-10-13T01:51:12.656000+00:00
logging
complex
always
Информация о ведении журналов.

bucket
string
always
Назначение S3-бакета для ведения журналов.

Пример:
logs-example-com.s3.amazonaws.com
enabled
boolean
always
Включено ли ведение журналов.

Пример:
True
include_cookies
boolean
always
Включать ли файлы cookie в журналы.

prefix
string
always
Префикс, добавляемый к именам объектов логов.

Пример:
cloudfront/test
origins
complex
always
Источники в распределённой системе CloudFront.

items
complex
always
Список источников.

custom_headers
complex
always
Пользовательские заголовки, передаваемые источнику.

quantity
integer
always
Количество заголовков.

Пример:
1
custom_origin_config
complex
always
Настройки источника.

http_port
integer
always
Порт для прослушивания HTTP.

Пример:
80
https_port
integer
always
Порт для прослушивания HTTPS.

Пример:
443
origin_keepalive_timeout
integer
always
Таймаут keep-alive.

Пример:
5
origin_protocol_policy
string
always
Политика поддерживаемых протоколов.

Пример:
https-only
origin_read_timeout
integer
always
Таймаут чтения из источника.

Пример:
30
origin_ssl_protocols
complex
always
Разрешенные SSL-протоколы источника.

items
list / elements=string
always
Список SSL-протоколов.

Пример:
['TLSv1', 'TLSv1.1', 'TLSv1.2']
quantity
integer
always
Количество SSL-протоколов.

Пример:
3
domain_name
string
always
Доменное имя источника.

Пример:
test-origin.example.com
id
string
always
Идентификатор источника.

Пример:
test-origin.example.com
origin_path
string
always
Подкаталог для префикса запроса к источнику S3 или HTTP.

quantity
integer
always
Количество источников.

Пример:
1
price_class
string
always
Класс цены распределённой системы CloudFront.

Пример:
PriceClass_All
restrictions
complex
always
Ограничения, используемые CloudFront.

geo_restriction
complex
always
Управление странами, в которых распространяется контент.

items
list / elements=string
always
Список кодов стран, разрешенных или запрещенных.

Пример:
xy
quantity
integer
always
Количество ограничений.

Пример:
1
restriction_type
string
always
Тип ограничения.

Пример:
blacklist
status
string
always
Статус распределённой системы CloudFront.

Пример:
InProgress
tags
dictionary
always
Теги распределённой системы.

Пример:
{'Hello': 'World'}
viewer_certificate
complex
always
Сертификат, используемый распределённой системой CloudFront.

acm_certificate_arn
string
when certificate comes from ACM
ARN сертификата ACM.

Пример:
arn:aws:acm:us-east-1:123456789012:certificate/abcd1234-1234-1234-abcd-123456abcdef
certificate
string
always
Ссылка на сертификат.

Пример:
arn:aws:acm:us-east-1:123456789012:certificate/abcd1234-1234-1234-abcd-123456abcdef
certificate_source
string
всегда
Источник сертификата.

Пример:
acm
minimum_protocol_version
string
всегда
Минимальная поддерживаемая версия SSL/TLS данного распределения.

Пример:
TLSv1
ssl_support_method
string
всегда
Поддержка браузеров до SNI или нет.

Пример:
sni-only
web_acl_id
string
всегда
Идентификатор списка управления веб-доступом (из службы WAF).

Пример:
abcd1234-1234-abcd-abcd-abcd12345678


Авторы

  • Willem van Ketwich (@wilvk)
  • Will Thames (@willthames)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/cloudfront_distribution_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API