Spec-Zone.ru › Ansible 2.5

aws_application_scaling_policy - Управление политиками масштабирования Application Auto Scaling

Новая в версии 2.5.

  • Обзор
    • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
    • Автор

Обзор

  • Создаёт, обновляет или удаляет политику масштабирования.

Требования

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

  • boto
  • boto3
  • botocore
  • json
  • python >= 2.6

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
aws_access_key Значение по умолчанию:
None
Ключ доступа AWS. Если не задан, используется значение переменной окружения AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY или EC2_ACCESS_KEY.

Псевдонимы: ec2_access_key, access_key
aws_secret_key Значение по умолчанию:
None
Секретный ключ AWS. Если не задан, используется значение переменной окружения AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY или EC2_SECRET_KEY.

Псевдонимы: ec2_secret_key, secret_key
ec2_url Значение по умолчанию:
None
URL для подключения к EC2 или облаку Eucalyptus (по умолчанию модуль использует конечные точки EC2). Игнорируется для модулей, где требуется регион. Должен быть указан для всех других модулей, если регион не используется. Если не задан, используется значение переменной окружения EC2_URL, если таковая есть.
policy_name
обязательно
Имя политики масштабирования.
policy_type
обязательно
    Варианты:
  • StepScaling
  • TargetTrackingScaling
Тип политики.
profile
(добавлено в 1.6)
Значение по умолчанию:
None
Использует профиль boto. Работает только с boto >= 2.24.0.
region
Регион AWS для использования. Если не указан, используется значение переменной окружения AWS_REGION или EC2_REGION, если таковая есть. См. http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

Псевдонимы: aws_region, ec2_region
resource_id
обязательно
Идентификатор ресурса, связанного с целевым объектом масштабирования.
scalable_dimension
обязательно
    Варианты:
  • ecs:service:DesiredCount
  • ec2:spot-fleet-request:TargetCapacity
  • elasticmapreduce:instancegroup:InstanceCount
  • appstream:fleet:DesiredCapacity
  • dynamodb:table:ReadCapacityUnits
  • dynamodb:table:WriteCapacityUnits
  • dynamodb:index:ReadCapacityUnits
  • dynamodb:index:WriteCapacityUnits
Изменяемая размерность, связанная с целевым объектом масштабирования.
security_token
(добавлено в 1.6)
Значение по умолчанию:
None
Токен безопасности AWS STS. Если не задан, используется значение переменной окружения AWS_SECURITY_TOKEN или EC2_SECURITY_TOKEN.

Псевдонимы: access_token
service_namespace
обязательно
    Варианты:
  • ecs
  • elasticmapreduce
  • ec2
  • appstream
  • dynamodb
Пространство имён службы AWS.
step_scaling_policy_configuration
Политика пошагового масштабирования. Этот параметр требуется, если вы создаёте политику, и тип политики — StepScaling.
target_tracking_scaling_policy_configuration
Политика отслеживания целевых значений. Этот параметр требуется, если вы создаёте новую политику, и тип политики — TargetTrackingScaling.
validate_certs
(добавлено в 1.5)
    Варианты:
  • нет
  • да ←
При значении "нет" сертификаты SSL не будут проверяться для boto-версий >= 2.6.0.

Примечания

Примечание

  • Подробные сведения о параметрах и возвращаемых значениях см. в http://boto3.readthedocs.io/en/latest/reference/services/application-autoscaling.html#ApplicationAutoScaling.Client.put_scaling_policy
  • Если параметры не заданы в модуле, можно использовать следующие переменные среды в порядке убывания приоритета AWS_URL или EC2_URL, 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
  • Ansible использует конфигурационный файл boto (обычно ~/.boto), если учетные данные не предоставлены. См. http://boto.readthedocs.org/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.

# Create scaling policy for ECS Service
- name: scaling_policy
  aws_application_scaling_policy:
  state: present
  policy_name: test_policy
  service_namespace: ecs
  resource_id: service/poc-pricing/test-as
  scalable_dimension: ecs:service:DesiredCount
  policy_type: StepScaling
  step_scaling_policy_configuration:
    AdjustmentType: ChangeInCapacity
    StepAdjustments:
      - MetricIntervalUpperBound: 123
        ScalingAdjustment: 2
      - MetricIntervalLowerBound: 123
        ScalingAdjustment: -2
    Cooldown: 123
    MetricAggregationType: Average

# Remove scalable target for ECS Service
- name: scaling_policy
  aws_application_scaling_policy:
    state: absent
    policy_name: test_policy
    policy_type: StepScaling
    service_namespace: ecs
    resource_id: service/cluster-name/service-name
    scalable_dimension: ecs:service:DesiredCount

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

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

Ключ Возвращённое значение Описание
creation_time
строка
при состоянии present
Отметка времени Unix для момента создания целевого объекта масштабирования.

Пример:
2017-09-28T08:22:51.881000-03:00
max_capacity
целое число
при состоянии present
Максимальное значение для масштабирования в ответ на событие масштабирования вверх. Требуется, если состояние — present.

Пример:
2
min_capacity
целое число
при состоянии present
Минимальное значение для масштабирования в ответ на событие масштабирования вниз. Требуется, если состояние — present.

Пример:
1
resource_id
строка
при состоянии present
Идентификатор ресурса, связанного с целевым объектом масштабирования.

Пример:
service/cluster-name/service-name
role_arn
строка
при состоянии present
ARN роли IAM, которая позволяет Application Auto Scaling изменять целевой объект масштабирования от вашего имени. Требуется, если состояние — present.

Пример:
arn:aws:iam::123456789123:role/roleName
scalable_dimension
строка
при состоянии present
Изменяемая размерность, связанная с целевым объектом масштабирования.

Пример:
ecs:service:DesiredCount
service_namespace
строка
при состоянии present
Пространство имён службы AWS.

Пример:
ecs


Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Автор

  • Gustavo Maia(@gurumaia)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/aws_application_scaling_policy_module.html

Spec-Zone.ru

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