Acciones de AWS Systems Manager

Esta página proporciona una referencia de las acciones de AWS Systems Manager disponibles en el catálogo de acciones de automatización de flujos de trabajo. Utilice estas acciones para crear, ejecutar y administrar documentos de automatización de AWS Systems Manager.

Requisitos previos

Para los requisitos previos y la configuración de credenciales, consulte Configurar las credenciales de AWS.

Crear un documento

El identificador de la acción es aws.systemsManager.writeDocument.

Crea o actualiza un documento de SSM en su cuenta de AWS. Consulte la documentación de AWS Systems Manager.

La siguiente tabla describe los campos de entrada para esta acción.

Aporte	Tipo	Descripción	Ejemplo
`awsRoleArn`	Cadena	Opcional. ARN del rol de IAM que se debe asumir para las llamadas API de AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Cadena	Opcional. ID de clave de acceso de AWS. Páselo como un secreto.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Cadena	Opcional. Clave de acceso secreta de AWS. Páselo como un secreto.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Cadena	Opcional. Token de sesión temporal para la autenticación STS. Páselo como un secreto.	`${{ :secrets:awsSessionToken }}`
`region`	Cadena	Requerido. Región de AWS donde se creará el documento.	`us-east-2`
`documentName`	Cadena	Requerido. Nombre para el documento de SSM.	`my-ssm-document`
`documentType`	Cadena	Opcional. Tipo de documento de SSM. Los valores válidos se enumeran en la Referencia de la API de AWS Systems Manager .	`Command`
`documentFormat`	Cadena	Opcional. Formato del contenido del documento. Valores válidos: `JSON` , `YAML` , `TEXT` .	`YAML`
`documentContent`	Cadena	Requerido. El contenido del documento de SSM como una cadena.	Consulte el ejemplo a continuación.
`override`	Booleano	Opcional. Cuando es `true` (predeterminado), sobrescribe un documento existente con el mismo nombre. Cuando es `false` , devuelve un error si ya existe un documento con ese nombre.	`true`
`selectors`	Lista	Opcional. Selectores JQ para extraer campos específicos de la salida de la acción.	`[{"name": "documentName", "expression": ".documentName"}]`

La siguiente tabla describe los campos de salida para esta acción.

Producción	Tipo	Ejemplo
`documentName`	Cadena	`my-ssm-document`
`documentVersion`	Cadena	`1`
`documentType`	Cadena	`Command`
`documentStatus`	Cadena	`Active` . El valor será uno de los estados de la Referencia de la API de AWS Systems Manager .
`success`	Booleano	`true`
`errorMessage`	Cadena	`"Some error message from ssm"`

Ejemplo: listar todas las funciones Lambda

Contenido del documento de SSM:

schemaVersion: '0.3'
description: List all Lambda function names.
mainSteps:
  - name: ExecuteAwsApi
    action: aws:executeAwsApi
    isEnd: true
    inputs:
      Service: lambda
      Api: ListFunctions
    outputs:
      - Name: resultFunctionName
        Selector: $..FunctionName
        Type: StringList
outputs:
  - ExecuteAwsApi.resultFunctionName

Flujo de trabajo completo usando este documento:

name: aws-api
workflowInputs:
  key:
    type: String
    defaultValue: "${{ :secrets:11933347:USERNAME_AWS_ACCESS_KEY_ID }}"
  access:
    type: String
    defaultValue: "${{ :secrets:11933347:USERNAME_AWS_SECRET_ACCESS_KEY }}"
  token:
    type: String
    defaultValue: "${{ :secrets:11933347:USERNAME_AWS_SESSION_TOKEN }}"
  region:
    type: String
    defaultValue: us-east-2
steps:
  - name: createSsmDocument
    type: action
    action: aws.systemsManager.writeDocument
    version: 1
    inputs:
      awsAccessKeyId: ${{ .workflowInputs.key }}
      awsSecretAccessKey: ${{ .workflowInputs.access }}
      awsSessionToken: ${{ .workflowInputs.token }}
      region: ${{ .workflowInputs.region }}
      documentName: "LambdaListFunctionNames"
      documentContent: |
        schemaVersion: '0.3'
        description: List all Lambda function names.
        mainSteps:
          - name: ExecuteAwsApi
            action: aws:executeAwsApi
            isEnd: true
            inputs:
              Service: lambda
              Api: ListFunctions
            outputs:
              - Name: resultFunctionName
                Selector: $..FunctionName
                Type: StringList
        outputs:
          - ExecuteAwsApi.resultFunctionName
  - name: start1
    type: action
    action: aws.systemsManager.startAutomation
    version: 1
    inputs:
      awsAccessKeyId: ${{ .workflowInputs.key }}
      awsSecretAccessKey: ${{ .workflowInputs.access }}
      awsSessionToken: ${{ .workflowInputs.token }}
      region: ${{ .workflowInputs.region }}
      documentName: "${{ .steps.createSsmDocument.outputs.documentName }}"

Borrar un documento

El identificador de la acción es aws.systemsManager.deleteDocument.

Elimina un documento de AWS SSM de la cuenta. Consulte la documentación de AWS Systems Manager.

La siguiente tabla describe los campos de entrada para esta acción.

