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.

Verwenden Sie Variablen in Ihrem Dokument mit benutzerdefinierten Komponenten

Variablen bieten eine Möglichkeit, Daten mit aussagekräftigen Namen zu versehen, die in der gesamten Anwendung verwendet werden können. Sie können benutzerdefinierte Variablen mit einfachen und lesbaren Formaten für komplexe Workflows definieren und sie im YAML-Anwendungskomponentendokument für eine AWSTOE Komponente referenzieren.

Dieser Abschnitt enthält Informationen, die Ihnen helfen, Variablen für Ihre AWSTOE Komponente im Dokument für die YAML-Anwendungskomponente zu definieren, einschließlich Syntax, Namenseinschränkungen und Beispielen.

Konstanten

Konstanten sind unveränderliche Variablen, die nach ihrer Definition nicht geändert oder überschrieben werden können. Konstanten können mithilfe von Werten im Abschnitt eines Dokuments definiert werden. constants AWSTOE

Syntax

constants:
  - <name>:
      type: <constant type>
      value: <constant value>

Verweisen Sie auf konstante Werte in einem Dokument

Sie können in Step- oder Loop-Eingaben in Ihrem YAML-Dokument wie folgt auf Konstanten verweisen:

Beispiele

In Schritteingaben referenzierte Konstante

name: Download AWS CLI version 2
schemaVersion: 1.0
constants:
  - Source:
      type: string
      value: https://awscli.amazonaws.com/AWSCLIV2.msi
phases:
  - name: build
    steps:
      - name: Download
        action: WebDownload
        inputs:
          - source: '{{ Source }}'
            destination: 'C:\Windows\Temp\AWSCLIV2.msi'

In Loop-Eingängen wird auf eine Konstante verwiesen

name: PingHosts
schemaVersion: 1.0
constants:
  - Hosts:
      type: string
      value: 127.0.0.1,amazon.com
phases:
  - name: build
    steps:
      - name: Ping
        action: ExecuteBash
        loop:
          forEach:
            list: '{{ Hosts }}'
            delimiter: ','
        inputs:
          commands:
            - ping -c 4 {{ loop.value }}

Parameters

Parameter sind veränderbare Variablen mit Einstellungen, die die aufrufende Anwendung zur Laufzeit bereitstellen kann. Sie können Parameter im Parameters Abschnitt des YAML-Dokuments definieren.

Syntax

parameters:
  - <name>:
      type: <parameter type>
      default: <parameter value>
      description: <parameter description>

Referenzparameterwerte in einem Dokument

Sie können Parameter in Step- oder Loop-Eingaben innerhalb Ihres YAML-Dokuments wie folgt referenzieren:

Beispiele

Die folgenden Beispiele zeigen, wie Sie Parameter in Ihrem YAML-Dokument verwenden können:

Parameter zur Laufzeit überschreiben

Sie können die --parameters Option AWS CLI mit einem Schlüssel-Wert-Paar verwenden, um zur Laufzeit einen Parameterwert festzulegen.

Syntax

--parameters name1=value1,name2=value2...

Beispiele

Die folgenden Beispiele zeigen, wie Sie Parameter in Ihrem YAML-Dokument verwenden können:

Verwenden Sie die Parameter Store-Parameter von Systems Manager

Sie können AWS Systems Manager Parameter Store-Parameter (SSM-Parameter) in Ihren Komponentendokumenten referenzieren, indem Sie Variablen das Präfix voranstellen. aws:ssm Zum Beispiel

{{ aws:ssm:/my/param }}wird in den Wert des SSM-Parameters aufgelöst. /my/param

Diese Funktion unterstützt die folgenden SSM-Parametertypen:

Weitere Informationen zum Parameterspeicher finden Sie unter AWS Systems Manager Parameterspeicher im AWS Systems Manager Benutzerhandbuch.

Sie können auch mithilfe eines SSM-Parameters SecureString auf AWS Secrets Manager Geheimnisse verweisen. Beispiel: {{ aws:ssm:/aws/reference/secretsmanager/test/test-secret }}. Weitere Informationen finden Sie unter Referenzieren von AWS Secrets Manager Geheimnissen aus Parameterspeicher-Parametern.

Erforderliche IAM-Berechtigungen

Um Systems Manager Manager-Parameter in Ihren Komponenten verwenden zu können, muss Ihre Instanzrolle über die ssm:GetParameter Berechtigung für die Parameterressource ARN verfügen. Beispiel:

JSON

{
	"Version":"2012-10-17",
	"Statement": [
		{
			"Effect": "Allow",
			"Action": "ssm:GetParameter",
			"Resource": "arn:aws:ssm:*:111122223333:parameter/ImageBuilder-*"
		}
	]
}

Für den Zugriff auf verschlüsselte Werte benötigen Sie außerdem die folgenden Berechtigungen:

Verweisen Sie in einem Komponentendokument auf einen SSM-Parameter

Das folgende Beispiel zeigt, wie auf einen Systems Manager Parameter Store-Parameter von Systems Manager Manager-Parametern in einer Komponente verwiesen wird:

name: UseSSMParameterVariable
description: This is a sample component document that prints out the value of an SSM Parameter. Never do this for a SecureString parameter.
schemaVersion: 1.0

phases:
  - name: verify
    steps:
      - name: EchoParameterValue
        action: ExecuteBash
        inputs:
          commands:
            - echo "Log SSM parameter name: /my/test/param, value {{ aws:ssm:/my/test/param }}."

Dynamische Auflösung von Laufzeitvariablen für SSM-Parameter

AWSTOE bietet die folgende integrierte Funktion, die Sie innerhalb von Variablenreferenzen verwenden können, um Werte zur Laufzeit zu manipulieren oder zu transformieren.

