update-association

Description

Обновляет ассоциацию. Вы можете обновить имя и версию ассоциации, версию документа, расписание, параметры и вывод Amazon Simple Storage Service (Amazon S3). При вызове UpdateAssociation система удаляет все необязательные параметры из запроса и перезаписывает ассоциацию значениями null для этих параметров. Это сделано намеренно. Вы должны указать все необязательные параметры в вызове, даже если вы не изменяете параметры. Это включает параметр Name. Перед вызовом этой операции API рекомендуется вызвать операцию API DescribeAssociation и записать все необязательные параметры, необходимые для вашего UpdateAssociation вызова.

Чтобы вызвать эту операцию API, пользователю, группе или роли должно быть предоставлено разрешение на вызов операции API DescribeAssociation. Если у вас нет разрешения на вызов DescribeAssociation, вы получите следующую ошибку: An error occurred (AccessDeniedException) when calling the UpdateAssociation operation: User: <user_arn> isn't authorized to perform: ssm:DescribeAssociation on resource: <resource_arn>

Предупреждение

При обновлении ассоциации она немедленно запускается на указанных целях. Вы можете добавить параметр ApplyOnlyAtCronInterval, чтобы запустить ассоциацию во время следующего запуска по расписанию.

См. также: Документация по API AWS

Synopsis

  update-association
--association-id <value>
[--parameters <value>]
[--document-version <value>]
[--schedule-expression <value>]
[--output-location <value>]
[--name <value>]
[--targets <value>]
[--association-name <value>]
[--association-version <value>]
[--automation-target-parameter-name <value>]
[--max-errors <value>]
[--max-concurrency <value>]
[--compliance-severity <value>]
[--sync-compliance <value>]
[--apply-only-at-cron-interval | --no-apply-only-at-cron-interval]
[--calendar-names <value>]
[--target-locations <value>]
[--schedule-offset <value>]
[--duration <value>]
[--target-maps <value>]
[--alarm-configuration <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--association-id (string)

Идентификатор ассоциации, которую вы хотите обновить.

--parameters (map)

Параметры, которые вы хотите обновить для ассоциации. Если вы создаете параметр с помощью Parameter Store, инструмента в Amazon Web Services Systems Manager, вы можете сослаться на параметр, используя {{ssm:parameter-name}} .

key -> (string)

value -> (list)

(string)

Сокращенный синтаксис:

KeyName1=string,string,KeyName2=string,string

Синтаксис JSON:

{"string": ["string", ...]
  ...}

--document-version (string)

Версия документа, которую вы хотите обновить для ассоциации.

Предупреждение

State Manager не поддерживает запуск ассоциаций, использующих новую версию документа, если этот документ предоставлен из другой учетной записи. State Manager всегда запускает версию default документа, если он предоставлен из другой учетной записи, даже если в консоли Systems Manager отображается, что обработана новая версия. Если вы хотите запустить ассоциацию, используя новую версию документа, предоставленную из другой учетной записи, вы должны установить версию документа в default .

--schedule-expression (string)

Выражение cron, используемое для планирования ассоциации, которую вы хотите обновить.

--output-location (structure)

S3 bucket, в котором вы хотите сохранить результаты этого запроса.

S3Location -> (structure)

S3 bucket, в котором вы хотите сохранить результаты этого запроса.

OutputS3Region -> (string)

Регион Amazon Web Services bucket S3.

OutputS3BucketName -> (string)

Имя bucket S3.

OutputS3KeyPrefix -> (string)

Подпапка bucket S3.

Сокращенный синтаксис:

S3Location={OutputS3Region=string,OutputS3BucketName=string,OutputS3KeyPrefix=string}

Синтаксис JSON:

{
  "S3Location": {
    "OutputS3Region": "string",
    "OutputS3BucketName": "string",
    "OutputS3KeyPrefix": "string"
  }
}

--name (string)

Имя документа SSM Command или runbook Automation, который содержит информацию о конфигурации для управляемого узла.

Вы можете указать предопределенные Amazon Web Services документы, созданные вами документы или документ, предоставленный вам из другой учетной записи.

Для документа Systems Manager (документ SSM), предоставленного вам из других учетных записей Amazon Web Services, необходимо указать полный ARN документа SSM в следующем формате:

``arn:aws:ssm:region :account-id :document/document-name ``

Например:

arn:aws:ssm:us-east-2:12345678912:document/My-Shared-Document

Для предопределенных документов Amazon Web Services и документов SSM, созданных в вашей учетной записи, вам нужно только указать имя документа. Например, AWS-ApplyPatchBaseline или My-Document .

--targets (list)

Цели ассоциации.

(structure)

Массив критериев поиска, который нацелен на управляемые узлы с использованием пары ключ-значение, которую вы указываете.

Примечание

Для задач Run Command в окне обслуживания необходимо указать одну или несколько целей. В зависимости от задачи цели являются необязательными для других типов задач в окне обслуживания (Automation, Lambda и Step Functions). Дополнительные сведения о запуске задач, не указывающих цели, см. в разделе Регистрация задач в окне обслуживания без целей в Руководстве пользователя Amazon Web Services Systems Manager .

Поддерживаемые форматы включают следующее.

Для всех инструментов Systems Manager:

Key=tag-key,Values=tag-value-1,tag-value-2

Для Automation и Change Manager:

Key=tag:tag-key,Values=tag-value
Key=ResourceGroup,Values=resource-group-name
Key=ParameterValues,Values=value-1,value-2,value-3
Чтобы нацелить все экземпляры в регионе Amazon Web Services:
- Key=AWS::EC2::Instance,Values=*
- Key=InstanceIds,Values=*

Для Run Command и Maintenance Windows:

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
Key=tag:tag-key,Values=tag-value-1,tag-value-2
Key=resource-groups:Name,Values=resource-group-name
Кроме того, окна обслуживания поддерживают нацеливание на типы ресурсов:
- Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

Для State Manager:

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
Key=tag:tag-key,Values=tag-value-1,tag-value-2
Чтобы нацелить все экземпляры в регионе Amazon Web Services:
- Key=InstanceIds,Values=*

Дополнительные сведения о том, как отправлять команды, которые нацелены на управляемые узлы с использованием параметров Key,Value , см. в разделе Нацеливание на несколько управляемых узлов в Руководстве пользователя Amazon Web Services Systems Manager .

Key -> (string)

Определенные пользователем критерии для отправки команд, которые нацелены на управляемые узлы, соответствующие критериям.

Values -> (list)

Определенные пользователем критерии, соответствующие Key . Например, если вы указали tag:ServerRole , вы можете указать value:WebServer , чтобы запустить команду на экземплярах, которые включают теги EC2 ServerRole,WebServer .

В зависимости от типа цели максимальное количество значений для ключа может быть меньше глобального максимума, равного 50.

(string)

Сокращенный синтаксис:

Key=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Values": ["string", ...]
  }
  ...
]

