Spec-Zone.ru › AWS CLI v2

[ aws . ssm ]

create-association

Описание

Ассоциация State Manager определяет состояние, которое вы хотите поддерживать на управляемых узлах. Например, ассоциация может указывать, что на управляемых узлах должен быть установлен и запущен антивирусный программный пакет или что определенные порты должны быть закрыты. Для статических целевых объектов ассоциация определяет расписание, когда конфигурация повторно применяется. Для динамических целевых объектов, таких как группа ресурсов Amazon Web Services или группа автоматического масштабирования Amazon Web Services, State Manager, инструмент в Amazon Web Services Systems Manager, применяет конфигурацию, когда новые управляемые узлы добавляются в группу. Ассоциация также определяет действия, которые необходимо предпринять при применении конфигурации. Например, ассоциация для антивирусного программного обеспечения может выполняться один раз в день. Если программное обеспечение не установлено, то State Manager устанавливает его. Если программное обеспечение установлено, но служба не работает, то ассоциация может поручить State Manager запустить службу.

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

Синтаксис

  create-association
--name <value>
[--document-version <value>]
[--instance-id <value>]
[--parameters <value>]
[--targets <value>]
[--schedule-expression <value>]
[--output-location <value>]
[--association-name <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>]
[--tags <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]

Параметры

--name (строка)

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

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

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

``arn:partition :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 .

--document-version (строка)

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

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

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

--instance-id (строка)

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

Примечание

InstanceId устарел. Чтобы указать идентификатор управляемого узла для ассоциации, используйте параметр Targets . Запросы, включающие параметр InstanceID с документами Systems Manager (SSM документами), использующими схему версии 2.0 или более позднюю, завершатся ошибкой. Кроме того, если вы используете параметр InstanceId, вы не можете использовать параметры AssociationName , DocumentVersion , MaxErrors , MaxConcurrency , OutputLocation или ScheduleExpression . Для использования этих параметров необходимо использовать параметр Targets.

--parameters (массив)

Параметры для конфигурации выполнения документа.

ключ -> (строка)

значение -> (список)

(строка)

Краткая запись:

KeyName1=string,string,KeyName2=string,string

Формат JSON:

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

--targets (список)

Целевые объекты для ассоциации. Вы можете нацеливать управляемые узлы, используя теги, группы ресурсов Amazon Web Services, все управляемые узлы в аккаунте Amazon Web Services или индивидуальные идентификаторы управляемых узлов. Вы можете нацелить все управляемые узлы в аккаунте Amazon Web Services, указав ключ InstanceIds со значением * . Дополнительную информацию о выборе целевых объектов для ассоциации см. в разделе "Понимание целевых объектов и ограничений скорости в ассоциациях State Manager" в руководстве пользователя Amazon Web Services Systems Manager.

(структура)

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

Примечание

