• El panel de AWS Systems Manager CloudWatch dejará de estar disponible después del 30 de abril de 2026. Los clientes pueden seguir utilizando la consola de Amazon CloudWatch para ver, crear y administrar sus paneles de Amazon CloudWatch, tal y como lo hacen actualmente. Para obtener más información, consulte la [documentación del panel de Amazon CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html). 

# Referencia de complementos del documento de comandos
<a name="documents-command-ssm-plugin-reference"></a>

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](automation-actions.md).

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](documents.md).

En el caso de los complementos que aceptan parámetros de cadena, como `aws:runShellScript` y `aws:runPowerShellScript`, el parámetro `interpolationType` se puede utilizar para mejorar la seguridad al tratar las entradas de los parámetros como cadenas literales en lugar de comandos potencialmente ejecutables. Por ejemplo:

```
{
    "schemaVersion": "2.2",
    "description": "runShellScript with command strings stored as Parameter Store parameter",
    "parameters": {
      "commands": {
        "type": "StringList",
        "description": "(Required) The commands to run on the instance.",
        "default": ["{{ ssm:myShellCommands }}"],
        "interpolationType" : "ENV_VAR"
      }
    },
    //truncated
 }
```

**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`

**Topics**
+ [Entradas compartidas](#shared-inputs)
+ [`aws:applications`](#aws-applications)
+ [`aws:cloudWatch`](#aws-cloudWatch)
+ [`aws:configureDocker`](#aws-configuredocker)
+ [`aws:configurePackage`](#aws-configurepackage)
+ [`aws:domainJoin`](#aws-domainJoin)
+ [`aws:downloadContent`](#aws-downloadContent)
+ [`aws:psModule`](#aws-psModule)
+ [`aws:refreshAssociation`](#aws-refreshassociation)
+ [`aws:runDockerAction`](#aws-rundockeraction)
+ [`aws:runDocument`](#aws-rundocument)
+ [`aws:runPowerShellScript`](#aws-runPowerShellScript)
+ [`aws:runShellScript`](#aws-runShellScript)
+ [`aws:softwareInventory`](#aws-softwareinventory)
+ [`aws:updateAgent`](#aws-updateagent)
+ [`aws:updateSsmAgent`](#aws-updatessmagent)

## Entradas compartidas
<a name="shared-inputs"></a>

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` \$1 `false`  
Obligatorio: 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` \$1 `successAndExit`  
Obligatorio: 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`  
Obligatorio: 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`
<a name="aws-applications"></a>

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

### Sintaxis
<a name="applications-syntax"></a>

#### Esquema 2.2
<a name="applications-syntax-2.2"></a>

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: aws:applications plugin
parameters:
  source:
    description: "(Required) Source of msi."
    type: String
mainSteps:
- action: aws:applications
  name: example
  inputs:
    action: Install
    source: "{{ source }}"
```

------
#### [ JSON ]

```
{
  "schemaVersion":"2.2",
  "description":"aws:applications",
  "parameters":{
    "source":{
    "description":"(Required) Source of msi.",
    "type":"String"
    }
  },
  "mainSteps":[
    {
      "action":"aws:applications",
      "name":"example",
      "inputs":{
        "action":"Install",
        "source":"{{ source }}"
      }
    }
  ]
}
```

------

#### Esquema 1.2
<a name="applications-syntax-1.2"></a>

------
#### [ YAML ]

```
---
runtimeConfig:
  aws:applications:
    properties:
    - id: 0.aws:applications
      action: "{{ action }}"
      parameters: "{{ parameters }}"
      source: "{{ source }}"
      sourceHash: "{{ sourceHash }}"
```

------
#### [ JSON ]

```
{
   "runtimeConfig":{
      "aws:applications":{
         "properties":[
            {
               "id":"0.aws:applications",
               "action":"{{ action }}",
               "parameters":"{{ parameters }}",
               "source":"{{ source }}",
               "sourceHash":"{{ sourceHash }}"
            }
         ]
      }
   }
}
```

------

### Propiedades
<a name="applications-properties"></a>

**acción**  
La acción que hay que realizar.  
Tipo: enumeración  
Valores válidos: `Install` \$1 `Repair` \$1 `Uninstall`  
Obligatorio: sí

**parameters**  
Los parámetros para el instalador.  
Tipo: cadena  
Requerido: no