--association-name (string)

Имя ассоциации, которую вы хотите обновить.

--association-version (string)

Этот параметр предоставляется для целей управления параллелизмом. Вы должны указать последнюю версию ассоциации в сервисе. Если вы хотите убедиться, что этот запрос выполнен успешно, укажите $LATEST или опустите этот параметр.

--automation-target-parameter-name (string)

Выберите параметр, который будет определять, как ваша автоматизация будет ветвиться. Эта цель требуется для ассоциаций, использующих runbook Automation и ориентированных на ресурсы с помощью средств управления скоростью. Automation — это инструмент в Amazon Web Services Systems Manager.

--max-errors (string)

Количество ошибок, которые допускаются до того, как система перестанет отправлять запросы на запуск ассоциации для дополнительных целей. Вы можете указать либо абсолютное количество ошибок, например 10, либо процент от целевого набора, например 10%. Например, если вы укажете 3, система перестанет отправлять запросы при получении четвертой ошибки. Если вы укажете 0, система перестанет отправлять запросы после возврата первой ошибки. Если вы запустите ассоциацию на 50 управляемых узлах и установите MaxError на 10%, система перестанет отправлять запрос при получении шестой ошибки.

Выполнение, в котором уже выполняется ассоциация при достижении MaxErrors , может быть завершено, но некоторые из этих выполнений также могут завершиться неудачей. Если вам нужно убедиться, что не будет более max-errors неудачных выполнений, установите MaxConcurrency на 1, чтобы выполнения выполнялись по одному.

--max-concurrency (string)

Максимальное количество целей, которым разрешено запускать ассоциацию одновременно. Вы можете указать число, например 10, или процент от целевого набора, например 10%. Значение по умолчанию — 100%, что означает, что все цели запускают ассоциацию одновременно.

Если новый управляемый узел запускается и пытается запустить ассоциацию, когда Systems Manager выполняет ассоциации MaxConcurrency , ассоциацию разрешено запустить. Во время следующего интервала ассоциации новый управляемый узел обработает свою ассоциацию в пределах лимита, указанного для MaxConcurrency .

--compliance-severity (string)

Уровень серьезности, который необходимо присвоить ассоциации.

Возможные значения:

CRITICAL
HIGH
MEDIUM
LOW
UNSPECIFIED

--sync-compliance (string)

Режим для создания соответствия ассоциации. Вы можете указать AUTO или MANUAL . В режиме AUTO система использует статус выполнения ассоциации для определения статуса соответствия. Если выполнение ассоциации выполняется успешно, ассоциация COMPLIANT . Если выполнение ассоциации не выполняется успешно, ассоциация NON-COMPLIANT .

