Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Aktionsmodule, die vom AWSTOE Komponentenmanager unterstützt werden

Image-Building-Services wie EC2 Image Builder verwenden AWSTOE Aktionsmodule, um die EC2 Instanzen zu konfigurieren, die zum Erstellen und Testen von benutzerdefinierten Computer-Images verwendet werden. In diesem Abschnitt werden die Funktionen häufig verwendeter AWSTOE Aktionsmodule und deren Konfiguration sowie Beispiele beschrieben.

Komponenten werden mit YAML Klartext-Dokumenten erstellt. Weitere Hinweise zur Dokumentensyntax finden Sie unter. Verwenden Sie das AWSTOE Component Document Framework für benutzerdefinierte Komponenten

Der folgende Querverweis kategorisiert Aktionsmodule nach der Art der Aktionen, die sie ausführen.

 

 

 

 

 

Allgemeine Ausführungsmodule

Der folgende Abschnitt enthält Einzelheiten zu Aktionsmodulen, die Befehle ausführen und den Ausführungsablauf steuern.

Assert

Das Assert-Aktionsmodul führt Wertvergleiche mit Vergleichsoperatoren oder Logische Operatoren als Eingabe durch. Das Ergebnis des Operatorausdrucks (wahr oder falsch) gibt den allgemeinen Erfolgs- oder Fehlschlagstatus für den Schritt an.

Ergibt der Vergleich oder der Ausdruck des logischen Operators das Ergebnistrue, wird der Schritt als Success markiert. Andernfalls ist der Schritt als Failed markiert. Wenn der Schritt fehlschlägt, entscheidet der onFailure Parameter über das Ergebnis des Schritts.

Eingabebeispiel: Ein einfacher Vergleich mit dem stringEquals Vergleichsoperator

In diesem Beispiel wird als ausgewertet. true

- name: StringComparison
  action: Assert
  inputs:
    stringEquals: '2.1.1'
    value: '{{ validate.ApplicationVersion.outputs.stdout }}'

Eingabebeispiel: Regex-Vergleiche mit dem Vergleichsoperator patternMatches

Diese Beispiele werden alle zu ausgewertet. true

- name: Letters only
  action: Assert
  inputs:
    patternMatches: '^[a-zA-Z]+$'
    value: 'ThisIsOnlyLetters'

- name: Letters and spaces only
  action: Assert
  inputs:
    patternMatches: '^[a-zA-Z\s]+$'
    value: 'This text contains spaces'
  
- name: Numbers only
  action: Assert
  inputs:
    patternMatches: '^[0-9]+$'
    value: '1234567890'

Eingabebeispiel: Verschachtelte Vergleiche mit logischen Operatoren und verketteten Variablen

Das folgende Beispiel zeigt verschachtelte Vergleiche mit logischen Operatoren, die Vergleiche mit verketteten Variablen verwenden. Das gibt Assert an, true ob eine der folgenden Aussagen zutrifft:

- name: NestedComparisons
  action: Assert
  inputs:
    or: # <- first level deep
      - and: # <- second level deep
          - numberGreaterThan: 2.0 # <- third level deep
            value: '{{ validate.ApplicationVersion.outputs.stdout }}'
          - stringEquals: 'arm64'
            value: '{{ validate.CPUArchitecture.outputs.stdout }}'
      - stringEquals: 'x86_64'
        value: '{{ validate.CPUArchitecture.outputs.stdout }}'

Ausgabe:

Die Ausgabe von an Assert ist Erfolg oder Misserfolg des Schritts.

ExecuteBash

Das ExecuteBashAktionsmodul ermöglicht es Ihnen, Bash-Skripte mit Inline-Shell-Code/Befehlen auszuführen. Dieses Modul unterstützt Linux.

Alle Befehle und Anweisungen, die Sie im Befehlsblock angeben, werden in eine Datei konvertiert (zum Beispielinput.sh) und mit der Bash-Shell ausgeführt. Das Ergebnis der Ausführung der Shell-Datei ist der Exit-Code des Schritts.

Das ExecuteBashModul verarbeitet Systemneustarts, wenn das Skript mit dem Exit-Code beendet wird. 194 Nach der Initiierung führt das Programm eine der folgenden Aktionen aus:

Nach dem Systemneustart führt die Anwendung denselben Schritt aus, der den Neustart initiiert hat. Wenn Sie diese Funktionalität benötigen, müssen Sie idempotente Skripten schreiben, die mehrere Aufrufe desselben Shell-Befehls verarbeiten können.

Eingabebeispiel: Vor und nach einem Neustart

name: ExitCode194Example
description: This shows how the exit code can be used to restart a system with ExecuteBash
schemaVersion: 1.0
phases:
  - name: build
    steps:
      - name: RestartTrigger
        action: ExecuteBash
        inputs:
          commands:
            - |
              REBOOT_INDICATOR=/var/tmp/reboot-indicator
              if [ -f "${REBOOT_INDICATOR}" ]; then
                echo 'The reboot file exists. Deleting it and exiting with success.'
                rm "${REBOOT_INDICATOR}"
                exit 0
              fi
              echo 'The reboot file does not exist. Creating it and triggering a restart.'
              touch "${REBOOT_INDICATOR}"
              exit 194

Wenn Sie einen Neustart starten und den Exit-Code 194 als Teil des Aktionsmoduls zurückgeben, wird der Build mit demselben Aktionsmodulschritt fortgesetzt, der den Neustart initiiert hat. Wenn Sie einen Neustart ohne den Exit-Code starten, schlägt der Build-Prozess möglicherweise fehl.

Ausgabebeispiel: Vor dem Neustart (zum ersten Mal über das Dokument)

{
	“stdout”: “The reboot file does not exist. Creating it and triggering a restart."
}

Ausgabebeispiel: Nach dem Neustart (zweites Mal durch das Dokument)

{
	“stdout”: “The reboot file exists. Deleting it and exiting with success."
}

ExecuteBinary

Das ExecuteBinaryAktionsmodul ermöglicht es Ihnen, Binärdateien mit einer Liste von Befehlszeilenargumenten auszuführen.

Das ExecuteBinaryModul verarbeitet Systemneustarts, wenn die Binärdatei mit dem Exit-Code 194 (Linux) oder 3010 (Windows) beendet wird. In diesem Fall führt das Programm eine der folgenden Aktionen aus:

Nach dem Neustart des Systems führt die Anwendung denselben Schritt aus, der den Neustart initiiert hat. Wenn Sie diese Funktionalität benötigen, müssen Sie idempotente Skripten schreiben, die mehrere Aufrufe desselben Shell-Befehls verarbeiten können.

Eingabebeispiel: installieren. NET

  - name: "InstallDotnet"
    action: ExecuteBinary
    inputs:
      path: C:\PathTo\dotnet_installer.exe
      arguments:
        - /qb
        - /norestart

Output example

{
	"stdout": "success"
}

ExecuteDocument

Das ExecuteDocumentAktionsmodul bietet Unterstützung für verschachtelte Komponentendokumente, sodass mehrere Komponentendokumente von einem Dokument aus ausgeführt werden. AWSTOE validiert das Dokument, das zur Laufzeit im Eingabeparameter übergeben wird.

Wenn ein Komponentendokument versucht, sich selbst oder eines der Komponentendokumente auszuführen, die in der aktuellen Ausführungskette weiter oben stehen, schlägt die Ausführung fehl.

Eingabe

Eingabe der Parameterzuweisung

Beispiele für die Eingabe

Die folgenden Beispiele zeigen Variationen der Eingaben für Ihr Komponentendokument, abhängig von Ihrem Installationspfad.

Eingabebeispiel: Lokaler Dokumentpfad

# main.yaml
schemaVersion: 1.0

phases:
  - name: build
    steps:
      - name: ExecuteNestedDocument
        action: ExecuteDocument
        inputs:
          document: Sample-1.yaml
          phases: build
          parameters:
            - name: parameter-1
              value: value-1
            - name: parameter-2
              value: value-2

Eingabebeispiel: S3 URI als Dokumentenpfad

# main.yaml
schemaVersion: 1.0

phases:
  - name: build
    steps:
      - name: ExecuteNestedDocument
        action: ExecuteDocument
        inputs:
          document: s3://my-bucket/Sample-1.yaml
          document-s3-bucket-owner: 123456789012
          phases: build,validate
          parameters:
            - name: parameter-1
              value: value-1
            - name: parameter-2
              value: value-2

Eingabebeispiel: EC2 Image Builder Builder-Komponente ARN als Dokumentpfad

# main.yaml
schemaVersion: 1.0

phases:
  - name: build
    steps:
      - name: ExecuteNestedDocument
        action: ExecuteDocument
        inputs:
          document: arn:aws:imagebuilder:us-west-2:aws:component/Sample-Test/1.0.0
          phases: test
          parameters:
            - name: parameter-1
              value: value-1
            - name: parameter-2
              value: value-2

Dokumente mithilfe einer ForEach Schleife ausführen

# main.yaml
schemaVersion: 1.0

phases:
  - name: build
    steps:
      - name: ExecuteNestedDocument
        action: ExecuteDocument
        loop:
          name: 'myForEachLoop'
          forEach:
            - Sample-1.yaml
            - Sample-2.yaml
        inputs:
          document: "{{myForEachLoop.value}}"
          phases: test
          parameters:
            - name: parameter-1
              value: value-1
            - name: parameter-2
              value: value-2

Verwenden einer For-Schleife zum Ausführen von Dokumenten

# main.yaml
schemaVersion: 1.0

phases:
  - name: build
    steps:
      - name: ExecuteNestedDocument
        action: ExecuteDocument
        loop:
          name: 'myForLoop'
          for:
            start: 1
            end: 2
            updateBy: 1
        inputs:
          document: "Sample-{{myForLoop.value}}.yaml"
          phases: test
          parameters:
            - name: parameter-1
              value: value-1
            - name: parameter-2
              value: value-2

