community.aws.ec2_vpc_endpoint – Создание и удаление конечных точек AWS VPC.

Примечание

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

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

Для использования в книге задач укажите: community.aws.ec2_vpc_endpoint.

Новая версия 1.0.0: из community.aws

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Создаёт конечные точки AWS VPC.
Удаляет конечные точки AWS VPC.
Этот модуль поддерживает режим проверки.

Требования

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

boto
boto3
python >= 2.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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'. См. http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto для получения дополнительной информации о конфигурации 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
client_token строка		Необязательный маркер клиента для обеспечения идемпотентности.
debug_botocore_endpoint_logs логический	Варианты: нет ← да	Используйте регистрируемый объект 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
policy json		Правильно отформатированная строка json-политики, см. https://github.com/ansible/ansible/issues/7005#issuecomment-42894813. Не может быть использовано вместе с policy_file. Параметр при создании конечной точки. Если не указано, AWS будет использовать политику по умолчанию, предоставляющую полный доступ к службе.
policy_file путь		Путь к файлу политики в формате правильно отформатированного json, см. https://github.com/ansible/ansible/issues/7005#issuecomment-42894813 по правильному использованию. Не может быть использовано вместе с policy. Параметр при создании конечной точки. Если не указано, AWS будет использовать политику по умолчанию, предоставляющую полный доступ к службе. псевдонимы: policy_path
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
region строка		AWS-регион для использования. Если не указан, используется значение переменной среды AWS_REGION или EC2_REGION, если таковая есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region псевдонимы: aws_region, ec2_region
route_table_ids список / элементы=строка		Список одного или нескольких идентификаторов таблиц маршрутизации, которые необходимо присоединить к конечной точке. Маршрут добавляется в таблицу маршрутизации с пунктом назначения конечной точки, если указан.
security_token строка		Токен безопасности AWS STS. Если не задан, используется значение переменной среды AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN. Если параметр profile задан, этот параметр игнорируется. Одновременное указание параметров security_token и profile устарело и параметры будут сделаны взаимоисключающими после 2022-06-01. псевдонимы: aws_security_token, access_token
service строка		Поддерживаемая AWS служба vpc endpoint. Используйте модуль community.aws.ec2_vpc_endpoint_info для описания поддерживаемых служб конечных точек. Требуется при создании конечной точки.
state строка	Варианты: present ← absent	present для обеспечения создания ресурса. absent для удаления ресурса
validate_certs логический	Варианты: нет да ←	При значении «нет» SSL-сертификаты не будут проверены для версий boto >= 2.6.0.
vpc_endpoint_id строка		Один или несколько идентификаторов конечных точек VPC для удаления из учетной записи AWS.
vpc_id строка		Необходим при создании конечной точки VPC.
wait логический	Варианты: нет ← да	При указании будет ожидать состояния available для state present. К сожалению, это игнорируется для действий удаления из-за различий в поведении от AWS.
wait_timeout целое число	Значение по умолчанию: 320	Используется в сочетании с wait. Количество секунд ожидания состояния. К сожалению, это игнорируется для действий удаления из-за различий в поведении от AWS.

Примечания

Примечание

Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета 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

Примеры

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: Create new vpc endpoint with a json template for policy
  community.aws.ec2_vpc_endpoint:
    state: present
    region: ap-southeast-2
    vpc_id: vpc-12345678
    service: com.amazonaws.ap-southeast-2.s3
    policy: " {{ lookup( 'template', 'endpoint_policy.json.j2') }} "
    route_table_ids:
      - rtb-12345678
      - rtb-87654321
  register: new_vpc_endpoint

- name: Create new vpc endpoint with the default policy
  community.aws.ec2_vpc_endpoint:
    state: present
    region: ap-southeast-2
    vpc_id: vpc-12345678
    service: com.amazonaws.ap-southeast-2.s3
    route_table_ids:
      - rtb-12345678
      - rtb-87654321
  register: new_vpc_endpoint

- name: Create new vpc endpoint with json file
  community.aws.ec2_vpc_endpoint:
    state: present
    region: ap-southeast-2
    vpc_id: vpc-12345678
    service: com.amazonaws.ap-southeast-2.s3
    policy_file: "{{ role_path }}/files/endpoint_policy.json"
    route_table_ids:
      - rtb-12345678
      - rtb-87654321
  register: new_vpc_endpoint

- name: Delete newly created vpc endpoint
  community.aws.ec2_vpc_endpoint:
    state: absent
    vpc_endpoint_id: "{{ new_vpc_endpoint.result['VpcEndpointId'] }}"
    region: ap-southeast-2

Значения возврата

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

Ключ	Возвращённое значение	Описание
endpoints список / элементы=строка	успех	Результирующие конечные точки из вызова модуля Пример: [{'creation_timestamp': '2017-02-20T05:04:15+00:00', 'policy_document': {'Id': 'Policy1450910922815', 'Statement': [{'Action': 's3:', 'Effect': 'Разрешить', 'Principal': '', 'Resource': ['arn:aws:s3:::/', 'arn:aws:s3:::*'], 'Sid': 'Stmt1450910920641'}], 'Version': '2012-10-17'}, 'route_table_ids': ['rtb-abcd1234'], 'service_name': 'com.amazonaws.ap-southeast-2.s3', 'vpc_endpoint_id': 'vpce-a1b2c3d4', 'vpc_id': 'vpc-abbad0d0'}]

Авторы

Karen Cheng (@Etherdaemon)

© 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/ec2_vpc_endpoint_module.html