Spec-Zone.ru › Ansible

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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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.35.0
  • botocore >= 1.35.0

Параметры

Параметр

Комментарии

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

путь

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

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

aws_config

словарь

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

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

comment

строка

Комментарий, связанный с зоной.

По умолчанию: ""

debug_botocore_endpoint_logs

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

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

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

Варианты:

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

delegation_set_id

строка

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

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

dnssec

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

добавлено в amazon.aws 9.2.0

Включает подпись DNSSEC для указанной размещенной зоны.

Варианты:

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

endpoint_url

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

строка

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

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

hosted_zone_id

строка

Уникальный идентификатор зоны, которую требуется удалить, или «all», если существует несколько зон с одинаковым доменным именем.

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

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.

purge_tags

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

Если задано значение 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

псевдонимы: 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.

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"

tags

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

словарь

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

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

validate_certs

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

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

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

Варианты:

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

vpc_id

строка

Идентификатор VPC, к которой должна относиться зона (если это будет частная зона).

vpc_region

строка

Регион VPC, к которой должна относиться зона (если это будет частная зона).

vpcs

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

добавлено в amazon.aws 5.3.0

Список VPC, к которым должна относиться зона (если это будет частная зона).

id

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

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

region

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

Регион VPC.

zone

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

Запись DNS-зоны (например: foo.com.)

Примечания

Примечание

  • Поддержка tags и purge_tags добавлена в выпуске 2.1.0.
  • Внимание: Для модулей переменные окружения и файлы конфигурации считываются из контекста «узла» Ansible, а не из контекста «контроллера». Поэтому файлы может потребоваться явно скопировать на «узел». Для плагинов поиска и подключения переменные окружения и файлы конфигурации считываются из контекста «контроллера» Ansible, а не из контекста «узла».
  • Используемый Ansible пакет AWS SDK (boto3) также может считывать значения учетных данных и других параметров по умолчанию, например региона, из файлов конфигурации в контексте «узла» 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

string

Необязательный комментарий к размещённой зоне.

Возвращается: когда размещённая зона существует

Пример: "Private zone"

delegation_set_id

string

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

Возвращается: для общедоступных размещённых зон, если они связаны с повторно используемым набором делегирования

Пример: "A1BCDEF2GHIJKL"

dnssec

dictionary

добавлено в amazon.aws 9.2.0

Информация о DNSSEC для указанной размещённой зоны.

Возвращается: когда state=present и размещённая зона является общедоступной

key_signing_key

list / elements=dictionary

Ключ подписи ключей (KSK), создаваемый запросом.

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

Пример: [{"created_date": "2024-12-04T15:15:36.715000+00:00", "digest_algorithm_mnemonic": "SHA-256", "digest_algorithm_type": 2, "digest_value": "xxx", "dnskey_record": "xxx", "ds_record": "xxx", "flag": 257, "key_tag": 18948, "kms_arn": "arn:aws:kms:us-east-1:xxx:key/xxx", "last_modified_date": "2024-12-04T15:15:36.715000+00:00", "name": "ansible-test-44230979--ksk", "public_key": "xxxx", "signing_algorithm_mnemonic": "ECDSAP256SHA256", "signing_algorithm_type": 13, "status": "INACTIVE"}]

created_date

string

Дата создания ключа подписи ключей (KSK).

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

digest_algorithm_mnemonic

string

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

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

digest_algorithm_type

integer

Целое число, обозначающее алгоритм дайджеста подписывающей стороны делегирования.

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

digest_value

string

Криптографический дайджест записи ресурса DNSKEY (RR).

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

dnskey_record

string

Строка, представляющая запись DNSKEY.

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

ds_record

string

Строка, представляющая запись подписывающей стороны делегирования (DS).

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

flag

integer

Целое число, указывающее, как используется ключ.

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

key_tag

integer

Целое число, используемое для идентификации записи DNSSEC для доменного имени.

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

kms_arn

string

Имя ресурса Amazon (ARN), используемое для идентификации управляемого клиентом ключа в службе управления ключами (KMS).

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

last_modified_date

string

Дата последнего изменения ключа подписи ключей (KSK).

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

name

string

Строка, используемая для идентификации ключа подписи ключей (KSK).

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

public_key

string

Открытый ключ в кодировке Base64.

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

signing_algorithm_mnemonic

string

Строка, обозначающая алгоритм подписи.

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

signing_algorithm_type

integer

Целое число, обозначающее алгоритм подписи.

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

status

string

Строка, обозначающая текущее состояние ключа подписи ключей (KSK).

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

status_message

string

Сообщение о состоянии для состояний ACTION_NEEDED или INTERNAL_FAILURE.

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

status

dictionary

Словарь, представляющий состояние DNSSEC.

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

Пример: {"serve_signature": "SIGNING"}

serve_signature

string

Строка, обозначающая текущее состояние подписания размещённой зоны.

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

name

string

Имя размещённой зоны.

Возвращается: когда размещённая зона существует

Пример: "private.local."

private_zone

boolean

Является ли размещённая зона частной или общедоступной.

Возвращается: когда размещённая зона существует

Пример: true

tags

dictionary

Теги, связанные с зоной.

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

vpc_id

string

Идентификатор первой VPC, подключённой к частной размещённой зоне (для связи нескольких VPC используйте vpcs).

Возвращается: для частной размещённой зоны

Пример: "vpc-1d36c84f"

vpc_region

string

Регион первой VPC, подключённой к частной размещённой зоне (для связи нескольких VPC используйте vpcs).

Возвращается: для частной размещённой зоны

Пример: "eu-west-1"

vpcs

list / elements=dictionary

добавлено в amazon.aws 5.3.0

Список VPC, подключённых к частной размещённой зоне.

Возвращается: для частной размещённой зоны

Пример: "[{'id': 'vpc-123456', 'region': 'us-west-2'}]"

id

string

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

Возвращается: для частной размещённой зоны

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

region

string

Регион VPC.

Возвращается: для частной размещённой зоны

Пример: "eu-west-2"

zone_id

string

Идентификатор размещённой зоны.

Возвращается: когда размещённая зона существует

Пример: "Z6JQG9820BEFMW"

Авторы

  • Christopher Troup (@minichate)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Связь

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

Spec-Zone.ru

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