Aporte	Tipo	Descripción	Ejemplo
`awsRoleArn`	Cadena	Opcional. ARN del rol de IAM que se debe asumir para las llamadas API de AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Cadena	Opcional. ID de clave de acceso de AWS. Páselo como un secreto.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Cadena	Opcional. Clave de acceso secreta de AWS. Páselo como un secreto.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Cadena	Opcional. Token de sesión temporal para la autenticación STS. Páselo como un secreto.	`${{ :secrets:awsSessionToken }}`
`region`	Cadena	Requerido. Región de AWS donde se encuentra el documento.	`us-east-2`
`documentName`	Cadena	Requerido. Nombre del documento de SSM a eliminar.	`my-ssm-document`
`selectors`	Lista	Opcional. Selectores JQ para extraer campos específicos de la salida de la acción.	`[{"name": "success", "expression": ".success"}]`

La siguiente tabla describe los campos de salida para esta acción.

Producción	Tipo	Ejemplo
`documentName`	Cadena	`my-ssm-document`
`success`	Booleano	`true`
`errorMessage`	Cadena	`"Some error message from ssm"`

Iniciar una automatización

El identificador de la acción es aws.systemsManager.startAutomation.

Inicia una automatización mediante un documento de AWS SSM. Consulte la documentación de AWS Systems Manager.

La siguiente tabla describe los campos de entrada para esta acción.

Aporte	Tipo	Descripción	Ejemplo
`awsRoleArn`	Cadena	Opcional. ARN del rol de IAM que se debe asumir para las llamadas API de AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Cadena	Opcional. ID de clave de acceso de AWS. Páselo como un secreto.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Cadena	Opcional. Clave de acceso secreta de AWS. Páselo como un secreto.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Cadena	Opcional. Token de sesión temporal para la autenticación STS. Páselo como un secreto.	`${{ :secrets:awsSessionToken }}`
`region`	Cadena	Requerido. Región de AWS donde se encuentra el documento de SSM.	`us-east-2`
`documentName`	Cadena	Requerido. Nombre del documento de SSM a ejecutar.	`my-ssm-document`
`parameters`	Mapa	Opcional. Pares de valor principal para pasar como parámetros al documento de SSM.	`{"myKey": "myValue"}`
`idempotencyToken`	UUID	Opcional. Se pasa como el token del cliente para la idempotencia al iniciar la automatización.	`any-token`
`selectors`	Lista	Opcional. Selectores JQ para extraer campos específicos de la salida de la acción.	`[{"name": "automationExecutionId", "expression": ".automationExecutionId"}]`

La siguiente tabla describe los campos de salida para esta acción.

Producción	Tipo	Ejemplo
`automationExecutionId`	Cadena	`3143a28d-241c-4abd-a3ca-9c0ff3890241`
`success`	Booleano	`true`
`errorMessage`	Cadena	`"Some error message from ssm"`

Espere el estado de automatización

El identificador de la acción es aws.systemsManager.waitForAutomationStatus.

Sondea una ejecución de automatización de AWS SSM hasta que alcanza uno de los estados finales especificados o se agota el tiempo de espera. Consulte la documentación de AWS Systems Manager.

La siguiente tabla describe los campos de entrada para esta acción.

Aporte	Tipo	Descripción	Ejemplo
`awsRoleArn`	Cadena	Opcional. ARN del rol de IAM que se debe asumir para las llamadas API de AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Cadena	Opcional. ID de clave de acceso de AWS. Páselo como un secreto.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Cadena	Opcional. Clave de acceso secreta de AWS. Páselo como un secreto.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Cadena	Opcional. Token de sesión temporal para la autenticación STS. Páselo como un secreto.	`${{ :secrets:awsSessionToken }}`
`region`	Cadena	Requerido. Región de AWS donde se está ejecutando la automatización.	`us-east-2`
`automationExecutionId`	Cadena	Requerido. El ID de ejecución que se debe esperar.	`3143a28d-241c-4abd-a3ca-9c0ff3890241`
`automationExecutionStatuses`	Lista	Opcional. Lista de estados de AutomationExecution que detienen la espera. Predeterminado: `["Success", "Failed"]` .	`["Success", "Failed"]`
`timeout`	En t	Opcional. Duración en segundos a esperar. El valor predeterminado es `180` , el máximo es `600` . Si se excede, devuelve `success: false` con `errorMessage: "Timeout waiting for automation status"` .	`180`
`selectors`	Lista	Opcional. Selectores JQ para extraer campos específicos de la salida de la acción.	`[{"name": "automationExecutionStatus", "expression": ".automationExecutionStatus"}]`

La siguiente tabla describe los campos de salida para esta acción.

Producción	Tipo	Ejemplo
`automationExecutionId`	Cadena	`3143a28d-241c-4abd-a3ca-9c0ff3890241`
`automationExecutionStatus`	Cadena	`Success` . Uno de los estados pasados en `automationExecutionStatuses` , o null si la acción falló.
`automationExecutionOutputs`	Mapa	`{"ExecuteGetApiResources": {"resultResourceId": ["pky3cb"]}}` . Mapa de valores de salida del documento de SSM; utilícelos en los pasos posteriores del flujo de trabajo.
`success`	Booleano	`true`
`errorMessage`	Cadena	`"Some error message from ssm"`

Te ofrecemos esta traducción automática para facilitar la lectura.

Requisitos previos.css-21sua1{background:none;border:none;width:0;padding:0;}

Crear un documento

Borrar un documento

Iniciar una automatización

Espere el estado de automatización

Requisitos previos