aws:executeScript: esecuzione di uno script - AWS Systems Manager

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

aws:executeScript: esecuzione di uno script

Esegue il Python o PowerShell lo script fornito utilizzando il tempo di esecuzione e il gestore specificati. Ogni operazione aws:executeScript può durare al massimo 600 secondi (10 minuti). Puoi limitare il timeout specificando il parametro timeoutSeconds per una fase aws:executeScript.

Usa le istruzioni return nella funzione per aggiungere output al payload di output. Per esempi di definizione degli output per l'operazione aws:executeScript, consulta Esempio 2: Runbook con script. Puoi anche inviare l'output dalle aws:executeScript operazioni nei tuoi runbook al gruppo di flussi di log Amazon CloudWatch Logs specificato. Per ulteriori informazioni, consulta Registrazione dell'output dell'azione di automazione con CloudWatch Logs.

Se desideri inviare l'output aws:executeScript delle azioni ai CloudWatch log o se gli script che specifichi per aws:executeScript le azioni richiamano AWS API operazioni, è sempre necessario un AWS Identity and Access Management (IAM) ruolo di servizio (o assumi un ruolo) per eseguire il runbook.

Attualmente, l'aws:executeScriptoperazione contiene i seguenti moduli PowerShell Core preinstallati:

  • Microsoft. PowerShell.Host

  • Microsoft. PowerShell.Gestione

  • Microsoft. PowerShell.Sicurezza

  • Microsoft. PowerShell.Utilità

  • PackageManagement

  • PowerShellGet

Per utilizzare i moduli PowerShell Core non preinstallati, lo script deve installare il modulo con il -Force flag, come illustrato nel comando seguente. Il modulo AWSPowerShell.NetCore non è supportato. Replace (Sostituisci) ModuleName con il modulo che vuoi installare.

Install-Module ModuleName -Force

Per utilizzare i cmdlet PowerShell Core nello script, è consigliabile utilizzare i AWS.Tools moduli, come illustrato nei comandi seguenti. Sostituisci ciascuno example resource placeholder con le tue informazioni.

  • Cmdlet Amazon S3

    Install-Module AWS.Tools.S3 -Force
Get-S3Bucket -BucketName amzn-s3-demo-bucket

  • EC2Cmdlet Amazon.

    Install-Module AWS.Tools.EC2 -Force
Get-EC2InstanceStatus -InstanceId instance-id

  • Cmdlet comuni o indipendenti dal AWS Tools for Windows PowerShell servizio.

    Install-Module AWS.Tools.Common -Force
Get-AWSRegion

Se lo script inizializza nuovi oggetti oltre a utilizzare i cmdlet PowerShell Core, è necessario importare anche il modulo come illustrato nel comando seguente.

Install-Module AWS.Tools.EC2 -Force
Import-Module AWS.Tools.EC2

$tag = New-Object Amazon.EC2.Model.Tag
$tag.Key = "Tag"
$tag.Value = "TagValue"

New-EC2Tag -Resource i-02573cafcfEXAMPLE -Tag $tag

Per esempi di installazione e importazione di AWS.Tools moduli e utilizzo dei cmdlet PowerShell Core nei runbook, vedi. Esperienza di progettazione visiva per i runbook di automazione

Input

Fornisci le informazioni necessarie per eseguire lo script. Sostituisci ciascuno example resource placeholder con le tue informazioni.

Nota

L'allegato per uno script Python può essere un file .py o .zip che contiene lo script. PowerShell gli script devono essere archiviati in file .zip.

YAML
action: "aws:executeScript"
inputs: 
 Runtime: runtime
 Handler: "functionName"
 InputPayload: 
  scriptInput: '{{parameterValue}}'
 Script: |-
   def functionName(events, context):
   ...
 Attachment: "scriptAttachment.zip"
JSON
{
    "action": "aws:executeScript",
    "inputs": {
        "Runtime": "runtime",
        "Handler": "functionName",
        "InputPayload": {
            "scriptInput": "{{parameterValue}}"
        },
        "Attachment": "scriptAttachment.zip"
    }
}
Runtime

Il linguaggio di runtime (tempo di esecuzione) da utilizzare per eseguire lo script fornito. aws:executeScriptsupporta Python 3.7 (python3.8), Python 3.8 (python3.8), Python 3.8 (python3.8) Python 3.8 (python3.8) Python 3.8 (python3.8), Python 3.8 (python3.8) Python 3.8 (dotnetcore2.1) e script 7.0 (dotnetcore3.1). PowerShell PowerShell

