Entradas compartidas aws:applications aws:cloudWatch aws:configureDocker aws:configurePackage aws:domainJoin aws:downloadContent aws:psModule aws:refreshAssociation aws:runDockerAction aws:runDocument aws:runPowerShellScript aws:runShellScript aws:softwareInventory aws:updateAgent aws:updateSsmAgent

Referencia de complementos del documento de comandos

Esta referencia describe los complementos que puede especificar en un documento de tipo de comandos de AWS Systems Manager (SSM). Estos complementos no se pueden utilizar en manuales de procedimientos de Automation, que utilizan acciones de automatización. Para obtener información acerca de las acciones de AWS Systems Manager Automation, consulte Referencia de acciones de Automatización de Systems Manager.

Systems Manager determina las acciones que hay que realizar en una instancia administrada; para ello, lee el contenido de un documento de SSM. Cada documento incluye una sección de ejecución de código. En función de la versión de esquema de su documento, esta sección de ejecución de código puede incluir uno o más complementos o pasos. A efectos de este tema de ayuda, los complementos y los pasos se denominan complementos. En esta sección, se incluye información sobre cada uno de los complementos de Systems Manager. Para obtener más información sobre los documentos, incluida la información sobre la creación de documentos y las diferencias entre las versiones de esquema, consulte Documentos de AWS Systems Manager.

nota

Algunos de los complementos descritos aquí se ejecutan solo en instancias de Windows Server o Linux. Se indican las dependencias de la plataforma para cada complemento.

Los siguientes complementos de documentos se admiten en instancias Amazon Elastic Compute Cloud (Amazon EC2) para macOS:

aws:refreshAssociation
aws:runShellScript
aws:runPowerShellScript
aws:softwareInventory
aws:updateSsmAgent

Contenidos

Entradas compartidas
aws:applications
aws:cloudWatch
aws:configureDocker
aws:configurePackage
aws:domainJoin
aws:downloadContent
aws:psModule
aws:refreshAssociation
aws:runDockerAction
aws:runDocument
aws:runPowerShellScript
aws:runShellScript
aws:softwareInventory
aws:updateAgent
aws:updateSsmAgent

Entradas compartidas

Solo con la versión 3.0.502 y las versiones posteriores de SSM Agent, todos los complementos pueden utilizar las siguientes entradas:

finallyStep

El último paso que desea que ejecute el documento. Si esta entrada se define para un paso, tendrá prioridad sobre un valor exit especificado en las entradas onFailure o onSuccess. Para que un paso con esta entrada se ejecute como se espera, el paso debe ser el último definido en los mainSteps del documento.

Tipo: Booleano

Valores válidos: true | false

Requerido: no

onFailure

Si especifica esta entrada para un complemento con el valor exit y el paso falla, el estado del paso refleja el error, y el documento no ejecuta los pasos restantes a menos que se haya definido un finallyStep. Si especifica esta entrada para un complemento con el valor successAndExit y el paso falla, el estado del paso aparece como realizado correctamente y el documento no ejecuta los pasos restantes a menos que se haya definido un finallyStep.

Tipo: cadena

Valores válidos: exit | successAndExit

Requerido: no

onSuccess

Si especifica esta entrada para un complemento y el paso se ejecuta correctamente, el documento no ejecutará los pasos restantes a menos que se haya definido un finallyStep.

Tipo: cadena

Valores válidos: exit

Requerido: no

YAML


---
schemaVersion: '2.2'
description: Shared inputs example
parameters:
  customDocumentParameter:
    type: String
    description: Example parameter for a custom Command-type document.
mainSteps:
- action: aws:runDocument
  name: runCustomConfiguration
  inputs:
    documentType: SSMDocument
    documentPath: "yourCustomDocument"
    documentParameters: '"documentParameter":{{customDocumentParameter}}'
    onSuccess: exit
- action: aws:runDocument
  name: ifConfigurationFailure
  inputs:
    documentType: SSMDocument
    documentPath: "yourCustomRepairDocument"
    onFailure: exit
- action: aws:runDocument
  name: finalConfiguration
  inputs:
    documentType: SSMDocument
    documentPath: "yourCustomFinalDocument"
    finallyStep: true

JSON


{
   "schemaVersion": "2.2",
   "description": "Shared inputs example",
   "parameters": {
      "customDocumentParameter": {
         "type": "String",
         "description": "Example parameter for a custom Command-type document."
      }
   },
   "mainSteps":[
      {
         "action": "aws:runDocument",
         "name": "runCustomConfiguration",
         "inputs": {
            "documentType": "SSMDocument",
            "documentPath": "yourCustomDocument",
            "documentParameters": "\"documentParameter\":{{customDocumentParameter}}",
            "onSuccess": "exit"
         }
      },
      {
         "action": "aws:runDocument",
         "name": "ifConfigurationFailure",
         "inputs": {
            "documentType": "SSMDocument",
            "documentPath": "yourCustomRepairDocument",
            "onFailure": "exit"
         }
      },
      {
         "action": "aws:runDocument",
         "name":"finalConfiguration",
         "inputs": {
            "documentType": "SSMDocument",
            "documentPath": "yourCustomFinalDocument",
            "finallyStep": true
         }
      }
   ]
}

`aws:applications`

Instalar, reparar o desinstalar aplicaciones en una instancia de EC2. Este complemento solo se ejecuta en los sistemas operativos Windows Server.

Sintaxis

Esquema 2.2

Esquema 1.2

Propiedades

acción

La acción que hay que realizar.

Tipo: enumeración

Valores válidos: Install| Repair| Uninstall

