модуль community.aws.ec2_carrier_gateway – управление шлюзом Carrier AWS VPC

access_key

псевдонимы: aws_access_key_id, aws_access_key

строка

Идентификатор ключа доступа 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.

aws_ca_bundle

путь

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

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

aws_config

словарь

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

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

carrier_gateway_id

строка

Идентификатор шлюза Carrier, которым нужно управлять.

debug_botocore_endpoint_logs

логическое значение

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

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

Варианты:

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

endpoint_url

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

строка

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

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

profile

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

строка

Именованный профиль 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.

purge_tags

логическое значение

Если задано 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

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

строка

Регион 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

строка

Секретный ключ доступа 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

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

строка

Токен сеанса 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

строка

Создать или удалить шлюз Carrier.

Варианты:

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

tags

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

словарь

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

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

validate_certs

логическое значение

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

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

Варианты:

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

vpc_id

строка / обязательный

Идентификатор VPC, в которой нужно управлять шлюзом Carrier.

carrier_gateway_id

строка

Уникальный идентификатор шлюза Carrier.

Возвращается: state=present

Пример: "{'carrier_gateway_id': 'cagw-XXXXXXXX'}"

changed

логическое значение

Были ли внесены изменения в шлюз Carrier.

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

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

tags

словарь

Теги, связанные со шлюзом Carrier.

Возвращается: state=present

Пример: {"tags": {"Ansible": "Test"}}

vpc_id

строка

Идентификатор VPC, связанной со шлюзом Carrier.

Возвращается: state=present

Пример: "{'vpc_id': 'vpc-XXXXXXXX'}"