Spec-Zone.ru › Ansible

модуль amazon.aws.route53_key_signing_key – Управляет ключом подписи ключей (KSK)

Примечание

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

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

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

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

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

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

Краткое описание

  • Создает новый ключ подписи ключей (KSK), связанный с размещенной зоной. Для каждой размещенной зоны можно создать не более двух KSK.
  • Если state=absent, деактивирует и удаляет ключ подписи ключей (KSK).
  • Активирует ключ подписи ключей (KSK), чтобы его можно было использовать для подписания с помощью DNSSEC.
  • Деактивирует ключ подписи ключей (KSK), чтобы он не использовался для подписания с помощью DNSSEC.

Требования

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

  • 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

путь

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

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

aws_config

словарь

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

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

caller_reference

строка

Уникальная строка, идентифицирующая запрос.

Обязателен, если state=present.

debug_botocore_endpoint_logs

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

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

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

Варианты:

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

endpoint_url

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

строка

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

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

hosted_zone_id

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

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

Уникальная строка (идентификатор), используемая для идентификации размещенной зоны.

key_management_service_arn

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

строка

Имя ресурса Amazon (ARN) ключа, управляемого клиентом, в сервисе управления ключами (KMS).

Обязателен, если state=present.

name

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

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

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.

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"

status

строка

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

Если state=presnent, можно задать значение ACTIVE или INACTIVE.

Варианты:

  • "ACTIVE" ← (по умолчанию)
  • "INACTIVE"

validate_certs

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

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

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

Варианты:

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

wait

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

Ожидать репликации изменений.

Варианты:

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

wait_timeout

целое число

Время ожидания репликации изменений в секундах.

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

Примечания

Примечание

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

Примеры

- name: Create a Key Signing Key Request
  amazon.aws.route53_ksk:
    name: "{{ resource_prefix }}-ksk"
    hosted_zone_id: "ZZZ1111112222"
    key_management_service_arn: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    caller_reference: "arn:aws:iam::123456789012:user/SomeUser"
    status: "INACTIVE"
    state: present

- name: Activate a Key Signing Key Request
  amazon.aws.route53_ksk:
    name: "{{ resource_prefix }}-ksk"
    hosted_zone_id: "ZZZ1111112222"
    key_management_service_arn: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"
    caller_reference: "arn:aws:iam::123456789012:user/SomeUser"
    status: "ACTIVE"
    state: present

- name: Delete a Key Signing Key Request and deactivate it
  amazon.aws.route53_ksk:
    name: "{{ resource_prefix }}-ksk"
    hosted_zone_id: "ZZZ1111112222"
    state: absent

Возвращаемые значения

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

Ключ

Описание

change_info

dictionary

Словарь с информацией об изменениях, внесённых в размещённую зону.

Возвращается: при создании ключа подписи ключей или если он существует и был обновлён/удалён

Пример: {"id": "/change/C090307813XORZJ5J3U4", "status": "PENDING", "submitted_at": "2024-12-04T15:15:36.743000+00:00"}

comment

string

Комментарий, который можно добавить.

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

id

string

Идентификатор изменения.

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

status

string

Текущее состояние запроса.

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

submitted_at

string

Дата и время отправки запроса на изменение в формате ISO 8601 и по всемирному координированному времени (UTC).

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

key_signing_key

dictionary

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

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

Пример: {"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.

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

location

string

Уникальный URL нового ключа подписи ключей (KSK).

Возвращается: только при создании нового ключа подписи ключей

Пример: "https://route53.amazonaws.com/2013-04-01/keysigningkey/xxx/ansible-test-ksk"

Авторы

  • Alina Buzachis (@alinabuzachis)

Ссылки коллекции

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

© 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_key_signing_key_module.html

Spec-Zone.ru

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