Funktion auflösen

Die resolve Funktion löst eine Variablenreferenz innerhalb einer anderen Variablenreferenz auf und ermöglicht so eine dynamische Referenzierung von Variablennamen. Dies ist nützlich, wenn Sie mit SSM-Parametern arbeiten, bei denen ein Teil des Parameterpfads variabel sein und als Dokumentparameter übergeben werden kann.

Die resolve Funktion unterstützt nur die dynamische Auflösung des Namensteils eines SSM-Parameters.

Syntax

Das dynamic_variable folgende Beispiel stellt den Namen eines SSM-Parameters dar und muss einer der folgenden sein:

{{ aws:ssm:resolve(dynamic_variable) }}

Beispiel: Einen SSM-Parameter zur Laufzeit auflösen

Das folgende Beispiel zeigt, wie die resolve Funktion in einem YAML-Komponentendokument verwendet wird:

name: SsmParameterTest
description: This component verifies an SSM parameter variable reference with the echo command.
schemaVersion: 1.0

parameters:
  - parameter-name:
      type: string
      description: "test"

phases:
  - name: validate
    steps:
      - name: PrintDynamicVariable
        action: ExecuteBash
        inputs:
          commands:
            - echo "{{ aws:ssm:resolve(parameter-name) }}"

Verwenden Sie Umgebungsvariablen

AWSTOE kann Umgebungsvariablen des Betriebssystems auflösen, die auf der Build- oder Testinstanz gesetzt sind. Um auf eine Umgebungsvariable zu verweisen, stellen Sie dem Variablennamen ein Präfix voranenv:. {{ env:MY_VAR }}Löst sich beispielsweise in den Wert der MY_VAR Umgebungsvariablen auf der Instanz auf.

AWSTOE stimmt exakt mit den Namen der Umgebungsvariablen überein. Ein Name kann alle Zeichen enthalten, die für das Betriebssystem gültig sind, einschließlich Punkte, Leerzeichen und Klammern. {{ env:ProgramFiles(x86) }}Ist beispielsweise eine gültige Referenz unter Windows.

Das folgende Beispiel zeigt, wie auf eine Umgebungsvariable in einer Komponente verwiesen wird:

name: UseEnvironmentVariable
description: This sample component prints out the value of an environment variable.
schemaVersion: 1.0

phases:
  - name: build
    steps:
      - name: EchoEnvironmentVariable
        action: ExecuteBash
        inputs:
          commands:
            - echo "The value of SOME_VAR is {{ env:SOME_VAR }}."

Umgebungsvariablen, die Image Builder bereitstellt

Wenn Image Builder eine Komponente auf einer Build- oder Testinstanz ausführt, legt es Umgebungsvariablen fest, die den aktuellen Image-Build beschreiben. Ihre Komponenten lesen diese Werte mit dem zuvor in diesem Thema beschriebenen AWSTOE env: Variablenpräfix.

Image Builder stellt die folgenden Umgebungsvariablen bereit.

Das folgende Beispiel zeigt, wie Image Builder Builder-Umgebungsvariablen in einer Komponente gelesen werden:

name: UseImageBuilderEnvironmentVariables
description: This sample component prints out Image Builder environment variable values.
schemaVersion: 1.0

phases:
  - name: build
    steps:
      - name: EchoImageBuildValues
        action: ExecuteBash
        inputs:
          commands:
            - echo "Image phase: {{ env:IMAGE_PHASE }}."
            - echo "Image build version ARN: {{ env:IMAGE_BUILD_VERSION_ARN }}."

Verwenden Sie Variablen mit Instanzmetadaten (IMDS)

AWSTOE kann Werte aus dem Amazon EC2 Instance Metadata Service (IMDS) auf der Build- oder Test-Instance auflösen. Um auf einen Metadatenwert zu verweisen, stellen Sie dem Metadatenpfad ein Präfix voran. aws:imds: Der Pfad ist relativ zur meta-data/ Metadatenkategorie der Instanz. Wird beispielsweise in die Instanz-ID {{ aws:imds:instance-id }} aufgelöst. Die Referenz {{ aws:imds:placement/region }} wird in die aufgelöst. AWS-Region

Weitere Informationen zu Instance-Metadaten finden Sie unter Verwenden von Instance-Metadaten zur Verwaltung Ihrer EC2-Instance im Amazon EC2 EC2-Benutzerhandbuch.

Das folgende Beispiel zeigt, wie auf einen IMDS-Wert in einer Komponente verwiesen wird:

name: UseInstanceMetadataVariable
description: This sample component prints out the instance ID from IMDS.
schemaVersion: 1.0

phases:
  - name: build
    steps:
      - name: EchoInstanceId
        action: ExecuteBash
        inputs:
          commands:
            - echo "The instance ID is {{ aws:imds:instance-id }}."

Verwenden Sie Kontextvariablen

AWSTOE stellt Kontextvariablen bereit, die die aktuelle Ausführung und Instanz beschreiben. Um auf eine Kontextvariable zu verweisen, stellen Sie dem Schlüssel ein Präfix vorancontext:. Wird beispielsweise in die AWS Konto-ID {{ context:accountId }} aufgelöst.

AWSTOE stellt die folgenden Kontextvariablen bereit.

Das folgende Beispiel zeigt, wie auf Kontextvariablen in einer Komponente verwiesen wird:

name: UseContextVariables
description: This sample component prints out context variable values.
schemaVersion: 1.0

phases:
  - name: build
    steps:
      - name: EchoContextValues
        action: ExecuteBash
        inputs:
          commands:
            - echo "Account: {{ context:accountId }}, OS: {{ context:osName }}."