Obligatorio: sí

parameters

Los parámetros para el instalador.

Tipo: cadena

Requerido: no

source

La URL del archivo .msi para la aplicación.

Tipo: cadena

Obligatorio: sí

sourceHash

Hash SHA256 del archivo .msi.

Tipo: cadena

Requerido: no

`aws:cloudWatch`

Exportar datos desde Windows Server a Amazon CloudWatch o los Registros de Amazon CloudWatch y monitorear los datos mediante las métricas de CloudWatch. Este complemento solo se ejecuta en los sistemas operativos Windows Server. Para obtener más información acerca de la integración de CloudWatch con Amazon Elastic Compute Cloud (Amazon EC2), consulte Recopilación de métricas y registros de instancias y servidores locales de Amazon EC2 con el agente de CloudWatch.

importante

El agente unificado de CloudWatch ha sustituido a SSM Agent como herramienta para enviar datos de registro a los Registros de Amazon CloudWatch. El complemento aws:cloudWatch del SSM Agent no es compatible. Recomendamos utilizar solo el agente de CloudWatch unificado para sus procesos de recopilación de registros. Para obtener más información, consulte los temas siguientes:

Puede exportar y monitorizar los siguientes tipos de datos:

ApplicationEventLog: Envía datos de registro de eventos de aplicación a los Registros de CloudWatch.
CustomLogs: Envía cualquier archivo de registro basado en texto a los Registros de Amazon CloudWatch. El complemento de CloudWatch crea una huella digital para archivos de registro. El sistema asocia, a continuación, un desplazamiento de datos con cada huella digital. El complemento carga archivos cuando hay cambios, registra el desplazamiento y asocia el desplazamiento con una huella digital. Este método se utiliza para evitar una situación en la que un usuario activa el complemento, asocia el servicio con un directorio que contiene un gran número de archivos y el sistema carga todos los archivos.

aviso
Tenga en cuenta que si la aplicación trunca o intenta limpiar registros durante el sondeo, cualquier registro especificado para LogDirectoryPath pueden perder entradas. Si, por ejemplo, desea limitar el tamaño de los archivos de registro, cree un nuevo archivo de registro cuando se alcance el límite y, a continuación, continúe escribiendo datos en el nuevo archivo.
ETW: Envía datos de Seguimiento de eventos para Windows (ETW) a los Registros de CloudWatch.
IIS: Envía datos de registro de IIS a los Registros de CloudWatch.
PerformanceCounter: Envía contadores de rendimiento de Windows a CloudWatch. Puede seleccionar diferentes categorías para cargar a CloudWatch como métricas. Para cada contador de rendimiento que desee cargar, cree una sección PerformanceCounter con un ID único (por ejemplo, "PerformanceCounter2", "PerformanceCounter3", etc.) y configure sus propiedades.

nota
Si se detiene el SSM Agent de AWS Systems Manager o el complemento de CloudWatch, los datos del contador de rendimiento no se registran en CloudWatch. Este comportamiento es distinto de los registros personalizados o de los registros de eventos de Windows. Estos registros mantienen los datos de contador de rendimiento y los cargan a CloudWatch después de que el SSM Agent o el complemento de CloudWatch estén disponibles.
SecurityEventLog: Envía datos de registro de eventos de seguridad a los Registros de CloudWatch.
SystemEventLog: Envía datos de registro de eventos de sistema a los Registros de CloudWatch.

Puede definir los siguientes destinos para los datos:

CloudWatch: El destino al que se envían los datos de las métricas del contador de rendimiento. Puede añadir más secciones con ID únicos (por ejemplo, "CloudWatch2", "CloudWatch3", etc.) y especificar una región diferente para cada ID nuevo para enviar los mismos datos a diferentes ubicaciones.
CloudWatchLogs: El destino al que se envían los datos de registro. Puede añadir más secciones con ID únicos (por ejemplo, "CloudWatchLogs2", "CloudWatchLogs3", etc.) y especificar una región diferente para cada ID nuevo para enviar los mismos datos a diferentes ubicaciones.

Sintaxis


"runtimeConfig":{
        "aws:cloudWatch":{
            "settings":{
                "startType":"{{ status }}"
            },
            "properties":"{{ properties }}"
        }
    }

Configuración y propiedades

AccessKey

El ID de la clave de acceso de . Esta propiedad es necesaria a menos que lanzara su instancia utilizando un rol de IAM. Esta propiedad no se puede utilizar con SSM.

Tipo: cadena

Requerido: no

CategoryName

La categoría de contador de rendimiento de Performance Monitor.

Tipo: cadena

Obligatorio: sí

CounterName

El nombre del contador de rendimiento de Performance Monitor.

Tipo: cadena

Obligatorio: sí

CultureName

La configuración regional en la que se registra la marca temporal. Si CultureName está en blanco, se usa de forma predeterminada la misma configuración regional que utiliza su instancia de Windows Server.

Tipo: cadena

Valores válidos: para obtener una lista de los valores admitidos, consulte el tema National Language Support (NLS) API Reference [Referencia de la API de compatibilidad con el idioma nacional (NLS)] en el sitio web de Microsoft. No se admiten los valores div, div-MV, hu y hu-HU.

Requerido: no

DimensionName

Una dimensión para la métrica de Amazon CloudWatch. Si especifica DimensionName, también debe especificar DimensionValue. Estos parámetros ofrecen otra vista al enumerar las métricas. Puede utilizar la misma dimensión para varias métricas, lo que le permite ver todas las métricas que pertenezcan a una dimensión concreta.

