Verwendung von Pseudo-Parametern bei der Registrierung von Aufgaben im Wartungsfenster - AWS Systems Manager
Beispiele für PseudoparameterUnterstützte Pseudoparameter

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.

Verwendung von Pseudo-Parametern bei der Registrierung von Aufgaben im Wartungsfenster

Wenn Sie eine Aufgabe registrieren in Maintenance Windows, einem Tool in AWS Systems Manager, geben Sie die Parameter an, die für jeden der vier Aufgabentypen einzigartig sind. (In CLI-Befehlen werden diese mit der --task-invocation-parameters-Option bereitgestellt.)

Sie können auch mithilfe der Pseudoparameter-Syntax wie {{RESOURCE_ID}}, {{TARGET_TYPE}} und {{WINDOW_TARGET_ID}} auf bestimmte Werte verweisen. Während der Ausführung übergibt die Wartungsfenster-Aufgabe anstelle der Pseudoparameter-Platzhalter richtige Werte. Die vollständige Liste der verwendbaren Pseudoparameter finden Sie weiter unten in diesem Thema unter Unterstützte Pseudoparameter.

Wichtig

Je nach dem für die Aufgabe erforderlichen ID-Format können Sie für den Zieltyp RESOURCE_GROUP auswählen, ob Sie die {{TARGET_ID}} und {{RESOURCE_ID}} zum Verweisen verwenden möchten, wenn Ihre Aufgabe ausgeführt wird. {{TARGET_ID}} gibt den vollständigen ARN der Ressource zurück. {{RESOURCE_ID}} gibt wie in diesen Beispielen gezeigt nur einen kürzeren Namen oder eine kürzere ID der Ressource zurück.

  • {{TARGET_ID}}-Format: arn:aws:ec2:us-east-1:123456789012:instance/i-02573cafcfEXAMPLE

  • {{RESOURCE_ID}}-Format: i-02573cafcfEXAMPLE

Für Zieltyp INSTANCE ergeben die Parameter {{TARGET_ID}} und {{RESOURCE_ID}} nur die Instance-ID. Weitere Informationen finden Sie unter Unterstützte Pseudoparameter.

{{TARGET_ID}}und {{RESOURCE_ID}} kann verwendet werden, um AWS Ressourcen nur IDs an Automation-, Lambda- und Step Functions Functions-Aufgaben weiterzugeben. Diese beiden Pseudo-Parameter können nicht verwendet werden mit Run Command Aufgaben.

Beispiele für Pseudoparameter

Angenommen, Ihre Payload für eine AWS Lambda Aufgabe muss anhand ihrer ID auf eine Instanz verweisen.

Unabhängig davon, ob Sie ein Wartungsfensterziel INSTANCE oder RESOURCE_GROUP verwenden, kann dies mit dem {{RESOURCE_ID}}-Pseudoparameter erreicht werden. Zum Beispiel:

"TaskArn": "arn:aws:lambda:us-east-2:111122223333:function:SSMTestFunction",
    "TaskType": "LAMBDA",
    "TaskInvocationParameters": {
        "Lambda": {
            "ClientContext": "ew0KICAi--truncated--0KIEXAMPLE",
            "Payload": "{ \"instanceId\": \"{{RESOURCE_ID}}\" }",
            "Qualifier": "$LATEST"
        }
    }

Wenn Ihre Lambda-Aufgabe zusätzlich zu Amazon Elastic Compute Cloud (Amazon EC2) -Instances auch für einen anderen unterstützten Zieltyp ausgeführt werden soll, z. B. für eine Amazon DynamoDB-Tabelle, kann dieselbe Syntax verwendet werden und {{RESOURCE_ID}} ergibt nur den Namen der Tabelle. Wenn Sie jedoch den vollständigen ARN der Tabelle benötigen, verwenden Sie {{TARGET_ID}}, wie im folgenden Beispiel gezeigt.

"TaskArn": "arn:aws:lambda:us-east-2:111122223333:function:SSMTestFunction",
    "TaskType": "LAMBDA",
    "TaskInvocationParameters": {
        "Lambda": {
            "ClientContext": "ew0KICAi--truncated--0KIEXAMPLE",
            "Payload": "{ \"tableArn\": \"{{TARGET_ID}}\" }",
            "Qualifier": "$LATEST"
        }
    }

Dieselbe Syntax funktioniert, wenn Sie auf Instances oder andere Ressourcentypen abzielen. Wenn einer Ressourcengruppe mehrere Ressourcentypen hinzugefügt wurden, wird die Aufgabe für jede der entsprechenden Ressourcen ausgeführt.

Wichtig

Nicht alle Ressourcentypen, die möglicherweise in eine Ressourcengruppe einbezogen werden, ergeben einen Wert für den {{RESOURCE_ID}}-Parameter. Eine Liste der unterstützten Ressourcentypen finden Sie unter Unterstützte Pseudoparameter.

Ein weiteres Beispiel: Um eine Automatisierungsaufgabe auszuführen, die Ihre EC2 Instanzen stoppt, geben Sie das AWS-StopEC2Instance Systems Manager Manager-Dokument (SSM-Dokument) als TaskArn Wert an und verwenden den {{RESOURCE_ID}} Pseudo-Parameter:

"TaskArn": "AWS-StopEC2Instance",
    "TaskType": "AUTOMATION"
    "TaskInvocationParameters": {
        "Automation": {
            "DocumentVersion": "1",
            "Parameters": {
                "instanceId": [
                    "{{RESOURCE_ID}}"
                ]
            }
        }
    }