**origen**  
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`
<a name="aws-cloudWatch"></a>

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 sobre cómo configurar la integración de CloudWatch con Amazon Elastic Compute Cloud (Amazon EC2), consulte [Recopilación de métricas, registros y seguimientos con el agente de CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Install-CloudWatch-Agent.html) en la *Guía del usuario de Amazon 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:  
[Envío de registros de nodos a los Registros de CloudWatch (agente de CloudWatch) unificado](monitoring-cloudwatch-agent.md)
[Migrar la recopilación de registros del nodo de Windows Server al agente de CloudWatch](monitoring-cloudwatch-agent.md#monitoring-cloudwatch-agent-migrate)
[Recopilación de métricas, registros y seguimientos con el agente de CloudWatch](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Install-CloudWatch-Agent.html) en la *Guía del usuario de Amazon CloudWatch*.

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.  
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.  
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
<a name="cloudWatch-syntax"></a>

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

### Configuración y propiedades
<a name="cloudWatch-properties"></a>

**AccessKey**  
ID de clave de acceso. 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)]](https://msdn.microsoft.com/en-us/library/cc233982.aspx) en el sitio web de Microsoft. No se admiten los valores **div**, **div-MV**, **hu** ni **hu-HU**.  
Obligatorio: 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](https://learn.microsoft.com/en-us/dotnet/api/system.text.encoding?view=net-7.0) 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](http://msdn.microsoft.com/en-us/library/system.io.filesystemwatcher.filter.aspx) en la biblioteca de MSDN.  
Obligatorio: 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  
Valores válidos (origen): `ApplicationEventLog` \$1 `CustomLogs` \$1 `ETW` \$1 `PerformanceCounter` \$1 `SystemEventLog` \$1 `SecurityEventLog`   
Los valores válidos (destino): `CloudWatch` \$1 `CloudWatchLogs` \$1 `CloudWatch`*n* \$1 `CloudWatchLogs`*n*   
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 (\$1) para indicar todas las instancias, porque cada componente de contador de rendimiento solo admite una métrica. Puede, sin embargo utilizar **\$1Total**.  
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í  
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  
Obligatorio: 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:\$1\$1inetpub\$1\$1logs\$1\$1LogFiles\$1\$1W3SVC*n***). 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 registro. 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.  

1. Para encontrar el nombre del registro, en Visor de eventos, en el panel de navegación, seleccione **Registros de aplicaciones y servicios**.

1. En la lista de registros, haga clic con el botón derecho en el registro que desea cargar (por ejemplo, `Microsoft` > `Windows` > `Backup` > `Operational`) y, a continuación, seleccione **Crear vista personalizada**.

1. 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` \$1 `Security` \$1 `System` \$1 `Microsoft-Windows-WinINet/Analytic`  
Obligatorio: sí

**LogStream**  
El flujo de registros de destino. Si utiliza **\$1instance\$1id\$1**, 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}` \$1 `{hostname}` \$1 `{ip_address}`*<log\$1stream\$1name>*  
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 (**\$1instance\$1id\$1**, **\$1hostname\$1**, **\$1ip\$1address\$1**), 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.  
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: número 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](https://docs.aws.amazon.com/general/latest/gr/cwl_region.html#cwl_region) y [Puntos de conexión de servicio de Systems Manager](https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region) en la *Referencia general de Amazon Web Services*.   
Obligatorio: sí

**SecretKey**  
Clave de acceso secreta. 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` \$1 `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](http://msdn.microsoft.com/en-us/library/8kb3ddd4.aspx) 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` \$1 `UTC`  
Obligatorio: no

**Unidad**  
La unidad de medida adecuada para la métrica.  
Tipo: cadena  
Valores válidos: segundos \$1 microsegundos \$1 milisegundos \$1 bytes \$1 kilobytes \$1 megabytes \$1 gigabytes \$1 terabytes \$1 bits \$1 kilobits \$1 megabits \$1 gigabits \$1 terabits \$1 porcentaje \$1 recuento \$1 bytes/segundo \$1 kilobytes/segundo \$1 megabytes/segundo \$1 gigabytes/segundo \$1 terabytes/segundo \$1 bits/segundo \$1 kilobits/segundo \$1 megabits/segundo \$1 gigabits/segundo \$1 terabits/segundo \$1 recuento/segundo o ninguno  
Obligatorio: sí

## `aws:configureDocker`
<a name="aws-configuredocker"></a>

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

### Sintaxis
<a name="configuredocker-syntax"></a>

#### Esquema 2.2
<a name="configuredocker-syntax-2.2"></a>

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: aws:configureDocker
parameters:
  action:
    description: "(Required) The type of action to perform."
    type: String
    default: Install
    allowedValues:
    - Install
    - Uninstall