Output

AWSTOE erstellt eine Ausgabedatei, die detailedoutput.json bei jeder Ausführung aufgerufen wird. Die Datei enthält Details zu jeder Phase und jedem Schritt jedes Komponentendokuments, das während der Ausführung aufgerufen wird. Für das ExecuteDocumentAktionsmodul finden Sie in dem outputs Feld eine kurze Zusammenfassung der Laufzeit sowie Einzelheiten zu den Phasen, Schritten und Dokumenten, in denen es ausgeführt wird. detailedOutput

{
	\"executedStepCount\":1,\"executionId\":\"97054e22-06cc-11ec-9b14-acde48001122\",\"failedStepCount\":0,\"failureMessage\":\"\",\"ignoredFailedStepCount\":0,\"logUrl\":\"\",\"status\":\"success\"
}",

Das Ausgabe-Übersichtsobjekt jedes Komponentendokuments enthält die folgenden Details, wie hier gezeigt, mit Beispielwerten:

Ausgabebeispiel

Das folgende Beispiel zeigt die Ausgabe des ExecuteDocumentAktionsmoduls, wenn eine verschachtelte Ausführung stattfindet. In diesem Beispiel führt das main.yaml Komponentendokument das Komponentendokument erfolgreich aus. Sample-1.yaml

{
    "executionId": "12345a67-89bc-01de-2f34-abcd56789012",
    "status": "success",
    "startTime": "2021-08-26T17:20:31-07:00",
    "endTime": "2021-08-26T17:20:31-07:00",
    "failureMessage": "",
    "documents": [
        {
            "name": "",
            "filePath": "main.yaml",
            "status": "success",
            "description": "",
            "startTime": "2021-08-26T17:20:31-07:00",
            "endTime": "2021-08-26T17:20:31-07:00",
            "failureMessage": "",
            "phases": [
                {
                    "name": "build",
                    "status": "success",
                    "startTime": "2021-08-26T17:20:31-07:00",
                    "endTime": "2021-08-26T17:20:31-07:00",
                    "failureMessage": "",
                    "steps": [
                        {
                            "name": "ExecuteNestedDocument",
                            "status": "success",
                            "failureMessage": "",
                            "timeoutSeconds": -1,
                            "onFailure": "Abort",
                            "maxAttempts": 1,
                            "action": "ExecuteDocument",
                            "startTime": "2021-08-26T17:20:31-07:00",
                            "endTime": "2021-08-26T17:20:31-07:00",
                            "inputs": "[{\"document\":\"Sample-1.yaml\",\"document-s3-bucket-owner\":\"\",\"phases\":\"\",\"parameters\":null}]",
                            "outputs": "[{\"executedStepCount\":1,\"executionId\":\"98765f43-21ed-09cb-8a76-fedc54321098\",\"failedStepCount\":0,\"failureMessage\":\"\",\"ignoredFailedStepCount\":0,\"logUrl\":\"\",\"status\":\"success\"}]",
                            "loop": null,
                            "detailedOutput": [
                                {
                                    "executionId": "98765f43-21ed-09cb-8a76-fedc54321098",
                                    "status": "success",
                                    "startTime": "2021-08-26T17:20:31-07:00",
                                    "endTime": "2021-08-26T17:20:31-07:00",
                                    "failureMessage": "",
                                    "documents": [
                                        {
                                            "name": "",
                                            "filePath": "Sample-1.yaml",
                                            "status": "success",
                                            "description": "",
                                            "startTime": "2021-08-26T17:20:31-07:00",
                                            "endTime": "2021-08-26T17:20:31-07:00",
                                            "failureMessage": "",
                                            "phases": [
                                                {
                                                    "name": "build",
                                                    "status": "success",
                                                    "startTime": "2021-08-26T17:20:31-07:00",
                                                    "endTime": "2021-08-26T17:20:31-07:00",
                                                    "failureMessage": "",
                                                    "steps": [
                                                        {
                                                            "name": "ExecuteBashStep",
                                                            "status": "success",
                                                            "failureMessage": "",
                                                            "timeoutSeconds": 7200,
                                                            "onFailure": "Abort",
                                                            "maxAttempts": 1,
                                                            "action": "ExecuteBash",
                                                            "startTime": "2021-08-26T17:20:31-07:00",
                                                            "endTime": "2021-08-26T17:20:31-07:00",
                                                            "inputs": "[{\"commands\":[\"echo \\\"Hello World!\\\"\"]}]",
                                                            "outputs": "[{\"stdout\":\"Hello World!\"}]",
                                                            "loop": null,
                                                            "detailedOutput": null
                                                        }]
                                                }]
                                        }]
                                }]
                        }]
                
                }]
        }]
}

ExecutePowerShell

Das ExecutePowerShellAktionsmodul ermöglicht es Ihnen, PowerShell Skripts mit Inline-Shell-Code/Befehlen auszuführen. Dieses Modul unterstützt die Windows-Plattform und Windows. PowerShell

Alle im Befehlsblock angegebenen Befehle/Anweisungen werden in eine Skriptdatei konvertiert (z. B.input.ps1) und unter Windows ausgeführt. PowerShell Das Ergebnis der Ausführung der Shell-Datei ist der Exit-Code.

Das ExecutePowerShellModul verarbeitet Systemneustarts, wenn der Shell-Befehl mit dem Exit-Code von beendet wird. 3010 Nach der Initiierung führt das Programm eine der folgenden Aktionen aus:

Nach dem Systemneustart führt die Anwendung denselben Schritt aus, der den Neustart initiiert hat. Wenn Sie diese Funktionalität benötigen, müssen Sie idempotente Skripten schreiben, die mehrere Aufrufe desselben Shell-Befehls verarbeiten können.

Eingabebeispiel: Vor und nach einem Neustart

name: ExitCode3010Example
description: This shows how the exit code can be used to restart a system with ExecutePowerShell
schemaVersion: 1.0
phases:
  - name: build
    steps:
      - name: RestartTrigger
        action: ExecutePowerShell
        inputs:
          commands:
            - |
              $rebootIndicator = Join-Path -Path $env:SystemDrive -ChildPath 'reboot-indicator'
              if (Test-Path -Path $rebootIndicator) {
                Write-Host 'The reboot file exists. Deleting it and exiting with success.'
                Remove-Item -Path $rebootIndicator -Force | Out-Null
                [System.Environment]::Exit(0)
              }
              Write-Host 'The reboot file does not exist. Creating it and triggering a restart.'
              New-Item -Path $rebootIndicator -ItemType File | Out-Null
              [System.Environment]::Exit(3010)

Wenn Sie einen Neustart ausführen und den Exit-Code 3010 als Teil des Aktionsmoduls zurückgeben, wird der Build mit demselben Aktionsmodulschritt fortgesetzt, der den Neustart initiiert hat. Wenn Sie einen Neustart ohne den Exit-Code ausführen, schlägt der Build-Prozess möglicherweise fehl.

Ausgabebeispiel: Vor dem Neustart (zum ersten Mal über das Dokument)

{
	“stdout”: “The reboot file does not exist. Creating it and triggering a restart."
}

Ausgabebeispiel: Nach dem Neustart (zweites Mal durch das Dokument)

{
	“stdout”: “The reboot file exists. Deleting it and exiting with success."
}

Module zum Herunterladen und Hochladen von Dateien

Der folgende Abschnitt enthält Informationen zu Aktionsmodulen, die Dateien hoch- oder herunterladen.

S3 herunterladen

Mit dem S3Download Aktionsmodul können Sie ein Amazon S3 S3-Objekt oder eine Reihe von Objekten in eine lokale Datei oder einen Ordner herunterladen, den Sie mit dem destination Pfad angeben. Wenn am angegebenen Speicherort bereits eine Datei vorhanden ist und das overwrite Flag auf true gesetzt ist, wird die Datei S3Download überschrieben.

