amazon.aws.rds_cluster_snapshot модуль – Управление снимками Amazon RDS баз данных кластеров

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 AWS botocore.

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

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

Копировать все метки из source_db_cluster_snapshot_identifier в db_cluster_snapshot_identifier.

Варианты:

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

db_cluster_identifier

псевдонимы: cluster_id, cluster_name

строка

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

Требуется при state=present.

db_cluster_snapshot_identifier

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

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

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

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_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

allocated_storage

integer

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

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

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

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

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

Пример: "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 ключа, ID ключа, ARN псевдонима или имя псевдонима для ключа KMS.

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

license_model

string

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

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

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

master_username

string

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

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

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

ID VPC, в котором находится БД.

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

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