Esempi di pseudoparametri Pseudoparametri supportati

Utilizzo degli pseudo parametri durante la registrazione delle attività della finestra di manutenzione

Quando si registra un'attività in Maintenance Windows, uno strumento di AWS Systems Manager, è possibile specificare i parametri univoci per ciascuno dei quattro tipi di attività. (Nei comandi CLI, questi vengono forniti utilizzando l'opzione --task-invocation-parameters.)

Puoi anche fare riferimento a determinati valori utilizzando la sintassi degli pseudoparametri, ad esempio {{RESOURCE_ID}}, {{TARGET_TYPE}} e {{WINDOW_TARGET_ID}}. Quando viene eseguita, l'operazione della finestra di manutenzione trasmette i valori corretti invece dei segnaposto degli pseudoparametri. L'elenco completo degli pseudo parametri che è possibile utilizzare è fornito di seguito in questo argomento in Pseudoparametri supportati.

Importante

Per il tipo di destinazione RESOURCE_GROUP, a seconda del formato ID necessario per l'attività, è possibile scegliere tra utilizzare {{TARGET_ID}} e {{RESOURCE_ID}} e fare riferimento alla risorsa quando viene eseguita l'attività. {{TARGET_ID}} restituisce l'ARN completo della risorsa. {{RESOURCE_ID}} restituisce solo un nome o un ID più breve della risorsa, come mostrato in questi esempi.

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

Per il tipo di destinazione INSTANCE, i parametri sia {{TARGET_ID}} sia {{RESOURCE_ID}} restituiscono solo l'ID istanza. Per ulteriori informazioni, consulta Pseudoparametri supportati.

{{TARGET_ID}} e {{RESOURCE_ID}} possono essere utilizzati per passare gli ID delle risorse AWS solo all'automazione, alle attività Step Functions e Lambda. Questi due pseudo parametri non possono essere usati con attività Run Command.

Esempi di pseudoparametri

Supponiamo che il payload per un'attività AWS Lambda debba fare riferimento a un'istanza con il relativo ID.

Sia che si utilizzi una destinazione della finestra di manutenzione INSTANCE o RESOURCE_GROUP, è possibile ottenere questo risultato utilizzando lo pseudoparametro {{RESOURCE_ID}}. Ad esempio:


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

Se l'attività Lambda è destinata a essere eseguita su un altro tipo di destinazione supportato oltre alle istanze Amazon Elastic Compute Cloud (Amazon EC2), ad esempio una tabella Amazon DynamoDB, è possibile utilizzare la stessa sintassi e {{RESOURCE_ID}} restituisce solo il nome della tabella. Tuttavia, se si richiede l'ARN completo della tabella, utilizzare {{TARGET_ID}}, come illustrato nell'esempio seguente.


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

La stessa sintassi funziona per il targeting di istanze o altri tipi di risorse. Quando più tipi di risorse sono stati aggiunti a un gruppo di risorse, l'attività viene eseguita su ciascuna delle risorse appropriate.

Importante

Non tutti i tipi di risorse che potrebbero essere inclusi in un gruppo di risorse producono un valore per il parametro {{RESOURCE_ID}}. Per un elenco dei tipi di risorse supportati, vedere Pseudoparametri supportati.

A titolo di esempio aggiuntivo, per eseguire un task di automazione che interrompa l'esecuzione delle istanze EC2, devi specificare il documento di Systems Manager AWS-StopEC2Instance (documento SSM) come valore TaskArn e utilizzare lo pseudoparametro {{RESOURCE_ID}}:


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

Per eseguire un'attività di automazione che copia uno snapshot di un volume Amazon Elastic Block Store (Amazon EBS), specificare il documento SSM AWS-CopySnapshot come valore TaskArn e utilizzare lo pseudoparametro {{RESOURCE_ID}}.


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

Pseudoparametri supportati

Nell'elenco seguente sono riportati gli pseudoparametri che puoi specificare utilizzando la sintassi {{PSEUDO_PARAMETER}} nell'opzione --task-invocation-parameters.

WINDOW_ID: ID della finestra di manutenzione di destinazione.
WINDOW_TASK_ID: l'ID dell'attività della finestra che è in esecuzione.
WINDOW_TARGET_ID: l'ID della destinazione della finestra che include la destinazione (ID destinazione).
WINDOW_EXECUTION_ID: l'ID dell'esecuzione della finestra corrente.
TASK_EXECUTION_ID: l'ID dell'esecuzione dell'attività corrente.
INVOCATION_ID: l'ID dell'invocazione corrente.
TARGET_TYPE: il tipo di destinazione. I tipi supportati includono RESOURCE_GROUP e INSTANCE.

TARGET_ID:

Se il tipo di destinazione specificato è INSTANCE, lo pseudoparametro TARGET_ID viene sostituito dall'ID dell'istanza. Ad esempio, i-078a280217EXAMPLE.

Se il tipo di destinazione specificato è RESOURCE_GROUP, il valore a cui si fa riferimento per l'esecuzione dell'attività è l'ARN completo della risorsa. Ad esempio: arn:aws:ec2:us-east-1:123456789012:instance/i-078a280217EXAMPLE. Nella tabella seguente sono riportati i valori TARGET_ID di esempio per particolari tipi di risorse in un gruppo di risorse.

Nota

TARGET_ID non è supportato per le attività Run Command.

Tipo di risorsa	Esempio 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: ID breve di un tipo di risorsa contenuto in un gruppo di risorse. Nella tabella seguente sono riportati i valori RESOURCE_ID di esempio per particolari tipi di risorse in un gruppo di risorse.

Nota

RESOURCE_ID non è supportato per le attività Run Command.

Tipo di risorsa	Esempio 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`

Nota

Se il gruppo di risorse AWS specificato include tipi di risorse che non producono un valore RESOURCE_ID e non sono elencati nella tabella precedente, il parametro RESOURCE_ID non viene popolato. Una chiamata di esecuzione verrà comunque eseguita per tale risorsa. In questi casi, utilizzare invece lo pseudo parametro TARGET_ID, che verrà sostituito con l'ARN completo della risorsa.

Avvertimento JavaScript è disabilitato o non è disponibile nel tuo browser.

Per usare la documentazione AWS, JavaScript deve essere abilitato. Consulta le pagine della guida del browser per le istruzioni.

Convenzioni dei documenti

Piani di applicazione di patch con le finestre di manutenzione

Opzioni di pianificazione e periodo attivo per la finestra di manutenzione