Verwenden von Vorlagenzielen

Vorlagenziele sind eine Reihe gängiger API-Operationen für eine Gruppe von Core- AWS Services wie Amazon SQS, Lambda und Step Functions. Sie können beispielsweise auf die Lambda-InvokeOperation abzielen, indem Sie den Funktions-ARN oder die -Operation von Amazon SQS mithilfe des Warteschlangen-ARN angeben. SendMessage Um ein Vorlagenziel zu konfigurieren, müssen Sie der Ausführungsrolle des Zeitplans auch Berechtigungen erteilen, um den Ziel-API-Vorgang auszuführen.

Um ein Vorlagenziel programmgesteuert mit der AWS CLI oder einem der EventBridge Scheduler-SDKs zu konfigurieren, müssen Sie den ARN der Ausführungsrolle, den ARN für die Zielressource, eine optionale Eingabe, die der EventBridge Scheduler an das Ziel liefern soll, und für einige Vorlagenziele einen eindeutigen Satz von Parametern mit zusätzlichen Konfigurationsoptionen für dieses Ziel angeben. Wenn Sie den ARN für eine Vorlagen-Zielressource angeben, geht EventBridge Scheduler automatisch davon aus, dass Sie die unterstützte API-Operation für diesen Service aufrufen möchten. Wenn Sie möchten, dass EventBridge Scheduler auf einen anderen API-Vorgang für den Service abzielt, müssen Sie das Ziel als universelles Ziel konfigurieren.

Im Folgenden finden Sie eine vollständige Liste aller Vorlagenziele, die EventBridge Scheduler unterstützt, und gegebenenfalls die eindeutigen zugehörigen Parameter jedes Ziels. Wählen Sie den Link für jeden Parametersatz aus, um die erforderlichen und optionalen Felder in der EventBridge Scheduler-API-Referenz anzuzeigen.

• CodeBuild – StartBuild

• CodePipeline – StartPipelineExecution

• Amazon ECS – RunTask

  • Parameter: EcsParameters

• EventBridge – PutEvents

  • Parameter: EventBridgeParameters

• Amazon Inspector – StartAssessmentRun

• Kinesis – PutRecord

  • Parameter: KinesisParameters

• Firehose – PutRecord

• Lambda – Invoke

• SageMaker – StartPipelineExecution

  • Parameter: SageMakerPipelineParameters

• Amazon SNS – Publish

• Amazon SQS – SendMessage

  • Parameter: SqsParameters

• Step Functions – StartExecution

In den folgenden Beispielen erfahren Sie, wie Sie verschiedene Vorlagenziele und die erforderlichen IAM-Berechtigungen für jedes beschriebene Ziel konfigurieren.

Amazon SQS SendMessage

Beispiel Berechtigungsrichtlinie für die Ausführungsrolle

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Action": [
                "sqs:SendMessage"
            ],
            "Effect": "Allow",
            "Resource": "*"
        }
    ]
}

Beispiel AWS CLI

$ aws scheduler create-schedule --name sqs-templated --schedule-expression 'rate(5 minutes)' \
--target '{"RoleArn": "ROLE_ARN", "Arn":"QUEUE_ARN", "Input": "Message for scheduleArn: '<aws.scheduler.schedule-arn>', scheduledTime: '<aws.scheduler.scheduled-time>'" }' \
--flexible-time-window '{ "Mode": "OFF"}'

Beispiel Python-SDK

import boto3
scheduler = boto3.client('scheduler')

flex_window = { "Mode": "OFF" }

sqs_templated = {
    "RoleArn": "<ROLE_ARN>",
    "Arn": "<QUEUE_ARN>",
    "Input": "Message for scheduleArn: '<aws.scheduler.schedule-arn>', scheduledTime: '<aws.scheduler.scheduled-time>'"
}

scheduler.create_schedule(
    Name="sqs-python-templated",
    ScheduleExpression="rate(5 minutes)",
    Target=sqs_templated,
    FlexibleTimeWindow=flex_window)

Beispiel Java-SDK

package com.example;

import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.scheduler.SchedulerClient;
import software.amazon.awssdk.services.scheduler.model.*;


public class MySchedulerApp {

    public static void main(String[] args) {
        
        final SchedulerClient client = SchedulerClient.builder()
                .region(Region.US_WEST_2)
                .build();
        
        Target sqsTarget = Target.builder()
                .roleArn("<ROLE_ARN>")
                .arn("<QUEUE_ARN>")
                .input("Message for scheduleArn: '<aws.scheduler.schedule-arn>', scheduledTime: '<aws.scheduler.scheduled-time>'")
                .build();
        
        CreateScheduleRequest createScheduleRequest = CreateScheduleRequest.builder()
                .name("<SCHEDULE NAME>")
                .scheduleExpression("rate(10 minutes)")
                .target(sqsTarget)
                .flexibleTimeWindow(FlexibleTimeWindow.builder()
                        .mode(FlexibleTimeWindowMode.OFF)
                        .build())
                .build();
                
        client.createSchedule(createScheduleRequest);
        System.out.println("Created schedule with rate expression and an Amazon SQS templated target");
    }
}