Tipo: cadena

Requerido: no

DimensionValue

Un valor de dimensión para la métrica de Amazon CloudWatch.

Tipo: cadena

Requerido: no

Codificación

La codificación del archivo que se va a utilizar (por ejemplo, UTF-8). Utilice el nombre de codificación, no el nombre de visualización.

Tipo: cadena

Valores válidos: para obtener una lista de los valores admitidos, consulte Clase Encoding en la biblioteca de Microsoft Learn.

Obligatorio: sí

Filtro

El prefijo de los nombres de registro. Deje en blanco este parámetro para monitorear todos los archivos.

Tipo: cadena

Valores válidos: para obtener una lista de los valores admitidos, consulte el tema Propiedad FileSystemWatcherFilter en la biblioteca de MSDN.

Requerido: no

Flujos

Cada tipo de datos que se va a cargar, junto con el destino de los datos (CloudWatch o Registros de CloudWatch). Por ejemplo, para enviar un contador de rendimiento definido bajo "Id": "PerformanceCounter" al destino de CloudWatch definido bajo "Id": "CloudWatch", escriba “PerformanceCounter,CloudWatch”. Del mismo modo, para enviar el registro personalizado, el registro de ETW y el registro del sistema al destino de los Registros de CloudWatch definido bajo "Id": "ETW", escriba “(ETW),CloudWatchLogs”. Además, puede enviar el mismo contador de rendimiento o archivo de registro a más de un destino. Por ejemplo, para enviar el registro de la aplicación a dos destinos diferentes definidos bajo "Id": "CloudWatchLogs" y "Id": "CloudWatchLogs2", escriba "ApplicationEventLog,(CloudWatchLogs, CloudWatchLogs2)".

Tipo: cadena

Los valores válidos (destino): CloudWatch | CloudWatchLogs | CloudWatchn | CloudWatchLogsn

Obligatorio: sí

FullName

El nombre completo del componente.

Tipo: cadena

Obligatorio: sí

Id

Identifica el origen o el destino de los datos. Este identificador deberá ser único dentro del archivo de configuración.

Tipo: cadena

Obligatorio: sí

InstanceName

El nombre de la instancia del contador de rendimiento. No utilice un asterisco (*) para indicar todas las instancias, porque cada componente de contador de rendimiento solo admite una métrica. Puede, sin embargo utilizar _Total.

Tipo: cadena

Obligatorio: sí

Niveles

Tipos de mensajes para enviar a Amazon CloudWatch.

Tipo: cadena

Valores válidos:

1: solo los mensajes de error cargados.
2: solo los mensajes de advertencia cargados.
4: solo los mensajes de información cargados.

Puede agregar valores juntos para incluir más de un tipo de mensaje. Por ejemplo, 3 significa que se incluyen mensajes de error (1) y mensajes de advertencia (2). El valor 7 significa que se incluyen mensajes de error (1), mensajes de advertencia (2) y mensajes informativos (4).

Obligatorio: sí

nota

Los registros de seguridad de Windows deben establecer los niveles en 7.

LineCount

El número de líneas del encabezado para identificar el archivo de registro. Por ejemplo, los archivos de registros de IIS tienen encabezados prácticamente idénticos. Puede especificar 3, que leería las tres primeras líneas del encabezado del archivo de registro para identificarlo. En los archivos de registro de IIS, la tercera línea es la marca de fecha y hora, que es distinta entre los archivos de registro.

Tipo: entero

Requerido: no

LogDirectoryPath

Para CustomLogs, escriba la ruta donde se almacenan registros en la instancia de EC2. Para los registros de IIS, la carpeta en la que se almacenan los registros de IIS para un sitio individual (por ejemplo, C:\\inetpub\\logs\\LogFiles\\W3SVCn). Para los registros de IIS, solo se admite el formato de registro W3C. No se admiten los formatos IIS, NCSA y personalizados.

Tipo: cadena

Obligatorio: sí

LogGroup

El nombre de su grupo de registros. Este nombre se muestra en la pantalla Grupos de registros en la consola de CloudWatch.

Tipo: cadena

Obligatorio: sí

LogName

El nombre del archivo de registro.

Para encontrar el nombre del registro, en Visor de eventos, en el panel de navegación, seleccione Registros de aplicaciones y servicios.
En la lista de registros, haga clic con el botón derecho en el registro que desea cargar (por ejemplo, Microsoft > Windows > Copia de seguridad > Operational) y, a continuación, seleccione Create Custom View.
En el cuadro de diálogo Create Custom View, seleccione la pestaña XML. LogName se encuentra en la etiqueta <Select Path=> (por ejemplo, Microsoft-Windows-Backup). Copie este texto en el parámetro LogName.

Tipo: cadena

Valores válidos: Application | Security | System | Microsoft-Windows-WinINet/Analytic

Obligatorio: sí

LogStream

El flujo de registros de destino. Si utiliza {instance_id}, se utiliza el ID de la instancia predeterminado de esta instancia como el nombre de registro de destino.

Tipo: cadena

Valores válidos: {instance_id} | {hostname} | {ip_address}<log_stream_name>

Si ingresa un nombre de flujo de registro que no existe, los Registros de CloudWatch lo crea automáticamente. Puede utilizar una cadena literal o variables predefinidas ({instance_id}, {hostname}, {ip_address}), o una combinación de las tres para definir el nombre del flujo de registro.

El nombre del flujo de registro especificado en este parámetro aparece en la pantalla Log Groups > Streams for <YourLogStream> en la consola de CloudWatch.

Obligatorio: sí

