create-association-batch
Описание
Связывает указанный документ Amazon Web Services Systems Manager (документ SSM) с указанными управляемыми узлами или целевыми объектами.
Когда вы связываете документ с одним или несколькими управляемыми узлами с помощью идентификаторов или тегов, агент Amazon Web Services Systems Manager Agent (SSM Agent), работающий на управляемом узле, обрабатывает документ и настраивает узел в соответствии со спецификацией.
Если вы связываете документ с управляемым узлом, который уже имеет связанный документ, система возвращает исключение AssociationAlreadyExists.
См. также: Документация API AWS
Синтаксис
create-association-batch
--entries <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]
Параметры
--entries (список)
Один или несколько ассоциаций.
(структура)
Описывает ассоциацию документа Amazon Web Services Systems Manager (документа SSM) и управляемого узла.
Имя -> (строка)
Имя документа SSM, содержащего конфигурационную информацию для управляемого узла. Вы можете указать команды или автоматизированные рабочие процессы.
Вы можете указать предопределенные документы Amazon Web Services, документы, которые вы создали, или документ, который был с вами поделен из другой учетной записи.
Для документов SSM, которые были с вами разделены из других учетных записей Amazon Web Services, необходимо указать полный ARN документа SSM в следующем формате:
Например:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-DocumentДля предопределенных документов Amazon Web Services и документов SSM, которые вы создали в своей учетной записи, вам нужно только указать имя документа. Например, AWS-ApplyPatchBaseline или My-Document .
InstanceId -> (строка)
Идентификатор управляемого узла.
Примечание
InstanceId устарел. Чтобы указать идентификатор управляемого узла для ассоциации, используйте параметр Targets . Запросы, включающие параметр InstanceID с документами Systems Manager (документами SSM), которые используют версию схемы 2.0 или новее, будут отклоняться. Кроме того, если вы используете параметр InstanceId, вы не можете использовать параметры AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation или ScheduleExpression. Чтобы использовать эти параметры, вы должны использовать параметр Targets.Parameters -> (массив)
Описание параметров для документа.
ключ -> (строка)
значение -> (список)
AutomationTargetParameterName -> (строка)
DocumentVersion -> (строка)
Targets -> (список)
Управляемые узлы, на которые нацелен запрос.
(структура)
Массив критериев поиска, который нацелен на управляемые узлы с помощью пары «ключ-значение», которую вы указываете.
Примечание
Для задач типа Run Command в окне обслуживания необходимо указать один или несколько целевых объектов. В зависимости от задачи целевые объекты необязательны для других типов задач в окне обслуживания (Automation, Lambda и Step Functions). Дополнительную информацию о запуске задач, не указывающих целевые объекты, см. в разделе «Регистрация задач окна обслуживания без целевых объектов» в руководстве пользователя Amazon Web Services Systems Manager.Поддерживаемые форматы включают следующее.
Key=tag-key,Values=tag-value-1,tag-value-2
Key=tag:tag-key,Values=tag-valueKey=ResourceGroup,Values=resource-group-nameKey=ParameterValues,Values=value-1,value-2,value-3- Чтобы нацелить все экземпляры в регионе Amazon Web Services:
Key=AWS::EC2::Instance,Values=*Key=InstanceIds,Values=*
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3Key=tag:tag-key,Values=tag-value-1,tag-value-2Key=resource-groups:Name,Values=resource-group-name- Кроме того, окна обслуживания поддерживают нацеливание на типы ресурсов:
Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3Key=tag:tag-key,Values=tag-value-1,tag-value-2- Чтобы нацелить все экземпляры в регионе Amazon Web Services:
Key=InstanceIds,Values=*
Дополнительную информацию о том, как отправлять команды, которые нацелены на управляемые узлы, используя параметры Key,Value, см. в разделе «Нацеливание на несколько управляемых узлов» в руководстве пользователя Amazon Web Services Systems Manager.
Ключ -> (строка)
Значения -> (список)
Пользовательские критерии, которые сопоставляются с Key. Например, если вы указали tag:ServerRole, вы могли бы указать value:WebServer для выполнения команды на экземплярах, которые включают теги EC2 ServerRole,WebServer .
В зависимости от типа целевого объекта максимальное количество значений для ключа может быть ниже глобального максимума в 50.
(строка)
ScheduleExpression -> (строка)
OutputLocation -> (структура)
Ведро S3, куда вы хотите сохранить результаты этого запроса.
S3Location -> (структура)
Ведро S3, куда вы хотите сохранить результаты этого запроса.
OutputS3Region -> (строка)
OutputS3BucketName -> (строка)
OutputS3KeyPrefix -> (строка)
AssociationName -> (строка)
MaxErrors -> (строка)
Количество ошибок, разрешенных до того, как система перестанет отправлять запросы для выполнения ассоциации на дополнительные целевые объекты. Вы можете указать абсолютное число ошибок, например 10, или процент от набора целевых объектов, например 10%. Если вы укажете 3, например, система перестанет отправлять запросы, когда будет получена четвертая ошибка. Если вы укажете 0, система перестанет отправлять запросы после возвращения первой ошибки. Если вы выполняете ассоциацию на 50 управляемых узлах и установили MaxError на 10%, система прекращает отправку запроса, когда получена шестая ошибка.
Выполнения, которые уже выполняют ассоциацию, когда достигнуто MaxErrors, разрешается завершить, но некоторые из этих выполнений также могут завершиться ошибкой. Если вам нужно убедиться, что не будет более max-errors завершений с ошибкой, установите MaxConcurrency в 1, чтобы выполнения происходили по одному.
MaxConcurrency -> (строка)
Максимальное количество целевых объектов, которые могут выполнять ассоциацию одновременно. Вы можете указать число, например 10, или процент от набора целевых объектов, например 10%. Значение по умолчанию — 100%, что означает, что все целевые объекты выполняют ассоциацию одновременно.
Если новый управляемый узел запускается и пытается выполнить ассоциацию, в то время как Systems Manager выполняет MaxConcurrency ассоциации, ассоциация разрешается к выполнению. В течение следующего интервала ассоциации новый управляемый узел обработает свою ассоциацию в пределах ограничения, указанного для MaxConcurrency.
ComplianceSeverity -> (строка)
SyncCompliance -> (строка)
Режим генерации соответствия ассоциации. Вы можете указать AUTO или MANUAL. В режиме AUTO система использует состояние выполнения ассоциации для определения состояния соответствия. Если выполнение ассоциации выполнено успешно, то ассоциация является COMPLIANT. Если выполнение ассоциации не выполнено успешно, ассоциация является NON-COMPLIANT.
В режиме MANUAL необходимо указать AssociationId в качестве параметра для операции PutComplianceItems API. В этом случае данные соответствия не управляются State Manager, инструментом Amazon Web Services Systems Manager. Они управляются вашим прямым вызовом операции PutComplianceItems API.
По умолчанию все ассоциации используют режим AUTO.
ApplyOnlyAtCronInterval -> (логическое значение)
По умолчанию, когда вы создаете новую ассоциацию, система выполняет ее сразу после создания, а затем в соответствии с указанным расписанием и при обнаружении изменений в целевых объектах. Укажите true для ApplyOnlyAtCronInterval, если вы хотите, чтобы ассоциация выполнялась только в соответствии с указанным расписанием.
Дополнительную информацию см. в разделах «Понимание, когда ассоциации применяются к ресурсам» и «О обновлениях целевых объектов с помощью автоматизированных рабочих процессов» в руководстве пользователя Amazon Web Services Systems Manager.
Этот параметр не поддерживается для выражений скорости.
CalendarNames -> (список)
Имена или Amazon Resource Names (ARN) документов типа «Календарь изменений», под которыми ваши ассоциации находятся под управлением. Ассоциации выполняются только при открытии этого календаря изменений. Дополнительную информацию см. в разделе «Календарь изменений Amazon Web Services Systems Manager» в руководстве пользователя Amazon Web Services Systems Manager.
(строка)
TargetLocations -> (список)
Используйте это действие для создания ассоциации в нескольких регионах и нескольких учетных записях.
(структура)
Комбинация регионов Amazon Web Services и учетных записей Amazon Web Services, на которые нацелено текущее выполнение автоматизации.
Учетные записи -> (список)
Учетные записи Amazon Web Services, на которые нацелено текущее выполнение автоматизации.
(строка)
Регионы -> (список)
Регионы Amazon Web Services, на которые нацелено текущее выполнение автоматизации.
(строка)
TargetLocationMaxConcurrency -> (строка)
TargetLocationMaxErrors -> (строка)
ExecutionRoleName -> (строка)
AWS-SystemsManager-AutomationExecutionRole .TargetLocationAlarmConfiguration -> (структура)
Подробности о сигнале CloudWatch, который вы хотите применить к автоматизации или команде.
IgnorePollAlarmFailure -> (булево)
Alarms -> (список)
Имя сигнала CloudWatch, указанного в конфигурации.
(структура)
Сигнал CloudWatch, который вы применяете к автоматизации или команде.
Name -> (строка)
IncludeChildOrganizationUnits -> (булево)
false.ExcludeAccounts -> (список)
Учетные записи Amazon Web Services или организационные подразделения, которые нужно исключить в качестве расширенных целей.
(строка)
Targets -> (список)
Список сопоставлений ключ-значение для целевых ресурсов. Если вы указываете значения для этого типа данных, вы также должны указать значение для TargetParameterName .
Этот Targets параметр имеет приоритет над StartAutomationExecution:Targets параметром, если оба заданы.
(структура)
Массив критериев поиска, которые нацелены на управляемые узлы с использованием пары ключ-значение, которую вы указываете.
Примечание
Для задач Run Command в окне обслуживания необходимо указать один или несколько целевых объектов. В зависимости от задачи целевые объекты необязательны для других типов задач в окне обслуживания (автоматизация, Lambda и Step Functions). Более подробную информацию о выполнении задач, не указывающих целевые объекты, см. в разделе «Регистрация задач окна обслуживания без целевых объектов» в руководстве пользователя Amazon Web Services Systems Manager.Поддерживаемые форматы включают следующие.
Key=tag-key,Values=tag-value-1,tag-value-2
Key=tag:tag-key,Values=tag-valueKey=ResourceGroup,Values=resource-group-nameKey=ParameterValues,Values=value-1,value-2,value-3- Чтобы нацелить все экземпляры в регионе Amazon Web Services:
Key=AWS::EC2::Instance,Values=*Key=InstanceIds,Values=*
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3Key=tag:tag-key,Values=tag-value-1,tag-value-2Key=resource-groups:Name,Values=resource-group-name- Кроме того, Maintenance Windows поддерживают нацеливание на типы ресурсов:
Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3Key=tag:tag-key,Values=tag-value-1,tag-value-2- Чтобы нацелить все экземпляры в регионе Amazon Web Services:
Key=InstanceIds,Values=*
Дополнительную информацию о том, как отправлять команды, нацеленные на управляемые узлы с использованием Key,Value параметров, см. в разделе «Нацеливание на несколько управляемых узлов» в руководстве пользователя Amazon Web Services Systems Manager.
Key -> (строка)
Values -> (список)
Пользовательские критерии, которые сопоставляются с Key. Например, если вы указали tag:ServerRole, вы можете указать value:WebServer, чтобы выполнить команду на экземплярах, которые включают теги EC2 ServerRole,WebServer.
В зависимости от типа целевого объекта максимальное количество значений для ключа может быть меньше глобального максимума 50.
(строка)
TargetsMaxConcurrency -> (строка)
TargetsMaxConcurrency параметр имеет приоритет над StartAutomationExecution:MaxConcurrency параметром, если оба заданы.TargetsMaxErrors -> (строка)
TargetsMaxErrors параметр имеет приоритет над StartAutomationExecution:MaxErrors параметром, если оба заданы.ScheduleOffset -> (целое число)
Duration -> (целое число)
Количество часов, в течение которого может выполняться ассоциация, прежде чем она будет отменена. Длительность применяется к ассоциациям, которые в данный момент выполняются, а также к любым ожидающим и текущим командам на всех целевых объектах. Если целевой объект был выведен из работы для выполнения ассоциации, он снова становится доступным немедленно без перезагрузки.
Параметр Duration применяется только в том случае, если оба эти условия верны:
- Ассоциация, для которой вы указываете длительность, может быть отменена в соответствии с параметрами документа команды SSM или сценария Automation, связанного с этим выполнением.
- Команда указывает параметр `` ApplyOnlyAtCronInterval ``, что означает, что ассоциация не запускается сразу после создания, а только в соответствии с указанным графиком.
TargetMaps -> (список)
Сопоставление ключ-значение параметров документа с целевыми ресурсами. Оба Targets и TargetMaps не могут быть указаны одновременно.
(мапа)
key -> (строка)
value -> (список)
AlarmConfiguration -> (структура)
Подробности о сигнале CloudWatch, который вы хотите применить к автоматизации или команде.
IgnorePollAlarmFailure -> (булево)
Alarms -> (список)
Имя сигнала CloudWatch, указанного в конфигурации.
(структура)
Сигнал CloudWatch, который вы применяете к автоматизации или команде.
Name -> (строка)
Синтаксис JSON:
[
{
"Name": "string",
"InstanceId": "string",
"Parameters": {"string": ["string", ...]
...},
"AutomationTargetParameterName": "string",
"DocumentVersion": "string",
"Targets": [
{
"Key": "string",
"Values": ["string", ...]
}
...
],
"ScheduleExpression": "string",
"OutputLocation": {
"S3Location": {
"OutputS3Region": "string",
"OutputS3BucketName": "string",
"OutputS3KeyPrefix": "string"
}
},
"AssociationName": "string",
"MaxErrors": "string",
"MaxConcurrency": "string",
"ComplianceSeverity": "CRITICAL"|"HIGH"|"MEDIUM"|"LOW"|"UNSPECIFIED",
"SyncCompliance": "AUTO"|"MANUAL",
"ApplyOnlyAtCronInterval": true|false,
"CalendarNames": ["string", ...],
"TargetLocations": [
{
"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"
}
...
],
"ScheduleOffset": integer,
"Duration": integer,
"TargetMaps": [
{"string": ["string", ...]
...}
...
],
"AlarmConfiguration": {
"IgnorePollAlarmFailure": true|false,
"Alarms": [
{
"Name": "string"
}
...
]
}
}
...
]
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке предоставлены другие аргументы, эти значения перепишут значения, предоставленные JSON. Невозможно передать произвольные двоичные значения с помощью значения, предоставленного JSON, так как строка будет взята буквально. Это может не быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит 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)
Регион для использования. Переопределяет настройки из конфигурации/среды.
--version (string)
Отобразить версию этого инструмента.
--color (string)
Включение/выключение цветного вывода.
- on
- off
- auto
--no-sign-request (boolean)
Не подписывать запросы. Кредиты не будут загружены, если этот аргумент предоставлен.
--ca-bundle (string)
Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки из конфигурации/среды.
--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.
Для создания нескольких ассоциаций
В этом примере конфигурационный документ связывается с несколькими экземплярами. Вывод возвращает список успешных и неудачных операций, если применимо.
Команда:
aws ssm create-association-batch --entries "Name=AWS-UpdateSSMAgent,InstanceId=i-1234567890abcdef0" "Name=AWS-UpdateSSMAgent,InstanceId=i-9876543210abcdef0"
Вывод:
{
"Successful": [
{
"Name": "AWS-UpdateSSMAgent",
"InstanceId": "i-1234567890abcdef0",
"AssociationVersion": "1",
"Date": 1550504725.007,
"LastUpdateAssociationDate": 1550504725.007,
"Status": {
"Date": 1550504725.007,
"Name": "Associated",
"Message": "Associated with AWS-UpdateSSMAgent"
},
"Overview": {
"Status": "Pending",
"DetailedStatus": "Creating"
},
"DocumentVersion": "$DEFAULT",
"AssociationId": "8dfe3659-4309-493a-8755-0123456789ab",
"Targets": [
{
"Key": "InstanceIds",
"Values": [
"i-1234567890abcdef0"
]
}
]
},
{
"Name": "AWS-UpdateSSMAgent",
"InstanceId": "i-9876543210abcdef0",
"AssociationVersion": "1",
"Date": 1550504725.057,
"LastUpdateAssociationDate": 1550504725.057,
"Status": {
"Date": 1550504725.057,
"Name": "Associated",
"Message": "Associated with AWS-UpdateSSMAgent"
},
"Overview": {
"Status": "Pending",
"DetailedStatus": "Creating"
},
"DocumentVersion": "$DEFAULT",
"AssociationId": "9c9f7f20-5154-4fed-a83e-0123456789ab",
"Targets": [
{
"Key": "InstanceIds",
"Values": [
"i-9876543210abcdef0"
]
}
]
}
],
"Failed": []
}
Вывод
Успешно -> (список)
Информация об ассоциациях, которые завершились успешно.
(структура)
Описание параметров документа.
Имя -> (строка)
InstanceId -> (строка)
AssociationVersion -> (строка)
Дата -> (отметка времени)
LastUpdateAssociationDate -> (отметка времени)
Статус -> (структура)
Статус ассоциации.
Дата -> (отметка времени)
Имя -> (строка)
Сообщение -> (строка)
Дополнительная информация -> (строка)
Обзор -> (структура)
Информация об ассоциации.
Статус -> (строка)
ПодробныйСтатус -> (строка)
AssociationStatusAggregatedCount -> (массив)
Возвращает количество целевых объектов для статуса ассоциации. Например, если вы создали ассоциацию с двумя управляемыми узлами, и один из них выполнился успешно, это вернет количество управляемых узлов по статусу.
ключ -> (строка)
значение -> (целое число)
DocumentVersion -> (строка)
AutomationTargetParameterName -> (строка)
Parameters -> (массив)
Описание параметров документа.
ключ -> (строка)
значение -> (список)
AssociationId -> (строка)
Targets -> (список)
Управляемые узлы, на которые направлен запрос.
(структура)
Массив критериев поиска, нацеленных на управляемые узлы с использованием пары «ключ-значение», которую вы указываете.
Примечание
Для задач типа «Run Command» в рамках окна обслуживания необходимо указать один или несколько целевых объектов. В зависимости от задачи, целевые объекты являются необязательными для других типов задач в рамках окна обслуживания (Automation, Lambda и Step Functions). Дополнительную информацию о выполнении задач, не указывающих целевых объектов, см. в разделе «Регистрация задач окна обслуживания без целевых объектов» в руководстве пользователя Amazon Web Services Systems Manager.Поддерживаемые форматы включают следующие.
Key=tag-key,Values=tag-value-1,tag-value-2
Key=tag:tag-key,Values=tag-valueKey=ResourceGroup,Values=resource-group-nameKey=ParameterValues,Values=value-1,value-2,value-3- Чтобы нацелить все экземпляры в регионе Amazon Web Services:
Key=AWS::EC2::Instance,Values=*Key=InstanceIds,Values=*
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3Key=tag:tag-key,Values=tag-value-1,tag-value-2Key=resource-groups:Name,Values=resource-group-name- Кроме того, Maintenance Windows поддерживают нацеливание на типы ресурсов:
Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3Key=tag:tag-key,Values=tag-value-1,tag-value-2- Чтобы нацелить все экземпляры в регионе Amazon Web Services:
Key=InstanceIds,Values=*
Дополнительную информацию о том, как отправлять команды, нацеленные на управляемые узлы с использованием параметров Key,Value, см. в разделе «Нацеливание на несколько управляемых узлов» в руководстве пользователя Amazon Web Services Systems Manager.
Ключ -> (строка)
Значения -> (список)
Пользовательские критерии, сопоставленные с Key. Например, если вы указали tag:ServerRole, вы можете указать value:WebServer, чтобы выполнить команду на экземплярах, которые включают теги EC2 ServerRole,WebServer.
В зависимости от типа цели максимальное количество значений для ключа может быть меньше глобального максимума в 50.
(строка)
ScheduleExpression -> (строка)
OutputLocation -> (структура)
Ведро S3, в котором вы хотите сохранить подробные сведения о запросе.
S3Location -> (структура)
Ведро S3, в котором вы хотите сохранить результаты этого запроса.
OutputS3Region -> (строка)
OutputS3BucketName -> (строка)
OutputS3KeyPrefix -> (строка)
LastExecutionDate -> (отметка времени)
LastSuccessfulExecutionDate -> (отметка времени)
AssociationName -> (строка)
MaxErrors -> (строка)
Количество ошибок, разрешенных до того, как система перестанет отправлять запросы для выполнения ассоциации на дополнительные целевые объекты. Вы можете указать либо абсолютное число ошибок (например, 10), либо процент от набора целевых объектов (например, 10%). Если вы укажете 3, например, система перестанет отправлять запросы, когда будет получена четвертая ошибка. Если вы укажете 0, то система перестанет отправлять запросы после получения первой ошибки. Если вы выполняете ассоциацию на 50 управляемых узлах и установили MaxError на 10%, то система перестанет отправлять запрос, когда будет получена шестая ошибка.
Выполнения, которые уже выполняют ассоциацию, когда достигается MaxErrors, разрешается завершить, но некоторые из этих выполнений также могут завершиться неудачно. Если вам нужно гарантировать, что не будет более max-errors неудачных выполнений, установите MaxConcurrency в 1, чтобы выполнения происходили по одному.
MaxConcurrency -> (строка)
Максимальное количество целевых объектов, которым разрешено одновременно выполнять ассоциацию. Вы можете указать число (например, 10) или процент от набора целевых объектов (например, 10%). Значение по умолчанию — 100%, что означает, что все целевые объекты выполняют ассоциацию одновременно.
Если новый управляемый узел запускается и пытается выполнить ассоциацию, в то время как Systems Manager выполняет MaxConcurrency ассоциации, выполнение ассоциации разрешено. В течение следующего интервала ассоциации новый управляемый узел обработает свою ассоциацию в пределах лимита, указанного для MaxConcurrency.
ComplianceSeverity -> (строка)
SyncCompliance -> (строка)
Режим для создания соответствия ассоциации. Вы можете указать AUTO или MANUAL. В режиме AUTO система использует статус выполнения ассоциации для определения статуса соответствия. Если выполнение ассоциации завершается успешно, ассоциация соответствует. Если выполнение ассоциации завершается неудачно, ассоциация не соответствует.
В режиме MANUAL вы должны указать AssociationId в качестве параметра для операции API PutComplianceItems. В этом случае данные соответствия не управляются State Manager, инструментом Amazon Web Services Systems Manager. Они управляются вашим прямым вызовом операции API PutComplianceItems.
По умолчанию все ассоциации используют режим AUTO.
ApplyOnlyAtCronInterval -> (логическое значение)
CalendarNames -> (список)
Имена или Amazon Resource Names (ARN) документов типа «Календарь изменений», под которыми ваши ассоциации находятся под управлением. Ассоциации выполняются только при открытии этого календаря изменений. Дополнительную информацию см. в разделе «Календарь изменений Amazon Web Services Systems Manager» в руководстве пользователя Amazon Web Services Systems Manager.
(строка)
TargetLocations -> (список)
Сочетание облачных регионов Amazon Web Services и учетных записей Amazon Web Services, в которых вы хотите запустить ассоциацию.
(структура)
Сочетание облачных регионов Amazon Web Services и учетных записей Amazon Web Services, на которые нацелено текущее выполнение автоматизации.
Accounts -> (список)
Учетные записи Amazon Web Services, на которые нацелено текущее выполнение автоматизации.
(строка)
Regions -> (список)
Регионы Amazon Web Services, на которые нацелено текущее выполнение автоматизации.
(строка)
TargetLocationMaxConcurrency -> (строка)
TargetLocationMaxErrors -> (строка)
ExecutionRoleName -> (строка)
AWS-SystemsManager-AutomationExecutionRole.TargetLocationAlarmConfiguration -> (структура)
Подробности для сигнализации CloudWatch, которую вы хотите применить к автоматизации или команде.
IgnorePollAlarmFailure -> (булево)
Alarms -> (список)
Имя сигнализации CloudWatch, указанной в конфигурации.
(структура)
Сигнализация CloudWatch, которую вы применяете к автоматизации или команде.
Name -> (строка)
IncludeChildOrganizationUnits -> (булево)
false.ExcludeAccounts -> (список)
Учетные записи Amazon Web Services или организационные единицы, которые необходимо исключить в качестве расширенных целевых объектов.
(строка)
Targets -> (список)
Список сопоставлений пар ключ-значение для целевых ресурсов. Если вы указываете значения для этого типа данных, вы также должны указать значение для TargetParameterName.
Этот Targets параметр имеет приоритет над параметром StartAutomationExecution:Targets, если оба указаны.
(структура)
Массив критериев поиска, которые нацелены на управляемые узлы с помощью заданной вами пары ключ-значение.
Примечание
Для задач типа Run Command в окне обслуживания требуется указать один или несколько целевых объектов. В зависимости от задачи, целевые объекты являются необязательными для других типов задач окна обслуживания (автоматизация, Lambda и Step Functions). Дополнительную информацию о выполнении задач, не указывающих целевых объектов, см. в руководстве пользователя Amazon Web Services Systems Manager: Регистрация задач окна обслуживания без целевых объектов.Поддерживаемые форматы включают следующие.
Key=tag-key,Values=tag-value-1,tag-value-2
Key=tag:tag-key,Values=tag-valueKey=ResourceGroup,Values=resource-group-nameKey=ParameterValues,Values=value-1,value-2,value-3- Для нацеливания на все экземпляры в облачном регионе Amazon Web Services:
Key=AWS::EC2::Instance,Values=*Key=InstanceIds,Values=*
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3Key=tag:tag-key,Values=tag-value-1,tag-value-2Key=resource-groups:Name,Values=resource-group-name- Кроме того, окна обслуживания поддерживают нацеливание на типы ресурсов:
Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3Key=tag:tag-key,Values=tag-value-1,tag-value-2- Для нацеливания на все экземпляры в облачном регионе Amazon Web Services:
Key=InstanceIds,Values=*
Дополнительную информацию о том, как отправлять команды, нацеленные на управляемые узлы с использованием параметров Key,Value, см. в руководстве пользователя Amazon Web Services Systems Manager: Нацеливание на несколько управляемых узлов.
Key -> (строка)
Values -> (список)
Пользовательские критерии, которые сопоставляются с Key. Например, если вы указали tag:ServerRole, вы можете указать value:WebServer для выполнения команды на экземплярах, которые включают теги EC2 ServerRole,WebServer.
В зависимости от типа целевого объекта максимальное количество значений для ключа может быть меньше глобального максимума в 50.
(строка)
TargetsMaxConcurrency -> (строка)
TargetsMaxConcurrency параметр имеет приоритет над параметром StartAutomationExecution:MaxConcurrency, если оба указаны.TargetsMaxErrors -> (строка)
TargetsMaxErrors параметр имеет приоритет над параметром StartAutomationExecution:MaxErrors, если оба указаны.ScheduleOffset -> (целое число)
Duration -> (целое число)
TargetMaps -> (список)
Сопоставление пар ключ-значение параметров документа с целевыми ресурсами. Параметры Targets и TargetMaps нельзя указывать одновременно.
(карта)
key -> (строка)
value -> (список)
AlarmConfiguration -> (структура)
Подробности для сигнализации CloudWatch, которую вы хотите применить к автоматизации или команде.
IgnorePollAlarmFailure -> (булево)
Alarms -> (список)
Имя сигнализации CloudWatch, указанной в конфигурации.
(структура)
Сигнализация CloudWatch, которую вы применяете к автоматизации или команде.
Name -> (строка)
TriggeredAlarms -> (список)
Сигнализация CloudWatch, которая была вызвана во время ассоциации.
(структура)
Подробности о состоянии вашей сигнализации CloudWatch.
Name -> (строка)
State -> (строка)
Failed -> (список)
Информация об ассоциациях, которые завершились с ошибкой.
(структура)
Описание неудачной ассоциации.
Запись -> (структура)
Ассоциация.
Имя -> (строка)
Имя документа SSM, содержащего конфигурационную информацию для управляемого узла. Вы можете указать командные или автоматизированные задания.
Вы можете указать предопределенные Amazon Web Services документы, документы, которые вы создали, или документ, который был с вами разделен другим аккаунтом.
Для документов SSM, которые были разделены с вами другими аккаунтами Amazon Web Services, вы должны указать полный ARN документа SSM в следующем формате:
Например:
arn:aws:ssm:us-east-2:12345678912:document/My-Shared-DocumentДля предопределенных документов Amazon Web Services и документов SSM, которые вы создали в своём аккаунте, вам нужно указать только имя документа. Например, AWS-ApplyPatchBaseline или My-Document .
InstanceId -> (строка)
Идентификатор управляемого узла.
Примечание
InstanceId устарел. Чтобы указать идентификатор управляемого узла для ассоциации, используйте параметр Targets. Запросы, содержащие параметр InstanceID вместе с документами Systems Manager (SSM), которые используют версию схемы 2.0 или выше, завершатся ошибкой. Кроме того, если вы используете параметр InstanceId, вы не можете использовать параметры AssociationName, DocumentVersion, MaxErrors, MaxConcurrency, OutputLocation или ScheduleExpression. Чтобы использовать эти параметры, вы должны использовать параметр Targets.Parameters -> (карта)
Описание параметров документа.
ключ -> (строка)
значение -> (список)
AutomationTargetParameterName -> (строка)
DocumentVersion -> (строка)
Targets -> (список)
Управляемые узлы, на которые направлен запрос.
(структура)
Массив критериев поиска, которые нацелены на управляемые узлы, используя заданные вами пары «ключ-значение».
Примечание
Для задач типа Run Command в окнах обслуживания необходимо указать один или несколько целевых объектов. В зависимости от задачи, целевые объекты являются необязательными для других типов задач в окнах обслуживания (Automation, Lambda и Step Functions). Дополнительную информацию о запуске задач без указания целевых объектов см. в руководстве пользователя Amazon Web Services Systems Manager.Поддерживаемые форматы включают следующие.
Key=tag-key,Values=tag-value-1,tag-value-2
Key=tag:tag-key,Values=tag-valueKey=ResourceGroup,Values=resource-group-nameKey=ParameterValues,Values=value-1,value-2,value-3- Чтобы нацелиться на все экземпляры в регионе Amazon Web Services:
Key=AWS::EC2::Instance,Values=*Key=InstanceIds,Values=*
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3Key=tag:tag-key,Values=tag-value-1,tag-value-2Key=resource-groups:Name,Values=resource-group-name- Кроме того, Maintenance Windows поддерживают нацеливание на типы ресурсов:
Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3Key=tag:tag-key,Values=tag-value-1,tag-value-2- Чтобы нацелиться на все экземпляры в регионе Amazon Web Services:
Key=InstanceIds,Values=*
Дополнительную информацию о том, как отправлять команды, нацеленные на управляемые узлы, используя параметры Key,Value, см. в руководстве пользователя Amazon Web Services Systems Manager.
Ключ -> (строка)
Значения -> (список)
Пользовательские критерии, сопоставленные с Key. Например, если вы указали tag:ServerRole, вы можете указать value:WebServer, чтобы выполнить команду на экземплярах, которые включают теги EC2 ServerRole,WebServer.
В зависимости от типа целевого объекта максимальное количество значений для ключа может быть меньше глобального максимума в 50.
(строка)
ScheduleExpression -> (строка)
OutputLocation -> (структура)
Ведро S3, в котором вы хотите сохранить результаты этого запроса.
S3Location -> (структура)
Ведро S3, в котором вы хотите сохранить результаты этого запроса.
OutputS3Region -> (строка)
OutputS3BucketName -> (строка)
OutputS3KeyPrefix -> (строка)
AssociationName -> (строка)
MaxErrors -> (строка)
Количество ошибок, разрешенных до прекращения системой отправки запросов для выполнения ассоциации на дополнительные целевые объекты. Вы можете указать либо абсолютное число ошибок (например, 10), либо процент от набора целей (например, 10%). Если вы укажете 3, то система прекратит отправку запросов после получения четвёртой ошибки. Если вы укажете 0, система прекратит отправку запросов после первой возвращённой ошибки. Если вы выполняете ассоциацию на 50 управляемых узлах и устанавливаете MaxError на 10%, система прекратит отправку запроса после получения шестой ошибки.
Выполнения, которые уже выполняют ассоциацию при достижении MaxErrors, разрешены для завершения, но некоторые из них могут завершиться с ошибкой. Если вам нужно убедиться, что не будет больше ошибок, чем max-errors, установите MaxConcurrency на 1, чтобы выполнения выполнялись по одному.
MaxConcurrency -> (строка)
Максимальное количество целевых объектов, которые могут выполнить ассоциацию одновременно. Вы можете указать число (например, 10) или процент от набора целевых объектов (например, 10%). Значение по умолчанию — 100%, что означает, что все целевые объекты выполняют ассоциацию одновременно.
Если новый управляемый узел запускается и пытается выполнить ассоциацию, в то время как Systems Manager выполняет MaxConcurrency ассоциации, ассоциация разрешена к выполнению. В течение следующего интервала ассоциации новый управляемый узел обработает свою ассоциацию в пределах предела, указанного для MaxConcurrency.
ComplianceSeverity -> (строка)
SyncCompliance -> (строка)
Режим создания соответствия ассоциации. Вы можете указать AUTO или MANUAL. В режиме AUTO система использует состояние выполнения ассоциации для определения статуса соответствия. Если выполнение ассоциации завершилось успешно, ассоциация считается COMPLIANT. Если выполнение ассоциации не завершилось успешно, ассоциация считается NON-COMPLIANT.
В режиме MANUAL вы должны указать AssociationId в качестве параметра для операции API PutComplianceItems. В этом случае данные о соответствии не управляются State Manager, инструментом в Amazon Web Services Systems Manager. Они управляются вашим прямым вызовом операции API PutComplianceItems.
По умолчанию все ассоциации используют режим AUTO.
ApplyOnlyAtCronInterval -> (булево)
По умолчанию, когда вы создаёте новую ассоциацию, система запускает её сразу после создания, а затем согласно заданному расписанию и при обнаружении изменений в целевых объектах. Укажите true для ApplyOnlyAtCronInterval, если вы хотите, чтобы ассоциация запускалась только согласно заданному расписанию.
Дополнительную информацию см. в руководстве пользователя Amazon Web Services Systems Manager.
Этот параметр не поддерживается для выражений скорости.
CalendarNames -> (список)
Имена или Amazon Resource Names (ARN) документов типа Change Calendar, под которыми ваши ассоциации находятся под управлением. Ассоциации запускаются только при открытии этого Change Calendar. Дополнительную информацию см. в руководстве пользователя Amazon Web Services Systems Manager.
(строка)
TargetLocations -> (список)
Используйте этот параметр для создания ассоциации в нескольких регионах и учетных записях.
(структура)
Сочетание регионов Amazon Web Services и учетных записей Amazon Web Services, на которые направлена текущая автоматизация.
Accounts -> (список)
Учетные записи Amazon Web Services, на которые направлена текущая автоматизация.
(строка)
Regions -> (список)
Регионы Amazon Web Services, на которые направлена текущая автоматизация.
(строка)
TargetLocationMaxConcurrency -> (строка)
TargetLocationMaxErrors -> (строка)
ExecutionRoleName -> (строка)
AWS-SystemsManager-AutomationExecutionRole.TargetLocationAlarmConfiguration -> (структура)
Подробная информация о сигнале CloudWatch, который вы хотите применить к автоматизации или команде.
IgnorePollAlarmFailure -> (логическое значение)
Alarms -> (список)
Имя сигнала CloudWatch, указанного в конфигурации.
(структура)
Сигнал CloudWatch, который вы применяете к автоматизации или команде.
Name -> (строка)
IncludeChildOrganizationUnits -> (логическое значение)
false.ExcludeAccounts -> (список)
Учетные записи Amazon Web Services или организационные единицы для исключения в качестве расширенных целевых объектов.
(строка)
Targets -> (список)
Список сопоставлений пар «ключ-значение» для целевых ресурсов. Если вы укажете значения для этого типа данных, вы также должны указать значение для TargetParameterName .
Этот параметр Targets имеет приоритет над параметром StartAutomationExecution:Targets, если оба указаны.
(структура)
Массив критериев поиска, которые нацелены на управляемые узлы, используя пару «ключ-значение», которую вы укажете.
Примечание
Для задач типа Run Command в окне технического обслуживания необходимо указать один или несколько целевых объектов. В зависимости от задачи, целевые объекты необязательны для других типов задач окна технического обслуживания (автоматизация, Lambda и Step Functions). Дополнительную информацию о запуске задач, которые не указывают целевые объекты, см. в разделе «Регистрация задач окна технического обслуживания без целевых объектов» в руководстве пользователя Amazon Web Services Systems Manager.Поддерживаются следующие форматы.
Key=tag-key,Values=tag-value-1,tag-value-2
Key=tag:tag-key,Values=tag-valueKey=ResourceGroup,Values=resource-group-nameKey=ParameterValues,Values=value-1,value-2,value-3- Для определения всех экземпляров в регионе Amazon Web Services:
Key=AWS::EC2::Instance,Values=*Key=InstanceIds,Values=*
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3Key=tag:tag-key,Values=tag-value-1,tag-value-2Key=resource-groups:Name,Values=resource-group-name- Кроме того, окна технического обслуживания поддерживают определение типов ресурсов:
Key=resource-groups:ResourceTypeFilters,Values=resource-type-1,resource-type-2
Key=InstanceIds,Values=instance-id-1,instance-id-2,instance-id-3Key=tag:tag-key,Values=tag-value-1,tag-value-2- Для определения всех экземпляров в регионе Amazon Web Services:
Key=InstanceIds,Values=*
Дополнительную информацию о том, как отправлять команды, которые нацелены на управляемые узлы, используя параметры Key,Value, см. в разделе «Назначение нескольких управляемых узлов» в руководстве пользователя Amazon Web Services Systems Manager.
Key -> (строка)
Values -> (список)
Пользовательские критерии, которые сопоставляются с Key. Например, если вы указали tag:ServerRole, вы можете указать value:WebServer для выполнения команды на экземплярах, которые включают теги EC2 ServerRole,WebServer.
В зависимости от типа целевого объекта, максимальное количество значений для ключа может быть меньше глобального максимума в 50.
(строка)
TargetsMaxConcurrency -> (строка)
TargetsMaxConcurrency имеет приоритет над параметром StartAutomationExecution:MaxConcurrency, если оба указаны.TargetsMaxErrors -> (строка)
TargetsMaxErrors имеет приоритет над параметром StartAutomationExecution:MaxErrors, если оба указаны.ScheduleOffset -> (целое число)
Duration -> (целое число)
Количество часов, в течение которых ассоциация может выполняться перед отменением. Параметр Duration применяется к ассоциациям, которые выполняются в настоящее время, а также ко всем ожидающим и выполняющимся командам на всех целевых объектах. Если целевой объект был выведен из строя для выполнения ассоциации, он становится доступным снова немедленно без перезагрузки.
Параметр Duration применяется только при соблюдении обоих этих условий:
- Ассоциация, для которой вы указываете период, может быть отменена в соответствии с параметрами документа команды SSM или сценария автоматизации, связанных с этим выполнением.
- Команда указывает параметр `` ApplyOnlyAtCronInterval ``, что означает, что ассоциация не запускается немедленно после создания, а только в соответствии с указанным расписанием.
TargetMaps -> (список)
Сопоставление пар «ключ-значение» параметров документа с целевыми ресурсами. Параметры Targets и TargetMaps нельзя указывать вместе.
(массив)
key -> (строка)
value -> (список)
AlarmConfiguration -> (структура)
Подробная информация о сигнале CloudWatch, который вы хотите применить к автоматизации или команде.
IgnorePollAlarmFailure -> (логическое значение)
Alarms -> (список)
Имя сигнала CloudWatch, указанного в конфигурации.
(структура)
Сигнал CloudWatch, который вы применяете к автоматизации или команде.
Name -> (строка)
Message -> (строка)
Fault -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.