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

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

allow_version_upgrade

aliases: version_upgrade

boolean

Если allow_version_upgrade=true, кластер может быть автоматически обновлен во время окна обслуживания.

Варианты:

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

automated_snapshot_retention_period

aliases: retention_period

integer

Количество дней хранения автоматических снимков.

availability_zone

aliases: zone, aws_zone

string

Зона доступности, в которой следует запустить кластер.

aws_ca_bundle

path

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

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

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

Тип кластера.

Варианты:

• "multi-node"
• "single-node" ← (по умолчанию)

cluster_version

aliases: version

string

Версия, которую должен использовать кластер.

Варианты:

• "1.0"

command

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

Задает выполняемое действие.

Варианты:

• "create"
• "facts"
• "delete"
• "modify"

db_name

string

Имя базы данных.

debug_botocore_endpoint_logs

boolean

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

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

Варианты:

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

elastic_ip

string

Elastic IP, используемый кластером.

encrypted

boolean

Определяет, будет ли кластер зашифрован.

Варианты:

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

endpoint_url

aliases: aws_endpoint_url

string

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

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

enhanced_vpc_routing

boolean

Определяет, следует ли включить для кластера расширенную маршрутизацию VPC.

Варианты:

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

final_cluster_snapshot_identifier

aliases: final_snapshot_id

string

Идентификатор итогового снимка, который будет создан перед удалением кластера.

Если этот параметр задан, для skip_final_cluster_snapshot необходимо указать false.

Используется только при command=delete.

identifier

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

Идентификатор кластера Redshift.

new_cluster_identifier

aliases: new_identifier

string

Используется только при command=modify.

node_type

string

Тип узла кластера.

Обязателен при command=create.

Варианты:

• "ds1.xlarge"
• "ds1.8xlarge"
• "ds2.xlarge"
• "ds2.8xlarge"
• "dc1.large"
• "dc2.large"
• "dc1.8xlarge"
• "dw1.xlarge"
• "dw1.8xlarge"
• "dw2.large"
• "dw2.8xlarge"

number_of_nodes

integer

Количество узлов.

Используется только при cluster_type=multi-node.

password

string

Пароль главной базы данных.

Используется только при command=create.

port

integer

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

preferred_maintenance_window

aliases: maintance_window, maint_window

string

Окно обслуживания в формате ddd:hh24:mi-ddd:hh24:mi. (Пример: Mon:22:00-Mon:23:15)

Время указывается в UTC.

Если окно не указано, будет назначено случайное 30-минутное окно обслуживания.

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.

publicly_accessible

boolean

Определяет, будет ли кластер общедоступным.

Варианты:

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

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

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 являются взаимоисключающими.

skip_final_cluster_snapshot

aliases: skip_final_snapshot

boolean

Пропустить создание итогового снимка перед удалением кластера.

Используется только при command=delete.

Варианты:

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

tags

aliases: resource_tags

dictionary

Словарь с тегами, которые следует назначить ресурсу.

Если параметр tags не задан, теги не будут изменены.

username

string

Имя пользователя главной базы данных.

Используется только при command=create.

validate_certs

boolean

Если задано значение false, SSL-сертификаты при взаимодействии с API AWS проверяться не будут.

Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle.

Варианты:

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

vpc_security_group_ids

aliases: vpc_security_groups

list / elements=string

Группа безопасности VPC

wait

boolean

При command=create, command=modify или command=restore ожидать перехода базы данных в состояние «available».

При command=delete ожидать завершения удаления базы данных.

Варианты:

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

wait_timeout

integer

При wait=true задает время ожидания в секундах, по истечении которого выполнение прекращается.

По умолчанию: 300

cluster

complex

словарь, содержащий всю информацию о кластере

Возвращается: при успехе

availability_zone

string

Зона доступности Amazon, в которой расположен кластер. Значение «None» до тех пор, пока кластер не станет доступен.

Возвращается: при успехе

Пример: "us-east-1b"

create_time

float

Время создания кластера в виде временной метки.

Возвращается: при успехе

Пример: 1430158536.308

db_name

string

Имя базы данных.

Возвращается: при успехе

Пример: "new_db_name"

enhanced_vpc_routing

boolean

Состояние функции расширенной маршрутизации VPC.

Возвращается: при успехе

identifier

string

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

Возвращается: при успехе

Пример: "new_redshift_cluster"

maintenance_window

string

Период времени, в течение которого выполняется обслуживание и обновление.

Возвращается: при успехе

Пример: "sun:09:30-sun:10:00"

port

integer

Порт кластера. Значение «None» до тех пор, пока кластер не станет доступен.

Возвращается: при успехе

Пример: 5439

private_ip_address

string

Частный IP-адрес главного узла.

Возвращается: при успехе

Пример: "10.10.10.10"

public_ip_address

string

Публичный IP-адрес главного узла. Значение «None», если включена функция enhanced_vpc_routing.

Возвращается: при успехе

Пример: "0.0.0.0"

status

string

Состояние кластера.

Возвращается: при успехе

Пример: "available"

tags

dictionary

Теги AWS для кластера.

Возвращается: при успехе

url

string

Полное доменное имя главного узла кластера. Значение «None» до тех пор, пока кластер не станет доступен.

Возвращается: при успехе

Пример: "new-redshift_cluster.jfkdjfdkj.us-east-1.redshift.amazonaws.com"