MetricName

La métrica de CloudWatch bajo la que desea que se incluyan los datos de rendimiento.

nota

No utilice caracteres especiales en el nombre. Si lo hace, es posible que la métrica y las alarmas asociadas no funcionen.

Tipo: cadena

Obligatorio: sí

NameSpace

El espacio de nombres de métrica en el que desea que se escriban los datos de contadores de rendimiento.

Tipo: cadena

Obligatorio: sí

PollInterval

¿Cuántos segundos deben transcurrir antes de que se carguen nuevos datos de registro y de contador de rendimiento?

Tipo: entero

Valores válidos: establecer este en 5 o más segundos. Se recomiendan quince segundos (00:00:15).

Obligatorio: sí

Región

La Región de AWS a la que desea enviar los datos de registro. Aunque puede enviar contadores de rendimiento a una región distinta de la que envía los datos de registro, le recomendamos que ajuste este parámetro a la misma región en la que se ejecuta la instancia.

Tipo: cadena

Valores válidos: ID de regiones de las Regiones de AWS compatibles con Systems Manager y los Registros de CloudWatch, como us-east-2, eu-west-1, y ap-southeast-1. Para las listas de Regiones de AWS compatibles con cada servicio, consulte Puntos de conexión de Registros de Amazon CloudWatch y Puntos de conexión de servicio de Systems Manager en la Referencia general de Amazon Web Services.

Obligatorio: sí

SecretKey

La clave de acceso secreta de . Esta propiedad es necesaria a menos que lanzara su instancia utilizando un rol de IAM.

Tipo: cadena

Requerido: no

startType

Active o desactive CloudWatch en la instancia.

Tipo: cadena

Valores válidos: Enabled | Disabled

Obligatorio: sí

TimestampFormat

El formato de marca temporal que desea utilizar. Para obtener una lista de los valores admitidos, consulte el tema Custom Date and Time Format Strings en la biblioteca de MSDN.

Tipo: cadena

Obligatorio: sí

TimeZoneKind

Proporciona información sobre la zona horaria cuando no se incluye ninguna información sobre la zona horaria en la marca temporal del registro. Si este parámetro se deja en blanco y su marca temporal no incluye información sobre la zona horaria, los Registros de CloudWatch utilizan de forma predeterminada la zona horaria local. Se hace caso omiso a este parámetro si la marca temporal ya contiene información sobre la zona horaria.

Tipo: cadena

Valores válidos: Local | UTC

Requerido: no

Unidad

La unidad de medida adecuada para la métrica.

Tipo: cadena

Obligatorio: sí

`aws:configureDocker`

(Versión de esquema 2.0 o posterior) Configure una instancia para trabajar con contenedores y Docker. Este complemento es compatible con los sistemas operativos Linux y Microsoft Windows Server.

Sintaxis

Esquema 2.2

Entradas

acción

El tipo de acción que se va a realizar.

Tipo: enumeración

Valores válidos: Install | Uninstall

Obligatorio: sí

`aws:configurePackage`

(Versión de esquema 2.0 o posterior) Instale o desinstale un paquete Distributor de AWS Systems Manager. Puede instalar la versión más reciente, la versión predeterminada o una versión del paquete que especifique. Los paquetes proporcionados por AWS también son compatibles. Este complemento se ejecuta en los sistemas operativos Windows Server y Linux, pero no todos los paquetes disponibles se admiten en sistemas operativos Linux.

Los paquetes de AWS disponibles para Windows Server, incluyen lo siguiente: AWSPVDriver, AWSNVMe, AwsEnaNetworkDriver, AwsVssComponents, AmazonCloudWatchAgent, CodeDeployAgent, y AWSSupport-EC2Rescue.

Los paquetes AWS disponibles para los sistemas operativos Linux incluyen los siguientes: AmazonCloudWatchAgent, CodeDeployAgent, y AWSSupport-EC2Rescue.

Sintaxis

Esquema 2.2

Entradas

name

El nombre del paquete de AWS que se va a instalar o desinstalar. Los paquetes disponible incluyen lo siguiente: AWSPVDriver, AwsEnaNetworkDriver, AwsVssComponents, y AmazonCloudWatchAgent.

Tipo: cadena

Obligatorio: sí

acción

Instalar o desinstalar un paquete.

Tipo: enumeración

Valores válidos: Install | Uninstall

Obligatorio: sí

installationType

El tipo de instalación que se va a realizar. Si especifica Uninstall and reinstall, el paquete se desinstala por completo y, a continuación, se vuelve a instalar. La aplicación no estará disponible hasta que se complete la reinstalación. Si especifica In-place update, solo se agregan archivos nuevos o modificados a la instalación existente según las instrucciones que proporcione en un script de actualización. La aplicación permanece disponible durante todo el proceso de actualización. La opción In-place update no es compatible con paquetes publicados de AWS. Uninstall and reinstall es el valor predeterminado.

Tipo: enumeración

Valores válidos: Uninstall and reinstall | In-place update

Requerido: no

additionalArguments

Una cadena JSON con los parámetros adicionales que se deben proporcionar a los scripts de instalación, desinstalación o actualización. Cada parámetro debe tener el prefijo SSM_. Puede hacer referencia a un parámetro Parameter Store en sus argumentos adicionales mediante el uso de la convención {{ssm:parameter-name}}. Para utilizar el parámetro adicional en el script de instalación, desinstalación o actualización, debe hacer referencia al parámetro como una variable de entorno utilizando la sintaxis adecuada para el sistema operativo. Por ejemplo, en PowerShell, se hace referencia al argumento SSM_arg como $Env:SSM_arg. No hay límite en el número de argumentos que define, pero la entrada de argumento adicional tiene un límite de 4096 caracteres. Este límite incluye todas las claves y los valores que defina.