mainSteps:
- action: aws:configureDocker
  name: configureDocker
  inputs:
    action: "{{ action }}"
```

------
#### [ JSON ]

```
{
  "schemaVersion": "2.2",
  "description": "aws:configureDocker plugin",
  "parameters": {
    "action": {
      "description": "(Required) The type of action to perform.",
      "type": "String",
      "default": "Install",
      "allowedValues": [
        "Install",
        "Uninstall"
      ]
    }
  },
  "mainSteps": [
    {
      "action": "aws:configureDocker",
      "name": "configureDocker",
      "inputs": {
        "action": "{{ action }}"
      }
    }
  ]
}
```

------

### Entradas
<a name="configuredocker-properties"></a>

**acción**  
El tipo de acción que se va a realizar.  
Tipo: enumeración  
Valores válidos: `Install` \$1 `Uninstall`  
Obligatorio: sí

## `aws:configurePackage`
<a name="aws-configurepackage"></a>

(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
<a name="configurepackage-syntax"></a>

#### Esquema 2.2
<a name="configurepackage-syntax-2.2"></a>

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: aws:configurePackage
parameters:
  name:
    description: "(Required) The name of the AWS package to install or uninstall."
    type: String
  action:
    description: "(Required) The type of action to perform."
    type: String
    default: Install
    allowedValues:
    - Install
    - Uninstall
  ssmParameter:
    description: "(Required) Argument stored in Parameter Store."
    type: String
    default: "{{ ssm:parameter_store_arg }}"
mainSteps:
- action: aws:configurePackage
  name: configurePackage
  inputs:
    name: "{{ name }}"
    action: "{{ action }}"
    additionalArguments: 
      "{\"SSM_parameter_store_arg\": \"{{ ssmParameter }}\", \"SSM_custom_arg\": \"myValue\"}"
```

------
#### [ JSON ]

```
{
   "schemaVersion": "2.2",
   "description": "aws:configurePackage",
   "parameters": {
      "name": {
         "description": "(Required) The name of the AWS package to install or uninstall.",
         "type": "String"
      },
      "action": {
         "description": "(Required) The type of action to perform.",
         "type": "String",
         "default": "Install",
         "allowedValues": [
            "Install",
            "Uninstall"
         ]
      },
      "ssmParameter": {
         "description": "(Required) Argument stored in Parameter Store.",
         "type": "String",
         "default": "{{ ssm:parameter_store_arg }}"
      }
   },
   "mainSteps": [
      {
         "action": "aws:configurePackage",
         "name": "configurePackage",
         "inputs": {
            "name": "{{ name }}",
            "action": "{{ action }}",
            "additionalArguments": "{\"SSM_parameter_store_arg\": \"{{ ssmParameter }}\", \"SSM_custom_arg\": \"myValue\"}"
         }
      }
   ]
}
```

------

### Entradas
<a name="configurepackage-properties"></a>

**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` \$1 `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` \$1 `In-place update`  
Obligatorio: 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  
Obligatorio: 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`
<a name="aws-domainJoin"></a>

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](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ms_ad_join_instance.html) en la *Guía de administración de AWS Directory Service*.

### Sintaxis
<a name="domainJoin-syntax"></a>

#### Esquema 2.2
<a name="domainJoin-syntax-2.2"></a>

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: aws:domainJoin
parameters:
  directoryId:
    description: "(Required) The ID of the directory."
    type: String
  directoryName:
    description: "(Required) The name of the domain."
    type: String
  directoryOU:
    description: "(Optional) The organizational unit to assign the computer object to."
    type: String
  dnsIpAddresses:
    description: "(Required) The IP addresses of the DNS servers for your directory."
    type: StringList
  hostname:
    description: "(Optional) The hostname you want to assign to the node."
    type: String
mainSteps:
- action: aws:domainJoin
  name: domainJoin
  inputs:
    directoryId: "{{ directoryId }}"
    directoryName: "{{ directoryName }}"
    directoryOU: "{{ directoryOU }}"
    dnsIpAddresses: "{{ dnsIpAddresses }}"
    hostname: "{{ hostname }}"