В режиме MANUAL необходимо указать AssociationId в качестве параметра для операции API PutComplianceItems. В этом случае данные соответствия не управляются State Manager, инструментом в Amazon Web Services Systems Manager. Он управляется вашим прямым вызовом операции API PutComplianceItems.

По умолчанию все ассоциации используют режим AUTO .

Возможные значения:

AUTO
MANUAL

--apply-only-at-cron-interval | --no-apply-only-at-cron-interval (boolean)

По умолчанию при обновлении ассоциации система запускает ее сразу после обновления, а затем в соответствии с указанным расписанием. Укажите true для ApplyOnlyAtCronInterval , если вы хотите, чтобы ассоциация выполнялась только в соответствии с указанным расписанием.

Если вы выбрали этот параметр при создании ассоциации, а затем отредактировали эту ассоциацию или внесли изменения в runbook Automation или документ SSM, на котором основана эта ассоциация, State Manager применяет ассоциацию в следующем указанном интервале cron. Например, если вы выбрали версию Latest документа SSM при создании ассоциации и отредактировали ассоциацию, выбрав другую версию документа на странице Documents, State Manager применяет ассоциацию в следующем указанном интервале cron, если вы ранее установили ApplyOnlyAtCronInterval на true . Если этот параметр не был выбран, State Manager немедленно запускает ассоциацию.

Дополнительные сведения см. в разделе Understanding when associations are applied to resources и About target updates with Automation runbooks в Руководстве пользователя Amazon Web Services Systems Manager .

Этот параметр не поддерживается для выражений скорости.

Вы можете сбросить этот параметр. Для этого укажите параметр no-apply-only-at-cron-interval при обновлении ассоциации из командной строки. Этот параметр заставляет ассоциацию запускаться немедленно после ее обновления и в соответствии с указанным интервалом.

--calendar-names (list)

Имена или ARN (Amazon Resource Names) документов типа Change Calendar, под которыми вы хотите управлять своими ассоциациями. Ассоциации запускаются только тогда, когда этот календарь изменений открыт. Дополнительные сведения см. в разделе Amazon Web Services Systems Manager Change Calendar в Руководстве пользователя Amazon Web Services Systems Manager .

(string)

Синтаксис:

"string" "string" ...

--target-locations (list)

Местоположение — это сочетание регионов Amazon Web Services и учетных записей Amazon Web Services, в которых вы хотите запустить ассоциацию. Используйте это действие для обновления ассоциации в нескольких регионах и нескольких учетных записях.

(структура)

Сочетание регионов Amazon Web Services и учетных записей Amazon Web Services, для которых предназначено текущее выполнение Automation.

Accounts -> (list)

Учетные записи Amazon Web Services, для которых предназначено текущее выполнение Automation.

(string)

Regions -> (list)

Регионы Amazon Web Services, для которых предназначено текущее выполнение Automation.

(string)

TargetLocationMaxConcurrency -> (string)

Максимальное количество регионов Amazon Web Services и учетных записей Amazon Web Services, разрешенных для одновременного запуска Automation.

TargetLocationMaxErrors -> (string)

Максимальное количество ошибок, разрешенных до того, как система прекратит постановку в очередь дополнительных выполнений Automation для выполняющейся в данный момент Automation.

ExecutionRoleName -> (string)

Роль выполнения Automation, используемая выполняющейся в данный момент Automation. Если не указано, значение по умолчанию — AWS-SystemsManager-AutomationExecutionRole .

TargetLocationAlarmConfiguration -> (structure)

Сведения для CloudWatch alarm, который вы хотите применить к автоматизации или команде.

IgnorePollAlarmFailure -> (boolean)

Когда это значение равно true , ваша автоматизация или команда продолжают выполняться в случаях, когда мы не можем получить информацию о статусе тревоги от CloudWatch. В случаях, когда мы успешно получаем статус тревоги ОК или INSUFFICIENT_DATA, автоматизация или команда продолжают выполняться, независимо от этого значения. Значение по умолчанию — false .

Alarms -> (list)

Имя CloudWatch alarm, указанного в конфигурации.

(структура)

CloudWatch alarm, который вы применяете к автоматизации или команде.

Name -> (string)

Имя вашего CloudWatch alarm.

IncludeChildOrganizationUnits -> (boolean)

Указывает, следует ли включать дочерние организационные подразделения (OU), являющиеся дочерними по отношению к целевым OU. Значение по умолчанию — false .

ExcludeAccounts -> (list)

Учетные записи Amazon Web Services или организационные подразделения, которые необходимо исключить в качестве расширенных целей.

(string)

Targets -> (list)

Список сопоставлений «ключ-значение» для целевых ресурсов. Если вы указываете значения для этого типа данных, вы также должны указать значение для параметра TargetParameterName .

Этот параметр Targets имеет приоритет над параметром StartAutomationExecution:Targets, если оба указаны.

(структура)