Ihr source Standort kann auf ein bestimmtes Objekt in Amazon S3 verweisen, oder Sie können ein key prefix mit einem Sternchen als Platzhalter (*) verwenden, um eine Reihe von Objekten herunterzuladen, die dem Schlüsselpräfixpfad entsprechen. Wenn Sie an Ihrem source Standort ein key prefix angeben, lädt das S3Download Aktionsmodul alles herunter, was dem Präfix entspricht (einschließlich Dateien und Ordner). Stellen Sie sicher, dass das key prefix mit einem Schrägstrich endet, gefolgt von einem Sternchen (/*), damit Sie alles herunterladen, was dem Präfix entspricht. Beispiel: s3://my-bucket/my-folder/*.

Wenn die S3Download Aktion für ein bestimmtes key prefix während eines Downloads fehlschlägt, wird der Ordnerinhalt nicht auf den Zustand vor dem Fehler zurückgesetzt. Der Zielordner bleibt so, wie er zum Zeitpunkt des Fehlers war.

Unterstützte Anwendungsfälle

Das S3Download Aktionsmodul unterstützt die folgenden Anwendungsfälle:

IAMAnforderungen

Die IAM Rolle, die Sie Ihrem Instanzprofil zuordnen, muss über Berechtigungen zum Ausführen des S3Download Aktionsmoduls verfügen. Die folgenden IAM Richtlinien müssen der IAM Rolle zugewiesen werden, die dem Instanzprofil zugeordnet ist:

Eingabebeispiel: Kopieren Sie ein Amazon S3 S3-Objekt in eine lokale Datei

Das folgende Beispiel zeigt, wie ein Amazon S3 S3-Objekt in eine lokale Datei kopiert wird.

  - name: DownloadMyFile
    action: S3Download
    inputs:
      - source: s3://amzn-s3-demo-source-bucket/path/to/package.zip
        destination: C:\myfolder\package.zip
        expectedBucketOwner: 123456789022
        overwrite: false
      - source: s3://amzn-s3-demo-source-bucket/path/to/package.zip
        destination: C:\myfolder\package.zip
        expectedBucketOwner: 123456789022
        overwrite: true
      - source: s3://amzn-s3-demo-source-bucket/path/to/package.zip
        destination: C:\myfolder\package.zip
        expectedBucketOwner: 123456789022

Eingabebeispiel: Alle Amazon S3 S3-Objekte in einem Amazon S3 S3-Bucket mit key prefix in einen lokalen Ordner kopieren

Das folgende Beispiel zeigt, wie alle Amazon S3 S3-Objekte in einem Amazon S3-Bucket mit dem key prefix in einen lokalen Ordner kopiert werden. Amazon S3 hat kein Ordnerkonzept, daher werden alle Objekte kopiert, die dem key prefix entsprechen. Die maximale Anzahl von Objekten, die heruntergeladen werden können, beträgt 1000.

  - name: MyS3DownloadKeyprefix
    action: S3Download
    maxAttempts: 3
    inputs:
      - source: s3://amzn-s3-demo-source-bucket/path/to/*
        destination: C:\myfolder\
        expectedBucketOwner: 123456789022
        overwrite: false
      - source: s3://amzn-s3-demo-source-bucket/path/to/*
        destination: C:\myfolder\
        expectedBucketOwner: 123456789022
        overwrite: true
      - source: s3://amzn-s3-demo-source-bucket/path/to/*
        destination: C:\myfolder\
        expectedBucketOwner: 123456789022

Output

Keine.

S3 Upload

Mit dem Aktionsmodul S3Upload können Sie eine Datei aus einer Quelldatei oder einem Quellordner an einen Amazon S3 S3-Speicherort hochladen. Sie können einen Platzhalter (*) in dem für Ihren Quellspeicherort angegebenen Pfad verwenden, um alle Dateien hochzuladen, deren Pfad dem Platzhaltermuster entspricht.

Wenn die rekursive S3Upload-Aktion fehlschlägt, verbleiben alle Dateien, die bereits hochgeladen wurden, im Amazon S3-Ziel-Bucket.

IAMAnforderungen

Die IAM Rolle, die Sie Ihrem Instanzprofil zuordnen, muss über Berechtigungen zum Ausführen des S3Upload Aktionsmoduls verfügen. Die folgende IAM Richtlinie muss der IAM Rolle zugewiesen werden, die dem Instanzprofil zugeordnet ist. Die Richtlinie muss dem Amazon S3 S3-Ziel-Bucket s3:PutObject Berechtigungen gewähren. Beispiel, arn:aws:s3:::BucketName/*).

Eingabebeispiel: Eine lokale Datei in ein Amazon S3 S3-Objekt kopieren

Das folgende Beispiel zeigt, wie eine lokale Datei in ein Amazon S3 S3-Objekt kopiert wird.

  - name: MyS3UploadFile
    action: S3Upload
    onFailure: Abort
    maxAttempts: 3
    inputs:
      - source: C:\myfolder\package.zip
        destination: s3://amzn-s3-demo-destination-bucket/path/to/package.zip
        expectedBucketOwner: 123456789022

Eingabebeispiel: Kopieren Sie alle Dateien in einem lokalen Ordner in einen Amazon S3 S3-Bucket mit key prefix

Das folgende Beispiel zeigt, wie Sie alle Dateien im lokalen Ordner in einen Amazon S3 S3-Bucket mit key prefix kopieren. In diesem Beispiel werden keine Unterordner oder deren Inhalt kopiert, da dies nicht angegeben recurse ist. Die Standardeinstellung ist. false

  - name: MyS3UploadMultipleFiles
    action: S3Upload
    onFailure: Abort
    maxAttempts: 3
    inputs:
      - source: C:\myfolder\*
        destination: s3://amzn-s3-demo-destination-bucket/path/to/
        expectedBucketOwner: 123456789022

Eingabebeispiel: Alle Dateien und Ordner rekursiv von einem lokalen Ordner in einen Amazon S3 S3-Bucket kopieren

Das folgende Beispiel zeigt, wie alle Dateien und Ordner rekursiv von einem lokalen Ordner in einen Amazon S3 S3-Bucket mit key prefix kopiert werden.

  - name: MyS3UploadFolder
    action: S3Upload
    onFailure: Abort
    maxAttempts: 3
    inputs:
      - source: C:\myfolder\*
        destination: s3://amzn-s3-demo-destination-bucket/path/to/
        recurse: true
        expectedBucketOwner: 123456789022

Output

Keine.

WebDownload

Das WebDownloadAktionsmodul ermöglicht es Ihnen, Dateien und Ressourcen über dasHTTP/HTTPS-Protokoll von einem entfernten Standort herunterzuladen (HTTPSwird empfohlen). Es gibt keine Beschränkungen für die Anzahl oder Größe der Downloads. Dieses Modul verarbeitet Wiederholungsversuche und exponentielle Backoff-Logik.

Jedem Download-Vorgang werden je nach Benutzereingabe maximal 5 Versuche zugewiesen, um erfolgreich zu sein. Diese Versuche unterscheiden sich von den im maxAttempts Dokumentfeld angegebenen Versuchensteps, die sich auf Fehler im Aktionsmodul beziehen.

Dieses Aktionsmodul verarbeitet implizit Weiterleitungen. Alle HTTP Statuscodes, mit Ausnahme von200, führen zu einem Fehler.

Eingabebeispiel: Laden Sie die Remote-Datei in ein lokales Ziel herunter

  - name: DownloadRemoteFile
    action: WebDownload
    maxAttempts: 3
    inputs:
      - source: https://testdomain/path/to/java14.zip
        destination: C:\testfolder\package.zip

Ausgabe:

{
	"destination": "C:\\testfolder\\package.zip"
}

Eingabebeispiel: Laden Sie mehr als eine Remote-Datei an mehr als ein lokales Ziel herunter

  - name: DownloadRemoteFiles
    action: WebDownload
    maxAttempts: 3
    inputs:
      - source: https://testdomain/path/to/java14.zip
        destination: /tmp/java14_renamed.zip
      - source: https://testdomain/path/to/java14.zip
        destination: /tmp/create_new_folder_and_add_java14_as_zip/

Ausgabe:

{
	"destination": "/tmp/create_new_folder/java14_renamed.zip\n/tmp/create_new_folder_and_add_java14_as_zip/java14.zip"
}

Eingabebeispiel: Laden Sie eine Remote-Datei herunter, ohne das lokale Ziel zu überschreiben, und laden Sie eine weitere Remote-Datei mit Dateiüberprüfung herunter

  - name: DownloadRemoteMultipleProperties
    action: WebDownload
    maxAttempts: 3
    inputs:
      - source: https://testdomain/path/to/java14.zip
        destination: C:\create_new_folder\java14_renamed.zip
        overwrite: false
      - source: https://testdomain/path/to/java14.zip
        destination: C:\create_new_folder_and_add_java14_as_zip\
        checksum: ac68bbf921d953d1cfab916cb6120864
        algorithm: MD5
        overwrite: true

Ausgabe:

{
	"destination": "C:\\create_new_folder\\java14_renamed.zip\nC:\\create_new_folder_and_add_java14_as_zip\\java14.zip"
}

Eingabebeispiel: Remote-Datei herunterladen und SSL Zertifizierungsvalidierung ignorieren

  - name: DownloadRemoteIgnoreValidation
    action: WebDownload
    maxAttempts: 3
    inputs:
      - source: https://www.bad-ssl.com/resource
        destination: /tmp/downloads/
        ignoreCertificateErrors: true

Ausgabe:

{
	"destination": "/tmp/downloads/resource"
}

Module für den Betrieb des Dateisystems

Der folgende Abschnitt enthält Einzelheiten zu Aktionsmodulen, die Dateisystemoperationen ausführen.

AppendFile

Das AppendFileAktionsmodul fügt dem bereits vorhandenen Inhalt einer Datei den angegebenen Inhalt hinzu.

Wenn sich der Dateicodierungswert vom Standardwert encoding (utf-8) unterscheidet, können Sie den Dateicodierungswert mithilfe der encoding Option angeben. Standardmäßig wird davon ausgegangen, utf-16 dass utf-32 sie die Little-Endian-Kodierung verwenden.

Das Aktionsmodul gibt einen Fehler zurück, wenn Folgendes eintritt:

Eingabebeispiel: Datei ohne Kodierung anhängen (Linux)

  - name: AppendingFileWithOutEncodingLinux
    action: AppendFile
    inputs:
      - path: ./Sample.txt
        content: "The string to be appended to the file"

Eingabebeispiel: Datei ohne Kodierung anhängen (Windows)

  - name: AppendingFileWithOutEncodingWindows
    action: AppendFile
    inputs:
      - path: C:\MyFolder\MyFile.txt
        content: "The string to be appended to the file"

Eingabebeispiel: Datei mit Kodierung anhängen (Linux)

  - name: AppendingFileWithEncodingLinux
    action: AppendFile
    inputs:
      - path: /FolderName/SampleFile.txt
        content: "The string to be appended to the file"
        encoding: UTF-32

Eingabebeispiel: Datei mit Kodierung anhängen (Windows)

  - name: AppendingFileWithEncodingWindows
    action: AppendFile
    inputs:
      - path: C:\MyFolderName\SampleFile.txt
        content: "The string to be appended to the file"
        encoding: UTF-32

Eingabebeispiel: Datei mit leerer Zeichenfolge anhängen (Linux)

  - name: AppendingEmptyStringLinux
    action: AppendFile
    inputs:
      - path: /FolderName/SampleFile.txt

Eingabebeispiel: Datei mit leerer Zeichenfolge anhängen (Windows)

  - name: AppendingEmptyStringWindows
    action: AppendFile
    inputs:
      - path: C:\MyFolderName\SampleFile.txt

Output

Keine.

CopyFile

Das CopyFileAktionsmodul kopiert Dateien von der angegebenen Quelle zum angegebenen Ziel. Standardmäßig erstellt das Modul den Zielordner rekursiv, wenn er zur Laufzeit nicht vorhanden ist.

Wenn eine Datei mit dem angegebenen Namen bereits im angegebenen Ordner vorhanden ist, überschreibt das Aktionsmodul standardmäßig die vorhandene Datei. Sie können dieses Standardverhalten außer Kraft setzen, indem Sie die Option Überschreiben auf setzen. false Wenn die Option zum Überschreiben auf false gesetzt ist und sich am angegebenen Speicherort bereits eine Datei mit dem angegebenen Namen befindet, gibt das Aktionsmodul einen Fehler zurück. Diese Option funktioniert genauso wie der cp Befehl unter Linux, der standardmäßig überschreibt.

Der Name der Quelldatei kann einen Platzhalter () * enthalten. Platzhalterzeichen werden nur nach dem letzten Dateipfad-Trennzeichen (/oder\) akzeptiert. Wenn der Quelldateiname Platzhalterzeichen enthält, werden alle Dateien, die dem Platzhalter entsprechen, in den Zielordner kopiert. Wenn Sie mehr als eine Datei mithilfe eines Platzhalterzeichens verschieben möchten, muss die Eingabe der destination Option mit einem Dateipfadtrennzeichen (/oder\) enden, das angibt, dass es sich bei der Zieleingabe um einen Ordner handelt.

Wenn sich der Zieldateiname vom Quelldateinamen unterscheidet, können Sie den Zieldateinamen mithilfe der destination Option angeben. Wenn Sie keinen Zieldateinamen angeben, wird der Name der Quelldatei verwendet, um die Zieldatei zu erstellen. Jeder Text, der auf das letzte Dateipfadtrennzeichen (/oder\) folgt, wird als Dateiname behandelt. Wenn Sie denselben Dateinamen wie die Quelldatei verwenden möchten, muss die Eingabe der destination Option mit einem Dateipfadtrennzeichen (/oder\) enden.

Das Aktionsmodul gibt einen Fehler zurück, wenn Folgendes eintritt:

Eingabebeispiel: Eine Datei kopieren (Linux)

  - name: CopyingAFileLinux
    action: CopyFile
    inputs:
      - source: /Sample/MyFolder/Sample.txt
        destination: /MyFolder/destinationFile.txt

Eingabebeispiel: Eine Datei kopieren (Windows)

  - name: CopyingAFileWindows
    action: CopyFile
    inputs:
      - source: C:\MyFolder\Sample.txt
        destination: C:\MyFolder\destinationFile.txt

Eingabebeispiel: Kopiert eine Datei unter Verwendung des Quelldateinamens (Linux)

  - name: CopyingFileWithSourceFileNameLinux
    action: CopyFile
    inputs:
      - source: /Sample/MyFolder/Sample.txt
        destination: /MyFolder/

Eingabebeispiel: Kopieren Sie eine Datei unter Verwendung des Quelldateinamens (Windows)

  - name: CopyingFileWithSourceFileNameWindows
    action: CopyFile
    inputs:
      - source: C:\Sample\MyFolder\Sample.txt
        destination: C:\MyFolder\

Eingabebeispiel: Kopiert eine Datei mit dem Platzhalterzeichen (Linux)

  - name: CopyingFilesWithWildCardLinux
    action: CopyFile
    inputs:
      - source: /Sample/MyFolder/Sample*
        destination: /MyFolder/

Eingabebeispiel: Kopiert eine Datei mit dem Platzhalterzeichen (Windows)

  - name: CopyingFilesWithWildCardWindows
    action: CopyFile
    inputs:
      - source: C:\Sample\MyFolder\Sample*
        destination: C:\MyFolder\

Eingabebeispiel: Eine Datei kopieren, ohne sie zu überschreiben (Linux)

  - name: CopyingFilesWithoutOverwriteLinux
    action: CopyFile
    inputs:
      - source: /Sample/MyFolder/Sample.txt
        destination: /MyFolder/destinationFile.txt
        overwrite: false

Eingabebeispiel: Eine Datei kopieren, ohne sie zu überschreiben (Windows)

  - name: CopyingFilesWithoutOverwriteWindows
    action: CopyFile
    inputs:
      - source: C:\Sample\MyFolder\Sample.txt
        destination: C:\MyFolder\destinationFile.txt
        overwrite: false

Output

Keine.

CopyFolder

Das CopyFolderAktionsmodul kopiert einen Ordner von der angegebenen Quelle zum angegebenen Ziel. Die Eingabe für die source Option ist der zu kopierende Ordner, und die Eingabe für die destination Option ist der Ordner, in den der Inhalt des Quellordners kopiert wird. Standardmäßig erstellt das Modul den Zielordner rekursiv, wenn er zur Laufzeit nicht vorhanden ist.

Wenn im angegebenen Ordner bereits ein Ordner mit dem angegebenen Namen vorhanden ist, überschreibt das Aktionsmodul standardmäßig den vorhandenen Ordner. Sie können dieses Standardverhalten außer Kraft setzen, indem Sie die Option Überschreiben auf setzen. false Wenn die Option zum Überschreiben auf false gesetzt ist und sich am angegebenen Speicherort bereits ein Ordner mit dem angegebenen Namen befindet, gibt das Aktionsmodul einen Fehler zurück.

Der Name des Quellordners kann einen Platzhalter () * enthalten. Platzhalterzeichen werden nur nach dem letzten Dateipfad-Trennzeichen (/oder\) akzeptiert. Wenn Platzhalterzeichen im Quellordnernamen enthalten sind, werden alle Ordner, die dem Platzhalter entsprechen, in den Zielordner kopiert. Wenn Sie mehr als einen Ordner mithilfe eines Platzhalterzeichens kopieren möchten, muss die Eingabe für die destination Option mit einem Dateipfadtrennzeichen (/oder\) enden, was darauf hinweist, dass es sich bei der Zieleingabe um einen Ordner handelt.

Wenn sich der Name des Zielordners vom Namen des Quellordners unterscheidet, können Sie den Namen des Zielordners mithilfe der destination Option angeben. Wenn Sie keinen Zielordnernamen angeben, wird der Name des Quellordners verwendet, um den Zielordner zu erstellen. Jeder Text, der auf das letzte Dateipfadtrennzeichen (/oder\) folgt, wird als Ordnername behandelt. Wenn Sie denselben Ordnernamen wie den Quellordner verwenden möchten, muss die Eingabe der destination Option mit einem Dateipfadtrennzeichen (/oder\) enden.

Das Aktionsmodul gibt einen Fehler zurück, wenn Folgendes eintritt:

Eingabebeispiel: Einen Ordner kopieren (Linux)

  - name: CopyingAFolderLinux
    action: CopyFolder
    inputs:
      - source: /Sample/MyFolder/SampleFolder
        destination: /MyFolder/destinationFolder

Eingabebeispiel: Einen Ordner kopieren (Windows)

  - name: CopyingAFolderWindows
    action: CopyFolder
    inputs:
      - source: C:\Sample\MyFolder\SampleFolder
        destination: C:\MyFolder\destinationFolder

Eingabebeispiel: Kopieren Sie einen Ordner unter Verwendung des Quellordnernamens (Linux)

  - name: CopyingFolderSourceFolderNameLinux
    action: CopyFolder
    inputs:
      - source: /Sample/MyFolder/SourceFolder
        destination: /MyFolder/

Eingabebeispiel: Kopieren Sie einen Ordner unter Verwendung des Quellordnernamens (Windows)

  - name: CopyingFolderSourceFolderNameWindows
    action: CopyFolder
    inputs:
      - source: C:\Sample\MyFolder\SampleFolder
        destination: C:\MyFolder\

Eingabebeispiel: Kopieren Sie einen Ordner mit dem Platzhalterzeichen (Linux)

  - name: CopyingFoldersWithWildCardLinux
    action: CopyFolder
    inputs:
      - source: /Sample/MyFolder/Sample*
        destination: /MyFolder/

Eingabebeispiel: Kopieren Sie einen Ordner mit dem Platzhalterzeichen (Windows)

  - name: CopyingFoldersWithWildCardWindows
    action: CopyFolder
    inputs:
      - source: C:\Sample\MyFolder\Sample*
        destination: C:\MyFolder\

Eingabebeispiel: Einen Ordner kopieren, ohne ihn zu überschreiben (Linux)

  - name: CopyingFoldersWithoutOverwriteLinux
    action: CopyFolder
    inputs:
      - source: /Sample/MyFolder/SourceFolder
        destination: /MyFolder/destinationFolder
        overwrite: false

Eingabebeispiel: Einen Ordner kopieren, ohne ihn zu überschreiben (Windows)

  - name: CopyingFoldersWithoutOverwrite
    action: CopyFolder
    inputs:
      - source: C:\Sample\MyFolder\SourceFolder
        destination: C:\MyFolder\destinationFolder
        overwrite: false

Output

Keine.

CreateFile

Das CreateFileAktionsmodul erstellt eine Datei an einem bestimmten Ort. Standardmäßig erstellt das Modul bei Bedarf auch rekursiv die übergeordneten Ordner.

Wenn die Datei bereits im angegebenen Ordner vorhanden ist, kürzt oder überschreibt das Aktionsmodul standardmäßig die vorhandene Datei. Sie können dieses Standardverhalten außer Kraft setzen, indem Sie die Option Überschreiben auf setzen. false Wenn die Option zum Überschreiben auf false gesetzt ist und sich am angegebenen Speicherort bereits eine Datei mit dem angegebenen Namen befindet, gibt das Aktionsmodul einen Fehler zurück.

Wenn sich der Wert für die Dateikodierung vom Standardwert für die Kodierung (utf-8) unterscheidet, können Sie den Wert für die Dateikodierung mithilfe der encoding Option angeben. Standardmäßig wird davon ausgegangen, utf-16 dass utf-32 sie die Little-Endian-Kodierung verwenden.

owner, und sind group optionale Eingaben. permissions Die Eingabe für permissions muss ein Zeichenkettenwert sein. Dateien werden mit Standardwerten erstellt, wenn sie nicht angegeben werden. Diese Optionen werden auf Windows-Plattformen nicht unterstützt. Dieses Aktionsmodul validiert und gibt einen Fehler zurück, wenn die permissions Optionen ownergroup, und auf Windows-Plattformen verwendet werden.

Dieses Aktionsmodul kann eine Datei mit Berechtigungen erstellen, die durch den umask Standardwert des Betriebssystems definiert sind. Sie müssen den umask Wert festlegen, wenn Sie den Standardwert überschreiben möchten.

Das Aktionsmodul gibt einen Fehler zurück, wenn Folgendes eintritt:

Eingabebeispiel: Eine Datei ohne Überschreiben erstellen (Linux)

  - name: CreatingFileWithoutOverwriteLinux
    action: CreateFile
    inputs:
      - path: /home/UserName/Sample.txt
        content: The text content of the sample file.
        overwrite: false

Eingabebeispiel: Erstellen Sie eine Datei ohne Überschreiben (Windows)

  - name: CreatingFileWithoutOverwriteWindows
    action: CreateFile
    inputs:
      - path: C:\Temp\Sample.txt
        content: The text content of the sample file.
        overwrite: false

Eingabebeispiel: Erstellen Sie eine Datei mit Dateieigenschaften

  - name: CreatingFileWithFileProperties
    action: CreateFile
    inputs:
      - path: SampleFolder/Sample.txt
        content: The text content of the sample file.
        encoding: UTF-16
        owner: Ubuntu
        group: UbuntuGroup
        permissions: 0777
     - path: SampleFolder/SampleFile.txt
        permissions: 755
      - path: SampleFolder/TextFile.txt
        encoding: UTF-16
        owner: root
        group: rootUserGroup

Eingabebeispiel: Erstellen Sie eine Datei ohne Dateieigenschaften

  - name: CreatingFileWithoutFileProperties
    action: CreateFile
    inputs:
      - path: ./Sample.txt
      - path: Sample1.txt

Eingabebeispiel: Erstellen Sie eine leere Datei, um einen Abschnitt im Linux-Bereinigungsskript zu überspringen

  - name: CreateSkipCleanupfile
    action: CreateFile
    inputs:
      - path: <skip section file name>

Weitere Informationen finden Sie unter Überschreiben Sie das Linux-Bereinigungsskript

Output

Keine.

CreateFolder

Das CreateFolderAktionsmodul erstellt einen Ordner an einem bestimmten Ort. Standardmäßig erstellt das Modul bei Bedarf auch rekursiv die übergeordneten Ordner.

Wenn der Ordner bereits im angegebenen Ordner vorhanden ist, kürzt oder überschreibt das Aktionsmodul standardmäßig den vorhandenen Ordner. Sie können dieses Standardverhalten außer Kraft setzen, indem Sie die Option Überschreiben auf setzen. false Wenn die Option zum Überschreiben auf false gesetzt ist und sich am angegebenen Speicherort bereits ein Ordner mit dem angegebenen Namen befindet, gibt das Aktionsmodul einen Fehler zurück.

ownergroup, und permissions sind optionale Eingaben. Die Eingabe für permissions muss ein Zeichenkettenwert sein. Diese Optionen werden auf Windows-Plattformen nicht unterstützt. Dieses Aktionsmodul validiert und gibt einen Fehler zurück, wenn die permissions Optionen ownergroup, und auf Windows-Plattformen verwendet werden.

Dieses Aktionsmodul kann einen Ordner mit Berechtigungen erstellen, die durch den umask Standardwert des Betriebssystems definiert sind. Sie müssen den umask Wert festlegen, wenn Sie den Standardwert überschreiben möchten.

Das Aktionsmodul gibt einen Fehler zurück, wenn Folgendes eintritt:

Eingabebeispiel: Erstellen Sie einen Ordner (Linux)

  - name: CreatingFolderLinux
    action: CreateFolder
    inputs:
      - path: /Sample/MyFolder/

Eingabebeispiel: Erstellen Sie einen Ordner (Windows)

  - name: CreatingFolderWindows
    action: CreateFolder
    inputs:
      - path: C:\MyFolder

Eingabebeispiel: Erstellen Sie einen Ordner, in dem die Ordnereigenschaften angegeben sind

  - name: CreatingFolderWithFolderProperties
    action: CreateFolder
    inputs:
      - path: /Sample/MyFolder/Sample/
        owner: SampleOwnerName
        group: SampleGroupName
        permissions: 0777
      - path: /Sample/MyFolder/SampleFoler/
        permissions: 777

Eingabebeispiel: Erstellen Sie einen Ordner, der den vorhandenen Ordner überschreibt, falls es einen gibt.

  - name: CreatingFolderWithOverwrite
    action: CreateFolder
    inputs:
      - path: /Sample/MyFolder/Sample/
        overwrite: true

Output

Keine.

CreateSymlink

Das CreateSymlinkAktionsmodul erstellt symbolische Links oder Dateien, die einen Verweis auf eine andere Datei enthalten. Dieses Modul wird auf Windows-Plattformen nicht unterstützt.

Die Eingabe für die target Optionen path und kann entweder ein absoluter oder ein relativer Pfad sein. Handelt es sich bei der Eingabe für die path Option um einen relativen Pfad, wird dieser bei der Erstellung des Links durch den absoluten Pfad ersetzt.

Wenn ein Link mit dem angegebenen Namen bereits im angegebenen Ordner vorhanden ist, gibt das Aktionsmodul standardmäßig einen Fehler zurück. Sie können dieses Standardverhalten außer Kraft setzen, indem Sie die force Option auf setzentrue. Wenn die force Option auf gesetzt isttrue, überschreibt das Modul den vorhandenen Link.

Wenn kein übergeordneter Ordner vorhanden ist, erstellt das Aktionsmodul den Ordner standardmäßig rekursiv.

Das Aktionsmodul gibt einen Fehler zurück, wenn Folgendes eintritt:

Eingabebeispiel: Erstellen Sie einen symbolischen Link, der die Erstellung eines Links erzwingt

  - name: CreatingSymbolicLinkWithForce
    action: CreateSymlink
    inputs:
      - path: /Folder2/Symboliclink.txt
        target: /Folder/Sample.txt
        force: true

Eingabebeispiel: Erstellen Sie einen symbolischen Link, der die Erstellung eines Links nicht erzwingt

  - name: CreatingSymbolicLinkWithOutForce
    action: CreateSymlink
    inputs:
      - path: Symboliclink.txt
        target: /Folder/Sample.txt

Output

Keine.

DeleteFile

Das DeleteFileAktionsmodul löscht eine oder mehrere Dateien an einem bestimmten Ort.

Die Eingabe von path sollte ein gültiger Dateipfad oder ein Dateipfad mit einem Platzhalterzeichen (*) im Dateinamen sein. Wenn Platzhalterzeichen im Dateinamen angegeben werden, werden alle Dateien innerhalb desselben Ordners, die dem Platzhalter entsprechen, gelöscht.

Das Aktionsmodul gibt einen Fehler zurück, wenn Folgendes eintritt:

Eingabebeispiel: Eine einzelne Datei löschen (Linux)

  - name: DeletingSingleFileLinux
    action: DeleteFile
    inputs:
      - path: /SampleFolder/MyFolder/Sample.txt

Eingabebeispiel: Eine einzelne Datei löschen (Windows)

  - name: DeletingSingleFileWindows
    action: DeleteFile
    inputs:
      - path: C:\SampleFolder\MyFolder\Sample.txt

Eingabebeispiel: Lösche eine Datei, die mit „log“ endet (Linux)

  - name: DeletingFileEndingWithLogLinux
    action: DeleteFile
    inputs:
      - path: /SampleFolder/MyFolder/*log

Eingabebeispiel: Lösche eine Datei, die mit „log“ endet (Windows)

  - name: DeletingFileEndingWithLogWindows
    action: DeleteFile
    inputs:
      - path: C:\SampleFolder\MyFolder\*log

Eingabebeispiel: lösche alle Dateien in einem angegebenen Ordner (Linux)

  - name: DeletingAllFilesInAFolderLinux
    action: DeleteFile
    inputs:
      - path: /SampleFolder/MyFolder/*

Eingabebeispiel: lösche alle Dateien in einem angegebenen Ordner (Windows)

  - name: DeletingAllFilesInAFolderWindows
    action: DeleteFile
    inputs:
      - path: C:\SampleFolder\MyFolder\*

Output

Keine.

DeleteFolder

Das DeleteFolderAktionsmodul löscht Ordner.

Wenn der Ordner nicht leer ist, müssen Sie die force Option auf setzen, true um den Ordner und seinen Inhalt zu entfernen. Wenn Sie die force Option nicht auf setzen und der Ordnertrue, den Sie löschen möchten, nicht leer ist, gibt das Aktionsmodul einen Fehler zurück. Der Standardwert der force Option istfalse.

Das Aktionsmodul gibt einen Fehler zurück, wenn Folgendes eintritt:

Eingabebeispiel: Löschen Sie einen Ordner, der nicht leer ist, mit der force Option (Linux)

  - name: DeletingFolderWithForceOptionLinux
    action: DeleteFolder
    inputs:
      - path: /Sample/MyFolder/Sample/
        force: true

Eingabebeispiel: Löschen Sie einen Ordner, der nicht leer ist, mit der force Option (Windows)

  - name: DeletingFolderWithForceOptionWindows
    action: DeleteFolder
    inputs:
      - path: C:\Sample\MyFolder\Sample\
        force: true

Eingabebeispiel: einen Ordner löschen (Linux)

  - name: DeletingFolderWithOutForceLinux
    action: DeleteFolder
    inputs:
      - path: /Sample/MyFolder/Sample/

Eingabebeispiel: einen Ordner löschen (Windows)

  - name: DeletingFolderWithOutForce
    action: DeleteFolder
    inputs:
      - path: C:\Sample\MyFolder\Sample\

Output

Keine.

ListFiles

Das ListFilesAktionsmodul listet die Dateien in einem angegebenen Ordner auf. Wenn die Option rekursiv auf gesetzt isttrue, listet sie die Dateien in Unterordnern auf. Dieses Modul listet standardmäßig keine Dateien in Unterordnern auf.

Um alle Dateien aufzulisten, deren Namen einem bestimmten Muster entsprechen, verwenden Sie die fileNamePattern Option zur Angabe des Musters. Die fileNamePattern Option akzeptiert den Platzhalterwert (*). Wenn der angegeben fileNamePattern ist, werden alle Dateien zurückgegeben, die dem angegebenen Dateinamenformat entsprechen.

Das Aktionsmodul gibt einen Fehler zurück, wenn Folgendes eintritt:

Eingabebeispiel: listet Dateien im angegebenen Ordner auf (Linux)

  - name: ListingFilesInSampleFolderLinux
    action: ListFiles
    inputs:
      - path: /Sample/MyFolder/Sample

Eingabebeispiel: Dateien im angegebenen Ordner auflisten (Windows)

  - name: ListingFilesInSampleFolderWindows
    action: ListFiles
    inputs:
      - path: C:\Sample\MyFolder\Sample

Eingabebeispiel: listet Dateien auf, die mit „log“ enden (Linux)

  - name: ListingFilesWithEndingWithLogLinux
    action: ListFiles
    inputs:
      - path: /Sample/MyFolder/
        fileNamePattern: *log

Eingabebeispiel: listet Dateien auf, die mit „log“ enden (Windows)

  - name: ListingFilesWithEndingWithLogWindows
    action: ListFiles
    inputs:
      - path: C:\Sample\MyFolder\
        fileNamePattern: *log

Eingabebeispiel: Dateien rekursiv auflisten

  - name: ListingFilesRecursively
    action: ListFiles
    inputs:
      - path: /Sample/MyFolder/
        recursive: true

Output example

{
	"files": "/sample1.txt,/sample2.txt,/sample3.txt"
}

MoveFile

Das MoveFileAktionsmodul verschiebt Dateien von der angegebenen Quelle zum angegebenen Ziel.

Wenn die Datei bereits im angegebenen Ordner vorhanden ist, überschreibt das Aktionsmodul standardmäßig die vorhandene Datei. Sie können dieses Standardverhalten außer Kraft setzen, indem Sie die Option Überschreiben auf setzen. false Wenn die Option zum Überschreiben auf false gesetzt ist und sich am angegebenen Speicherort bereits eine Datei mit dem angegebenen Namen befindet, gibt das Aktionsmodul einen Fehler zurück. Diese Option funktioniert genauso wie der mv Befehl unter Linux, der standardmäßig überschreibt.

Der Name der Quelldatei kann einen Platzhalter () * enthalten. Platzhalterzeichen werden nur nach dem letzten Dateipfad-Trennzeichen (/oder\) akzeptiert. Wenn der Quelldateiname Platzhalterzeichen enthält, werden alle Dateien, die dem Platzhalter entsprechen, in den Zielordner kopiert. Wenn Sie mehr als eine Datei mithilfe eines Platzhalterzeichens verschieben möchten, muss die Eingabe der destination Option mit einem Dateipfadtrennzeichen (/oder\) enden, das angibt, dass es sich bei der Zieleingabe um einen Ordner handelt.

Wenn sich der Zieldateiname vom Quelldateinamen unterscheidet, können Sie den Zieldateinamen mithilfe der destination Option angeben. Wenn Sie keinen Zieldateinamen angeben, wird der Name der Quelldatei verwendet, um die Zieldatei zu erstellen. Jeder Text, der auf das letzte Dateipfadtrennzeichen (/oder\) folgt, wird als Dateiname behandelt. Wenn Sie denselben Dateinamen wie die Quelldatei verwenden möchten, muss die Eingabe der destination Option mit einem Dateipfadtrennzeichen (/oder\) enden.

Das Aktionsmodul gibt einen Fehler zurück, wenn Folgendes eintritt:

Eingabebeispiel: Eine Datei verschieben (Linux)

  - name: MovingAFileLinux
    action: MoveFile
    inputs:
      - source: /Sample/MyFolder/Sample.txt
        destination: /MyFolder/destinationFile.txt

Eingabebeispiel: Eine Datei verschieben (Windows)

  - name: MovingAFileWindows
    action: MoveFile
    inputs:
      - source: C:\Sample\MyFolder\Sample.txt
        destination: C:\MyFolder\destinationFile.txt

Eingabebeispiel: Verschieben Sie eine Datei unter Verwendung des Quelldateinamens (Linux)

  - name: MovingFileWithSourceFileNameLinux
    action: MoveFile
    inputs:
      - source: /Sample/MyFolder/Sample.txt
        destination: /MyFolder/

Eingabebeispiel: Verschieben Sie eine Datei unter Verwendung des Quelldateinamens (Windows)

  - name: MovingFileWithSourceFileNameWindows
    action: MoveFile
    inputs:
      - source: C:\Sample\MyFolder\Sample.txt
        destination: C:\MyFolder

Eingabebeispiel: Verschieben Sie eine Datei mit einem Platzhalterzeichen (Linux)

  - name: MovingFilesWithWildCardLinux
    action: MoveFile
    inputs:
      - source: /Sample/MyFolder/Sample*
        destination: /MyFolder/

Eingabebeispiel: Verschieben Sie eine Datei mit einem Platzhalterzeichen (Windows)

  - name: MovingFilesWithWildCardWindows
    action: MoveFile
    inputs:
      - source: C:\Sample\MyFolder\Sample*
        destination: C:\MyFolder

Eingabebeispiel: Eine Datei verschieben, ohne sie zu überschreiben (Linux)

  - name: MovingFilesWithoutOverwriteLinux
    action: MoveFile
    inputs:
      - source: /Sample/MyFolder/Sample.txt
        destination: /MyFolder/destinationFile.txt
        overwrite: false

Eingabebeispiel: Eine Datei verschieben, ohne sie zu überschreiben (Windows)

  - name: MovingFilesWithoutOverwrite
    action: MoveFile
    inputs:
      - source: C:\Sample\MyFolder\Sample.txt
        destination: C:\MyFolder\destinationFile.txt
        overwrite: false

Output

Keine.

MoveFolder

Das MoveFolderAktionsmodul verschiebt Ordner von der angegebenen Quelle zum angegebenen Ziel. Die Eingabe für die source Option ist der Ordner, der verschoben werden soll, und die Eingabe für die destination Option ist der Ordner, in den der Inhalt der Quellordner verschoben wird.

Wenn der übergeordnete Zielordner oder die Eingabe für die destination Option zur Laufzeit nicht vorhanden sind, besteht das Standardverhalten des Moduls darin, den Ordner rekursiv am angegebenen Ziel zu erstellen.

Wenn im Zielordner bereits ein Ordner vorhanden ist, der mit dem Quellordner identisch ist, überschreibt das Aktionsmodul standardmäßig den vorhandenen Ordner. Sie können dieses Standardverhalten außer Kraft setzen, indem Sie die Option Überschreiben auf setzen. false Wenn die Option zum Überschreiben auf false gesetzt ist und sich am angegebenen Speicherort bereits ein Ordner mit dem angegebenen Namen befindet, gibt das Aktionsmodul einen Fehler zurück.

Der Name des Quellordners kann einen Platzhalter () * enthalten. Platzhalterzeichen werden nur nach dem letzten Dateipfad-Trennzeichen (/oder\) akzeptiert. Wenn Platzhalterzeichen im Quellordnernamen enthalten sind, werden alle Ordner, die dem Platzhalter entsprechen, in den Zielordner kopiert. Wenn Sie mehr als einen Ordner mithilfe eines Platzhalterzeichens verschieben möchten, muss die Eingabe für die destination Option mit einem Dateipfadtrennzeichen (/oder\) enden, was darauf hinweist, dass es sich bei der Zieleingabe um einen Ordner handelt.

Wenn sich der Name des Zielordners vom Namen des Quellordners unterscheidet, können Sie den Namen des Zielordners mithilfe der destination Option angeben. Wenn Sie keinen Zielordnernamen angeben, wird der Name des Quellordners verwendet, um den Zielordner zu erstellen. Jeder Text, der auf das letzte Dateipfadtrennzeichen (/oder\) folgt, wird als Ordnername behandelt. Wenn Sie denselben Ordnernamen wie den Quellordner verwenden möchten, muss die Eingabe der destination Option mit einem Dateipfadtrennzeichen (/oder\) enden.

Das Aktionsmodul gibt einen Fehler zurück, wenn Folgendes eintritt:

Eingabebeispiel: Einen Ordner verschieben (Linux)

  - name: MovingAFolderLinux
    action: MoveFolder
    inputs:
      - source: /Sample/MyFolder/SourceFolder
        destination: /MyFolder/destinationFolder

Eingabebeispiel: Einen Ordner verschieben (Windows)

  - name: MovingAFolderWindows
    action: MoveFolder
    inputs:
      - source: C:\Sample\MyFolder\SourceFolder
        destination: C:\MyFolder\destinationFolder

Eingabebeispiel: Verschieben Sie einen Ordner unter Verwendung des Quellordnernamens (Linux)

  - name: MovingFolderWithSourceFolderNameLinux
    action: MoveFolder
    inputs:
      - source: /Sample/MyFolder/SampleFolder
        destination: /MyFolder/

Eingabebeispiel: Verschieben Sie einen Ordner mit dem Namen des Quellordners (Windows)

  - name: MovingFolderWithSourceFolderNameWindows
    action: MoveFolder
    inputs:
      - source: C:\Sample\MyFolder\SampleFolder
        destination: C:\MyFolder\

Eingabebeispiel: Verschieben Sie einen Ordner mithilfe eines Platzhalterzeichens (Linux)

  - name: MovingFoldersWithWildCardLinux
    action: MoveFolder
    inputs:
      - source: /Sample/MyFolder/Sample*
        destination: /MyFolder/

Eingabebeispiel: Verschieben Sie einen Ordner mithilfe eines Platzhalterzeichens (Windows)

  - name: MovingFoldersWithWildCardWindows
    action: MoveFolder
    inputs:
      - source: C:\Sample\MyFolder\Sample*
        destination: C:\MyFolder\

Eingabebeispiel: Einen Ordner verschieben, ohne ihn zu überschreiben (Linux)

  - name: MovingFoldersWithoutOverwriteLinux
    action: MoveFolder
    inputs:
      - source: /Sample/MyFolder/SampleFolder
    destination: /MyFolder/destinationFolder
    overwrite: false

Eingabebeispiel: Einen Ordner verschieben, ohne ihn zu überschreiben (Windows)

  - name: MovingFoldersWithoutOverwriteWindows
    action: MoveFolder
    inputs:
      - source: C:\Sample\MyFolder\SampleFolder
        destination: C:\MyFolder\destinationFolder
        overwrite: false

Output

Keine.

ReadFile

Das ReadFileAktionsmodul liest den Inhalt einer Textdatei vom Typ Zeichenfolge. Dieses Modul kann verwendet werden, um den Inhalt einer Datei zur Verwendung in nachfolgenden Schritten durch Verkettung oder zum Lesen von Daten in die console.log Datei zu lesen. Wenn der angegebene Pfad ein symbolischer Link ist, gibt dieses Modul den Inhalt der Zieldatei zurück. Dieses Modul unterstützt nur Textdateien.

Wenn sich der Dateicodierungswert vom Standardwert encoding (utf-8) unterscheidet, können Sie den Dateicodierungswert mithilfe der encoding Option angeben. Standardmäßig wird davon ausgegangen, utf-16 dass utf-32 sie die Little-Endian-Kodierung verwenden.

Standardmäßig kann dieses Modul den Dateiinhalt nicht in die Datei drucken. console.log Sie können diese Einstellung überschreiben, indem Sie die printFileContent Eigenschaft auf setzentrue.

Dieses Modul kann nur den Inhalt einer Datei zurückgeben. Es kann keine Dateien wie Excel oder JSON Dateien analysieren.

Das Aktionsmodul gibt einen Fehler zurück, wenn Folgendes eintritt:

Eingabebeispiel: Eine Datei lesen (Linux)

  - name: ReadingFileLinux
    action: ReadFile
    inputs:
      - path: /home/UserName/SampleFile.txt

Eingabebeispiel: eine Datei lesen (Windows)

  - name: ReadingFileWindows
    action: ReadFile
    inputs:
      - path: C:\Windows\WindowsUpdate.log

Eingabebeispiel: Eine Datei lesen und den Kodierungsstandard angeben

  - name: ReadingFileWithFileEncoding
    action: ReadFile
    inputs:
      - path: /FolderName/SampleFile.txt
        encoding: UTF-32

Eingabebeispiel: Eine Datei lesen und in die console.log Datei drucken

  - name: ReadingFileToConsole
    action: ReadFile
    inputs:
      - path: /home/UserName/SampleFile.txt
        printFileContent: true

Output example

{
	"content" : "The file content"
}

SetFileEncoding

Das SetFileEncodingAktionsmodul ändert die Kodierungseigenschaft einer vorhandenen Datei. Dieses Modul kann die Dateikodierung von utf-8 zu einem bestimmten Kodierungsstandard konvertieren. Standardmäßig wird davon ausgegangen, utf-16 dass utf-32 es sich um Little-Endian-Kodierung handelt.

Das Aktionsmodul gibt einen Fehler zurück, wenn Folgendes eintritt:

Eingabebeispiel: Legen Sie die Eigenschaft für die Dateikodierung fest

  - name: SettingFileEncodingProperty
    action: SetFileEncoding
    inputs:
      - path: /home/UserName/SampleFile.txt
        encoding: UTF-16

Output

Keine.

SetFileOwner

Das SetFileOwnerAktionsmodul ändert die Eigenschaften owner und group Eigentümer einer vorhandenen Datei. Wenn es sich bei der angegebenen Datei um einen symbolischen Link handelt, ändert das Modul die owner Eigenschaft der Quelldatei. Dieses Modul wird auf Windows-Plattformen nicht unterstützt.

Dieses Modul akzeptiert Benutzer- und Gruppennamen als Eingaben. Wenn der Gruppenname nicht angegeben wird, weist das Modul den Gruppeneigentümer der Datei der Gruppe zu, zu der der Benutzer gehört.

Das Aktionsmodul gibt einen Fehler zurück, wenn Folgendes eintritt:

Eingabebeispiel: Legen Sie die Eigenschaft des Dateibesitzers fest, ohne den Namen der Benutzergruppe anzugeben

  - name: SettingFileOwnerPropertyNoGroup
    action: SetFileOwner
    inputs:
      - path: /home/UserName/SampleText.txt
        owner: LinuxUser

Eingabebeispiel: Legen Sie die Eigenschaft des Dateibesitzers fest, indem Sie den Eigentümer und die Benutzergruppe angeben

  - name: SettingFileOwnerProperty
    action: SetFileOwner
    inputs:
      - path: /home/UserName/SampleText.txt
        owner: LinuxUser
        group: LinuxUserGroup

Output

Keine.

SetFolderOwner

Das SetFolderOwnerAktionsmodul ändert rekursiv die Eigenschaften owner und group Eigentümer eines vorhandenen Ordners. Standardmäßig kann das Modul die Eigentümerschaft für den gesamten Inhalt eines Ordners ändern. Sie können die recursive Option auf setzen, false um dieses Verhalten zu überschreiben. Dieses Modul wird auf Windows-Plattformen nicht unterstützt.

Dieses Modul akzeptiert Benutzer- und Gruppennamen als Eingaben. Wenn der Gruppenname nicht angegeben wird, weist das Modul den Gruppeneigentümer der Datei der Gruppe zu, zu der der Benutzer gehört.

Das Aktionsmodul gibt einen Fehler zurück, wenn Folgendes eintritt:

Eingabebeispiel: Legen Sie die Eigenschaft des Ordnerbesitzers fest, ohne den Namen der Benutzergruppe anzugeben

  - name: SettingFolderPropertyWithOutGroup
    action: SetFolderOwner
    inputs:
      - path: /SampleFolder/
        owner: LinuxUser

Eingabebeispiel: Legen Sie die Eigenschaft des Ordnerbesitzers fest, ohne die Eigentümerschaft aller Inhalte in einem Ordner zu überschreiben

  - name: SettingFolderPropertyWithOutRecursively
    action: SetFolderOwner
    inputs:
      - path: /SampleFolder/
        owner: LinuxUser
        recursive: false

Eingabebeispiel: Legen Sie die Eigenschaft „Dateibesitz“ fest, indem Sie den Namen der Benutzergruppe angeben

  - name: SettingFolderPropertyWithGroup
    action: SetFolderOwner
    inputs:
      - path: /SampleFolder/
        owner: LinuxUser
        group: LinuxUserGroup

Output

Keine.

SetFilePermissions

Das SetFilePermissionsAktionsmodul ändert die permissions einer vorhandenen Datei. Dieses Modul wird auf Windows-Plattformen nicht unterstützt.

Die Eingabe für permissions muss ein Zeichenkettenwert sein.

Dieses Aktionsmodul kann eine Datei mit Berechtigungen erstellen, die durch den Standard-Umask-Wert des Betriebssystems definiert sind. Sie müssen den umask Wert festlegen, wenn Sie den Standardwert überschreiben möchten.

Das Aktionsmodul gibt einen Fehler zurück, wenn Folgendes eintritt:

Eingabebeispiel: Dateiberechtigungen ändern

  - name: ModifyingFilePermissions
    action: SetFilePermissions
    inputs:
      - path: /home/UserName/SampleFile.txt
        permissions: 766

Output

Keine.

SetFolderPermissions

Das SetFolderPermissionsAktionsmodul ändert rekursiv den permissions eines vorhandenen Ordners und all seiner Unterdateien und Unterordner. Standardmäßig kann dieses Modul die Berechtigungen für den gesamten Inhalt des angegebenen Ordners ändern. Sie können die recursive Option auf setzen, false um dieses Verhalten zu überschreiben. Dieses Modul wird auf Windows-Plattformen nicht unterstützt.

Die Eingabe für permissions muss ein Zeichenkettenwert sein.

Dieses Aktionsmodul kann Berechtigungen entsprechend dem Standard-Umask-Wert des Betriebssystems ändern. Sie müssen den umask Wert festlegen, wenn Sie den Standardwert überschreiben möchten.

Das Aktionsmodul gibt einen Fehler zurück, wenn Folgendes eintritt:

Eingabebeispiel: Ordnerberechtigungen festlegen

  - name: SettingFolderPermissions
    action: SetFolderPermissions
    inputs:
      - path: SampleFolder/
        permissions: 0777

Eingabebeispiel: Ordnerberechtigungen festlegen, ohne die Berechtigungen für den gesamten Inhalt eines Ordners zu ändern

  - name: SettingFolderPermissionsNoRecursive
    action: SetFolderPermissions
    inputs:
      - path: /home/UserName/SampleFolder/
        permissions: 777
        recursive: false

Output

Keine.

Aktionen zur Softwareinstallation

Im folgenden Abschnitt werden Aktionsmodule beschrieben, mit denen Software installiert oder deinstalliert wird.

IAMAnforderungen

Wenn Ihr Installations-Download-Pfad ein S3 istURI, muss die IAM Rolle, die Sie Ihrem Instanzprofil zuordnen, über die Berechtigung verfügen, das S3Download Aktionsmodul auszuführen. Um die erforderliche Berechtigung zu erteilen, fügen Sie die S3:GetObject IAM Richtlinie der IAM Rolle hinzu, die Ihrem Instanzprofil zugeordnet ist, und geben Sie den Pfad für Ihren Bucket an. Beispiel, arn:aws:s3:::BucketName/*).

Komplexe MSI Eingaben

Wenn Ihre Eingabezeichenfolgen doppelte Anführungszeichen (") enthalten, müssen Sie eine der folgenden Methoden verwenden, um sicherzustellen, dass sie korrekt interpretiert werden:

Beide Methoden übergeben den Wert COMPANYNAME="Acme ""Widgets"" and ""Gizmos.""" an den msiexec Befehl.

Installieren MSI

Das InstallMSI Aktionsmodul installiert eine Windows-Anwendung mithilfe einer MSI Datei. Sie können die MSI Datei mithilfe eines lokalen Pfads, eines S3-Objekts URI oder eines Webs angebenURL. Die Neustartoption konfiguriert das Neustartverhalten des Systems.

AWSTOE generiert den msiexec Befehl auf der Grundlage der Eingabeparameter für das Aktionsmodul. Werte für die Eingabeparameter path (MSIDateispeicherort) und logFile (Speicherort der Protokolldatei) müssen in Anführungszeichen („) eingeschlossen werden.

Die folgenden MSI Exit-Codes werden als erfolgreich angesehen:

Beispiele

Die folgenden Beispiele zeigen Varianten des Eingabeabschnitts für Ihr Komponentendokument, abhängig von Ihrem Installationspfad.

Eingabebeispiel: Installation im lokalen Dokumentpfad

- name: local-path-install
  steps:
    - name: LocalPathInstaller
      action: InstallMSI
      inputs:
        path: C:\sample.msi
        logFile: C:\msilogs\local-path-install.log
        logOptions: '*VX'
        reboot: Allow
        properties:
          COMPANYNAME: '"Amazon Web Services"'
        ignoreAuthenticodeSignatureErrors: true
        allowUnsignedInstaller: true

Eingabebeispiel: Amazon S3 S3-Pfadinstallation

- name: s3-path-install
  steps:
    - name: S3PathInstaller
      action: InstallMSI
      inputs:
        path: s3://<bucket-name>/sample.msi
        logFile: s3-path-install.log
        reboot: Force
        ignoreAuthenticodeSignatureErrors: false
        allowUnsignedInstaller: true

Eingabebeispiel: Installation eines Webpfads

- name: web-path-install
  steps:
    - name: WebPathInstaller
      action: InstallMSI
      inputs:
        path: https://<some-path>/sample.msi
        logFile: web-path-install.log
        reboot: Skip
        ignoreAuthenticodeSignatureErrors: true
        allowUnsignedInstaller: false

Output

Das Folgende ist ein Beispiel für die Ausgabe des InstallMSI Aktionsmoduls.

{
	"logFile": "web-path-install.log",
	"msiExitCode": 0,
	"stdout": ""
}

Deinstallieren MSI

Das UninstallMSI Aktionsmodul ermöglicht es Ihnen, eine Windows-Anwendung mithilfe einer MSI Datei zu entfernen. Sie können den Speicherort der MSI Datei mithilfe eines lokalen Dateipfads, eines S3-Objekts URI oder eines Webs angebenURL. Die Neustartoption konfiguriert das Neustartverhalten des Systems.

AWSTOE generiert den msiexec Befehl auf der Grundlage der Eingabeparameter für das Aktionsmodul. Der Speicherort der MSI Datei (path) und der Speicherort der Protokolldatei (logFile) werden bei der Generierung des msiexec Befehls explizit in doppelte Anführungszeichen („) eingeschlossen.

Die folgenden MSI Exit-Codes werden als erfolgreich angesehen:

Beispiele

Die folgenden Beispiele zeigen Varianten des Eingabeabschnitts für Ihr Komponentendokument, abhängig von Ihrem Installationspfad.

Eingabebeispiel: Installation des lokalen Dokumentpfads entfernen

- name: local-path-uninstall
  steps:
    - name: LocalPathUninstaller
      action: UninstallMSI
      inputs:
        path: C:\sample.msi
        logFile: C:\msilogs\local-path-uninstall.log
        logOptions: '*VX'
        reboot: Allow
        properties:
          COMPANYNAME: '"Amazon Web Services"'
        ignoreAuthenticodeSignatureErrors: true
        allowUnsignedInstaller: true

Eingabebeispiel: Amazon S3 S3-Pfadinstallation entfernen

- name: s3-path-uninstall
  steps:
    - name: S3PathUninstaller
      action: UninstallMSI
      inputs:
        path: s3://<bucket-name>/sample.msi
        logFile: s3-path-uninstall.log
        reboot: Force
        ignoreAuthenticodeSignatureErrors: false
        allowUnsignedInstaller: true

Eingabebeispiel: Webpfad-Installation entfernen

- name: web-path-uninstall
  steps:
    - name: WebPathUninstaller
      action: UninstallMSI
      inputs:
        path: https://<some-path>/sample.msi
        logFile: web-path-uninstall.log
        reboot: Skip
        ignoreAuthenticodeSignatureErrors: true
        allowUnsignedInstaller: false

Output

Das Folgende ist ein Beispiel für die Ausgabe des UninstallMSI Aktionsmoduls.

{
	"logFile": "web-path-uninstall.log",
	"msiExitCode": 0,
	"stdout": ""
}

Aktionsmodule des Systems

Im folgenden Abschnitt werden Aktionsmodule beschrieben, die Systemaktionen ausführen oder Systemeinstellungen aktualisieren.

Neustart

Das Aktionsmodul Reboot startet die Instanz neu. Es verfügt über eine konfigurierbare Option, um den Start des Neustarts zu verzögern. Standardmäßig delaySeconds ist auf eingestellt, was bedeutet0, dass es keine Verzögerung gibt. Das Schrittzeitlimit wird für das Aktionsmodul Neustart nicht unterstützt, da es nicht gilt, wenn die Instanz neu gestartet wird.

Wenn die Anwendung vom Systems Manager Agent aufgerufen wird, übergibt sie den Exit-Code (3010für Windows, 194 für Linux) an den Systems Manager Agent. Der Systems Manager Agent führt den Systemneustart wie unter Managed Instance from Scripts neu starten beschrieben durch.

Wenn die Anwendung auf dem Host als eigenständiger Prozess aufgerufen wird, speichert sie den aktuellen Ausführungsstatus, konfiguriert einen Auslöser für die automatische Ausführung nach dem Neustart, sodass die Anwendung nach dem Neustart erneut ausgeführt wird, und startet dann das System neu.

Automatischer Start-Trigger nach dem Neustart:

@reboot /download/path/awstoe run --document s3://bucket/key/doc.yaml

Dieser Trigger wird bereinigt, wenn die Anwendung gestartet wird.

Um das Reboot-Aktionsmodul für Schritte zu verwenden, die einen Neustart beinhalten exitcode (z. B.3010), müssen Sie die Anwendungsbinärdatei als ausführensudo user.

Eingabebeispiel: Neustart-Schritt

  - name: RebootStep
    action: Reboot
    onFailure: Abort
    maxAttempts: 2
    inputs:
      delaySeconds: 60

Ausgabe

Keine.

Wenn das Reboot-Modul abgeschlossen ist, fährt Image Builder mit dem nächsten Schritt im Build fort.

SetRegistry

Das SetRegistryAktionsmodul akzeptiert eine Liste von Eingaben und ermöglicht es Ihnen, den Wert für den angegebenen Registrierungsschlüssel festzulegen. Wenn ein Registrierungsschlüssel nicht existiert, wird er im definierten Pfad erstellt. Diese Funktion gilt nur für Windows.

Eingabebeispiel: Legen Sie die Werte der Registrierungsschlüssel fest

  - name: SetRegistryKeyValues
    action: SetRegistry
    maxAttempts: 3
    inputs:
      - path: HKLM:\SOFTWARE\MySoftWare
        name: MyName
        value: FirstVersionSoftware
        type: SZ
      - path: HKEY_CURRENT_USER\Software\Test
        name: Version
        value: 1.1
        type: DWORD

Ausgabe

Keine.

OS aktualisieren

Das UpdateOS-Aktionsmodul bietet Unterstützung für die Installation von Windows- und Linux-Updates. Es installiert standardmäßig alle verfügbaren Updates. Alternativ können Sie eine Liste mit einem oder mehreren spezifischen Updates konfigurieren, die das Aktionsmodul installieren soll. Sie können auch Updates angeben, die von der Installation ausgeschlossen werden sollen.

Wenn sowohl die Listen „Einschließen“ als auch „Ausschließen“ bereitgestellt werden, kann die resultierende Liste von Updates nur die Updates enthalten, die in der „Einschluss“ -Liste aufgeführt sind und nicht in der Ausschlussliste aufgeführt sind.

Eingabebeispiel: Unterstützung für die Installation von Linux-Updates hinzufügen

  - name: UpdateMyLinux
    action: UpdateOS
    onFailure: Abort
    maxAttempts: 3
    inputs:
      exclude:
        - ec2-hibinit-agent

Eingabebeispiel: Unterstützung für die Installation von Windows-Updates hinzufügen

  - name: UpdateWindowsOperatingSystem
    action: UpdateOS
    onFailure: Abort
    maxAttempts: 3
    inputs:
      include:
        - KB1234567
        - '*Security*'

Ausgabe

Keine.