```

------
#### [ JSON ]

```
{
  "schemaVersion": "2.2",
  "description": "aws:domainJoin",
  "parameters": {
    "directoryId": {
      "description": "(Required) The ID of the directory.",
      "type": "String"
    },
    "directoryName": {
      "description": "(Required) The name of the domain.",
      "type": "String"
    },
    "directoryOU": {
        "description": "(Optional) The organizational unit to assign the computer object to.",
        "type": "String"
      },
    "dnsIpAddresses": {
      "description": "(Required) The IP addresses of the DNS servers for your directory.",
      "type": "StringList"
    },
    "hostname": {
        "description": "(Optional) The hostname you want to assign to the node.",
        "type": "String"
      }
  },
  "mainSteps": [
    {
      "action": "aws:domainJoin",
      "name": "domainJoin",
      "inputs": {
        "directoryId": "{{ directoryId }}",
        "directoryName": "{{ directoryName }}",
        "directoryOU":"{{ directoryOU }}",
        "dnsIpAddresses":"{{ dnsIpAddresses }}",
        "hostname":"{{ hostname }}"
      }
    }
  ]
}
```

------

#### Esquema 1.2
<a name="domainJoin-syntax-1.2"></a>

------
#### [ YAML ]

```
---
runtimeConfig:
  aws:domainJoin:
    properties:
      directoryId: "{{ directoryId }}"
      directoryName: "{{ directoryName }}"
      directoryOU: "{{ directoryOU }}"
      dnsIpAddresses: "{{ dnsIpAddresses }}"
```

------
#### [ JSON ]

```
{
   "runtimeConfig":{
      "aws:domainJoin":{
         "properties":{
            "directoryId":"{{ directoryId }}",
            "directoryName":"{{ directoryName }}",
            "directoryOU":"{{ directoryOU }}",
            "dnsIpAddresses":"{{ dnsIpAddresses }}"
         }
      }
   }
}
```

------

### Propiedades
<a name="domainJoin-properties"></a>

**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"]

**hostname**  
El nombre de host que desea asignar al nodo. Si no se proporciona, no se cambiará el nombre de las instancias de Windows Server, mientras que las instancias de Linux utilizarán el patrón de nomenclatura predeterminado. Si se proporciona, las instancias de Windows Server usarán el valor exacto proporcionado, mientras que, para las instancias de Linux, este servirá como prefijo (a menos que `keepHostName` se establezca como “true”).  
Tipo: cadena  
Requerido: no

**keepHostName**  
Determina si se cambia el nombre de host de las instancias de Linux cuando se unen al dominio. Este es un parámetro exclusivo de Linux. Los nombres de los hosts de Linux se cambiarán de forma predeterminada (sin entradas para `hostname`, `hostnameNumAppendDigits` y con `keepHostName` como “false”) siguiendo el patrón EC2AMAZ-XXXXXX. Cuando se establece como “true”, mantiene el nombre de host original e ignora las entradas para `hostname` y `hostnameNumAppendDigits`.  
Tipo: Booleano  
Obligatorio: no

**hostnameNumAppendDigits**  
Define el número de dígitos numéricos aleatorios que se añadirán después del valor del nombre de host. Este es un parámetro exclusivo de Linux y se utiliza junto con el parámetro `hostname`. Se ignora si no se proporciona el `hostname`.  
Tipo: cadena  
Valores permitidos: de 1 a 5  
Obligatorio: no

### Ejemplos
<a name="domainJoin-examples"></a>

Para ver ejemplos, consulte [Join an Amazon EC2 Instance to your AWS Managed Microsoft AD](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ec2-join-aws-domain.html) en la *Guía de administración de AWS Directory Service*.

## `aws:downloadContent`
<a name="aws-downloadContent"></a>

(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
<a name="downloadContent-syntax"></a>

#### Esquema 2.2
<a name="downloadContent-syntax-2.2"></a>

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: aws:downloadContent
parameters:
  sourceType:
    description: "(Required) The download source."
    type: String
  sourceInfo:
    description: "(Required) The information required to retrieve the content from
      the required source."
    type: StringMap
mainSteps:
- action: aws:downloadContent
  name: downloadContent
  inputs:
    sourceType: "{{ sourceType }}"
    sourceInfo: "{{ sourceInfo }}"
```

------
#### [ JSON ]

```
{
  "schemaVersion": "2.2",
  "description": "aws:downloadContent",
  "parameters": {
    "sourceType": {
    "description": "(Required) The download source.",
    "type": "String"
  },
  "sourceInfo": {
    "description": "(Required) The information required to retrieve the content from the required source.",
    "type": "StringMap"
    }
  },
  "mainSteps": [
    {
      "action": "aws:downloadContent",
      "name": "downloadContent",
      "inputs": {
        "sourceType":"{{ sourceType }}",
        "sourceInfo":"{{ sourceInfo }}"
      }
    }
  ]
}
```

------

### Entradas
<a name="downloadContent-inputs"></a>

