Actions AWS Systems Manager

Cette page fournit une référence des actions AWS Systems Manager disponibles dans le catalogue des actions d’automatisation des workflows. Utilisez ces actions pour créer, exécuter et gérer des documents d’automatisation AWS Systems Manager.

Prérequis

Pour les prérequis et la configuration des identifiants, consultez Configurer les identifiants AWS.

Créer un document

L’identifiant de l’action est aws.systemsManager.writeDocument.

Crée ou met à jour un document SSM dans votre compte AWS. Consultez la documentation AWS Systems Manager.

Le tableau suivant décrit les champs d’entrée pour cette action.

Saisir	Type	Description	Exemple
`awsRoleArn`	Chaîne	Facultatif. ARN du rôle IAM à assumer pour les appels d'API AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Chaîne	Facultatif. ID de clé d’accès AWS. Passer en tant que secret.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Chaîne	Facultatif. Clé d’accès secrète AWS. Passer en tant que secret.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Chaîne	Facultatif. Jeton de session temporaire pour l'authentification STS. Transmettez en tant que secret.	`${{ :secrets:awsSessionToken }}`
`region`	Chaîne	Obligatoire. Région AWS où le document sera créé.	`us-east-2`
`documentName`	Chaîne	Obligatoire. Nom pour le document SSM.	`my-ssm-document`
`documentType`	Chaîne	Facultatif. Type de document SSM. Les valeurs valides sont répertoriées dans la Référence de l’API AWS Systems Manager .	`Command`
`documentFormat`	Chaîne	Facultatif. Format du contenu du document. Valeurs valides : `JSON` , `YAML` , `TEXT` .	`YAML`
`documentContent`	Chaîne	Obligatoire. Le contenu du document SSM sous forme de chaîne de caractères.	Voir l'exemple ci-dessous.
`override`	Booléen	Facultatif. Lorsque `true` (par défaut), écrase un document existant avec le même nom. Lorsque `false` , renvoie une erreur si un document avec ce nom existe déjà.	`true`
`selectors`	List	Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.	`[{"name": "documentName", "expression": ".documentName"}]`

Le tableau suivant décrit les champs de sortie pour cette action.

Sortir	Type	Exemple
`documentName`	Chaîne	`my-ssm-document`
`documentVersion`	Chaîne	`1`
`documentType`	Chaîne	`Command`
`documentStatus`	Chaîne	`Active` . La valeur sera l’un des statuts de la référence de l’API AWS Systems Manager .
`success`	Booléen	`true`
`errorMessage`	Chaîne	`"Some error message from ssm"`

Exemple : répertorier toutes les fonctions Lambda

Contenu du document 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

Workflow complet utilisant ce document :

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 }}"

Supprimer un document

L’identifiant de l’action est aws.systemsManager.deleteDocument.

Supprime un document AWS SSM de votre compte. Consultez la documentation AWS Systems Manager.

Le tableau suivant décrit les champs d’entrée pour cette action.

Saisir	Type	Description	Exemple
`awsRoleArn`	Chaîne	Facultatif. ARN du rôle IAM à assumer pour les appels d'API AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Chaîne	Facultatif. ID de clé d’accès AWS. Passer en tant que secret.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Chaîne	Facultatif. Clé d’accès secrète AWS. Passer en tant que secret.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Chaîne	Facultatif. Jeton de session temporaire pour l'authentification STS. Transmettez en tant que secret.	`${{ :secrets:awsSessionToken }}`
`region`	Chaîne	Obligatoire. Région AWS où se trouve le document.	`us-east-2`
`documentName`	Chaîne	Obligatoire. Nom du document SSM à supprimer.	`my-ssm-document`
`selectors`	List	Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.	`[{"name": "success", "expression": ".success"}]`

Le tableau suivant décrit les champs de sortie pour cette action.

Sortir	Type	Exemple
`documentName`	Chaîne	`my-ssm-document`
`success`	Booléen	`true`
`errorMessage`	Chaîne	`"Some error message from ssm"`

Démarrer une automatisation

L’identifiant de l’action est aws.systemsManager.startAutomation.

Démarre une automatisation à l’aide d’un document AWS SSM. Consultez la documentation AWS Systems Manager.

Le tableau suivant décrit les champs d’entrée pour cette action.

