Spec-Zone.ru › Ansible

amazon.aws.rds_instance_snapshot модуль — Управление моментальными снимками экземпляров Amazon RDS

Примечание

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

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

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

Для использования в playbook укажите: amazon.aws.rds_instance_snapshot.

Впервые появился в amazon.aws 5.0.0

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

Обзор

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

Требования

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

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

Параметры

Параметр

Комментарии

access_key

псевдонимы: aws_access_key_id, aws_access_key, ec2_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 или EC2_ACCESS_KEY в порядке убывания приоритета.

Параметры aws_access_key и profile взаимоисключающие.

Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для соответствия SDK botocore AWS.

Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01.

Поддержка переменной среды EC2_ACCESS_KEY устарела и будет удалена в релизе после 2024-12-01.

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.

copy_tags

булево

добавлен в community.aws 3.3.0

Нужно ли копировать все метки из source_db_snapshot_identifier в db_instance_identifier.

Варианты:

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

db_instance_identifier

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

строка

Идентификатор экземпляра базы данных. Требуется при создании снимка.

db_snapshot_identifier

псевдонимы: id, snapshot_id

строка / требуется

Снимок для управления.

debug_botocore_endpoint_logs

булево

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

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

Варианты:

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

endpoint_url

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

строка

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

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

Псевдонимы ec2_url и s3_url устарели и будут удалены в релизе после 2024-12-01.

Поддержка переменной среды EC2_URL устарела и будет удалена в релизе после 2024-12-01.

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 и security_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, ec2_region

строка

Используемый регион 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 для соответствия с SDK AWS botocore.

Псевдоним 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

string

Токен сеанса 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, 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.

source_db_snapshot_identifier

aliases: source_id, source_snapshot_id

string

added in community.aws 3.3.0

Идентификатор исходного снимка БД.

Требуется при копировании снимка.

Если исходный снимок находится в той же области AWS, что и копия, укажите идентификатор снимка.

Если исходный снимок находится в другой области AWS, чем копия, укажите ARN снимка.

source_region

string

added in community.aws 3.3.0

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

state

string

Укажите желаемое состояние снимка.

Выберите:

  • "present" ← (по умолчанию)
  • "absent"

tags

aliases: resource_tags

dictionary

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

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

validate_certs

boolean

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

Настройка validate_certs=false крайне не рекомендуется. В качестве альтернативы, рассмотрите возможность настройки aws_ca_bundle.

Выберите:

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

wait

boolean

Дожидаться создания или удаления снимка.

Выберите:

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

wait_timeout

integer

Время ожидания до отказа, в секундах.

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

Примечания

Примечание

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

Примеры

- name: Create snapshot
  amazon.aws.rds_instance_snapshot:
    db_instance_identifier: new-database
    db_snapshot_identifier: new-database-snapshot
  register: snapshot

- name: Copy snapshot from a different region and copy its tags
  amazon.aws.rds_instance_snapshot:
    id: new-database-snapshot-copy
    region: us-east-1
    source_id: "{{ snapshot.db_snapshot_arn }}"
    source_region: us-east-2
    copy_tags: true

- name: Delete snapshot
  amazon.aws.rds_instance_snapshot:
    db_snapshot_identifier: new-database-snapshot
    state: absent

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

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

Ключ

Описание

allocated_storage

integer

Сколько памяти выделено в ГБ.

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

Пример: 20

availability_zone

string

Зона доступности базы данных, из которой был создан снимок.

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

Пример: "us-west-2a"

db_instance_identifier

string

База данных, из которой был создан снимок.

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

Пример: "ansible-test-16638696"

db_snapshot_arn

string

Универсальное имя ресурса Amazon для снимка.

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

Пример: "arn:aws:rds:us-west-2:123456789012:snapshot:ansible-test-16638696-test-snapshot"

db_snapshot_identifier

string

Имя снимка.

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

Пример: "ansible-test-16638696-test-snapshot"

dbi_resource_id

string

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

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

Пример: "db-MM4P2U35RQRAMWD3QDOXWPZP4U"

encrypted

boolean

Зашифрован ли снимок.

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

Пример: false

engine

string

Ядро базы данных, из которой был создан снимок.

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

Пример: "mariadb"

engine_version

string

Версия базы данных, из которой был создан снимок.

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

Пример: "10.2.21"

iam_database_authentication_enabled

boolean

Включена ли аутентификация базы данных IAM.

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

Пример: false

instance_create_time

string

Время создания экземпляра, из которого был создан снимок.

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

Пример: "2019-06-15T10:15:56.221000+00:00"

license_model

string

Модель лицензирования базы данных.

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

Пример: "general-public-license"

master_username

string

Главное имя пользователя базы данных.

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

Пример: "test"

option_group_name

string

Группа параметров базы данных.

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

Пример: "default:mariadb-10-2"

percent_progress

integer

Сколько процентов прогресса было достигнуто при создании снимка. Будет 100 для доступного снимка.

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

Пример: 100

port

integer

Порт, на котором прослушивает база данных.

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

Пример: 3306

processor_features

list / elements=string

Список функций процессора базы данных.

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

Пример: []

snapshot_create_time

string

Время создания снимка.

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

Пример: "2019-06-15T10:46:23.776000+00:00"

snapshot_type

string

Как был создан снимок (для этого модуля всегда вручную!).

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

Пример: "manual"

source_db_snapshot_identifier

string

добавлен в community.aws 3.3.0

Идентификатор снимка БД (ARN), с которого был скопирован снимок.

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

Пример: "arn:aws:rds:us-west-2:123456789012:snapshot:ansible-test-16638696-test-snapshot-source"

status

string

Статус снимка.

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

Пример: "available"

storage_type

string

Тип хранилища базы данных.

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

Пример: "gp2"

tags

complex

Теги, примененные к снимку.

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

vpc_id

string

Идентификатор VPC, в котором находится база данных.

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

Пример: "vpc-09ff232e222710ae0"

Авторы

  • Will Thames (@willthames)
  • Michael De La Rue (@mikedlr)
  • Alina Buzachis (@alinabuzachis)
  • Joseph Torcasso (@jatorcasso)

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

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

© 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/rds_instance_snapshot_module.html

Spec-Zone.ru

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