Spec-Zone.ru › Ansible

Модуль amazon.aws.rds_cluster_snapshot – управление снимками кластеров БД Amazon RDS

Примечание

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

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

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

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

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

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

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

  • Создание, изменение и удаление снимков кластеров БД RDS.
  • Этот модуль впервые добавлен в community.aws в выпуске 4.0.0.

Требования

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

  • python >= 3.6
  • boto3 >= 1.35.0
  • botocore >= 1.35.0

Параметры

Параметр

Комментарии

access_key

aliases: aws_access_key_id, aws_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 в порядке убывания приоритета.

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

Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для согласованности с AWS SDK botocore.

aws_ca_bundle

path

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

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

aws_config

dictionary

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

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

copy_tags

boolean

Копировать ли все теги из source_db_cluster_snapshot_identifier в db_cluster_snapshot_identifier.

Варианты:

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

db_cluster_identifier

aliases: cluster_id, cluster_name

string

Идентификатор кластера БД, для которого нужно создать снимок.

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

db_cluster_snapshot_identifier

aliases: snapshot_id, id, snapshot_name

string / обязательный

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

debug_botocore_endpoint_logs

boolean

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

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

Варианты:

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

endpoint_url

aliases: aws_endpoint_url

string

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

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

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 и session_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

string

Регион AWS для использования.

Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется.

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

Дополнительную информацию см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

secret_key

aliases: aws_secret_access_key, aws_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 в порядке убывания приоритета.

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

Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для согласованности с AWS SDK botocore.

session_token

aliases: aws_session_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.

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

source_db_cluster_snapshot_identifier

aliases: source_id, source_snapshot_id

string

Идентификатор снимка кластера БД, который нужно скопировать.

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

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

source_region

string

Регион, в котором находится копируемый снимок.

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

Примечания

Примечание

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

Примеры

- name: Create a DB cluster snapshot
  amazon.aws.rds_cluster_snapshot:
    db_cluster_identifier: "{{ cluster_id }}"
    db_cluster_snapshot_identifier: new-cluster-snapshot

- name: Delete a DB cluster snapshot
  amazon.aws.rds_cluster_snapshot:
    db_cluster_snapshot_identifier: new-cluster-snapshot
    state: absent

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

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

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

Ключ

Описание

allocated_storage

integer

Размер выделенного хранилища снимка кластера БД в гибибайтах (ГиБ).

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

Пример: 0

availability_zone

string

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

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

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

cluster_create_time

string

Время создания кластера БД по всемирному координированному времени (UTC).

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

Пример: "2024-07-01T05:27:53.478000+00:00"

db_cluster_identifier

string

Указывает идентификатор кластера БД, из которого был создан этот снимок кластера БД.

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

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

db_cluster_snapshot_arn

string

Имя ресурса Amazon для снимка.

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

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

db_cluster_snapshot_identifier

string

Указывает идентификатор снимка кластера БД.

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

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

engine

string

Указывает название ядра базы данных для этого снимка кластера БД.

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

Пример: "aurora"

engine_mode

string

Указывает режим ядра базы данных для этого снимка кластера БД.

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

Пример: "5.6.mysql_aurora.1.22.5"

engine_version

string

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

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

Пример: "5.6.mysql_aurora.1.22.5"

iam_database_authentication_enabled

boolean

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

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

Пример: false

kms_key_id

string

Идентификатор ключа Amazon Web Services KMS — это ARN ключа, идентификатор ключа, ARN псевдонима или имя псевдонима для ключа KMS.

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

license_model

string

Сведения о модели лицензирования для этого снимка кластера БД.

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

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

master_username

string

Имя пользователя master для этого снимка кластера БД.

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

Пример: "test"

percent_progress

integer

Указывает процент от предполагаемого объёма данных, который был передан.

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

Пример: 100

port

integer

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

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

Пример: 3306

snapshot_create_time

string

Время создания снимка по всемирному координированному времени (UTC).

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

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

snapshot_type

string

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

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

Пример: "manual"

source_db_cluster_snapshot_arn

string

Если снимок кластера БД был скопирован из исходного снимка кластера БД, содержит ARN исходного снимка кластера БД; в противном случае — null.

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

status

string

Указывает состояние этого снимка кластера БД.

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

Пример: "available"

storage_encrypted

boolean

Указывает, зашифрован ли снимок кластера БД.

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

Пример: false

tag_list

list / elements=string

Список тегов.

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

Пример: [{"key": "tag_one", "value": "ansible-test-123456789012-rds-cluster-snapshot-b One"}]

tags

dictionary

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

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

Пример: {"Tag Two": "two ansible-test-123456789012-rds-cluster-snapshot-b"}

vpc_id

string

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

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

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

Авторы

  • 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/rds_cluster_snapshot_module.html

Spec-Zone.ru

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