community.aws.redshift модуль – создание, удаление или изменение экземпляра Amazon Redshift
Примечание
Этот модуль входит в коллекцию community.aws (версия 8.0.0).
У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля требуются дополнительные компоненты. Подробную информацию см. в разделе Требования.
Для использования в плейбуке укажите: community.aws.redshift.
Добавлен в community.aws 1.0.0
Обзор
- Создает, удаляет или изменяет экземпляры кластеров Amazon Redshift.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 3.6
- boto3 >= 1.26.0
- botocore >= 1.29.0
Параметры
Параметр | Комментарии |
|---|---|
access_key aliases: aws_access_key_id, aws_access_key, ec2_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 и profile являются взаимоисключающими. Псевдоним aws_access_key_id был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним ec2_access_key устарел и будет удален в релизе после 2024-12-01. Поддержка переменной среды |
allow_version_upgrade aliases: version_upgrade boolean | Когда allow_version_upgrade=true кластер может быть автоматически обновлен во время окна технического обслуживания. Варианты:
|
automated_snapshot_retention_period aliases: retention_period integer | Количество дней, в течение которых хранятся автоматические снимки. |
availability_zone aliases: zone, aws_zone string | Зона доступности, в которой будет запущен кластер. |
aws_ca_bundle path | Расположение пакета CA, используемого при проверке SSL-сертификатов. Переменная среды |
aws_config dictionary | Словарь для изменения конфигурации botocore. Параметры можно найти в документации AWS https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
cluster_parameter_group_name aliases: param_group_name string | Имя группы параметров кластера. |
cluster_security_groups aliases: security_groups list / elements=string | В какой группе безопасности находится кластер. |
cluster_subnet_group_name aliases: subnet string | В какой подсети разместить кластер. |
cluster_type string | Тип кластера. Варианты:
|
cluster_version aliases: version string | Какая версия должна быть у кластера. Варианты:
|
command string / required | Указывает действие, которое нужно выполнить. Варианты:
|
db_name string | Имя базы данных. |
debug_botocore_endpoint_logs boolean | Использовать Переменная среды Варианты:
|
elastic_ip string | Эластичный IP-адрес для использования кластером. |
encrypted boolean | Зашифрован ли кластер или нет. Варианты:
|
endpoint_url aliases: ec2_url, aws_endpoint_url, s3_url строка | URL для подключения вместо стандартных конечных точек AWS. Хотя это можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws протестированы только с AWS. Также можно использовать переменные среды Псевдонимы ec2_url и s3_url устарели и будут удалены в версии после 2024-12-01. Поддержка переменной среды |
enhanced_vpc_routing логическое | Указывает, включена ли расширенная маршрутизация VPC для кластера. Варианты:
|
final_cluster_snapshot_identifier aliases: final_snapshot_id строка | Идентификатор финальной копии, которая будет создана перед удалением кластера. Если этот параметр указан, параметр skip_final_cluster_snapshot должен быть Используется только при command=delete. |
identifier строка / обязательный | Идентификатор кластера Amazon Redshift. |
new_cluster_identifier aliases: new_identifier строка | Используется только при command=modify. |
node_type строка | Тип узла кластера. Требуется при command=create. Варианты:
|
number_of_nodes целое число | Количество узлов. Используется только при cluster_type=multi-node. |
password строка | Пароль для главной базы данных. Используется только при command=create. |
port целое число | Порт, на котором прослушивает кластер. |
preferred_maintenance_window aliases: maintance_window, maint_window строка | Окно технического обслуживания в формате Время указано в UTC. Если не указано, назначается случайное окно технического обслуживания продолжительностью 30 минут. |
profile aliases: aws_profile строка | Используемый профиль AWS для аутентификации. См. документацию AWS для получения дополнительной информации о профилях: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную среды Параметр profile взаимоисключающий с параметрами aws_access_key, aws_secret_key и security_token. |
publicly_accessible логическое | Указывает, доступен ли кластер публично. Варианты:
|
purge_tags логическое | Если purge_tags=true и установлен параметр tags, существующие теги будут удалены, чтобы точно соответствовать параметру tags. Если параметр tags не указан, теги не будут изменены, даже если purge_tags=True. Ключи тегов, начинающиеся с Варианты:
|
region aliases: aws_region, ec2_region строка | Используемый регион AWS. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр 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, 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. Также могут использоваться переменные окружения Параметры secret_key и profile взаимоисключающие. Псевдоним aws_secret_access_key был добавлен в релизе 5.1.0 для согласованности с AWS botocore SDK. Псевдоним 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. Также могут использоваться переменные окружения Параметры 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. Поддержка переменных окружения |
skip_final_cluster_snapshot aliases: skip_final_snapshot boolean | Пропустить окончательный снимок перед удалением кластера. Используется только при command=delete. Варианты:
|
tags aliases: resource_tags dictionary | Словарь, представляющий теги, которые нужно применить к ресурсу. Если параметр tags не задан, теги не будут изменены. |
username string | Имя пользователя основной базы данных. Используется только при command=create. |
validate_certs boolean | При значении Установка validate_certs=false настоятельно не рекомендуется. В качестве альтернативы, рассмотрите установку aws_ca_bundle вместо этого. Варианты:
|
vpc_security_group_ids aliases: vpc_security_groups list / elements=string | Группа безопасности VPC |
wait boolean | При command=create, command=modify или command=restore ожидать, пока база данных не перейдет в состояние «доступно». При command=delete ожидать завершения работы базы данных. Варианты:
|
wait_timeout integer | При wait=true определяет, сколько секунд ожидать, прежде чем прекратить ожидание. По умолчанию: |
Примечания
Примечание
- Поддержка tags и purge_tags была добавлена в релизе 1.3.0.
- Внимание: Для модулей переменные окружения и конфигурационные файлы читаются из контекста Ansible «хост» и не из контекста «контроллер». Поэтому может потребоваться явно скопировать файлы на «хост». Для плагинов поиска и соединения переменные окружения и конфигурационные файлы читаются из контекста Ansible «контроллер» и не из контекста «хост».
- AWS SDK (boto3), используемый Ansible, также может считывать значения по умолчанию для учетных данных и других параметров, таких как регион, из своих конфигурационных файлов в контексте Ansible «хост» (обычно
~/.aws/credentials). См. https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html для получения дополнительной информации.
Примеры
- name: Basic cluster provisioning example
community.aws.redshift:
command: create
node_type: ds1.xlarge
identifier: new_cluster
username: cluster_admin
password: 1nsecure
- name: Cluster delete example
community.aws.redshift:
command: delete
identifier: new_cluster
skip_final_cluster_snapshot: true
wait: true
Значения возврата
Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:
Ключ | Описание |
|---|---|
cluster сложное | словарь, содержащий всю информацию о кластере Возвращается: успех |
|
availability_zone строка |
Зона доступности Amazon, в которой расположен кластер. «None» до тех пор, пока кластер не будет доступен. Возвращается: успех Пример: |
|
create_time число с плавающей точкой |
Время создания кластера в виде метки времени. Возвращается: успех Пример: |
|
db_name строка |
Имя базы данных. Возвращается: успех Пример: |
|
enhanced_vpc_routing логическое значение |
статус функции расширенного маршрутизации VPC. Возвращается: успех |
|
identifier строка |
Идентификатор кластера. Возвращается: успех Пример: |
|
maintenance_window строка |
Период времени, когда выполняются задачи технического обслуживания/обновления. Возвращается: успех Пример: |
|
port целое число |
Порт кластера. «None» до тех пор, пока кластер не будет доступен. Возвращается: успех Пример: |
|
private_ip_address строка |
Приватный IP-адрес основного узла. Возвращается: успех Пример: |
|
public_ip_address строка |
Публичный IP-адрес основного узла. «None», когда включена enhanced_vpc_routing. Возвращается: успех Пример: |
|
status строка |
Статус кластера. Возвращается: успех Пример: |
|
tags словарь |
метки aws для кластера. Возвращается: успех |
|
url строка |
FQDN основного узла кластера. «None» до тех пор, пока кластер не будет доступен. Возвращается: успех Пример: |
Ссылки на сборки
© 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/community/aws/redshift_module.html