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

Примечание

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

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

Для использования в playbook укажите: 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 целое число		Количество дней, в течение которых сохраняются автоматические снимки. псевдонимы: retention_period
availability_zone строка		Зона доступности, в которой нужно запустить кластер. псевдонимы: zone, aws_zone
aws_access_key строка		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 считывается со стороны «модуля» и, возможно, должен быть явно скопирован с контроллера, если он не выполняется локально.
aws_config словарь		Словарь для изменения конфигурации botocore. Параметры можно найти по адресу https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Для модулей boto используется только ключ 'user_agent'. Дополнительную информацию о конфигурации boto см. по адресу http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto.
aws_secret_key строка		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 строка		Имя группы параметров кластера. псевдонимы: param_group_name
cluster_security_groups список / элементы=строка		Группа безопасности, к которой принадлежит кластер. псевдонимы: security_groups
cluster_subnet_group_name строка		Подсеть для размещения кластера. псевдонимы: subnet
cluster_type строка	Варианты: многоузловой одноузловой ←	Тип кластера.
cluster_version строка	Варианты: 1.0	Версия кластера. псевдонимы: version
command строка / обязательно	Варианты: создать факты удалить изменить	Указывает действие, которое нужно выполнить.
db_name строка		Имя базы данных.
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 строка		Пароль для базы данных master. Используется только при 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 security token. Если не задан, используется значение переменной окружения 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 строка		Имя пользователя базы данных master. Используется только при command=create.
validate_certs boolean	Варианты: нет да ←	Если установлено «нет», SSL-сертификаты для версий boto >= 2.6.0 не будут проверены.
vpc_security_group_ids список / элементы=строка		Группа безопасности VPC псевдонимы: vpc_security_groups

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 complex		успех	словарь, содержащий всю информацию о кластере
	availability_zone строка	успех	Зона доступности Amazon, где расположен кластер. "None" до тех пор, пока кластер не будет доступен. Пример: us-east-1b
	create_time float	успех	Время создания кластера в формате временной метки. Пример: 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", когда включена функция enhanced_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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/aws/redshift_module.html