Saisir	Type	Description	Exemple
`awsRoleArn`	Chaîne	Facultatif. ARN du rôle IAM à assumer pour les appels d'API AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Chaîne	Facultatif. ID de clé d’accès AWS. Passer en tant que secret.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Chaîne	Facultatif. Clé d’accès secrète AWS. Passer en tant que secret.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Chaîne	Facultatif. Jeton de session temporaire pour l'authentification STS. Transmettez en tant que secret.	`${{ :secrets:awsSessionToken }}`
`region`	Chaîne	Obligatoire. Région AWS où se trouve le document SSM.	`us-east-2`
`documentName`	Chaîne	Obligatoire. Nom du document SSM à exécuter.	`my-ssm-document`
`parameters`	Carte	Facultatif. Paires valeur clé à passer en paramètres au document SSM.	`{"myKey": "myValue"}`
`idempotencyToken`	UUID	Facultatif. Transmis en tant que jeton client pour l'idempotence lors du démarrage de l'automatisation.	`any-token`
`selectors`	List	Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.	`[{"name": "automationExecutionId", "expression": ".automationExecutionId"}]`

Le tableau suivant décrit les champs de sortie pour cette action.

Sortir	Type	Exemple
`automationExecutionId`	Chaîne	`3143a28d-241c-4abd-a3ca-9c0ff3890241`
`success`	Booléen	`true`
`errorMessage`	Chaîne	`"Some error message from ssm"`

Attendez l'état de l'automatisation

L’identifiant de l’action est aws.systemsManager.waitForAutomationStatus.

Interroge une exécution d’automatisation AWS SSM jusqu’à ce qu’elle atteigne l’un des statuts terminaux spécifiés ou que le délai d’attente expire. Consultez la documentation AWS Systems Manager.

Le tableau suivant décrit les champs d’entrée pour cette action.

Saisir	Type	Description	Exemple
`awsRoleArn`	Chaîne	Facultatif. ARN du rôle IAM à assumer pour les appels d'API AWS.	`arn:aws:iam::123456789012:role/my-workflow-role`
`awsAccessKeyId`	Chaîne	Facultatif. ID de clé d’accès AWS. Passer en tant que secret.	`${{ :secrets:awsAccessKeyId }}`
`awsSecretAccessKey`	Chaîne	Facultatif. Clé d’accès secrète AWS. Passer en tant que secret.	`${{ :secrets:awsSecretAccessKey }}`
`awsSessionToken`	Chaîne	Facultatif. Jeton de session temporaire pour l'authentification STS. Transmettez en tant que secret.	`${{ :secrets:awsSessionToken }}`
`region`	Chaîne	Obligatoire. Région AWS où l'exécution de l'automatisation est en cours.	`us-east-2`
`automationExecutionId`	Chaîne	Obligatoire. L’ID d’exécution à attendre.	`3143a28d-241c-4abd-a3ca-9c0ff3890241`
`automationExecutionStatuses`	List	Facultatif. Liste des statuts AutomationExecution qui arrêtent l’attente. Par défaut : `["Success", "Failed"]` .	`["Success", "Failed"]`
`timeout`	Int	Facultatif. Durée d'attente en secondes. La valeur par défaut est de `180` , le maximum est de `600` . En cas de dépassement, renvoie `success: false` avec `errorMessage: "Timeout waiting for automation status"` .	`180`
`selectors`	List	Facultatif. Sélecteurs JQ pour extraire des champs spécifiques de la sortie de l'action.	`[{"name": "automationExecutionStatus", "expression": ".automationExecutionStatus"}]`

Le tableau suivant décrit les champs de sortie pour cette action.

Sortir	Type	Exemple
`automationExecutionId`	Chaîne	`3143a28d-241c-4abd-a3ca-9c0ff3890241`
`automationExecutionStatus`	Chaîne	`Success` . L'un des statuts transmis dans `automationExecutionStatuses` , ou null si l'action a échoué.
`automationExecutionOutputs`	Carte	`{"ExecuteGetApiResources": {"resultResourceId": ["pky3cb"]}}` . Mappage des valeurs de sortie du document SSM ; utilisez-les dans les étapes de workflow suivantes.
`success`	Booléen	`true`
`errorMessage`	Chaîne	`"Some error message from ssm"`

Cette traduction automatique est fournie pour votre commodité.

Prérequis.css-21sua1{background:none;border:none;width:0;padding:0;}

Créer un document

Supprimer un document

Démarrer une automatisation

Attendez l'état de l'automatisation

Prérequis