Для задач запуска команд в окне обслуживания необходимо указать один или несколько целевых объектов. В зависимости от задачи, целевые объекты являются необязательными для других типов задач в окне обслуживания (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 . Например, если вы указали tag:ServerRole, вы можете указать value:WebServer для запуска команды на экземплярах, включающих теги EC2 ServerRole,WebServer.

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

(строка)

Краткая запись:

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

Формат JSON:

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

--schedule-expression (строка)

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

--output-location (структура)

Ведро Amazon Simple Storage Service (Amazon S3), в котором вы хотите хранить подробную информацию о результатах запроса.

S3Location -> (структура)

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

OutputS3Region -> (строка)

Регион Amazon Web Services ведра S3.

OutputS3BucketName -> (строка)

Имя ведра S3.

OutputS3KeyPrefix -> (строка)

Подпапка ведра S3.

Краткая запись:

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

Формат JSON:

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

--association-name (строка)

Укажите описательное имя для ассоциации.

--automation-target-parameter-name (строка)

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

--max-errors (строка)

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

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

--max-concurrency (строка)

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

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

--compliance-severity (строка)

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

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

  • CRITICAL
  • HIGH
  • MEDIUM
  • LOW
  • UNSPECIFIED

--sync-compliance (строка)

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

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

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

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

  • AUTO
  • MANUAL

--apply-only-at-cron-interval | --no-apply-only-at-cron-interval (булево)

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

Дополнительную информацию см. в разделах "Понимание того, когда ассоциации применяются к ресурсам" и "О обновлениях целевых объектов с исполняемыми скриптами Automation" в руководстве пользователя Amazon Web Services Systems Manager.

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

--calendar-names (список)

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

(строка)

--target-locations (список)

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

(структура)

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

Учетные записи -> (список)

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

(строка)

Регионы -> (список)

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

(строка)

TargetLocationMaxConcurrency -> (строка)

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

TargetLocationMaxErrors -> (строка)

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

ExecutionRoleName -> (строка)

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

TargetLocationAlarmConfiguration -> (структура)

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

IgnorePollAlarmFailure -> (логическое)

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

Alarms -> (список)

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

(структура)

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

Name -> (строка)

Имя вашей сигнализации CloudWatch.

IncludeChildOrganizationUnits -> (логическое)

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

ExcludeAccounts -> (список)

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

(строка)

Targets -> (список)

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

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

(структура)

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

Примечание

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

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

Для всех инструментов Systems Manager:
  • Key=tag-key,Values=tag-value-1,tag-value-2
Для автоматизации и 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 и окон технического обслуживания:
  • 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 -> (строка)

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

Values -> (список)

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

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

(строка)

TargetsMaxConcurrency -> (строка)

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

TargetsMaxErrors -> (строка)

Максимальное количество ошибок, разрешенных перед тем, как система остановит выполнение автоматизации на дополнительных целевых объектах. Этот параметр 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 (целое число)

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

Примечание

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

--duration (целое число)

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

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

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

--target-maps (список)

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

(карта)

ключ -> (строка)

значение -> (список)

(строка)

Краткая форма синтаксиса:

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

Синтаксис JSON:

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

--tags (список)

Добавляет или перезаписывает один или несколько тегов для ассоциации State Manager. Теги — это метаданные, которые вы можете назначить своим ресурсам Amazon Web Services. Теги позволяют категоризировать ресурсы по-разному, например, по назначению, владельцу или среде. Каждый тег состоит из ключа и необязательного значения, оба из которых вы определяете.

(структура)

Метаданные, которые вы назначаете своим ресурсам Amazon Web Services. Теги позволяют категоризировать ресурсы по-разному, например, по назначению, владельцу или среде. В Amazon Web Services Systems Manager вы можете применять теги к документам Systems Manager (документы SSM), управляемым узлам, окнам технического обслуживания, параметрам, эталонным значениям патчей, элементам Ops и данным OpsMetadata.

Key -> (строка)

Название тега.

Value -> (строка)

Значение тега.

Краткая форма синтаксиса:

Key=string,Value=string ...

Синтаксис JSON:

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

--alarm-configuration (структура)

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

IgnorePollAlarmFailure -> (логическое)

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

Alarms -> (список)

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

(структура)

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

Name -> (строка)

Имя вашей сигнализации CloudWatch.

Краткая форма синтаксиса:

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

Синтаксис JSON:

{
  "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-auto-prompt (boolean)

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

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

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

Примеры

Примечание

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

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

Пример 1: Для ассоциации документа с использованием идентификаторов экземпляров

В этом примере документ конфигурации ассоциируется с экземпляром с использованием идентификаторов экземпляров.

aws ssm create-association \
    --instance-id "i-0cb2b964d3e14fd9f" \
    --name "AWS-UpdateSSMAgent"

Вывод:

{
    "AssociationDescription": {
        "Status": {
            "Date": 1487875500.33,
            "Message": "Associated with AWS-UpdateSSMAgent",
            "Name": "Associated"
        },
        "Name": "AWS-UpdateSSMAgent",
        "InstanceId": "i-0cb2b964d3e14fd9f",
        "Overview": {
            "Status": "Pending",
            "DetailedStatus": "Creating"
        },
        "AssociationId": "b7c3266e-a544-44db-877e-b20d3a108189",
        "DocumentVersion": "$DEFAULT",
        "LastUpdateAssociationDate": 1487875500.33,
        "Date": 1487875500.33,
        "Targets": [
            {
                "Values": [
                    "i-0cb2b964d3e14fd9f"
                ],
                "Key": "InstanceIds"
            }
        ]
    }
}

Дополнительную информацию см. в CreateAssociation в Справочнике по API AWS Systems Manager.

Пример 2: Для ассоциации документа с использованием целевых объектов

В этом примере документ конфигурации ассоциируется с экземпляром с использованием целевых объектов.

aws ssm create-association \
    --name "AWS-UpdateSSMAgent" \
    --targets "Key=instanceids,Values=i-0cb2b964d3e14fd9f"

Вывод:

{
    "AssociationDescription": {
        "Status": {
            "Date": 1487875500.33,
            "Message": "Associated with AWS-UpdateSSMAgent",
            "Name": "Associated"
        },
        "Name": "AWS-UpdateSSMAgent",
        "InstanceId": "i-0cb2b964d3e14fd9f",
        "Overview": {
            "Status": "Pending",
            "DetailedStatus": "Creating"
        },
        "AssociationId": "b7c3266e-a544-44db-877e-b20d3a108189",
        "DocumentVersion": "$DEFAULT",
        "LastUpdateAssociationDate": 1487875500.33,
        "Date": 1487875500.33,
        "Targets": [
            {
                "Values": [
                    "i-0cb2b964d3e14fd9f"
                ],
                "Key": "InstanceIds"
            }
        ]
    }
}

Дополнительную информацию см. в CreateAssociation в Справочнике по API AWS Systems Manager.

Пример 3: Для создания ассоциации, выполняемой только один раз

В этом примере создается новая ассоциация, которая выполняется только один раз в указанную дату и время. Ассоциации, созданные с датой в прошлом или настоящем (к моменту обработки дата находится в прошлом), выполняются немедленно.

aws ssm create-association \
    --name "AWS-UpdateSSMAgent" \
    --targets "Key=instanceids,Values=i-0cb2b964d3e14fd9f" \
    --schedule-expression "at(2020-05-14T15:55:00)"  \
    --apply-only-at-cron-interval

Вывод:

{
    "AssociationDescription": {
        "Status": {
            "Date": 1487875500.33,
            "Message": "Associated with AWS-UpdateSSMAgent",
            "Name": "Associated"
        },
        "Name": "AWS-UpdateSSMAgent",
        "InstanceId": "i-0cb2b964d3e14fd9f",
        "Overview": {
            "Status": "Pending",
            "DetailedStatus": "Creating"
        },
        "AssociationId": "b7c3266e-a544-44db-877e-b20d3a108189",
        "DocumentVersion": "$DEFAULT",
        "LastUpdateAssociationDate": 1487875500.33,
        "Date": 1487875500.33,
        "Targets": [
            {
                "Values": [
                    "i-0cb2b964d3e14fd9f"
                ],
                "Key": "InstanceIds"
            }
        ]
    }
}

Дополнительную информацию см. в CreateAssociation в Справочнике по API AWS Systems Manager или Справочник: Выражения cron и скорости для Systems Manager в Руководстве пользователя AWS Systems Manager.

Вывод

AssociationDescription -> (структура)

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

Name -> (строка)

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

InstanceId -> (строка)

ID управляемого узла.

AssociationVersion -> (строка)

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

Date -> (метка времени)

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

LastUpdateAssociationDate -> (метка времени)

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

Status -> (структура)

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

Date -> (метка времени)

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

Name -> (строка)

Статус.

Message -> (строка)

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

AdditionalInfo -> (строка)

Пользовательская строка.

Overview -> (структура)

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

Status -> (строка)

Статус ассоциации. Статус может быть: Ожидание, Успех или Неудачно.

DetailedStatus -> (строка)

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

AssociationStatusAggregatedCount -> (карта)

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

ключ -> (строка)

значение -> (целое число)

DocumentVersion -> (строка)

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

AutomationTargetParameterName -> (строка)

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

Parameters -> (карта)

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

ключ -> (строка)

значение -> (список)

(строка)

AssociationId -> (строка)

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

Targets -> (список)

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

(структура)

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

Примечание

Для задач типа 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 и окон обслуживания:
  • 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. Например, если вы указали tag:ServerRole, вы можете указать value:WebServer, чтобы запустить команду на экземплярах, включающих теги EC2 ServerRole,WebServer.

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

(строка)

ScheduleExpression -> (строка)

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

OutputLocation -> (структура)

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

S3Location -> (структура)

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

OutputS3Region -> (строка)

Регион Amazon Web Services ведра S3.

OutputS3BucketName -> (строка)

Имя ведра S3.

OutputS3KeyPrefix -> (строка)

Подпапка ведра S3.

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 система использует состояние выполнения ассоциации для определения статуса соответствия. Если выполнение ассоциации прошло успешно, то ассоциация считается COMPLIANT. Если выполнение ассоциации не прошло успешно, ассоциация считается NON-COMPLIANT.

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

По умолчанию все ассоциации используют режим 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, нацеленных на текущее выполнение автоматизации.

Учетные записи -> (список)

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

(строка)

Регионы -> (список)

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

(строка)

TargetLocationMaxConcurrency -> (строка)

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

TargetLocationMaxErrors -> (строка)

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

ExecutionRoleName -> (строка)

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

TargetLocationAlarmConfiguration -> (структура)

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

IgnorePollAlarmFailure -> (булево)

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

Alarms -> (список)

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

(структура)

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

Name -> (строка)

Имя вашей сигнализации CloudWatch.

IncludeChildOrganizationUnits -> (булево)

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

ExcludeAccounts -> (список)

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

(строка)

Targets -> (список)

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

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

(структура)

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

Примечание

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

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

Для всех инструментов Systems Manager:
  • Key=tag-key,Values=tag-value-1,tag-value-2
Для автоматизации и управления изменениями:
  • 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=*
Для запуска команды и окон обслуживания:
  • 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 -> (строка)

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

Values -> (список)

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

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

(строка)

TargetsMaxConcurrency -> (строка)

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

TargetsMaxErrors -> (строка)

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

ScheduleOffset -> (целое число)

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

Duration -> (целое число)

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

TargetMaps -> (список)

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

(карта)

ключ -> (строка)

значение -> (список)

(строка)

AlarmConfiguration -> (структура)

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

IgnorePollAlarmFailure -> (булево)

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

Alarms -> (список)

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

(структура)

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

Name -> (строка)

Имя вашей сигнализации CloudWatch.

TriggeredAlarms -> (список)

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

(структура)

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

Name -> (строка)

Имя вашей сигнализации CloudWatch.

State -> (строка)

Состояние вашей сигнализации CloudWatch.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

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