Массив критериев поиска, который нацелен на управляемые узлы с использованием пары «ключ-значение», которую вы указываете.

Примечание

Для задач типа «Выполнить команду» окна обслуживания необходимо указать одну или несколько целей. В зависимости от задачи цели необязательны для других типов задач окна обслуживания (Automation, Lambda и Step Functions). Дополнительную информацию о выполнении задач, не указывающих цели, см. в разделе Регистрация задач окна обслуживания без целей в Руководстве пользователя Amazon Web Services Systems Manager .

Поддерживаемые форматы включают следующие.

Для всех инструментов Systems Manager:

Key=tag-key,Values=tag-value-1,tag-value-2

Для Automation и Change Manager:

Key=tag:tag-key,Values=tag-value
Key=ResourceGroup,Values=resource-group-name
Key=ParameterValues,Values=value-1,value-2,value-3
Для нацеливания на все экземпляры в регионе Amazon Web Services:
- Key=AWS::EC2::Instance,Values=*
- Key=InstanceIds,Values=*

Для Run Command и Maintenance Windows:

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
Key=tag:tag-key,Values=tag-value-1,tag-value-2
Key=resource-groups:Name,Values=resource-group-name
Кроме того, окна обслуживания поддерживают нацеливание на типы ресурсов:
- Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

Для State Manager:

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
Key=tag:tag-key,Values=tag-value-1,tag-value-2
Для нацеливания на все экземпляры в регионе Amazon Web Services:
- Key=InstanceIds,Values=*

Дополнительную информацию о том, как отправлять команды, которые ориентированы на управляемые узлы с использованием параметров Key,Value, см. в разделе Нацеливание на несколько управляемых узлов в Руководстве пользователя Amazon Web Services Systems Manager .

Key -> (string)

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

Values -> (list)

Определяемые пользователем критерии, соответствующие параметру Key . Например, если вы указали параметр tag:ServerRole , вы можете указать параметр value:WebServer , чтобы выполнить команду на экземплярах, которые включают теги EC2 параметра ServerRole,WebServer .

(string)

TargetsMaxConcurrency -> (string)

Максимальное количество целей, которым разрешено выполнять эту задачу параллельно. Этот параметр TargetsMaxConcurrency имеет приоритет над параметром StartAutomationExecution:MaxConcurrency, если оба указаны.

TargetsMaxErrors -> (string)

Максимальное количество ошибок, которые разрешены до того, как система прекратит выполнение автоматизации для дополнительных целей. Этот параметр TargetsMaxErrors имеет приоритет над параметром StartAutomationExecution:MaxErrors, если оба указаны.

Синтаксис JSON:

[
  {
    "Accounts": ["string", ...],
    "Regions": ["string", ...],
    "TargetLocationMaxConcurrency": "string",
    "TargetLocationMaxErrors": "string",
    "ExecutionRoleName": "string",
    "TargetLocationAlarmConfiguration": {
      "IgnorePollAlarmFailure": true|false,
      "Alarms": [
        {
          "Name": "string"
        }
        ...
      ]
    },
    "IncludeChildOrganizationUnits": true|false,
    "ExcludeAccounts": ["string", ...],
    "Targets": [
      {
        "Key": "string",
        "Values": ["string", ...]
      }
      ...
    ],
    "TargetsMaxConcurrency": "string",
    "TargetsMaxErrors": "string"
  }
  ...
]

--schedule-offset (integer)