**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í  
 **Para 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\$1name*

    El valor predeterminado es `master`.

    Para especificar una ramificación no predeterminada, utilice el siguiente formato:

    branch:refs/heads/*branch\$1name*
  + 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}}"
}
```
 **Para sourceType `Git`, debe especificar lo siguiente:**   
+ repositorio

  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\$1name*

    El valor predeterminado es `master`.

    `"branch"` Solo se requiere si el documento SSM se almacena en una sucursal que no sea `master`. Por ejemplo:

    ```
    "getOptions": "branch:refs/heads/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
+ nombre de usuario

  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
+ contraseña

  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
 **Para 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](https://aws.amazon.com/compliance/shared-responsibility-model/).

  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` \$1 `Basic` \$1 `Digest`
+ nombre de usuario

  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
+ contraseña

  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
 **Para sourceType `S3`, especifique lo siguiente:**   
+ path: la URL al archivo o directorio que desea descargar de Amazon S3.
Cuando se descarga un archivo de un bucket de S3, se generan los archivos .etag en el directorio de descargas.

```
{
    "path": "https://s3.amazonaws.com/amzn-s3-demo-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`
<a name="aws-psModule"></a>

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

### Sintaxis
<a name="psModule-syntax"></a>

#### Esquema 2.2
<a name="psModule-syntax-2.2"></a>

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: aws:psModule
parameters:
  source:
    description: "(Required) The URL or local path on the instance to the application
      .zip file."
    type: String
mainSteps:
- action: aws:psModule
  name: psModule
  inputs:
    source: "{{ source }}"
```

------
#### [ JSON ]

```
{
  "schemaVersion": "2.2",
  "description": "aws:psModule",
  "parameters": {
    "source": {
      "description": "(Required) The URL or local path on the instance to the application .zip file.",
      "type": "String"
    }
  },
  "mainSteps": [
    {
      "action": "aws:psModule",
      "name": "psModule",
      "inputs": {
        "source": "{{ source }}"
      }
    }
  ]
}
```

------

#### Esquema 1.2
<a name="domainJoin-syntax-1.2"></a>

------
#### [ YAML ]

```
---
runtimeConfig:
  aws:psModule:
    properties:
    - runCommand: "{{ commands }}"
      source: "{{ source }}"
      sourceHash: "{{ sourceHash }}"
      workingDirectory: "{{ workingDirectory }}"
      timeoutSeconds: "{{ executionTimeout }}"
```

------
#### [ JSON ]

```
{
   "runtimeConfig":{
      "aws:psModule":{
         "properties":[
            {
               "runCommand":"{{ commands }}",
               "source":"{{ source }}",
               "sourceHash":"{{ sourceHash }}",
               "workingDirectory":"{{ workingDirectory }}",
               "timeoutSeconds":"{{ executionTimeout }}"
            }
         ]
      }
   }
}
```

------

### Propiedades
<a name="psModule-properties"></a>

**runCommand**  
El comando de PowerShell que se va a ejecutar tras la instalación del módulo.  
Tipo: StringList  
Obligatorio: no

**origen**  
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`
<a name="aws-refreshassociation"></a>

(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
<a name="refreshassociation-syntax"></a>

#### Esquema 2.2
<a name="refreshassociation-syntax-2.2"></a>

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: aws:refreshAssociation
parameters:
  associationIds:
    description: "(Optional) List of association IDs. If empty, all associations bound
      to the specified target are applied."
    type: StringList
mainSteps:
- action: aws:refreshAssociation
  name: refreshAssociation
  inputs:
    associationIds:
    - "{{ associationIds }}"
```

------
#### [ JSON ]

```
{
  "schemaVersion": "2.2",
  "description": "aws:refreshAssociation",
  "parameters": {
    "associationIds": {
      "description": "(Optional) List of association IDs. If empty, all associations bound to the specified target are applied.",
      "type": "StringList"
    }
  },
  "mainSteps": [
    {
      "action": "aws:refreshAssociation",
      "name": "refreshAssociation",
      "inputs": {
        "associationIds": [
          "{{ associationIds }}"
        ]
      }
    }
  ]
}
```

------

### Entradas
<a name="refreshassociation-properties"></a>

**associationIds**  
Lista de ID de asociación. Si está vacía, se aplican todas las asociaciones vinculadas al destino especificado.  
Tipo: StringList  
Obligatorio: no

## `aws:runDockerAction`
<a name="aws-rundockeraction"></a>

(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
<a name="rundockeraction-syntax"></a>

#### Esquema 2.2
<a name="rundockeraction-syntax-2.2"></a>

------
#### [ YAML ]

```
---
mainSteps:
- action: aws:runDockerAction
  name: RunDockerAction
  inputs:
    action: "{{ action }}"
    container: "{{ container }}"
    image: "{{ image }}"
    memory: "{{ memory }}"
    cpuShares: "{{ cpuShares }}"
    volume: "{{ volume }}"
    cmd: "{{ cmd }}"
    env: "{{ env }}"
    user: "{{ user }}"
    publish: "{{ publish }}"
    workingDirectory: "{{ workingDirectory }}"
    timeoutSeconds: "{{ timeoutSeconds }}"
```

------
#### [ JSON ]

```
{
   "mainSteps":[
      {
         "action":"aws:runDockerAction",
         "name":"RunDockerAction",
         "inputs":{
            "action":"{{ action }}",
            "container":"{{ container }}",
            "image":"{{ image }}",
            "memory":"{{ memory }}",
            "cpuShares":"{{ cpuShares }}",
            "volume":"{{ volume }}",
            "cmd":"{{ cmd }}",
            "env":"{{ env }}",
            "user":"{{ user }}",
            "publish":"{{ publish }}",
            "workingDirectory": "{{ workingDirectory }}",
            "timeoutSeconds": "{{ timeoutSeconds }}"
         }
      }
   ]
}
```

------

### Entradas
<a name="rundockeraction-properties"></a>

**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  
Obligatorio: 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

**workingDirectory**  
La ruta al directorio de trabajo en el nodo administrado.  
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

## `aws:runDocument`
<a name="aws-rundocument"></a>

(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`](#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
<a name="rundocument-syntax"></a>

#### Esquema 2.2
<a name="aws-rundocument-syntax-2.2"></a>

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: aws:runDocument
parameters:
  documentType:
    description: "(Required) The document type to run."
    type: String
    allowedValues:
    - LocalPath
    - SSMDocument
mainSteps:
- action: aws:runDocument
  name: runDocument
  inputs:
    documentType: "{{ documentType }}"
```

------
#### [ JSON ]

```
{
  "schemaVersion": "2.2",
  "description": "aws:runDocument",
  "parameters": {
    "documentType": {
      "description": "(Required) The document type to run.",
      "type": "String",
      "allowedValues": [
        "LocalPath",
        "SSMDocument"
      ]
    }
  },
  "mainSteps": [
    {
      "action": "aws:runDocument",
      "name": "runDocument",
      "inputs": {
        "documentType": "{{ documentType }}"
      }
    }
  ]
}
```

------

### Entradas
<a name="rundocument-properties"></a>

**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  
Obligatorio: no

## `aws:runPowerShellScript`
<a name="aws-runPowerShellScript"></a>

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
<a name="runPowerShellScript-syntax"></a>

#### Esquema 2.2
<a name="runPowerShellScript-syntax-2.2"></a>

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: aws:runPowerShellScript
parameters:
  commands:
    type: String
    description: "(Required) The commands to run or the path to an existing script
      on the instance."
    default: Write-Host "Hello World"
mainSteps:
- action: aws:runPowerShellScript
  name: runPowerShellScript
  inputs:
    timeoutSeconds: '60'
    runCommand:
    - "{{ commands }}"
```

------
#### [ JSON ]

```
{
  "schemaVersion": "2.2",
  "description": "aws:runPowerShellScript",
  "parameters": {
    "commands": {
      "type": "String",
      "description": "(Required) The commands to run or the path to an existing script on the instance.",
      "default": "Write-Host \"Hello World\""
    }
  },
  "mainSteps": [
    {
      "action": "aws:runPowerShellScript",
      "name": "runPowerShellScript",
      "inputs": {
        "timeoutSeconds": "60",
        "runCommand": [
          "{{ commands }}"
        ]
      }
    }
  ]
}
```

------

#### Esquema 1.2
<a name="runPowerShellScript-syntax-1.2"></a>

------
#### [ YAML ]

```
---
runtimeConfig:
  aws:runPowerShellScript:
    properties:
    - id: 0.aws:runPowerShellScript
      runCommand: "{{ commands }}"
      workingDirectory: "{{ workingDirectory }}"
      timeoutSeconds: "{{ executionTimeout }}"
```

------
#### [ JSON ]

```
{
   "runtimeConfig":{
      "aws:runPowerShellScript":{
         "properties":[
            {
               "id":"0.aws:runPowerShellScript",
               "runCommand":"{{ commands }}",
               "workingDirectory":"{{ workingDirectory }}",
               "timeoutSeconds":"{{ executionTimeout }}"
            }
         ]
      }
   }
}
```

------

### Propiedades
<a name="runPowerShellScript-properties"></a>

**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`
<a name="aws-runShellScript"></a>

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
<a name="runShellScript-syntax"></a>

#### Esquema 2.2
<a name="runShellScript-syntax-2.2"></a>

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: aws:runShellScript
parameters:
  commands:
    type: String
    description: "(Required) The commands to run or the path to an existing script
      on the instance."
    default: echo Hello World
mainSteps:
- action: aws:runShellScript
  name: runShellScript
  inputs:
    timeoutSeconds: '60'
    runCommand:
    - "{{ commands }}"
```

------
#### [ JSON ]

```
{
  "schemaVersion": "2.2",
  "description": "aws:runShellScript",
  "parameters": {
    "commands": {
      "type": "String",
      "description": "(Required) The commands to run or the path to an existing script on the instance.",
      "default": "echo Hello World"
    }
  },
  "mainSteps": [
    {
      "action": "aws:runShellScript",
      "name": "runShellScript",
      "inputs": {
        "timeoutSeconds": "60",
        "runCommand": [
          "{{ commands }}"
        ]
      }
    }
  ]
}
```

------

#### Esquema 1.2
<a name="runShellScript-syntax-1.2"></a>

------
#### [ YAML ]

```
---
runtimeConfig:
  aws:runShellScript:
    properties:
    - runCommand: "{{ commands }}"
      workingDirectory: "{{ workingDirectory }}"
      timeoutSeconds: "{{ executionTimeout }}"
```

------
#### [ JSON ]

```
{
   "runtimeConfig":{
      "aws:runShellScript":{
         "properties":[
            {
               "runCommand":"{{ commands }}",
               "workingDirectory":"{{ workingDirectory }}",
               "timeoutSeconds":"{{ executionTimeout }}"
            }
         ]
      }
   }
}
```

------

### Propiedades
<a name="runShellScript-properties"></a>

**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`
<a name="aws-softwareinventory"></a>

(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](systems-manager-inventory.md).

### Sintaxis
<a name="softwareinventory-syntax"></a>

#### Esquema 2.2
<a name="softwareinventory-syntax-2.2"></a>

------
#### [ YAML ]

```
---
mainSteps:
- action: aws:softwareInventory
  name: collectSoftwareInventoryItems
  inputs:
    applications: "{{ applications }}"
    awsComponents: "{{ awsComponents }}"
    networkConfig: "{{ networkConfig }}"
    files: "{{ files }}"
    services: "{{ services }}"
    windowsRoles: "{{ windowsRoles }}"
    windowsRegistry: "{{ windowsRegistry}}"
    windowsUpdates: "{{ windowsUpdates }}"
    instanceDetailedInformation: "{{ instanceDetailedInformation }}"
    customInventory: "{{ customInventory }}"
```

------
#### [ JSON ]

```
{
   "mainSteps":[
      {
         "action":"aws:softwareInventory",
         "name":"collectSoftwareInventoryItems",
         "inputs":{
            "applications":"{{ applications }}",
            "awsComponents":"{{ awsComponents }}",
            "networkConfig":"{{ networkConfig }}",
            "files":"{{ files }}",
            "services":"{{ services }}",
            "windowsRoles":"{{ windowsRoles }}",
            "windowsRegistry":"{{ windowsRegistry}}",
            "windowsUpdates":"{{ windowsUpdates }}",
            "instanceDetailedInformation":"{{ instanceDetailedInformation }}",
            "customInventory":"{{ customInventory }}"
         }
      }
   ]
}
```

------

### Entradas
<a name="softwareinventory-properties"></a>

**aplicaciones**  
(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](inventory-file-and-registry.md).  
Tipo: cadena  
Requerido: no

**networkConfig**  
(Opcional) Recopilar metadatos para las configuraciones de red.  
Tipo: cadena  
Requerido: no

**billingInfo**  
(Opcional) Recopile metadatos para los detalles de la plataforma asociados con el código de facturación de la AMI.  
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](inventory-file-and-registry.md).  
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](inventory-custom.md)  
Tipo: cadena  
Requerido: no

**customInventoryDirectory**  
(Opcional) Recopile datos de inventario personalizados desde el directorio especificado. Para obtener más información acerca del inventario personalizado, consulte . [Uso del inventario personalizado](inventory-custom.md)  
Tipo: cadena  
Requerido: no

## `aws:updateAgent`
<a name="aws-updateagent"></a>

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 sobre el servicio EC2Config, consulte [Configuración de una instancia de Windows mediante el servicio EC2Config (heredado)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2config-service.html) en la *Guía del usuario de Amazon EC2*.

### Sintaxis
<a name="updateagent-syntax"></a>

#### Esquema 2.2
<a name="updateagent-syntax-2.2"></a>

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: aws:updateAgent
mainSteps:
- action: aws:updateAgent
  name: updateAgent
  inputs:
    agentName: Ec2Config
    source: https://s3.{Region}.amazonaws.com/aws-ssm-{Region}/manifest.json
```

------
#### [ JSON ]

```
{
  "schemaVersion": "2.2",
  "description": "aws:updateAgent",
  "mainSteps": [
    {
      "action": "aws:updateAgent",
      "name": "updateAgent",
      "inputs": {
        "agentName": "Ec2Config",
        "source": "https://s3.{Region}.amazonaws.com/aws-ssm-{Region}/manifest.json"
      }
    }
  ]
}
```

------

#### Esquema 1.2
<a name="updateagent-syntax-1.2"></a>

------
#### [ YAML ]

```
---
runtimeConfig:
  aws:updateAgent:
    properties:
      agentName: Ec2Config
      source: https://s3.{Region}.amazonaws.com/aws-ssm-{Region}/manifest.json
      allowDowngrade: "{{ allowDowngrade }}"
      targetVersion: "{{ version }}"
```

------
#### [ JSON ]

```
{
   "runtimeConfig":{
      "aws:updateAgent":{
         "properties":{
            "agentName":"Ec2Config",
            "source":"https://s3.{Region}.amazonaws.com/aws-ssm-{Region}/manifest.json",
            "allowDowngrade":"{{ allowDowngrade }}",
            "targetVersion":"{{ version }}"
         }
      }
   }
}
```

------

### Propiedades
<a name="updateagent-properties"></a>

**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  
Obligatorio: no

**origen**  
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`
<a name="aws-updatessmagent"></a>

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](ssm-agent.md). 

### Sintaxis
<a name="updateSSMagent-syntax"></a>

#### Esquema 2.2
<a name="updateaSSMgent-syntax-2.2"></a>

------
#### [ YAML ]

```
---
schemaVersion: '2.2'
description: aws:updateSsmAgent
parameters:
  allowDowngrade:
    default: 'false'
    description: "(Optional) Allow the Amazon SSM Agent service to be downgraded to
      an earlier version. If set to false, the service can be upgraded to newer versions
      only (default). If set to true, specify the earlier version."
    type: String
    allowedValues:
    - 'true'
    - 'false'
mainSteps:
- action: aws:updateSsmAgent
  name: updateSSMAgent
  inputs:
    agentName: amazon-ssm-agent
    source: https://s3.{Region}.amazonaws.com/amazon-ssm-{Region}/ssm-agent-manifest.json
    allowDowngrade: "{{ allowDowngrade }}"
```

------
#### [ JSON ]

```
{
  "schemaVersion": "2.2",
  "description": "aws:updateSsmAgent",
  "parameters": {
    "allowDowngrade": {
      "default": "false",
      "description": "(Required) Allow the Amazon SSM Agent service to be downgraded to an earlier version. If set to false, the service can be upgraded to newer versions only (default). If set to true, specify the earlier version.",
      "type": "String",
      "allowedValues": [
        "true",
        "false"
      ]
    }
  },
  "mainSteps": [
    {
      "action": "aws:updateSsmAgent",
      "name": "awsupdateSsmAgent",
      "inputs": {
        "agentName": "amazon-ssm-agent",
        "source": "https://s3.{Region}.amazonaws.com/amazon-ssm-{Region}/ssm-agent-manifest.json",
        "allowDowngrade": "{{ allowDowngrade }}"
      }
    }
  ]
}
```

------

#### Esquema 1.2
<a name="updateaSSMgent-syntax-1.2"></a>

------
#### [ YAML ]

```
---
runtimeConfig:
  aws:updateSsmAgent:
    properties:
    - agentName: amazon-ssm-agent
      source: https://s3.{Region}.amazonaws.com/aws-ssm-{Region}/manifest.json
      allowDowngrade: "{{ allowDowngrade }}"
```

------
#### [ JSON ]

```
{
   "runtimeConfig":{
      "aws:updateSsmAgent":{
         "properties":[
            {
               "agentName":"amazon-ssm-agent",
               "source":"https://s3.{Region}.amazonaws.com/aws-ssm-{Region}/manifest.json",
               "allowDowngrade":"{{ allowDowngrade }}"
            }
         ]
      }
   }
}
```

------

### Propiedades
<a name="updateSSMagent-properties"></a>

**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í

**origen**  
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