Tipo: StringMap

Requerido: no

versión

Una versión específica del paquete que se va a instalar o desinstalar. Si se va a instalar, el sistema instala la versión más reciente publicada, de forma predeterminada. Si se va a desinstalar, el sistema desinstala la versión instalada, de forma predeterminada. Si no se encuentra ninguna versión instalada, se descarga la versión más reciente publicada y se ejecuta la acción de desintalación.

Tipo: cadena

Requerido: no

`aws:domainJoin`

Unir una instancia de EC2 a un dominio. Este complemento se ejecuta en los sistemas operativos Linux y Windows Server. Este complemento cambia el nombre de host de las instancias de Linux al formato EC2AMAZ-XXXXXXX. Para obtener más información acerca de cómo unir instancias de EC2, consulte Cómo unir una instancia de EC2 al Directorio de Microsoft AD administrado de AWS en la Guía de administración de AWS Directory Service.

Sintaxis

Esquema 2.2

Esquema 1.2

Propiedades

directoryId

El ID del directorio.

Tipo: cadena

Obligatorio: sí

Ejemplo: "directoryId": "d-1234567890"

directoryName

El nombre del dominio.

Tipo: cadena

Obligatorio: sí

Ejemplo: "directoryName": "example.com"

directoryOU

La unidad organizativa.

Tipo: cadena

Requerido: no

Ejemplo: "directoryOU": "OU=test,DC=example,DC=com"

dnsIpAddresses

Las direcciones IP de los servidores DNS.

Tipo: StringList

Obligatorio: sí

Ejemplo: "dnsIpAddresses": ["198.51.100.1"," 198.51.100.2"]

Ejemplos

Para ver ejemplos, consulte Join an Amazon EC2 Instance to your AWS Managed Microsoft AD en la Guía de administración de AWS Directory Service.

`aws:downloadContent`

(Versión de esquema 2.0 o posterior) Descargue documentos y scripts de SSM de ubicaciones remotas. Los repositorios GitHub Enterprise no son compatibles. Este complemento es compatible con los sistemas operativos Linux y Microsoft Windows Server.

Sintaxis

Esquema 2.2

Entradas

sourceType

La fuente de descarga. Systems Manager admite los siguientes tipos de fuente para la descarga de scripts y documentos de SSM: GitHub, Git, HTTP, S3, y SSMDocument.

Tipo: cadena

Obligatorio: sí

sourceInfo

La información necesaria para recuperar el contenido del origen necesario.

Tipo: StringMap

Obligatorio: sí

En sourceType GitHub, especifique lo siguiente:

propietario: el propietario del repositorio.
repositorio: el nombre del repositorio.
ruta: la ruta del archivo o directorio que desea descargar.
getOptions: opciones adicionales para recuperar contenido de una rama que no sea maestra o de una confirmación específica en el repositorio. getOptions se pueden omitir si está utilizando la última confirmación en la rama maestra. Si su repositorio se creó después del 1 de octubre de 2020, la rama predeterminada podría llamarse principal en lugar de maestra. En este caso, deberá especificar valores para el parámetro getOptions.

Este parámetro utiliza el siguiente formato:
- branch:refs/heads/branch_name
  
  El valor predeterminado es master.
  
  Para especificar una ramificación no predeterminada, utilice el siguiente formato:
  
  branch:refs/heads/branch_name
- commitID:commitID
  
  El valor predeterminado es head.
  
  Para utilizar la versión del documento SSM en una confirmación que no sea la última, especifique el ID de confirmación completo. Por ejemplo:
```
"getOptions": "commitID:bbc1ddb94...b76d3bEXAMPLE",
```
tokenInfo: el parámetro de Systems Manager (un parámetro SecureString) donde almacena su información del token de acceso GitHub, en el formato {{ssm-secure:secure-string-token-name}}.

nota
Este campo tokenInfo es el único campo del complemento de documentos de SSM que admite un parámetro SecureString. Los parámetros SecureString no se admiten para ningún otro campo ni para ningún otro complemento de documentos de SSM.


{
    "owner":"TestUser",
    "repository":"GitHubTest",
    "path":"scripts/python/test-script",
    "getOptions":"branch:master",
    "tokenInfo":"{{ssm-secure:secure-string-token}}"
}

En sourceType Git, debe especificar lo siguiente:

repository

La URL del repositorio de Git al archivo o directorio que desea descargar.

Tipo: cadena

Además, puede especificar los siguientes parámetros opcionales:

getOptions

Opciones adicionales para recuperar contenido de una rama que no sea maestra o de una confirmación específica en el repositorio. getOptions se pueden omitir si está utilizando la última confirmación en la rama maestra.

Tipo: cadena

Este parámetro utiliza el siguiente formato:
- branch:refs/heads/branch_name
  
  El valor predeterminado es master.
  
  Solo se requiere "branch" si el documento SSM se almacena en una sucursal que no sea master. Por ejemplo:
```
"getOptions": "branch:refs/head/main"
```
- commitID:commitID
  
  El valor predeterminado es head.
  
  Para utilizar la versión del documento SSM en una confirmación que no sea la última, especifique el ID de confirmación completo. Por ejemplo:
```
"getOptions": "commitID:bbc1ddb94...b76d3bEXAMPLE",
```
privateSSHKey