Количество дней, которые необходимо подождать после запланированного дня, чтобы запустить ассоциацию. Например, если вы указали расписание cron cron(0 0 ? * THU#2 *) , вы можете указать смещение 3, чтобы запускать ассоциацию каждое воскресенье после второго четверга месяца. Дополнительную информацию о расписаниях cron для ассоциаций см. в разделе Справочник: выражения Cron и rate для Systems Manager в Руководстве пользователя Amazon Web Services Systems Manager .

Примечание

Чтобы использовать смещения, необходимо указать параметр ApplyOnlyAtCronInterval . Эта опция указывает системе не запускать ассоциацию сразу после ее создания.

--duration (integer)

Количество часов, в течение которых ассоциация может работать до отмены. Продолжительность применяется к ассоциациям, которые выполняются в данный момент, а также к любым ожидающим и выполняющимся командам для всех целей. Если цель была переведена в автономный режим для выполнения ассоциации, она снова становится доступной немедленно, без перезагрузки.

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

Ассоциация, для которой вы указываете продолжительность, может быть отменена в соответствии с параметрами документа команды SSM или Runbook Automation, связанного с этим выполнением.
Команда указывает параметр `` ApplyOnlyAtCronInterval ``, что означает, что ассоциация не запускается сразу после ее обновления, а только в соответствии с указанным расписанием.

--target-maps (list)

Сопоставление «ключ-значение» параметров документа с целевыми ресурсами. Нельзя указывать одновременно параметры Targets и TargetMaps.

(map)

key -> (string)

value -> (list)

(string)

Сокращенный синтаксис:

KeyName1=string,string,KeyName2=string,string ...

Синтаксис JSON:

[
  {"string": ["string", ...]
    ...}
  ...
]

--alarm-configuration (structure)

Сведения для CloudWatch alarm, который вы хотите применить к автоматизации или команде.

IgnorePollAlarmFailure -> (boolean)

Alarms -> (list)

Имя CloudWatch alarm, указанного в конфигурации.

(структура)

CloudWatch alarm, который вы применяете к автоматизации или команде.

Name -> (string)

Имя вашего CloudWatch alarm.

Сокращенный синтаксис:

IgnorePollAlarmFailure=boolean,Alarms=[{Name=string},{Name=string}]

Синтаксис JSON:

{
  "IgnorePollAlarmFailure": true|false,
  "Alarms": [
    {
      "Name": "string"
    }
    ...
  ]
}

--cli-input-json | --cli-input-yaml (string) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с использованием значения, предоставленного JSON, поскольку строка будет восприниматься буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (string) Выводит скелет JSON в стандартный вывод без отправки запроса API. Если не указано значение или указано значение input, выводит образец входного JSON, который можно использовать в качестве аргумента для параметра --cli-input-json. Аналогично, если указано yaml-input, будет выведен образец входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, он проверяет входные данные команды и возвращает образец выходного JSON для этой команды. Сгенерированный скелет JSON не является стабильным между версиями AWS CLI, и гарантии обратной совместимости в сгенерированном скелете JSON отсутствуют.

Глобальные опции

--debug (boolean)

Включить ведение журнала отладки.

--endpoint-url (string)

Переопределить URL по умолчанию команды с заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при взаимодействии со службами AWS. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Эта опция переопределяет поведение по умолчанию при проверке SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическое разбиение на страницы. Если автоматическое разбиение на страницы отключено, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования для вывода команды.

json
text
table
yaml
yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

Использовать регион. Переопределяет параметры config/env.

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/выключить цветной вывод.

on
off
auto

--no-sign-request (boolean)

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

--ca-bundle (string)

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

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокироваться и не истечет время ожидания. Значение по умолчанию — 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокироваться и не истечет время ожидания. Значение по умолчанию — 60 секунд.

--cli-binary-format (string)

Стиль форматирования, который будет использоваться для двоичных больших объектов. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные большие объекты будут предоставлены в виде строки с кодировкой base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, а двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному большому объекту, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую, независимо от параметра cli-binary-format. При использовании file:// содержимое файла необходимо будет правильно отформатировать для настроенного cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Отключить пейджер cli для вывода.

--cli-auto-prompt (boolean)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматический запрос параметров ввода CLI.

Примеры

Примечание

Чтобы использовать следующие примеры, необходимо установить и настроить AWS CLI. Дополнительную информацию см. в руководстве по началу работы в Руководстве пользователя AWS CLI.

Если не указано иное, во всех примерах используются правила цитирования, подобные unix. Эти примеры необходимо будет адаптировать к правилам цитирования вашего терминала. См. раздел Использование кавычек со строками в Руководстве пользователя AWS CLI.

Пример 1. Обновление ассоциации документа

Следующий пример update-association обновляет ассоциацию с новой версией документа.

aws ssm update-association \
    --association-id "8dfe3659-4309-493a-8755-0123456789ab" \
    --document-version "\$LATEST"

Вывод:

{
    "AssociationDescription": {
        "Name": "AWS-UpdateSSMAgent",
        "AssociationVersion": "2",
        "Date": 1550508093.293,
        "LastUpdateAssociationDate": 1550508106.596,
        "Overview": {
            "Status": "Pending",
            "DetailedStatus": "Creating"
        },
        "DocumentVersion": "$LATEST",
        "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab",
        "Targets": [
            {
                "Key": "tag:Name",
                "Values": [
                    "Linux"
                ]
            }
        ],
        "LastExecutionDate": 1550508094.879,
        "LastSuccessfulExecutionDate": 1550508094.879
    }
}

Дополнительные сведения см. в разделе Редактирование и создание новой версии ассоциации в Руководстве пользователя AWS Systems Manager.

Пример 2. Обновление выражения расписания ассоциации

В следующем примере update-association обновляется выражение расписания для указанной ассоциации.

aws ssm update-association \
    --association-id "8dfe3659-4309-493a-8755-0123456789ab" \
    --schedule-expression "cron(0 0 0/4 1/1 * ? *)"

Вывод:

{
    "AssociationDescription": {
        "Name": "AWS-HelloWorld",
        "AssociationVersion": "2",
        "Date": "2021-02-08T13:54:19.203000-08:00",
        "LastUpdateAssociationDate": "2021-06-29T11:51:07.933000-07:00",
        "Overview": {
            "Status": "Pending",
            "DetailedStatus": "Creating"
        },
        "DocumentVersion": "$DEFAULT",
        "AssociationId": "8dfe3659-4309-493a-8755-0123456789ab",
        "Targets": [
            {
                "Key": "aws:NoOpAutomationTag",
                "Values": [
                    "AWS-NoOpAutomationTarget-Value"
                ]
            }
        ],
        "ScheduleExpression": "cron(0 0 0/4 1/1 * ? *)",
        "LastExecutionDate": "2021-06-26T19:00:48.110000-07:00",
        "ApplyOnlyAtCronInterval": false
    }
}

Output

AssociationDescription -> (structure)

Описание ассоциации, которая была обновлена.

Name -> (string)

Имя документа SSM.

InstanceId -> (string)

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

AssociationVersion -> (string)

Версия ассоциации.

Date -> (timestamp)

Дата создания ассоциации.

LastUpdateAssociationDate -> (timestamp)

Дата последнего обновления ассоциации.

Status -> (structure)

Статус ассоциации.

Date -> (timestamp)

Дата изменения статуса.

Name -> (string)

Статус.

Message -> (string)

Причина статуса.

AdditionalInfo -> (string)

Строка, определяемая пользователем.

Overview -> (structure)

Информация об ассоциации.

Status -> (string)

Статус ассоциации. Статус может быть: Pending, Success или Failed.

DetailedStatus -> (string)

Подробный статус ассоциации.

AssociationStatusAggregatedCount -> (map)

Возвращает количество целевых объектов для статуса ассоциации. Например, если вы создали ассоциацию с двумя управляемыми узлами и один из них был успешным, это вернет количество управляемых узлов по статусу.

key -> (string)

value -> (integer)

DocumentVersion -> (string)

Версия документа.

AutomationTargetParameterName -> (string)

Выберите параметр, который будет определять, как ваша автоматизация будет разветвляться. Эта цель требуется для ассоциаций, которые используют runbook автоматизации и нацеливают ресурсы, используя элементы управления скоростью. Automation — это инструмент в Amazon Web Services Systems Manager.

Parameters -> (map)

Описание параметров для документа.

key -> (string)

value -> (list)

(string)

AssociationId -> (string)

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

Targets -> (list)

Управляемые узлы, предназначенные для запроса.

(structure)

Массив критериев поиска, который нацеливает управляемые узлы, используя пару "ключ-значение", которую вы указываете.

Примечание

Для задач типа Run Command окна обслуживания необходимо указать одну или несколько целей. В зависимости от задачи цели являются необязательными для других типов задач окна обслуживания (Automation, Lambda и Step Functions). Дополнительные сведения о запуске задач, которые не указывают цели, см. в разделе Регистрация задач окна обслуживания без целей в Руководстве пользователя Amazon Web Services Systems Manager .

Поддерживаются следующие форматы.

Для всех инструментов Systems Manager:

Key=tag-key,Values=tag-value-1,tag-value-2

Для Automation и Change Manager:

Key=tag:tag-key,Values=tag-value
Key=ResourceGroup,Values=resource-group-name
Key=ParameterValues,Values=value-1,value-2,value-3
Чтобы нацелить все экземпляры в регионе Amazon Web Services:
- Key=AWS::EC2::Instance,Values=*
- Key=InstanceIds,Values=*

Для Run Command и Maintenance Windows:

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
Key=tag:tag-key,Values=tag-value-1,tag-value-2
Key=resource-groups:Name,Values=resource-group-name
Кроме того, Maintenance Windows поддерживают нацеливание типов ресурсов:
- Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

Для State Manager:

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
Key=tag:tag-key,Values=tag-value-1,tag-value-2
Чтобы нацелить все экземпляры в регионе Amazon Web Services:
- Key=InstanceIds,Values=*

Дополнительные сведения о том, как отправлять команды, предназначенные для управляемых узлов, с использованием параметров Key,Value , см. в разделе Нацеливание нескольких управляемых узлов в Руководстве пользователя Amazon Web Services Systems Manager .

Key -> (string)

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

Values -> (list)

Определяемые пользователем критерии, которые соответствуют Key . Например, если вы указали tag:ServerRole , вы можете указать value:WebServer для выполнения команды в экземплярах, которые включают теги EC2 ServerRole,WebServer .

В зависимости от типа целевого объекта максимальное количество значений для ключа может быть меньше глобального максимума, равного 50.

(string)

ScheduleExpression -> (string)

Выражение cron, определяющее расписание выполнения ассоциации.

OutputLocation -> (structure)

Bucke S3, в котором вы хотите сохранить выходные данные запроса.

S3Location -> (structure)

Bucket S3, в котором вы хотите сохранить результаты этого запроса.

OutputS3Region -> (string)

Регион Amazon Web Services для бакета S3.

OutputS3BucketName -> (string)

Имя бакета S3.

OutputS3KeyPrefix -> (string)

Подпапка бакета S3.

LastExecutionDate -> (timestamp)

Дата последнего запуска ассоциации.

LastSuccessfulExecutionDate -> (timestamp)

Дата последнего успешного запуска ассоциации.

AssociationName -> (string)

Имя ассоциации.

MaxErrors -> (string)

Количество ошибок, которые допускаются до того, как система перестанет отправлять запросы на запуск ассоциации для дополнительных целей. Можно указать либо абсолютное количество ошибок, например 10, либо процент от набора целевых объектов, например 10%. Например, если вы укажете 3, система перестанет отправлять запросы при получении четвертой ошибки. Если указать 0, система перестанет отправлять запросы после возврата первой ошибки. Если вы запускаете ассоциацию на 50 управляемых узлах и устанавливаете MaxError на 10%, система прекратит отправку запроса при получении шестой ошибки.

Выполнение, которое уже запускает ассоциацию при достижении MaxErrors , разрешено завершить, но некоторые из этих выполнений также могут завершиться неудачно. Если необходимо убедиться, что будет не более max-errors неудачных выполнений, установите MaxConcurrency в 1, чтобы выполнение продолжалось по одному за раз.

MaxConcurrency -> (string)

Максимальное количество целей, разрешенных для одновременного запуска ассоциации. Можно указать число, например 10, или процент от набора целевых объектов, например 10%. Значение по умолчанию — 100%, что означает, что все целевые объекты запускают ассоциацию одновременно.

Если новый управляемый узел запускается и пытается запустить ассоциацию, когда Systems Manager запускает MaxConcurrency ассоциации, ассоциации разрешено запускаться. Во время следующего интервала ассоциации новый управляемый узел обработает свою ассоциацию в пределах лимита, указанного для MaxConcurrency .

ComplianceSeverity -> (string)

Уровень серьезности, назначенный ассоциации.

SyncCompliance -> (string)

Режим для создания соответствия ассоциации. Можно указать AUTO или MANUAL . В режиме AUTO система использует статус выполнения ассоциации для определения статуса соответствия. Если выполнение ассоциации завершается успешно, ассоциация COMPLIANT . Если выполнение ассоциации завершается неудачно, ассоциация NON-COMPLIANT .

В режиме MANUAL необходимо указать AssociationId в качестве параметра для операции API PutComplianceItems. В этом случае данные о соответствии не управляются State Manager, инструментом в Amazon Web Services Systems Manager. Он управляется вашим прямым вызовом операции API PutComplianceItems.

По умолчанию все ассоциации используют режим AUTO .

ApplyOnlyAtCronInterval -> (boolean)

По умолчанию при создании новых ассоциаций система запускает ее сразу после создания, а затем в соответствии с указанным расписанием. Укажите этот параметр, если не хотите, чтобы ассоциация запускалась сразу после ее создания. Этот параметр не поддерживается для выражений скорости.

CalendarNames -> (list)

Имена или ARN (Amazon Resource Names) документов типа "Календарь изменений", в которых заключены ваши ассоциации. Ассоциации выполняются только тогда, когда этот календарь изменений открыт. Дополнительные сведения см. в разделе Календарь изменений Amazon Web Services Systems Manager в Руководстве пользователя Amazon Web Services Systems Manager .

(string)

TargetLocations -> (list)

Сочетание регионов Amazon Web Services и учетных записей Amazon Web Services, для которых требуется запустить ассоциацию.

(структура)

Сочетание регионов Amazon Web Services и учетных записей Amazon Web Services, для которых выполняется текущее выполнение автоматизации.

Accounts -> (list)

Учетные записи Amazon Web Services, для которых выполняется текущее выполнение автоматизации.

(string)

Regions -> (list)

Регионы Amazon Web Services, для которых выполняется текущее выполнение автоматизации.

(string)

TargetLocationMaxConcurrency -> (string)

Максимальное количество регионов Amazon Web Services и учетных записей Amazon Web Services, разрешенных для одновременного запуска автоматизации.

TargetLocationMaxErrors -> (string)

Максимальное количество ошибок, разрешенных до того, как система прекратит постановку в очередь дополнительных выполнений автоматизации для выполняющейся в данный момент автоматизации.

ExecutionRoleName -> (string)

Роль выполнения автоматизации, используемая выполняющейся в данный момент автоматизацией. Если не указано, значение по умолчанию — AWS-SystemsManager-AutomationExecutionRole .

TargetLocationAlarmConfiguration -> (structure)

Подробности для тревоги CloudWatch, которую вы хотите применить к автоматизации или команде.

IgnorePollAlarmFailure -> (boolean)

Если это значение равно true, автоматизация или команда продолжат выполняться в случаях, когда мы не можем получить информацию о статусе тревоги из CloudWatch. В случаях, когда мы успешно получаем статус тревоги OK или INSUFFICIENT_DATA, автоматизация или команда продолжат выполняться, независимо от этого значения. По умолчанию — false .

Alarms -> (list)

Имя тревоги CloudWatch, указанной в конфигурации.

(structure)

Тревога CloudWatch, которую вы применяете к автоматизации или команде.

Name -> (string)

Имя вашей тревоги CloudWatch.

IncludeChildOrganizationUnits -> (boolean)

ExcludeAccounts -> (list)

Учетные записи Amazon Web Services или организационные подразделения, которые следует исключить в качестве расширенных целей.

(string)

Targets -> (list)

Список сопоставлений "ключ – значение" для целевых ресурсов. Если вы укажете значения для этого типа данных, необходимо также указать значение для TargetParameterName .

Этот Targets параметр имеет приоритет над параметром StartAutomationExecution:Targets , если указаны оба параметра.

(structure)

Массив критериев поиска, которые нацеливаются на управляемые узлы, используя пару "ключ-значение", которую вы указываете.

Примечание

Для задач типа Run Command окна обслуживания необходимо указать одну или несколько целей. В зависимости от задачи цели являются необязательными для других типов задач окна обслуживания (Автоматизация, Lambda и Step Functions). Дополнительную информацию о запуске задач, не указывающих цели, см. в разделе Registering maintenance window tasks without targets в Amazon Web Services Systems Manager User Guide .

Поддерживаются следующие форматы.

Для всех инструментов Systems Manager:

Key=tag-key,Values=tag-value-1,tag-value-2

Для Automation и Change Manager:

Key=tag:tag-key,Values=tag-value
Key=ResourceGroup,Values=resource-group-name
Key=ParameterValues,Values=value-1,value-2,value-3
Чтобы нацелиться на все инстансы в регионе Amazon Web Services:
- Key=AWS::EC2::Instance,Values=*
- Key=InstanceIds,Values=*

Для Run Command и Maintenance Windows:

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
Key=tag:tag-key,Values=tag-value-1,tag-value-2
Key=resource-groups:Name,Values=resource-group-name
Кроме того, Maintenance Windows поддерживает нацеливание на типы ресурсов:
- Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2

Для State Manager:

Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3
Key=tag:tag-key,Values=tag-value-1,tag-value-2
Чтобы нацелиться на все инстансы в регионе Amazon Web Services:
- Key=InstanceIds,Values=*

Дополнительные сведения о том, как отправлять команды, предназначенные для управляемых узлов, с помощью Key,Value параметров, см. в разделе Targeting multiple managed nodes в Amazon Web Services Systems Manager User Guide .

Key -> (string)

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

Values -> (list)

Определенные пользователем критерии, соответствующие Key . Например, если вы указали tag:ServerRole , вы можете указать value:WebServer , чтобы запустить команду на инстансах, включающих теги EC2 ServerRole,WebServer .

(string)

TargetsMaxConcurrency -> (string)

Максимальное количество целевых объектов, которым разрешено запускать эту задачу параллельно. Этот TargetsMaxConcurrency параметр имеет приоритет над параметром StartAutomationExecution:MaxConcurrency , если указаны оба параметра.

TargetsMaxErrors -> (string)

Максимальное количество ошибок, разрешенных до того, как система прекратит выполнение автоматизации для дополнительных целевых объектов. Этот TargetsMaxErrors параметр имеет приоритет над параметром StartAutomationExecution:MaxErrors , если указаны оба параметра.

ScheduleOffset -> (integer)

Количество дней ожидания после запланированного дня запуска ассоциации.

Duration -> (integer)

Количество часов, в течение которых ассоциация может выполняться для указанных целевых объектов. По истечении времени отсечения ассоциации, которые выполняются в данный момент, отменяются, и никакие ожидающие выполнения не запускаются для оставшихся целевых объектов.

TargetMaps -> (list)

Сопоставление "ключ-значение" параметров документа с целевыми ресурсами. Нельзя указывать как Targets, так и TargetMaps вместе.

(map)

key -> (string)

value -> (list)

(string)

AlarmConfiguration -> (structure)

Подробности для тревоги CloudWatch, которую вы хотите применить к автоматизации или команде.

IgnorePollAlarmFailure -> (boolean)

Alarms -> (list)

Имя тревоги CloudWatch, указанной в конфигурации.

(structure)

Тревога CloudWatch, которую вы применяете к автоматизации или команде.

Name -> (string)

Имя вашей тревоги CloudWatch.

TriggeredAlarms -> (list)

Тревога CloudWatch, которая была вызвана во время ассоциации.

(structure)

Подробности о состоянии вашей тревоги CloudWatch.

Name -> (string)

Имя вашей тревоги CloudWatch.

State -> (string)

Состояние вашей тревоги CloudWatch.