Spec-Zone.ru › Ansible

Модуль community.aws.lightsail — управление экземплярами в AWS Lightsail

Примечание

Этот модуль входит в коллекцию community.aws (версия 10.1.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.aws. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.aws.lightsail.

Добавлено в community.aws 1.0.0

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

Краткое описание

  • Управление экземплярами в AWS Lightsail.
  • Добавление тегов экземплярам пока не поддерживается этим модулем.

Требования

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

  • python >= 3.6
  • boto3 >= 1.34.0
  • botocore >= 1.34.0

Параметры

Параметр

Описание

access_key

псевдонимы: 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 SDK botocore.

aws_ca_bundle

path

Путь к пакету центров сертификации для проверки SSL-сертификатов.

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

aws_config

dictionary

Словарь для изменения конфигурации botocore.

Параметры приведены в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

blueprint_id

string

Идентификатор образа конфигурации экземпляра.

Обязателен при state=present

bundle_id

string

Пакет сведений о конфигурации экземпляра.

Обязателен при state=present.

debug_botocore_endpoint_logs

boolean

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

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

Варианты:

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

endpoint_url

псевдонимы: aws_endpoint_url

string

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

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

key_pair_name

string

Имя пары ключей, используемой с экземпляром.

Если state=present и имя key_pair_name не указано, будет использоваться пара ключей по умолчанию для региона.

name

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

Имя экземпляра.

profile

псевдонимы: 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.

public_ports

list / элементы=dictionary

добавлено в community.aws 6.0.0

Список словарей с описанием портов, которые нужно открыть для указанного экземпляра.

cidrs

list / элементы=string

Адрес IPv4 или диапазон адресов IPv4 (в нотации CIDR), которым разрешено подключаться к экземпляру через указанные порты и протокол.

Необходимо указать один из параметров: cidrs или ipv6_cidrs.

from_port

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

Первый порт в диапазоне открытых портов экземпляра.

ipv6_cidrs

list / элементы=string

Адрес IPv6 или диапазон адресов IPv6 (в нотации CIDR), которым разрешено подключаться к экземпляру через указанные порты и протокол.

Необходимо указать один из параметров: cidrs или ipv6_cidrs.

protocol

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

Название протокола IP, допустимого для заданного диапазона открытых портов.

Варианты:

  • "tcp"
  • "all"
  • "udp"
  • "icmp"

to_port

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

Последний порт в диапазоне открытых портов экземпляра.

region

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

псевдонимы: 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 SDK botocore.

session_token

псевдонимы: 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 взаимоисключающие.

state

string

Задайте требуемое состояние целевого объекта.

rebooted и restarted являются псевдонимами.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"
  • "running"
  • "restarted"
  • "rebooted"
  • "stopped"

user_data

string

Сценарий запуска, который может настроить экземпляр с помощью дополнительных данных.

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

validate_certs

boolean

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

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

Варианты:

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

wait

boolean

Перед возвратом дождаться, пока экземпляр перейдет в состояние «running».

Если wait=false, IP-адрес может не возвращаться.

Не влияет на поведение при state=rebooted или state=absent.

Варианты:

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

wait_timeout

integer

Время в секундах, по истечении которого ожидание wait прекращается.

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

zone

string

Зона доступности AWS, в которой будет запущен экземпляр.

Обязателен при state=present

Примечания

Примечание

  • Внимание: Для модулей переменные среды и файлы конфигурации считываются в контексте «узла» Ansible, а не в контексте «контроллера». Поэтому может потребоваться явно скопировать файлы на «узел». Для плагинов поиска и подключений переменные среды и файлы конфигурации считываются в контексте «контроллера» Ansible, а не в контексте «узла».
  • Используемый Ansible AWS SDK (boto3) также может считывать значения учетных данных и других параметров по умолчанию, например региона, из файлов конфигурации в контексте «узла» Ansible (обычно ~/.aws/credentials). Дополнительную информацию см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

- name: Create a new Lightsail instance
  community.aws.lightsail:
    state: present
    name: my_instance
    region: us-east-1
    zone: us-east-1a
    blueprint_id: ubuntu_16_04
    bundle_id: nano_1_0
    key_pair_name: id_rsa
    user_data: " echo 'hello world' > /home/ubuntu/test.txt"
    public_ports:
      - from_port: 22
        to_port: 22
        protocol: "tcp"
        cidrs: ["0.0.0.0/0"]
        ipv6_cidrs: ["::/0"]
  register: my_instance

- name: Delete an instance
  community.aws.lightsail:
    state: absent
    region: us-east-1
    name: my_instance

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ

Описание

changed

boolean

изменен или создан ли снимок

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

Пример: {"changed": true}

instance

dictionary

данные экземпляра

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

Пример: {"arn": "arn:aws:lightsail:us-east-1:123456789012:Instance/1fef0175-d6c8-480e-84fa-214f969cda87", "blueprint_id": "ubuntu_16_04", "blueprint_name": "Ubuntu", "bundle_id": "nano_1_0", "created_at": "2017-03-27T08:38:59.714000-04:00", "hardware": {"cpu_count": 1, "ram_size_in_gb": 0.5}, "is_static_ip": false, "location": {"availability_zone": "us-east-1a", "region_name": "us-east-1"}, "name": "my_instance", "networking": {"monthly_transfer": {"gb_per_month_allocated": 1024}, "ports": [{"access_direction": "inbound", "access_from": "Anywhere (0.0.0.0/0)", "access_type": "public", "common_name": "", "from_port": 80, "protocol": "tcp", "to_port": 80}, {"access_direction": "inbound", "access_from": "Anywhere (0.0.0.0/0)", "access_type": "public", "common_name": "", "from_port": 22, "protocol": "tcp", "to_port": 22}]}, "private_ip_address": "172.26.8.14", "public_ip_address": "34.207.152.202", "resource_type": "Instance", "ssh_key_name": "keypair", "state": {"code": 16, "name": "running"}, "support_code": "123456789012/i-0997c97831ee21e33", "username": "ubuntu"}

Авторы

  • Nick Ball (@nickball)
  • Prasad Katti (@prasadkatti)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Связь

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API