python3.7python3.8Valori python3.9 supportatiPowerShell Core 6.0: | | | | | python3.10 python3.11 PowerShell 7.0

Tipo: stringa

Campo obbligatorio: sì

Gestore

Il nome della funzione. È necessario assicurarsi che la funzione definita nel gestore abbia due parametri, events e context. Il PowerShell tempo di esecuzione non supporta questo parametro.

Tipo: stringa

Richiesto: Sì (Python) | Non supportato () PowerShell

InputPayload

Un YAML oggetto JSON o che verrà passato al primo parametro del gestore. Questo può essere usato per passare i dati di input allo script.

Tipo: string

Campo obbligatorio: no

Python
description: Tag an instance
schemaVersion: '0.3'
assumeRole: '{{AutomationAssumeRole}}'
parameters:
    AutomationAssumeRole:
        type: String
        description: '(Required) The Amazon Resource Name (ARN) of the IAM role that allows Automation to perform the actions on your behalf. If no role is specified, Systems Manager Automation uses your IAM permissions to operate this runbook.'
    InstanceId:
        type: String
        description: (Required) The ID of the EC2 instance you want to tag.
mainSteps:
  - name: tagInstance
    action: 'aws:executeScript'
    inputs:
        Runtime: "python3.8"
        Handler: tagInstance
        InputPayload:
            instanceId: '{{InstanceId}}'
        Script: |-
          def tagInstance(events,context):
            import boto3

            #Initialize client
            ec2 = boto3.client('ec2')
            instanceId = events['instanceId']
            tag = {
                "Key": "Env",
                "Value": "Example"
            }
            ec2.create_tags(
                Resources=[instanceId],
                Tags=[tag]
            )
PowerShell
description: Tag an instance
schemaVersion: '0.3'
assumeRole: '{{AutomationAssumeRole}}'
parameters:
    AutomationAssumeRole:
        type: String
        description: '(Required) The Amazon Resource Name (ARN) of the IAM role that allows Automation to perform the actions on your behalf. If no role is specified, Systems Manager Automation uses your IAM permissions to operate this runbook.'
    InstanceId:
        type: String
        description: (Required) The ID of the EC2 instance you want to tag.
mainSteps:
  - name: tagInstance
    action: 'aws:executeScript'
    inputs:
        Runtime: PowerShell 7.0
        InputPayload:
          instanceId: '{{InstanceId}}'
        Script: |-
          Install-Module AWS.Tools.EC2 -Force
          Import-Module AWS.Tools.EC2

          $input = $env:InputPayload | ConvertFrom-Json

          $tag = New-Object Amazon.EC2.Model.Tag
          $tag.Key = "Env"
          $tag.Value = "Example"

          New-EC2Tag -Resource $input.instanceId -Tag $tag
Script

Uno script incorporato che si desidera eseguire durante l'automazione.

Tipo: stringa

Obbligatorio: No (Python) | Sì () PowerShell

Allegato

Il nome di un file di script standalone o di un file .zip che può essere richiamato dall'operazione. Specifica lo stesso valore del Name del file allegato del documento che specifichi nel parametro della richiesta Attachments. Per ulteriori informazioni, consulta Allegati nel AWS Systems Manager API riferimento. Se stai fornendo uno script utilizzando un allegato, devi anche definire una sezione files negli elementi di primo livello del runbook. Per ulteriori informazioni, consulta Versione dello schema 0.3.

Per richiamare un file per python, utilizzare il formato filename.method_name in Handler.

Nota

L'allegato per uno script Python può essere un file .py o .zip che contiene lo script. PowerShell gli script devono essere archiviati in file .zip.

Quando si includono librerie Python nell'allegato, si consiglia di aggiungere un file __init__.py vuoto in ogni directory del modulo. Ciò consente di importare i moduli dalla libreria nell'allegato all'interno del contenuto dello script. Ad esempio: from library import module

Tipo: string

Campo obbligatorio: no

Output
Payload

JSONRappresentazione dell'oggetto restituito dalla funzione. Vengono restituiti fino a 100 KB. Se si genera un elenco, viene restituito un massimo di 100 elementi.