Um eine Automatisierungsaufgabe auszuführen, die einen Snapshot eines Amazon Elastic Block Store (Amazon EBS)-Volumes kopiert, geben Sie das AWS-CopySnapshot-SSM-Dokument als TaskArn-Wert an und verwenden den Pseudoparameter „{{RESOURCE_ID}}“:

"TaskArn": "AWS-CopySnapshot",
    "TaskType": "AUTOMATION"
    "TaskInvocationParameters": {
        "Automation": {
            "DocumentVersion": "1",
            "Parameters": {
                "SourceRegion": "us-east-2",
                "targetType":"RESOURCE_GROUP",
                "SnapshotId": [
                    "{{RESOURCE_ID}}"
                ]
            }
        }
    }

Unterstützte Pseudoparameter

Die folgende Liste beschreibt die Pseudoparameter, die Sie mit der {{PSEUDO_PARAMETER}}-Syntax in der --task-invocation-parameters-Option angeben können.

  • WINDOW_ID: Die ID des Ziel-Wartungsfensters.

  • WINDOW_TASK_ID: Die ID der Fensteraufgabe, die ausgeführt wird.

  • WINDOW_TARGET_ID: Die ID des Fensterziels, die das Ziel (die Ziel-ID) umfasst.

  • WINDOW_EXECUTION_ID: Die ID der aktuellen Fensterausführung.

  • TASK_EXECUTION_ID: Die ID der aktuellen Aufgabenausführung.

  • INVOCATION_ID: Die ID des aktuellen Aufrufs.

  • TARGET_TYPE: Der Zieltyp. Unterstützte Typen sind u. a.: RESOURCE_GROUP und INSTANCE.

  • TARGET_ID:

    Wenn der angegebene Zieltyp „INSTANCE“ lautet, wird der Pseudoparameter „TARGET_ID“ durch die ID der Instance ersetzt. Beispiel, i-078a280217EXAMPLE.

    Wenn der angegebene Zieltyp „RESOURCE_GROUP“ lautet, ist der für die Aufgabenausführung referenzierte Wert der vollständige ARN der Ressource. Beispiel: arn:aws:ec2:us-east-1:123456789012:instance/i-078a280217EXAMPLE. Die folgende Tabelle enthält TARGET_ID-Beispielwerte für bestimmte Ressourcentypen in einer Ressourcengruppe.

    Anmerkung

    TARGET_IDwird nicht unterstützt für Run Command Aufgaben.

    Ressourcentyp Beispiel-TARGET_ID
    AWS::CloudWatch::Alarm arn:aws:cloudwatch:us-east-1:123456789012:alarm:MyCloudWatchAlarmi-078a280217EXAMPLE
    AWS::DynamoDB::Table arn:aws:dynamodb:us-east-1:123456789012:table/MyTable
    AWS::EC2::Instance arn:aws:ec2:us-east-1:123456789012:instance/i-078a280217EXAMPLE
    AWS::EC2::Image arn:aws:ec2:us-east-1:123456789012:image/ami-02250b3732EXAMPLE
    AWS::EC2::SecurityGroup arn:aws:ec2:us-east-1:123456789012:security-group/sg-cEXAMPLE
    AWS::EC2::Snapshot arn:aws:ec2:us-east-1:123456789012:snapshot/snap-03866bf003EXAMPLE
    AWS::EC2::Volume arn:aws:ec2:us-east-1:123456789012:volume/vol-0912e04d78EXAMPLE
    AWS::ECS::Service arn:aws:ecs:us-east-1:123456789012:service/my-ecs-service
    AWS::RDS::DBCluster arn:aws:rds:us-east-2:123456789012:cluster:My-Cluster

    AWS::RDS::DBInstance

    		 arn:aws:rds:us-east-1:123456789012:db:My-SQL-Instance
    AWS::S3::Bucket arn:aws:s3:::amzn-s3-demo-bucket

    AWS::SSM::ManagedInstance

    		 arn:aws:ssm:us-east-1:123456789012:managed-instance/mi-0feadcf2d9EXAMPLE

  • RESOURCE_ID: Die kurze ID eines Ressourcentyps, der in einer Ressourcengruppe enthalten ist. Die folgende Tabelle enthält RESOURCE_ID-Beispielwerte für bestimmte Ressourcentypen in einer Ressourcengruppe.

    Anmerkung

    RESOURCE_IDwird nicht unterstützt für Run Command Aufgaben.

    Ressourcentyp Beispiel-RESOURCE_ID
    AWS::CloudWatch::Alarm MyCloudWatchAlarm
    AWS::DynamoDB::Table MyTable
    AWS::EC2::Instance i-078a280217EXAMPLE
    AWS::EC2::Image ami-02250b3732EXAMPLE
    AWS::EC2::SecurityGroup sg-cEXAMPLE
    AWS::EC2::Snapshot snap-03866bf003EXAMPLE
    AWS::EC2::Volume vol-0912e04d78EXAMPLE
    AWS::ECS::Service my-ecs-service
    AWS::RDS::DBCluster My-Cluster
    AWS::RDS::DBInstance My-SQL-Instance
    AWS::S3::Bucket amzn-s3-demo-bucket
    AWS::SSM::ManagedInstance mi-0feadcf2d9EXAMPLE
    Anmerkung

    Wenn die von Ihnen angegebene AWS Ressourcengruppe Ressourcentypen enthält, die keinen RESOURCE_ID Wert ergeben und in der obigen Tabelle nicht aufgeführt sind, wird der RESOURCE_ID Parameter nicht aufgefüllt. Für diese Ressource wird weiterhin ein Ausführungsaufruf ausgeführt. Verwenden Sie in diesen Fällen stattdessen Pseudoparameter „TARGET_ID“, der durch den vollständigen ARN der Ressource ersetzt wird.