Модуль amazon.aws.route53_zone — добавление или удаление зон Route 53

Примечание

Этот модуль является частью коллекции amazon.aws (версия 8.2.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install amazon.aws. Для использования этого модуля необходимы дополнительные требования. Подробнее об этом см. Требования.

Чтобы использовать его в плейбуке, укажите: amazon.aws.route53_zone.

Добавлен в amazon.aws 5.0.0

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Создаёт и удаляет частные и публичные зоны Route 53.
Этот модуль был первоначально добавлен в community.aws в релизе 1.0.0.

Требования

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

python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0

Параметры

Параметр	Комментарии
access_key aliases: aws_access_key_id, aws_access_key, ec2_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` или `EC2_ACCESS_KEY` также могут использоваться в порядке убывания предпочтения. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_ACCESS_KEY` устарела и будет удалена в релизе после 2024-12-01.
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.
comment string	Комментарий, связанный с зоной. По умолчанию: `""`
debug_botocore_endpoint_logs boolean	Использовать `botocore.endpoint` регистратор для анализа уникальных (а не общих) `"resource:action"` вызовов API, выполненных во время задачи, выводя набор в ключ resource_actions в результатах задачи. Используйте обратный вызов `aws_resource_action` для вывода в общий список, созданный во время playbook. Переменная среды `ANSIBLE_DEBUG_BOTOCORE_LOGS` также может использоваться. Варианты: `false` ← (по умолчанию) `true`
delegation_set_id string	Идентификатор многоразового набора делегирования, который будет связан с зоной. Обратите внимание, что вы не можете связать многоразовый набор делегирования с частной хостинг-зоной.
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url string	URL для подключения вместо конечных точек AWS по умолчанию. Хотя это можно использовать для подключения к другим совместимым с AWS службам, коллекции amazon.aws и community.aws тестируются только с AWS. Переменные среды `AWS_URL` или `EC2_URL` также могут использоваться в порядке убывания предпочтения. Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01. Поддержка переменной среды `EC2_URL` устарела и будет удалена в релизе после 2024-12-01.
hosted_zone_id string	Уникальный идентификатор зоны, который вы хотите удалить, или «all», если есть много зон с тем же именем домена. Обязательно, если есть несколько зон, определенных с помощью вышеуказанных параметров.
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 и security_token.
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, ec2_region string	Регион AWS для использования. Для глобальных служб, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Переменные среды `AWS_REGION` или `EC2_REGION` также могут использоваться. См. документацию Amazon AWS для получения дополнительной информации http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. Псевдоним `ec2_region` устарел и будет удален в релизе после 2024-12-01 Поддержка переменной среды `EC2_REGION` устарела и будет удалена в релизе после 2024-12-01.
secret_key aliases: aws_secret_access_key, aws_secret_key, ec2_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`, или `EC2_SECRET_KEY` также могут использоваться в порядке убывания предпочтения. Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_secret_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды `EC2_SECRET_KEY` устарела и будет удалена в релизе после 2024-12-01.

session_token aliases: aws_session_token, security_token, aws_security_token, access_token строка	Токен сессии AWS STS для использования с временными учетными данными. См. документацию AWS для получения дополнительной информации об access токенах https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные среды `AWS_SESSION_TOKEN`, `AWS_SECURITY_TOKEN` или `EC2_SECURITY_TOKEN` в порядке убывания приоритета. Параметры security_token и profile взаимоисключающие. Псевдонимы aws_session_token и session_token были добавлены в релизе 3.2.0, а параметр был переименован из security_token в session_token в релизе 6.0.0. Псевдонимы security_token, aws_security_token и access_token устарели и будут удалены в релизе после 2024-12-01. Поддержка переменных среды `EC2_SECRET_KEY` и `AWS_SECURITY_TOKEN` устарела и будет удалена в релизе после 2024-12-01.
state строка	Определяет, должно ли существовать зона или нет. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags aliases: resource_tags словарь	Словарь, представляющий теги, которые необходимо применить к ресурсу. Если параметр tags не задан, теги не будут изменены.
validate_certs логическое	Если установлено значение `false`, сертификаты SSL для связи с API AWS не будут проверяться. Настройка validate_certs=false настоятельно не рекомендуется, как альтернатива, рассмотрите настройку aws_ca_bundle вместо этого. Варианты: `false` `true` ← (по умолчанию)
vpc_id строка	ID VPC, к которому должна принадлежать зона (если это будет частная зона).
vpc_region строка	Регион VPC, к которому должна принадлежать зона (если это будет частная зона).
vpcs список / элементы=словарь добавлен в amazon.aws 5.3.0	VPC, к которым должна принадлежать зона (если это будет частная зона).
id строка / обязательно	ID VPC.
region строка / обязательно	Регион VPC.
zone строка / обязательно	Запись DNS зоны (например: foo.com.)

Примечания

Примечание

Поддержка tags и purge_tags была добавлена в релизе 2.1.0.
Предупреждение: Для модулей переменные среды и конфигурационные файлы читаются из контекста Ansible «хост» и не из контекста «контроллер». Следовательно, файлы могут потребоваться явно скопировать на «хост». Для плагинов поиска и подключения переменные среды и конфигурационные файлы читаются из контекста Ansible «контроллер» и не из контекста «хост».
AWS SDK (boto3), который использует Ansible, также может считывать значения по умолчанию для учетных данных и других настроек, таких как регион, из своих конфигурационных файлов в контексте Ansible «хост» (обычно ~/.aws/credentials). См. https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html для получения дополнительной информации.

Примеры

- name: create a public zone
  amazon.aws.route53_zone:
    zone: example.com
    comment: this is an example

- name: delete a public zone
  amazon.aws.route53_zone:
    zone: example.com
    state: absent

- name: create a private zone
  amazon.aws.route53_zone:
    zone: devel.example.com
    vpc_id: '{{ myvpc_id }}'
    vpc_region: us-west-2
    comment: developer domain

- name: create a private zone with multiple associated VPCs
  amazon.aws.route53_zone:
    zone: crossdevel.example.com
    vpcs:
      - id: vpc-123456
        region: us-west-2
      - id: vpc-000001
        region: us-west-2
    comment: developer cross-vpc domain

- name: create a public zone associated with a specific reusable delegation set
  amazon.aws.route53_zone:
    zone: example.com
    comment: reusable delegation set example
    delegation_set_id: A1BCDEF2GHIJKL

- name: create a public zone with tags
  amazon.aws.route53_zone:
    zone: example.com
    comment: this is an example
    tags:
      Owner: Ansible Team

- name: modify a public zone, removing all previous tags and adding a new one
  amazon.aws.route53_zone:
    zone: example.com
    comment: this is an example
    tags:
      Support: Ansible Community
    purge_tags: true

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

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

Ключ	Описание
comment строка	Необязательный комментарий к размещённой зоне. Возвращаемое значение: когда зона размещения существует Пример: `"Private zone"`
delegation_set_id строка	Идентификатор связанного набора делегирования. Возвращаемое значение: для общедоступных зон размещения, если они были связаны с набором делегирования Пример: `"A1BCDEF2GHIJKL"`
name строка	Имя размещённой зоны. Возвращаемое значение: когда зона размещения существует Пример: `"private.local."`
private_zone логический тип	Является ли размещённая зона приватной или общедоступной. Возвращаемое значение: когда зона размещения существует Пример: `true`
tags словарь	Теги, связанные с зоной. Возвращаемое значение: при определении тегов
vpc_id строка	Идентификатор первого VPC, подключенного к приватной зоне размещения (используйте vpcs для ассоциации нескольких). Возвращаемое значение: для приватной зоны размещения Пример: `"vpc-1d36c84f"`
vpc_region строка	Регион первого VPC, подключенного к приватной зоне размещения (используйте vpcs для ассоциации нескольких). Возвращаемое значение: для приватной зоны размещения Пример: `"eu-west-1"`
vpcs список / элементы=словарь добавлено в amazon.aws 5.3.0	Список VPC, подключенных к приватной зоне размещения. Возвращаемое значение: для приватной зоны размещения Пример: `"[{'id': 'vpc-123456', 'region': 'us-west-2'}]"`
id строка	Идентификатор VPC. Возвращаемое значение: для приватной зоны размещения Пример: `"vpc-123456"`
region строка	Регион VPC. Возвращаемое значение: для приватной зоны размещения Пример: `"eu-west-2"`
zone_id строка	Идентификатор зоны размещения. Возвращаемое значение: когда зона размещения существует Пример: `"Z6JQG9820BEFMW"`

Авторы

Christopher Troup (@minichate)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/amazon/aws/route53_zone_module.html