La clave SSH que se utilizará cuando se conecte al repository que especifique. Puede utilizar el siguiente formato para hacer referencia a un parámetro SecureString para el valor de su clave SSH: {{ssm-secure:your-secure-string-parameter}}.

Tipo: cadena
skipHostKeyChecking

Determina el valor de la opción StrictHostKeyChecking cuando se conecta al repository que especifique. El valor predeterminado es false.

Tipo: Booleano
username

El nombre de usuario que se utilizará cuando se conecte al repository que especifique mediante HTTP. Puede utilizar el siguiente formato para hacer referencia a un parámetro SecureString para el valor de su nombre de usuario: {{ssm-secure:your-secure-string-parameter}}.

Tipo: cadena
password

La contraseña que se utilizará cuando se conecte al repository que especifique mediante HTTP. Puede utilizar el siguiente formato para hacer referencia a un parámetro SecureString para el valor de su contraseña: {{ssm-secure:your-secure-string-parameter}}.

Tipo: cadena

En sourceType HTTP, debe especificar lo siguiente:

url

La URL al archivo o directorio que desea descargar.

Tipo: cadena

Además, puede especificar los siguientes parámetros opcionales:

allowInsecureDownload

Determina si una descarga se puede realizar a través de una conexión que no está cifrada con Capa de conexión segura (SSL) o Transport Layer Security (TLS). El valor predeterminado es false. No le recomendamos realizar descargas sin cifrado. Si decide hacerlo, deberá asumir todos los riesgos asociados. La seguridad es una responsabilidad compartida entre AWS y usted. Se describe como el modelo de responsabilidad compartida. Para obtener más información, consulte el Modelo de responsabilidad compartida.

Tipo: Booleano
authMethod

Determina si un nombre de usuario y una contraseña se utilizan para la autenticación cuando se conecta a la url que especifique. Si especifica Basic o Digest, debe proporcionar valores para los parámetros username y password. Para utilizar el método Digest, el SSM Agent versión 3.0.1181.0 o posterior debe estar instalada en la instancia. El método Digest admite el cifrado MD5 y SHA256.

Tipo: cadena

Valores válidos: None| Basic| Digest
username

El nombre de usuario que se utilizará cuando se conecte al url que especifique mediante autenticación Basic. Puede utilizar el siguiente formato para hacer referencia a un parámetro SecureString para el valor de su nombre de usuario: {{ssm-secure:your-secure-string-parameter}}.

Tipo: cadena
password

La contraseña que se utilizará cuando se conecte al url que especifique mediante autenticación Basic. Puede utilizar el siguiente formato para hacer referencia a un parámetro SecureString para el valor de su contraseña: {{ssm-secure:your-secure-string-parameter}}.

Tipo: cadena

En sourceType S3, especifique lo siguiente:

path: la URL al archivo o directorio que desea descargar de Amazon S3.


{
    "path": "https://s3.amazonaws.com/doc-example-bucket/powershell/helloPowershell.ps1" 
}

Para sourceType SSMDocument, especifique uno de los siguientes:

nombre: el nombre y la versión del documento en el siguiente formato: name:version. La versión es opcional.
```
{
    "name": "Example-RunPowerShellScript:3" 
}
```
name: el ARN del documento en el siguiente formato: arn:aws:ssm:region:account_id:document/document_name
```
{
   "name":"arn:aws:ssm:us-east-2:3344556677:document/MySharedDoc"
}
```

destinationPath

Una ruta local opcional en la instancia en la que se desea descargar el archivo. Si no se especifica una ruta, el contenido se descarga en una ruta relativa al ID de comando.

Tipo: cadena

Requerido: no

`aws:psModule`

Instalar módulos de PowerShell en una instancia Amazon EC2. Este complemento solo se ejecuta en los sistemas operativos Windows Server.

Sintaxis

Esquema 2.2

Esquema 1.2

Propiedades

runCommand

El comando de PowerShell que se va a ejecutar tras la instalación del módulo.

Tipo: StringList

Requerido: no

source

La dirección URL o ruta local en la instancia al archivo .zip de la aplicación.

Tipo: cadena

Obligatorio: sí

sourceHash

Hash SHA256 del archivo .zip.

Tipo: cadena

Requerido: no

timeoutSeconds

El tiempo en segundos para que un comando se complete antes de considerar que se ha producido un error.

Tipo: cadena

Requerido: no

workingDirectory

La ruta al directorio de trabajo en la instancia.

Tipo: cadena

Requerido: no

`aws:refreshAssociation`

(Versión de esquema 2.0 o posterior) Actualice (fuerce aplicación) una asociación bajo demanda. Esta acción cambiará el estado del sistema en función de lo que se define en la asociación seleccionada o todas las asociaciones vinculadas a los destinos. Este complemento se ejecuta en los sistemas operativos Linux y Microsoft Windows Server.

Sintaxis

Esquema 2.2

Entradas

associationIds

Lista de ID de asociación. Si está vacía, se aplican todas las asociaciones vinculadas al destino especificado.

Tipo: StringList

Requerido: no

`aws:runDockerAction`

(Versión de esquema 2.0 o posterior) Ejecute acciones de Docker en contenedores. Este complemento se ejecuta en los sistemas operativos Linux y Microsoft Windows Server.

Sintaxis

Esquema 2.2

Entradas

acción

El tipo de acción que se va a realizar.

Tipo: cadena

Obligatorio: sí

contenedor

El ID del contenedor de Docker.

Tipo: cadena

Requerido: no

imagen

El nombre de la imagen de Docker.

Tipo: cadena

Requerido: no

cmd

El comando del contenedor.

