community.aws.redshift – создание, удаление или изменение экземпляра Amazon Redshift

Примечание

Этот плагин входит в коллекцию community.aws (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install community.aws.

Для использования в плейбуке укажите: community.aws.redshift.

Новая версия 1.0.0: коллекции community.aws

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

Описание

Создаёт, удаляет или изменяет экземпляры кластера Amazon Redshift.

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
allow_version_upgrade boolean	Варианты: нет да ←	Когда allow_version_upgrade=true, кластер может быть автоматически обновлён во время окна обслуживания. псевдонимы: version_upgrade
automated_snapshot_retention_period integer		Количество дней, в течение которых сохраняются автоматические снимки. псевдонимы: retention_period
availability_zone string		Зона доступности для запуска кластера. псевдонимы: zone, aws_zone
aws_access_key string		Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_access_key и profile устарело и будет сделано взаимоисключающим после 2022-06-01. псевдонимы: ec2_access_key, access_key
aws_ca_bundle путь		Расположение файла сертификата CA для проверки SSL-сертификатов. Используется только для модулей на основе boto3. Примечание: Файл CA Bundle читается со стороны модуля и, возможно, потребует явного копирования с контроллера, если он не запускается локально.
aws_config словарь		Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для получения дополнительной информации о конфигурации boto.
aws_secret_key string		Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров aws_secret_key и profile устарело и будет сделано взаимоисключающим после 2022-06-01. псевдонимы: ec2_secret_key, secret_key
cluster_parameter_group_name string		Имя группы параметров кластера. псевдонимы: param_group_name
cluster_security_groups список / элементы=строка		Группа безопасности, к которой принадлежит кластер. псевдонимы: security_groups
cluster_subnet_group_name string		Подсеть для размещения кластера. псевдонимы: subnet
cluster_type string	Варианты: многоузловой одноузловой ←	Тип кластера.
cluster_version string	Варианты: 1.0	Версия кластера. псевдонимы: version
command строка / обязательно	Варианты: создать факты удалить изменить	Указывает действие, которое нужно выполнить.
db_name string		Имя базы данных.
debug_botocore_endpoint_logs boolean	Варианты: нет ← да	Использование логирования botocore.endpoint для парсинга уникальных (а не общих) API-вызовов «ресурс:действие» во время задачи, выводящего набор в ключ resource_actions в результатах задачи. Используйте обратный вызов aws_resource_action для вывода общего списка, созданного во время выполнения плейбука. Также может быть использована переменная окружения ANSIBLE_DEBUG_BOTOCORE_LOGS.
ec2_url строка		URL для подключения к EC2 или вашему облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех остальных модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая есть. псевдонимы: aws_endpoint_url, endpoint_url
elastic_ip строка		Упругий IP-адрес для использования в кластере.
encrypted boolean	Варианты: нет ← да	Шифруется ли кластер.
enhanced_vpc_routing boolean	Варианты: нет ← да	Включить ли расширенное маршрутизирование VPC для кластера.
final_cluster_snapshot_identifier строка		Идентификатор финального снимка, который должен быть создан перед удалением кластера. Если этот параметр указан, параметр skip_final_cluster_snapshot должен быть `false`. Используется только при command=delete. псевдонимы: final_snapshot_id
identifier строка / обязательно		Идентификатор кластера Redshift.
new_cluster_identifier строка		Используется только при command=modify. псевдонимы: new_identifier
node_type строка	Варианты: ds1.xlarge ds1.8xlarge ds2.xlarge ds2.8xlarge dc1.large dc2.large dc1.8xlarge dw1.xlarge dw1.8xlarge dw2.large dw2.8xlarge	Тип узла кластера. Требуется при command=create.
number_of_nodes целое число		Количество узлов. Используется только при cluster_type=multi-node.
password строка		Пароль мастера базы данных. Используется только при command=create.
port целое число		Порт, на котором слушает кластер.
preferred_maintenance_window строка		Окно обслуживания в формате `ddd:hh24:mi-ddd:hh24:mi`. (Пример: `Mon:22:00-Mon:23:15`) Время указано в UTC. Если не указано, назначается случайное окно обслуживания длительностью 30 минут. псевдонимы: maintance_window, maint_window
profile строка		Использует профиль boto. Работает только с boto >= 2.24.0. Использование profile переопределяет aws_access_key, aws_secret_key и security_token, и поддержка их одновременного использования с profile устарела. aws_access_key, aws_secret_key и security_token будут сделаны взаимоисключающими с profile после 2022-06-01. псевдонимы: aws_profile
publicly_accessible boolean	Варианты: нет ← да	Кластер доступен публично или нет.
purge_tags boolean добавлен в 1.3.0 community.aws	Варианты: нет да ←	Очистить существующие теги, которых нет в кластере
region строка		Регион AWS. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковая есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region псевдонимы: aws_region, ec2_region
security_token строка		Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если задан параметр profile, этот параметр игнорируется. Одновременное использование параметров security_token и profile устарело и будет сделано взаимоисключающим после 2022-06-01. псевдонимы: aws_security_token, access_token
skip_final_cluster_snapshot boolean	Варианты: нет ← да	Пропустить финальный снимок перед удалением кластера. Используется только при command=delete. псевдонимы: skip_final_snapshot
tags словарь добавлен в 1.3.0 community.aws		Словарь тегов ресурса. псевдонимы: resource_tags
username строка		Имя пользователя мастера базы данных. Используется только при command=create.
validate_certs boolean	Варианты: нет да ←	При значении «нет», SSL-сертификаты не будут проверяться для версий boto >= 2.6.0.
vpc_security_group_ids список / элементы=строка		Группа безопасности VPC псевдонимы: vpc_security_groups

END_OF_DOCUMENT_MARKER

wait boolean	Варианты: нет ← да	Когда command=create, command=modify или command=restore, ожидать, пока база данных перейдёт в состояние 'доступна'. Когда command=delete, ожидать завершения работы базы данных.
wait_timeout integer	По умолчанию: 300	Когда wait=true, определяет время в секундах, после которого произойдёт отказ.

Примечания

Примечание

Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета AWS_URL или EC2_URL, AWS_PROFILE или AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID или AWS_ACCESS_KEY или EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY или AWS_SECRET_KEY или EC2_SECRET_KEY, AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN, AWS_REGION или EC2_REGION, AWS_CA_BUNDLE
Ansible использует файл конфигурации boto (обычно ~/.boto), если учетные данные не предоставлены. См. https://boto.readthedocs.io/en/latest/boto_config_tut.html
AWS_REGION или EC2_REGION можно использовать для указания региона AWS, когда это необходимо, но это также можно настроить в файле конфигурации boto

Примеры

- 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» до тех пор, пока кластер не будет доступен. Пример: us-east-1b
	create_time вещественное число	успех	Время создания кластера в виде метки времени. Пример: 1430158536.308
	db_name строка	успех	Имя базы данных. Пример: new_db_name
	enhanced_vpc_routing boolean	успех	Статус функции расширенного маршрутизации VPC.
	identifier строка	успех	Идентификатор кластера. Пример: new_redshift_cluster
	maintenance_window строка	успех	Временной интервал, когда выполняется обслуживание/обновление. Пример: sun:09:30-sun:10:00
	port целое число	успех	Порт кластера. «None» до тех пор, пока кластер не будет доступен. Пример: 5439
	private_ip_address строка	успех	Приватный IP-адрес основного узла. Пример: 10.10.10.10
	public_ip_address строка	успех	Публичный IP-адрес основного узла. «None», когда enabled_vpc_routing включен. Пример: 0.0.0.0
	status строка	успех	Статус кластера. Пример: доступно
	tags словарь	успех	метки aws для кластера.
	url строка	успех	FQDN основного узла кластера. «None» до тех пор, пока кластер не будет доступен. Пример: new-redshift_cluster.jfkdjfdkj.us-east-1.redshift.amazonaws.com

Авторы

Jens Carl (@j-carl), Hothead Games Inc.
Rafael Driutti (@rafaeldriutti)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/aws/redshift_module.html