Модуль google.cloud.gcp_kms_crypto_key — Создаёт GCP CryptoKey

Примечание

Этот модуль является частью коллекции google.cloud (версия 1.4.1).

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

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

Чтобы использовать его в книге задач, укажите: google.cloud.gcp_kms_crypto_key.

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

Описание

`CryptoKey` представляет собой логический ключ, который можно использовать для криптографических операций.

Требования

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

python >= 2.6
requests >= 2.18.4
google-auth >= 1.3.0

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_token строка	Токен доступа OAuth2, если тип учетных данных — accesstoken.
auth_kind строка / обязательно	Тип учетных данных, используемых. Варианты: `"application"` `"machineaccount"` `"serviceaccount"` `"accesstoken"`
env_type строка	Указывает, в какой среде Ansible вы выполняете этот модуль. Это не следует устанавливать, если вы не знаете, что делаете. Это изменяет только строку User Agent для всех запросов к API.
key_ring строка / обязательно	Кольцо ключей, к которому принадлежит этот ключ. Формат: `’projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}’`.
labels словарь	Метки с пользовательскими метаданными, применяемые к этому ресурсу.
name строка / обязательно	Имя ресурса CryptoKey.
project строка	Проект Google Cloud Platform для использования.
purpose строка	Неизменяемое назначение CryptoKey. См. https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKeyPurpose для входных данных. Некоторые допустимые значения: «ENCRYPT_DECRYPT», «ASYMMETRIC_SIGN», «ASYMMETRIC_DECRYPT» По умолчанию: `"ENCRYPT_DECRYPT"`
rotation_period строка	Каждый раз, когда этот период проходит, генерируется новая версия CryptoKey и устанавливается в качестве основной. Первая ротация произойдёт после указанного периода. Период ротации имеет формат десятичного числа с до 9 знаков после запятой, за которым следует буква `s` (секунды). Он должен быть больше одного дня (например, 86400).
scopes список / элементы=строка	Массив используемых областей
service_account_contents jsonarg	Содержимое файла JSON учетной записи службы, либо в словаре, либо в виде JSON-строки, представляющей его.
service_account_email строка	Дополнительный адрес электронной почты учетной записи службы, если выбран machineaccount, и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь	Путь к файлу JSON учетной записи службы, если тип выбран serviceaccount.
skip_initial_version_creation логическое	Если установлено в true, запрос создаст CryptoKey без каких-либо CryptoKeyVersions. Для импорта CryptoKeyVersion необходимо использовать ресурс `google_kms_key_ring_import_job`. Варианты: `false` `true`
state строка	Указывает, должен ли данный объект существовать в GCP Варианты: `"present"` ← (по умолчанию) `"absent"`
version_template словарь	Шаблон, описывающий параметры для новых версий криптографического ключа.
algorithm строка / обязательно	Алгоритм, используемый при создании версии на основе этого шаблона. См. [справочник по алгоритму](https://cloud.google.com/kms/docs/reference/rest/v1/CryptoKeyVersionAlgorithm) для возможных значений.
protection_level строка	Уровень защиты при создании версии на основе шаблона. Некоторые допустимые значения: «SOFTWARE», «HSM»

Примечания

Примечание

Ссылка на API: https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys
Создание ключа: https://cloud.google.com/kms/docs/creating-keys#create_a_key
Для аутентификации можно установить service_account_file с помощью переменной среды GCP_SERVICE_ACCOUNT_FILE.
Для аутентификации можно установить service_account_contents с помощью переменной среды GCP_SERVICE_ACCOUNT_CONTENTS.
Для аутентификации можно установить service_account_email с помощью переменной среды GCP_SERVICE_ACCOUNT_EMAIL.
Для аутентификации можно установить access_token с помощью переменной среды GCP_ACCESS_TOKEN.
Для аутентификации можно установить auth_kind с помощью переменной среды GCP_AUTH_KIND.
Для аутентификации можно установить scopes с помощью переменной среды GCP_SCOPES.
Значения переменных среды будут использованы только в том случае, если значения в playbook не заданы.
Параметры service_account_email и service_account_file взаимоисключающие.

Примеры

- name: create a key ring
  google.cloud.gcp_kms_key_ring:
    name: key-key-ring
    location: us-central1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
    state: present
  register: keyring

- name: create a crypto key
  google.cloud.gcp_kms_crypto_key:
    name: test_object
    key_ring: projects/{{ gcp_project }}/locations/us-central1/keyRings/key-key-ring
    project: test_project
    auth_kind: serviceaccount
    service_account_file: "/tmp/auth.pem"
    state: present

Значения возвращаемых данных

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

Ключ	Описание
createTime строка	Время создания этого ресурса на сервере. Формат — RFC3339. Возвращаемое значение: успех
keyRing строка	Кольцо ключей (KeyRing), к которому принадлежит этот ключ. Формат: `’projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}’`. Возвращаемое значение: успех
labels словарь	Метки с пользовательскими метаданными для применения к этому ресурсу. Возвращаемое значение: успех
name строка	Имя ресурса CryptoKey. Возвращаемое значение: успех
nextRotationTime строка	Время, когда KMS создаст новую версию этого Crypto Key. Возвращаемое значение: успех
purpose строка	Неизменяемое назначение CryptoKey. См. https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKeyPurpose для входных данных. Возвращаемое значение: успех
rotationPeriod строка	Каждый раз, когда проходит этот период, генерируется новая версия CryptoKey и устанавливается как основная. Первый цикл обновления произойдёт после указанного периода. Период обновления имеет формат десятичного числа с до 9 десятичными знаками, за которым следует буква `s` (секунды). Он должен быть больше одного дня (например, 86400). Возвращаемое значение: успех
skipInitialVersionCreation логическое	Если установлено в значение «true», запрос создаст CryptoKey без каких-либо CryptoKeyVersions. Вы должны использовать ресурс `google_kms_key_ring_import_job` для импорта CryptoKeyVersion. Возвращаемое значение: успех
versionTemplate сложное	Шаблон, описывающий параметры новых версий криптографических ключей. Возвращаемое значение: успех
algorithm строка	Алгоритм, который нужно использовать при создании версии на основе этого шаблона. См. [справочник по алгоритму](https://cloud.google.com/kms/docs/reference/rest/v1/CryptoKeyVersionAlgorithm) для возможных входных данных. Возвращаемое значение: успех
protectionLevel строка	Уровень защиты, который нужно использовать при создании версии на основе этого шаблона. Возвращаемое значение: успех

Авторы

Google Inc. (@googlecloudplatform)

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

© 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/google/cloud/gcp_kms_crypto_key_module.html