Tipo: cadena

Requerido: no

memoria

El límite de memoria del contenedor.

Tipo: cadena

Requerido: no

cpuShares

El contenedor que comparte la CPU (peso relativo).

Tipo: cadena

Requerido: no

volume

El volumen que el contenedor monta.

Tipo: StringList

Requerido: no

env

Las variables del entorno del contenedor.

Tipo: cadena

Requerido: no

usuario

El nombre de usuario de un contenedor.

Tipo: cadena

Requerido: no

publish

Los puertos publicados del contenedor.

Tipo: cadena

Requerido: no

`aws:runDocument`

(Versión de esquema 2.0 o posterior) Ejecuta documentos de SSM almacenados en Systems Manager o en un recurso compartido local. Puede utilizar este complemento con el complemento aws:downloadContent para descargar un documento de SSM a un recurso compartido local y, a continuación, ejecutarlo. Este complemento es compatible con los sistemas operativos Linux y Microsoft Windows Server. Este complemento no admite la ejecución del documento AWS-UpdateSSMAgent o cualquier documento que utilice el complemento aws:updateSsmAgent.

Sintaxis

Esquema 2.2

Entradas

documentType

El tipo de documento que se va a ejecutar. Puede ejecutar documentos locales (LocalPath) o documentos almacenados en Systems Manager (SSMDocument).

Tipo: cadena

Obligatorio: sí

documentPath

La ruta al documento. Si documentType es LocalPath, entonces especifique la ruta al documento en el recurso compartido local. Si documentType es SSMDocument, entonces especifique el nombre del documento.

Tipo: cadena

Requerido: no

documentParameters

Parámetros para el documento.

Tipo: StringMap

Requerido: no

`aws:runPowerShellScript`

Ejecute scripts de PowerShell o especifique la ruta a un script para su ejecución. Este complemento se ejecuta en los sistemas operativos Microsoft Windows Server y Linux.

Sintaxis

Esquema 2.2

Esquema 1.2

Propiedades

runCommand

Especifique los comandos que se deben ejecutar o la ruta a un script existente en la instancia.

Tipo: StringList

Obligatorio: sí

timeoutSeconds

El tiempo en segundos para que un comando se complete antes de considerar que se ha producido un error. Cuando se alcanza el tiempo de espera, Systems Manager detiene la ejecución del comando.

Tipo: cadena

Requerido: no

workingDirectory

La ruta al directorio de trabajo en la instancia.

Tipo: cadena

Requerido: no

`aws:runShellScript`

Ejecute scripts de shell de Linux o especifique la ruta a un script para su ejecución. Este complemento solo se ejecuta en los sistemas operativos Linux.

Sintaxis

Esquema 2.2

Esquema 1.2

Propiedades

runCommand

Especifique los comandos que se deben ejecutar o la ruta a un script existente en la instancia.

Tipo: StringList

Obligatorio: sí

timeoutSeconds

El tiempo en segundos para que un comando se complete antes de considerar que se ha producido un error. Cuando se alcanza el tiempo de espera, Systems Manager detiene la ejecución del comando.

Tipo: cadena

Requerido: no

workingDirectory

La ruta al directorio de trabajo en la instancia.

Tipo: cadena

Requerido: no

`aws:softwareInventory`

(Versión de esquema 2.0 o posterior) Recopilar metadatos de aplicaciones, archivos y configuraciones de sus instancias administradas. Este complemento se ejecuta en los sistemas operativos Linux y Microsoft Windows Server. Cuando configure la recopilación de inventario, comience por crear una asociación de AWS Systems Manager State Manager. Systems Manager recopila los datos de inventario cuando se ejecuta la asociación. Si no crea la asociación en primer lugar e intenta invocar el complemento aws:softwareInventory, el sistema devolverá el siguiente error:

The aws:softwareInventory plugin can only be invoked via ssm-associate.

Una instancia solo puede tener una única asociación a inventario configurada a la vez. Si configura una instancia con dos o más asociaciones, la asociación de inventario no funciona y no se recopilan los datos de inventario. Para obtener más información acerca de la recopilación de inventario, consulte Inventario de AWS Systems Manager.

Sintaxis

Esquema 2.2

Entradas

applications

(Opcional) Recopilar metadatos para las aplicaciones instaladas.

Tipo: cadena

Requerido: no

awsComponents

(Opcional) Recopilar metadatos para componentes de AWS como amazon-ssm-agent.

Tipo: cadena

Requerido: no

files

(Opcional, requiere SSM Agent versión 2.2.64.0 o posterior) Recopilar metadatos de archivos, incluidos los nombres de archivos, la hora en que se crearon los archivos, la hora en que se modificaron y se accedió por última vez a los archivos y los tamaños de los archivos, por citar algunos. Para obtener más información acerca de la recopilación de inventario de archivos, consulte Uso del inventario de archivos y del registro de Windows.

Tipo: cadena

Requerido: no

networkConfig

(Opcional) Recopilar metadatos para las configuraciones de red.

Tipo: cadena

Requerido: no

windowsUpdates

(Opcional) Recopilar metadatos de todas las actualizaciones de Windows.

Tipo: cadena

Requerido: no

InstanceDetailedInformation

(Opcional) Recopilar más información de instancia de la que proporciona el complemento de inventario predeterminado (aws:instanceInformation), incluido el modelo de CPU, la velocidad y el número de núcleos, entre otros.

Tipo: cadena

Requerido: no

servicios

(Opcional, solo para SO Windows, requiere SSM Agent versión 2.2.64.0 o posterior) Recopilar metadatos para configuraciones de servicio.