Lambda Invoke

Beispiel Berechtigungsrichtlinie für die Ausführungsrolle

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Action": [
                "lambda:InvokeFunction"
            ],
            "Effect": "Allow",
            "Resource": "*"
        }
    ]
}

Beispiel AWS CLI

$ aws scheduler create-schedule --name lambda-templated-schedule --schedule-expression 'rate(5 minutes)' \
--target '{"RoleArn": "ROLE_ARN", "Arn":"FUNCTION_ARN", "Input": "{ \"Payload\": \"TEST_PAYLOAD\" }" }' \
--flexible-time-window '{ "Mode": "OFF"}'

Beispiel Python-SDK

import boto3
scheduler = boto3.client('scheduler')

flex_window = { "Mode": "OFF" }

lambda_templated = {
    "RoleArn": "<ROLE_ARN>",
    "Arn": "<LAMBDA_ARN>",
    "Input": "{ 'Payload': 'TEST_PAYLOAD' }"}
}

scheduler.create_schedule(
    Name="lambda-python-templated",
    ScheduleExpression="rate(5 minutes)",
    Target=lambda_templated,
    FlexibleTimeWindow=flex_window)

Beispiel Java-SDK

package com.example;

import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.scheduler.SchedulerClient;
import software.amazon.awssdk.services.scheduler.model.*;


public class MySchedulerApp {

    public static void main(String[] args) {
        
        final SchedulerClient client = SchedulerClient.builder()
                .region(Region.US_WEST_2)
                .build();
                
        Target lambdaTarget = Target.builder()
                .roleArn("<ROLE_ARN>")
                .arn("<Lambda ARN>")
                .input("{ 'Payload': 'TEST_PAYLOAD' }")
                .build();
        
        CreateScheduleRequest createScheduleRequest = CreateScheduleRequest.builder()
                .name("<SCHEDULE_NAME>")
                .scheduleExpression("rate(10 minutes)")
                .target(lambdaTarget)
                .flexibleTimeWindow(FlexibleTimeWindow.builder()
                        .mode(FlexibleTimeWindowMode.OFF)
                        .build())
                .clientToken("<Token GUID>")
                .build();
                
        client.createSchedule(createScheduleRequest);
        System.out.println("Created schedule with rate expression and Lambda templated target");        
    }
}

Schrittfunktionen StartExecution

Beispiel Berechtigungsrichtlinie für die Ausführungsrolle

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Action": [
                "states:StartExecution"
            ],
            "Effect": "Allow",
            "Resource": "*"
        }
    ]
}

Beispiel AWS CLI

$ aws scheduler create-schedule --name sfn-templated-schedule --schedule-expression 'rate(5 minutes)' \
--target '{"RoleArn": "ROLE_ARN", "Arn":"STATE_MACHINE_ARN", "Input": "{ \"Payload\": \"TEST_PAYLOAD\" }" }' \
--flexible-time-window '{ "Mode": "OFF"}'

Beispiel Python-SDK

import boto3
scheduler = boto3.client('scheduler')

flex_window = { "Mode": "OFF" }

sfn_templated= {
    "RoleArn": "<ROLE_ARN>",
    "Arn": "<STATE_MACHINE_ARN>",
    "Input": "{ 'Payload': 'TEST_PAYLOAD' }"
}

scheduler.create_schedule(Name="sfn-python-templated",
    ScheduleExpression="rate(5 minutes)",
    Target=sfn_templated,
    FlexibleTimeWindow=flex_window)

Beispiel Java-SDK

package com.example;

import software.amazon.awssdk.regions.Region;
import software.amazon.awssdk.services.scheduler.SchedulerClient;
import software.amazon.awssdk.services.scheduler.model.*;


public class MySchedulerApp {

    public static void main(String[] args) {
        
        final SchedulerClient client = SchedulerClient.builder()
                .region(Region.US_WEST_2)
                .build();
                
        Target stepFunctionsTarget = Target.builder()
                .roleArn("<ROLE_ARN>")
                .arn("<STATE_MACHINE_ARN>")
                .input("{ 'Payload': 'TEST_PAYLOAD' }")
                .build();
        
        CreateScheduleRequest createScheduleRequest = CreateScheduleRequest.builder()
                .name("<SCHEDULE_NAME>")
                .scheduleExpression("rate(10 minutes)")
                .target(stepFunctionsTarget)
                .flexibleTimeWindow(FlexibleTimeWindow.builder()
                        .mode(FlexibleTimeWindowMode.OFF)
                        .build())
                .clientToken("<Token GUID>")
                .build();
                
        client.createSchedule(createScheduleRequest);
        System.out.println("Created schedule with rate expression and Step Function templated target");
    }
}