Tipo: cadena

Requerido: no

windowsRegistry

(Opcional, solo para SO Windows, requiere SSM Agent versión 2.2.64.0 o posterior) Recopilar claves y valores de Windows Registry. Puede elegir una ruta de clave y recopilar todas las claves y valores recursivamente. También puede recopilar una clave de registro específica y su valor para una ruta específica. El inventario recopila la ruta de clave, el nombre, el tipo y el valor. Para obtener más información acerca de cómo recopilar el inventario de Windows Registry, consulte Uso del inventario de archivos y del registro de Windows.

Tipo: cadena

Requerido: no

windowsRoles

(Opcional, solo para SO Windows, requiere SSM Agent versión 2.2.64.0 o posterior) Recopilar metadatos para configuraciones de roles de Microsoft Windows.

Tipo: cadena

Requerido: no

customInventory

(Opcional) Recopilar datos de inventario personalizados. Para obtener más información acerca del inventario personalizado, consulte Uso del inventario personalizado.

Tipo: cadena

Requerido: no

`aws:updateAgent`

Actualice el servicio EC2Config a la versión más reciente o especifique una versión más antigua. Este complemento solo se ejecuta en los sistemas operativos Microsoft Windows Server. Para obtener más información acerca del servicio EC2Config, consulte Configuración de una instancia de Windows mediante el servicio EC2Config.

Sintaxis

Esquema 2.2

Esquema 1.2

Propiedades

agentName

EC2Config. Este es el nombre del agente que ejecuta el servicio EC2Config.

Tipo: cadena

Obligatorio: sí

allowDowngrade

Permita el cambio del servicio EC2Config a una versión anterior. Si se establece en "false", el servicio solo se puede actualizar a versiones más recientes (predeterminado). Si se establece en "true", especifique la versión anterior.

Tipo: Booleano

Requerido: no

source

La ubicación donde Systems Manager copia la versión de EC2Config que se va a instalar. No se puede cambiar esta ubicación.

Tipo: cadena

Obligatorio: sí

targetVersion

Una versión específica del servicio EC2Config que se va a instalar. Si no se especifica, el servicio se actualizará a la versión más reciente.

Tipo: cadena

Requerido: no

`aws:updateSsmAgent`

Actualice el SSM Agent a la versión más reciente o especifique una versión más antigua. Este complemento se ejecuta en los sistemas operativos Linux y Windows Server. Para obtener más información, consulte Uso de SSM Agent.

Sintaxis

Esquema 2.2

Esquema 1.2

Propiedades

agentName

amazon-ssm-agent. Este es el nombre del agente de Systems Manager que procesa las solicitudes y ejecuta los comandos en la instancia.

Tipo: cadena

Obligatorio: sí

allowDowngrade

Permita el cambio del SSM Agent a una versión anterior. Si se establece en "false", el agente solo se puede actualizar a versiones más recientes (predeterminado). Si se establece en "true", especifique la versión anterior.

Tipo: Booleano

Obligatorio: sí

source

La ubicación donde Systems Manager copia la versión del SSM Agent que se va a instalar. No se puede cambiar esta ubicación.

Tipo: cadena

Obligatorio: sí

targetVersion

Versión concreta del SSM Agent que se va a instalar. Si no se especifica, el agente se actualizará a la versión más reciente.

Tipo: cadena

Obligatorio: no

Aviso JavaScript está desactivado o no está disponible en su navegador.

Para utilizar la documentación de AWS, debe estar habilitado JavaScript. Para obtener más información, consulte las páginas de ayuda de su navegador.

Convenciones del documento

Elementos y parámetros de datos

Crear contenido en el documento de SSM

Referencia de complementos del documento de comandos

nota

Contenidos

Entradas compartidas

aws:applications

Sintaxis

Esquema 2.2

Esquema 1.2

Propiedades

aws:cloudWatch

importante

aviso

nota

Sintaxis

Configuración y propiedades

nota

nota

aws:configureDocker

Sintaxis

Esquema 2.2

Entradas

aws:configurePackage

Sintaxis

Esquema 2.2

Entradas

aws:domainJoin

Sintaxis

Esquema 2.2

Esquema 1.2

Propiedades

Ejemplos

aws:downloadContent

Sintaxis

Esquema 2.2

Entradas

nota

aws:psModule

Sintaxis

Esquema 2.2

Esquema 1.2

Propiedades

aws:refreshAssociation

Sintaxis

Esquema 2.2

Entradas

aws:runDockerAction

Sintaxis

Esquema 2.2

Entradas

aws:runDocument

Sintaxis

Esquema 2.2

Entradas

aws:runPowerShellScript

Sintaxis

Esquema 2.2

Esquema 1.2

Propiedades

aws:runShellScript

Sintaxis

Esquema 2.2

Esquema 1.2

Propiedades

aws:softwareInventory

Sintaxis

Esquema 2.2

Entradas

aws:updateAgent

Sintaxis

Esquema 2.2

Esquema 1.2

Propiedades

aws:updateSsmAgent

Sintaxis

Esquema 2.2

Esquema 1.2

Propiedades

`aws:applications`

`aws:cloudWatch`

`aws:configureDocker`

`aws:configurePackage`

`aws:domainJoin`

`aws:downloadContent`

`aws:psModule`

`aws:refreshAssociation`

`aws:runDockerAction`

`aws:runDocument`

`aws:runPowerShellScript`

`aws:runShellScript`

`aws:softwareInventory`

`aws:updateAgent`

`aws:updateSsmAgent`