AWS v6.60.0, Nov 19 24

AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.scheduler.Schedule

Explore with Pulumi AI

AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

pulumi/pulumi-aws

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.scheduler.Schedule("example", {
    name: "my-schedule",
    groupName: "default",
    flexibleTimeWindow: {
        mode: "OFF",
    },
    scheduleExpression: "rate(1 hours)",
    target: {
        arn: exampleAwsSqsQueue.arn,
        roleArn: exampleAwsIamRole.arn,
    },
});

import pulumi
import pulumi_aws as aws

example = aws.scheduler.Schedule("example",
    name="my-schedule",
    group_name="default",
    flexible_time_window={
        "mode": "OFF",
    },
    schedule_expression="rate(1 hours)",
    target={
        "arn": example_aws_sqs_queue["arn"],
        "role_arn": example_aws_iam_role["arn"],
    })

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/scheduler"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := scheduler.NewSchedule(ctx, "example", &scheduler.ScheduleArgs{
			Name:      pulumi.String("my-schedule"),
			GroupName: pulumi.String("default"),
			FlexibleTimeWindow: &scheduler.ScheduleFlexibleTimeWindowArgs{
				Mode: pulumi.String("OFF"),
			},
			ScheduleExpression: pulumi.String("rate(1 hours)"),
			Target: &scheduler.ScheduleTargetArgs{
				Arn:     pulumi.Any(exampleAwsSqsQueue.Arn),
				RoleArn: pulumi.Any(exampleAwsIamRole.Arn),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Scheduler.Schedule("example", new()
    {
        Name = "my-schedule",
        GroupName = "default",
        FlexibleTimeWindow = new Aws.Scheduler.Inputs.ScheduleFlexibleTimeWindowArgs
        {
            Mode = "OFF",
        },
        ScheduleExpression = "rate(1 hours)",
        Target = new Aws.Scheduler.Inputs.ScheduleTargetArgs
        {
            Arn = exampleAwsSqsQueue.Arn,
            RoleArn = exampleAwsIamRole.Arn,
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.scheduler.Schedule;
import com.pulumi.aws.scheduler.ScheduleArgs;
import com.pulumi.aws.scheduler.inputs.ScheduleFlexibleTimeWindowArgs;
import com.pulumi.aws.scheduler.inputs.ScheduleTargetArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Schedule("example", ScheduleArgs.builder()
            .name("my-schedule")
            .groupName("default")
            .flexibleTimeWindow(ScheduleFlexibleTimeWindowArgs.builder()
                .mode("OFF")
                .build())
            .scheduleExpression("rate(1 hours)")
            .target(ScheduleTargetArgs.builder()
                .arn(exampleAwsSqsQueue.arn())
                .roleArn(exampleAwsIamRole.arn())
                .build())
            .build());

    }
}

resources:
  example:
    type: aws:scheduler:Schedule
    properties:
      name: my-schedule
      groupName: default
      flexibleTimeWindow:
        mode: OFF
      scheduleExpression: rate(1 hours)
      target:
        arn: ${exampleAwsSqsQueue.arn}
        roleArn: ${exampleAwsIamRole.arn}

Universal Target

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.sqs.Queue("example", {});
const exampleSchedule = new aws.scheduler.Schedule("example", {
    name: "my-schedule",
    flexibleTimeWindow: {
        mode: "OFF",
    },
    scheduleExpression: "rate(1 hours)",
    target: {
        arn: "arn:aws:scheduler:::aws-sdk:sqs:sendMessage",
        roleArn: exampleAwsIamRole.arn,
        input: pulumi.jsonStringify({
            MessageBody: "Greetings, programs!",
            QueueUrl: example.url,
        }),
    },
});

import pulumi
import json
import pulumi_aws as aws

example = aws.sqs.Queue("example")
example_schedule = aws.scheduler.Schedule("example",
    name="my-schedule",
    flexible_time_window={
        "mode": "OFF",
    },
    schedule_expression="rate(1 hours)",
    target={
        "arn": "arn:aws:scheduler:::aws-sdk:sqs:sendMessage",
        "role_arn": example_aws_iam_role["arn"],
        "input": pulumi.Output.json_dumps({
            "MessageBody": "Greetings, programs!",
            "QueueUrl": example.url,
        }),
    })

package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/scheduler"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sqs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := sqs.NewQueue(ctx, "example", nil)
		if err != nil {
			return err
		}
		_, err = scheduler.NewSchedule(ctx, "example", &scheduler.ScheduleArgs{
			Name: pulumi.String("my-schedule"),
			FlexibleTimeWindow: &scheduler.ScheduleFlexibleTimeWindowArgs{
				Mode: pulumi.String("OFF"),
			},
			ScheduleExpression: pulumi.String("rate(1 hours)"),
			Target: &scheduler.ScheduleTargetArgs{
				Arn:     pulumi.String("arn:aws:scheduler:::aws-sdk:sqs:sendMessage"),
				RoleArn: pulumi.Any(exampleAwsIamRole.Arn),
				Input: example.Url.ApplyT(func(url string) (pulumi.String, error) {
					var _zero pulumi.String
					tmpJSON0, err := json.Marshal(map[string]interface{}{
						"MessageBody": "Greetings, programs!",
						"QueueUrl":    url,
					})
					if err != nil {
						return _zero, err
					}
					json0 := string(tmpJSON0)
					return pulumi.String(json0), nil
				}).(pulumi.StringOutput),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Sqs.Queue("example");

    var exampleSchedule = new Aws.Scheduler.Schedule("example", new()
    {
        Name = "my-schedule",
        FlexibleTimeWindow = new Aws.Scheduler.Inputs.ScheduleFlexibleTimeWindowArgs
        {
            Mode = "OFF",
        },
        ScheduleExpression = "rate(1 hours)",
        Target = new Aws.Scheduler.Inputs.ScheduleTargetArgs
        {
            Arn = "arn:aws:scheduler:::aws-sdk:sqs:sendMessage",
            RoleArn = exampleAwsIamRole.Arn,
            Input = Output.JsonSerialize(Output.Create(new Dictionary<string, object?>
            {
                ["MessageBody"] = "Greetings, programs!",
                ["QueueUrl"] = example.Url,
            })),
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sqs.Queue;
import com.pulumi.aws.scheduler.Schedule;
import com.pulumi.aws.scheduler.ScheduleArgs;
import com.pulumi.aws.scheduler.inputs.ScheduleFlexibleTimeWindowArgs;
import com.pulumi.aws.scheduler.inputs.ScheduleTargetArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Queue("example");

        var exampleSchedule = new Schedule("exampleSchedule", ScheduleArgs.builder()
            .name("my-schedule")
            .flexibleTimeWindow(ScheduleFlexibleTimeWindowArgs.builder()
                .mode("OFF")
                .build())
            .scheduleExpression("rate(1 hours)")
            .target(ScheduleTargetArgs.builder()
                .arn("arn:aws:scheduler:::aws-sdk:sqs:sendMessage")
                .roleArn(exampleAwsIamRole.arn())
                .input(example.url().applyValue(url -> serializeJson(
                    jsonObject(
                        jsonProperty("MessageBody", "Greetings, programs!"),
                        jsonProperty("QueueUrl", url)
                    ))))
                .build())
            .build());

    }
}

resources:
  example:
    type: aws:sqs:Queue
  exampleSchedule:
    type: aws:scheduler:Schedule
    name: example
    properties:
      name: my-schedule
      flexibleTimeWindow:
        mode: OFF
      scheduleExpression: rate(1 hours)
      target:
        arn: arn:aws:scheduler:::aws-sdk:sqs:sendMessage
        roleArn: ${exampleAwsIamRole.arn}
        input:
          fn::toJSON:
            MessageBody: Greetings, programs!
            QueueUrl: ${example.url}

Create Schedule Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Schedule(name: string, args: ScheduleArgs, opts?: CustomResourceOptions);

@overload
def Schedule(resource_name: str,
             args: ScheduleArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Schedule(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             flexible_time_window: Optional[ScheduleFlexibleTimeWindowArgs] = None,
             schedule_expression: Optional[str] = None,
             target: Optional[ScheduleTargetArgs] = None,
             description: Optional[str] = None,
             end_date: Optional[str] = None,
             group_name: Optional[str] = None,
             kms_key_arn: Optional[str] = None,
             name: Optional[str] = None,
             name_prefix: Optional[str] = None,
             schedule_expression_timezone: Optional[str] = None,
             start_date: Optional[str] = None,
             state: Optional[str] = None)

func NewSchedule(ctx *Context, name string, args ScheduleArgs, opts ...ResourceOption) (*Schedule, error)

public Schedule(string name, ScheduleArgs args, CustomResourceOptions? opts = null)

public Schedule(String name, ScheduleArgs args)
public Schedule(String name, ScheduleArgs args, CustomResourceOptions options)

type: aws:scheduler:Schedule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args ScheduleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ScheduleArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ScheduleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ScheduleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ScheduleArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var awsScheduleResource = new Aws.Scheduler.Schedule("awsScheduleResource", new()
{
    FlexibleTimeWindow = new Aws.Scheduler.Inputs.ScheduleFlexibleTimeWindowArgs
    {
        Mode = "string",
        MaximumWindowInMinutes = 0,
    },
    ScheduleExpression = "string",
    Target = new Aws.Scheduler.Inputs.ScheduleTargetArgs
    {
        Arn = "string",
        RoleArn = "string",
        DeadLetterConfig = new Aws.Scheduler.Inputs.ScheduleTargetDeadLetterConfigArgs
        {
            Arn = "string",
        },
        EcsParameters = new Aws.Scheduler.Inputs.ScheduleTargetEcsParametersArgs
        {
            TaskDefinitionArn = "string",
            PlacementConstraints = new[]
            {
                new Aws.Scheduler.Inputs.ScheduleTargetEcsParametersPlacementConstraintArgs
                {
                    Type = "string",
                    Expression = "string",
                },
            },
            EnableExecuteCommand = false,
            Group = "string",
            LaunchType = "string",
            NetworkConfiguration = new Aws.Scheduler.Inputs.ScheduleTargetEcsParametersNetworkConfigurationArgs
            {
                Subnets = new[]
                {
                    "string",
                },
                AssignPublicIp = false,
                SecurityGroups = new[]
                {
                    "string",
                },
            },
            CapacityProviderStrategies = new[]
            {
                new Aws.Scheduler.Inputs.ScheduleTargetEcsParametersCapacityProviderStrategyArgs
                {
                    CapacityProvider = "string",
                    Base = 0,
                    Weight = 0,
                },
            },
            PlacementStrategies = new[]
            {
                new Aws.Scheduler.Inputs.ScheduleTargetEcsParametersPlacementStrategyArgs
                {
                    Type = "string",
                    Field = "string",
                },
            },
            PlatformVersion = "string",
            PropagateTags = "string",
            ReferenceId = "string",
            Tags = 
            {
                { "string", "string" },
            },
            TaskCount = 0,
            EnableEcsManagedTags = false,
        },
        EventbridgeParameters = new Aws.Scheduler.Inputs.ScheduleTargetEventbridgeParametersArgs
        {
            DetailType = "string",
            Source = "string",
        },
        Input = "string",
        KinesisParameters = new Aws.Scheduler.Inputs.ScheduleTargetKinesisParametersArgs
        {
            PartitionKey = "string",
        },
        RetryPolicy = new Aws.Scheduler.Inputs.ScheduleTargetRetryPolicyArgs
        {
            MaximumEventAgeInSeconds = 0,
            MaximumRetryAttempts = 0,
        },
        SagemakerPipelineParameters = new Aws.Scheduler.Inputs.ScheduleTargetSagemakerPipelineParametersArgs
        {
            PipelineParameters = new[]
            {
                new Aws.Scheduler.Inputs.ScheduleTargetSagemakerPipelineParametersPipelineParameterArgs
                {
                    Name = "string",
                    Value = "string",
                },
            },
        },
        SqsParameters = new Aws.Scheduler.Inputs.ScheduleTargetSqsParametersArgs
        {
            MessageGroupId = "string",
        },
    },
    Description = "string",
    EndDate = "string",
    GroupName = "string",
    KmsKeyArn = "string",
    Name = "string",
    NamePrefix = "string",
    ScheduleExpressionTimezone = "string",
    StartDate = "string",
    State = "string",
});

example, err := scheduler.NewSchedule(ctx, "awsScheduleResource", &scheduler.ScheduleArgs{
	FlexibleTimeWindow: &scheduler.ScheduleFlexibleTimeWindowArgs{
		Mode:                   pulumi.String("string"),
		MaximumWindowInMinutes: pulumi.Int(0),
	},
	ScheduleExpression: pulumi.String("string"),
	Target: &scheduler.ScheduleTargetArgs{
		Arn:     pulumi.String("string"),
		RoleArn: pulumi.String("string"),
		DeadLetterConfig: &scheduler.ScheduleTargetDeadLetterConfigArgs{
			Arn: pulumi.String("string"),
		},
		EcsParameters: &scheduler.ScheduleTargetEcsParametersArgs{
			TaskDefinitionArn: pulumi.String("string"),
			PlacementConstraints: scheduler.ScheduleTargetEcsParametersPlacementConstraintArray{
				&scheduler.ScheduleTargetEcsParametersPlacementConstraintArgs{
					Type:       pulumi.String("string"),
					Expression: pulumi.String("string"),
				},
			},
			EnableExecuteCommand: pulumi.Bool(false),
			Group:                pulumi.String("string"),
			LaunchType:           pulumi.String("string"),
			NetworkConfiguration: &scheduler.ScheduleTargetEcsParametersNetworkConfigurationArgs{
				Subnets: pulumi.StringArray{
					pulumi.String("string"),
				},
				AssignPublicIp: pulumi.Bool(false),
				SecurityGroups: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
			CapacityProviderStrategies: scheduler.ScheduleTargetEcsParametersCapacityProviderStrategyArray{
				&scheduler.ScheduleTargetEcsParametersCapacityProviderStrategyArgs{
					CapacityProvider: pulumi.String("string"),
					Base:             pulumi.Int(0),
					Weight:           pulumi.Int(0),
				},
			},
			PlacementStrategies: scheduler.ScheduleTargetEcsParametersPlacementStrategyArray{
				&scheduler.ScheduleTargetEcsParametersPlacementStrategyArgs{
					Type:  pulumi.String("string"),
					Field: pulumi.String("string"),
				},
			},
			PlatformVersion: pulumi.String("string"),
			PropagateTags:   pulumi.String("string"),
			ReferenceId:     pulumi.String("string"),
			Tags: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			TaskCount:            pulumi.Int(0),
			EnableEcsManagedTags: pulumi.Bool(false),
		},
		EventbridgeParameters: &scheduler.ScheduleTargetEventbridgeParametersArgs{
			DetailType: pulumi.String("string"),
			Source:     pulumi.String("string"),
		},
		Input: pulumi.String("string"),
		KinesisParameters: &scheduler.ScheduleTargetKinesisParametersArgs{
			PartitionKey: pulumi.String("string"),
		},
		RetryPolicy: &scheduler.ScheduleTargetRetryPolicyArgs{
			MaximumEventAgeInSeconds: pulumi.Int(0),
			MaximumRetryAttempts:     pulumi.Int(0),
		},
		SagemakerPipelineParameters: &scheduler.ScheduleTargetSagemakerPipelineParametersArgs{
			PipelineParameters: scheduler.ScheduleTargetSagemakerPipelineParametersPipelineParameterArray{
				&scheduler.ScheduleTargetSagemakerPipelineParametersPipelineParameterArgs{
					Name:  pulumi.String("string"),
					Value: pulumi.String("string"),
				},
			},
		},
		SqsParameters: &scheduler.ScheduleTargetSqsParametersArgs{
			MessageGroupId: pulumi.String("string"),
		},
	},
	Description:                pulumi.String("string"),
	EndDate:                    pulumi.String("string"),
	GroupName:                  pulumi.String("string"),
	KmsKeyArn:                  pulumi.String("string"),
	Name:                       pulumi.String("string"),
	NamePrefix:                 pulumi.String("string"),
	ScheduleExpressionTimezone: pulumi.String("string"),
	StartDate:                  pulumi.String("string"),
	State:                      pulumi.String("string"),
})

var awsScheduleResource = new Schedule("awsScheduleResource", ScheduleArgs.builder()
    .flexibleTimeWindow(ScheduleFlexibleTimeWindowArgs.builder()
        .mode("string")
        .maximumWindowInMinutes(0)
        .build())
    .scheduleExpression("string")
    .target(ScheduleTargetArgs.builder()
        .arn("string")
        .roleArn("string")
        .deadLetterConfig(ScheduleTargetDeadLetterConfigArgs.builder()
            .arn("string")
            .build())
        .ecsParameters(ScheduleTargetEcsParametersArgs.builder()
            .taskDefinitionArn("string")
            .placementConstraints(ScheduleTargetEcsParametersPlacementConstraintArgs.builder()
                .type("string")
                .expression("string")
                .build())
            .enableExecuteCommand(false)
            .group("string")
            .launchType("string")
            .networkConfiguration(ScheduleTargetEcsParametersNetworkConfigurationArgs.builder()
                .subnets("string")
                .assignPublicIp(false)
                .securityGroups("string")
                .build())
            .capacityProviderStrategies(ScheduleTargetEcsParametersCapacityProviderStrategyArgs.builder()
                .capacityProvider("string")
                .base(0)
                .weight(0)
                .build())
            .placementStrategies(ScheduleTargetEcsParametersPlacementStrategyArgs.builder()
                .type("string")
                .field("string")
                .build())
            .platformVersion("string")
            .propagateTags("string")
            .referenceId("string")
            .tags(Map.of("string", "string"))
            .taskCount(0)
            .enableEcsManagedTags(false)
            .build())
        .eventbridgeParameters(ScheduleTargetEventbridgeParametersArgs.builder()
            .detailType("string")
            .source("string")
            .build())
        .input("string")
        .kinesisParameters(ScheduleTargetKinesisParametersArgs.builder()
            .partitionKey("string")
            .build())
        .retryPolicy(ScheduleTargetRetryPolicyArgs.builder()
            .maximumEventAgeInSeconds(0)
            .maximumRetryAttempts(0)
            .build())
        .sagemakerPipelineParameters(ScheduleTargetSagemakerPipelineParametersArgs.builder()
            .pipelineParameters(ScheduleTargetSagemakerPipelineParametersPipelineParameterArgs.builder()
                .name("string")
                .value("string")
                .build())
            .build())
        .sqsParameters(ScheduleTargetSqsParametersArgs.builder()
            .messageGroupId("string")
            .build())
        .build())
    .description("string")
    .endDate("string")
    .groupName("string")
    .kmsKeyArn("string")
    .name("string")
    .namePrefix("string")
    .scheduleExpressionTimezone("string")
    .startDate("string")
    .state("string")
    .build());

aws_schedule_resource = aws.scheduler.Schedule("awsScheduleResource",
    flexible_time_window={
        "mode": "string",
        "maximum_window_in_minutes": 0,
    },
    schedule_expression="string",
    target={
        "arn": "string",
        "role_arn": "string",
        "dead_letter_config": {
            "arn": "string",
        },
        "ecs_parameters": {
            "task_definition_arn": "string",
            "placement_constraints": [{
                "type": "string",
                "expression": "string",
            }],
            "enable_execute_command": False,
            "group": "string",
            "launch_type": "string",
            "network_configuration": {
                "subnets": ["string"],
                "assign_public_ip": False,
                "security_groups": ["string"],
            },
            "capacity_provider_strategies": [{
                "capacity_provider": "string",
                "base": 0,
                "weight": 0,
            }],
            "placement_strategies": [{
                "type": "string",
                "field": "string",
            }],
            "platform_version": "string",
            "propagate_tags": "string",
            "reference_id": "string",
            "tags": {
                "string": "string",
            },
            "task_count": 0,
            "enable_ecs_managed_tags": False,
        },
        "eventbridge_parameters": {
            "detail_type": "string",
            "source": "string",
        },
        "input": "string",
        "kinesis_parameters": {
            "partition_key": "string",
        },
        "retry_policy": {
            "maximum_event_age_in_seconds": 0,
            "maximum_retry_attempts": 0,
        },
        "sagemaker_pipeline_parameters": {
            "pipeline_parameters": [{
                "name": "string",
                "value": "string",
            }],
        },
        "sqs_parameters": {
            "message_group_id": "string",
        },
    },
    description="string",
    end_date="string",
    group_name="string",
    kms_key_arn="string",
    name="string",
    name_prefix="string",
    schedule_expression_timezone="string",
    start_date="string",
    state="string")

const awsScheduleResource = new aws.scheduler.Schedule("awsScheduleResource", {
    flexibleTimeWindow: {
        mode: "string",
        maximumWindowInMinutes: 0,
    },
    scheduleExpression: "string",
    target: {
        arn: "string",
        roleArn: "string",
        deadLetterConfig: {
            arn: "string",
        },
        ecsParameters: {
            taskDefinitionArn: "string",
            placementConstraints: [{
                type: "string",
                expression: "string",
            }],
            enableExecuteCommand: false,
            group: "string",
            launchType: "string",
            networkConfiguration: {
                subnets: ["string"],
                assignPublicIp: false,
                securityGroups: ["string"],
            },
            capacityProviderStrategies: [{
                capacityProvider: "string",
                base: 0,
                weight: 0,
            }],
            placementStrategies: [{
                type: "string",
                field: "string",
            }],
            platformVersion: "string",
            propagateTags: "string",
            referenceId: "string",
            tags: {
                string: "string",
            },
            taskCount: 0,
            enableEcsManagedTags: false,
        },
        eventbridgeParameters: {
            detailType: "string",
            source: "string",
        },
        input: "string",
        kinesisParameters: {
            partitionKey: "string",
        },
        retryPolicy: {
            maximumEventAgeInSeconds: 0,
            maximumRetryAttempts: 0,
        },
        sagemakerPipelineParameters: {
            pipelineParameters: [{
                name: "string",
                value: "string",
            }],
        },
        sqsParameters: {
            messageGroupId: "string",
        },
    },
    description: "string",
    endDate: "string",
    groupName: "string",
    kmsKeyArn: "string",
    name: "string",
    namePrefix: "string",
    scheduleExpressionTimezone: "string",
    startDate: "string",
    state: "string",
});

type: aws:scheduler:Schedule
properties:
    description: string
    endDate: string
    flexibleTimeWindow:
        maximumWindowInMinutes: 0
        mode: string
    groupName: string
    kmsKeyArn: string
    name: string
    namePrefix: string
    scheduleExpression: string
    scheduleExpressionTimezone: string
    startDate: string
    state: string
    target:
        arn: string
        deadLetterConfig:
            arn: string
        ecsParameters:
            capacityProviderStrategies:
                - base: 0
                  capacityProvider: string
                  weight: 0
            enableEcsManagedTags: false
            enableExecuteCommand: false
            group: string
            launchType: string
            networkConfiguration:
                assignPublicIp: false
                securityGroups:
                    - string
                subnets:
                    - string
            placementConstraints:
                - expression: string
                  type: string
            placementStrategies:
                - field: string
                  type: string
            platformVersion: string
            propagateTags: string
            referenceId: string
            tags:
                string: string
            taskCount: 0
            taskDefinitionArn: string
        eventbridgeParameters:
            detailType: string
            source: string
        input: string
        kinesisParameters:
            partitionKey: string
        retryPolicy:
            maximumEventAgeInSeconds: 0
            maximumRetryAttempts: 0
        roleArn: string
        sagemakerPipelineParameters:
            pipelineParameters:
                - name: string
                  value: string
        sqsParameters:
            messageGroupId: string

Schedule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Schedule resource accepts the following input properties:

FlexibleTimeWindow ScheduleFlexibleTimeWindow

Configures a time window during which EventBridge Scheduler invokes the schedule. Detailed below.

ScheduleExpression string

Defines when the schedule runs. Read more in Schedule types on EventBridge Scheduler.

Target ScheduleTarget

Configures the target of the schedule. Detailed below.

The following arguments are optional:

Description string

Brief description of the schedule.

EndDate string

The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the end date you specify. EventBridge Scheduler ignores the end date for one-time schedules. Example: 2030-01-01T01:00:00Z.

GroupName string

Name of the schedule group to associate with this schedule. When omitted, the default schedule group is used.

KmsKeyArn string

ARN for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

Name string

Name of the schedule. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

NamePrefix string

Creates a unique name beginning with the specified prefix. Conflicts with name.

ScheduleExpressionTimezone string

Timezone in which the scheduling expression is evaluated. Defaults to UTC. Example: Australia/Sydney.

StartDate string

The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the start date you specify. EventBridge Scheduler ignores the start date for one-time schedules. Example: 2030-01-01T01:00:00Z.

State string

Specifies whether the schedule is enabled or disabled. One of: ENABLED (default), DISABLED.

FlexibleTimeWindow ScheduleFlexibleTimeWindowArgs

Configures a time window during which EventBridge Scheduler invokes the schedule. Detailed below.

ScheduleExpression string

Defines when the schedule runs. Read more in Schedule types on EventBridge Scheduler.

Target ScheduleTargetArgs

Configures the target of the schedule. Detailed below.

The following arguments are optional:

Description string

Brief description of the schedule.

EndDate string

GroupName string

Name of the schedule group to associate with this schedule. When omitted, the default schedule group is used.

KmsKeyArn string

ARN for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

Name string

Name of the schedule. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

NamePrefix string

Creates a unique name beginning with the specified prefix. Conflicts with name.

ScheduleExpressionTimezone string

Timezone in which the scheduling expression is evaluated. Defaults to UTC. Example: Australia/Sydney.

StartDate string

State string

Specifies whether the schedule is enabled or disabled. One of: ENABLED (default), DISABLED.

flexibleTimeWindow ScheduleFlexibleTimeWindow

Configures a time window during which EventBridge Scheduler invokes the schedule. Detailed below.

scheduleExpression String

Defines when the schedule runs. Read more in Schedule types on EventBridge Scheduler.

target ScheduleTarget

Configures the target of the schedule. Detailed below.

The following arguments are optional:

description String

Brief description of the schedule.

endDate String

groupName String

Name of the schedule group to associate with this schedule. When omitted, the default schedule group is used.

kmsKeyArn String

ARN for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

name String

Name of the schedule. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

namePrefix String

Creates a unique name beginning with the specified prefix. Conflicts with name.

scheduleExpressionTimezone String

Timezone in which the scheduling expression is evaluated. Defaults to UTC. Example: Australia/Sydney.

startDate String

state String

Specifies whether the schedule is enabled or disabled. One of: ENABLED (default), DISABLED.

flexibleTimeWindow ScheduleFlexibleTimeWindow

Configures a time window during which EventBridge Scheduler invokes the schedule. Detailed below.

scheduleExpression string

Defines when the schedule runs. Read more in Schedule types on EventBridge Scheduler.

target ScheduleTarget

Configures the target of the schedule. Detailed below.

The following arguments are optional:

description string

Brief description of the schedule.

endDate string

groupName string

Name of the schedule group to associate with this schedule. When omitted, the default schedule group is used.

kmsKeyArn string

ARN for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

name string

Name of the schedule. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

namePrefix string

Creates a unique name beginning with the specified prefix. Conflicts with name.

scheduleExpressionTimezone string

Timezone in which the scheduling expression is evaluated. Defaults to UTC. Example: Australia/Sydney.

startDate string

state string

Specifies whether the schedule is enabled or disabled. One of: ENABLED (default), DISABLED.

flexible_time_window ScheduleFlexibleTimeWindowArgs

Configures a time window during which EventBridge Scheduler invokes the schedule. Detailed below.

schedule_expression str

Defines when the schedule runs. Read more in Schedule types on EventBridge Scheduler.

target ScheduleTargetArgs

Configures the target of the schedule. Detailed below.

The following arguments are optional:

description str

Brief description of the schedule.

end_date str

group_name str

Name of the schedule group to associate with this schedule. When omitted, the default schedule group is used.

kms_key_arn str

ARN for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

name str

Name of the schedule. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

name_prefix str

Creates a unique name beginning with the specified prefix. Conflicts with name.

schedule_expression_timezone str

Timezone in which the scheduling expression is evaluated. Defaults to UTC. Example: Australia/Sydney.

start_date str

state str

Specifies whether the schedule is enabled or disabled. One of: ENABLED (default), DISABLED.

flexibleTimeWindow Property Map

Configures a time window during which EventBridge Scheduler invokes the schedule. Detailed below.

scheduleExpression String

Defines when the schedule runs. Read more in Schedule types on EventBridge Scheduler.

target Property Map

Configures the target of the schedule. Detailed below.

The following arguments are optional:

description String

Brief description of the schedule.

endDate String

groupName String

Name of the schedule group to associate with this schedule. When omitted, the default schedule group is used.

kmsKeyArn String

ARN for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

name String

Name of the schedule. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

namePrefix String

Creates a unique name beginning with the specified prefix. Conflicts with name.

scheduleExpressionTimezone String

Timezone in which the scheduling expression is evaluated. Defaults to UTC. Example: Australia/Sydney.

startDate String

state String

Specifies whether the schedule is enabled or disabled. One of: ENABLED (default), DISABLED.

Outputs

All input properties are implicitly available as output properties. Additionally, the Schedule resource produces the following output properties:

Arn string: ARN of the schedule.
Id string: The provider-assigned unique ID for this managed resource.

Arn string: ARN of the schedule.
Id string: The provider-assigned unique ID for this managed resource.

arn String: ARN of the schedule.
id String: The provider-assigned unique ID for this managed resource.

arn string: ARN of the schedule.
id string: The provider-assigned unique ID for this managed resource.

arn str: ARN of the schedule.
id str: The provider-assigned unique ID for this managed resource.

arn String: ARN of the schedule.
id String: The provider-assigned unique ID for this managed resource.

Look up Existing Schedule Resource

Get an existing Schedule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ScheduleState, opts?: CustomResourceOptions): Schedule

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        end_date: Optional[str] = None,
        flexible_time_window: Optional[ScheduleFlexibleTimeWindowArgs] = None,
        group_name: Optional[str] = None,
        kms_key_arn: Optional[str] = None,
        name: Optional[str] = None,
        name_prefix: Optional[str] = None,
        schedule_expression: Optional[str] = None,
        schedule_expression_timezone: Optional[str] = None,
        start_date: Optional[str] = None,
        state: Optional[str] = None,
        target: Optional[ScheduleTargetArgs] = None) -> Schedule

func GetSchedule(ctx *Context, name string, id IDInput, state *ScheduleState, opts ...ResourceOption) (*Schedule, error)

public static Schedule Get(string name, Input<string> id, ScheduleState? state, CustomResourceOptions? opts = null)

public static Schedule get(String name, Output<String> id, ScheduleState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Arn string

ARN of the schedule.

Description string

Brief description of the schedule.

EndDate string

FlexibleTimeWindow ScheduleFlexibleTimeWindow

Configures a time window during which EventBridge Scheduler invokes the schedule. Detailed below.

GroupName string

Name of the schedule group to associate with this schedule. When omitted, the default schedule group is used.

KmsKeyArn string

ARN for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

Name string

Name of the schedule. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

NamePrefix string

Creates a unique name beginning with the specified prefix. Conflicts with name.

ScheduleExpression string

Defines when the schedule runs. Read more in Schedule types on EventBridge Scheduler.

ScheduleExpressionTimezone string

Timezone in which the scheduling expression is evaluated. Defaults to UTC. Example: Australia/Sydney.

StartDate string

State string

Specifies whether the schedule is enabled or disabled. One of: ENABLED (default), DISABLED.

Target ScheduleTarget

Configures the target of the schedule. Detailed below.

The following arguments are optional:

Arn string

ARN of the schedule.

Description string

Brief description of the schedule.

EndDate string

FlexibleTimeWindow ScheduleFlexibleTimeWindowArgs

Configures a time window during which EventBridge Scheduler invokes the schedule. Detailed below.

GroupName string

Name of the schedule group to associate with this schedule. When omitted, the default schedule group is used.

KmsKeyArn string

ARN for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

Name string

Name of the schedule. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

NamePrefix string

Creates a unique name beginning with the specified prefix. Conflicts with name.

ScheduleExpression string

Defines when the schedule runs. Read more in Schedule types on EventBridge Scheduler.

ScheduleExpressionTimezone string

Timezone in which the scheduling expression is evaluated. Defaults to UTC. Example: Australia/Sydney.

StartDate string

State string

Specifies whether the schedule is enabled or disabled. One of: ENABLED (default), DISABLED.

Target ScheduleTargetArgs

Configures the target of the schedule. Detailed below.

The following arguments are optional:

arn String

ARN of the schedule.

description String

Brief description of the schedule.

endDate String

flexibleTimeWindow ScheduleFlexibleTimeWindow

Configures a time window during which EventBridge Scheduler invokes the schedule. Detailed below.

groupName String

Name of the schedule group to associate with this schedule. When omitted, the default schedule group is used.

kmsKeyArn String

ARN for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

name String

Name of the schedule. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

namePrefix String

Creates a unique name beginning with the specified prefix. Conflicts with name.

scheduleExpression String

Defines when the schedule runs. Read more in Schedule types on EventBridge Scheduler.

scheduleExpressionTimezone String

Timezone in which the scheduling expression is evaluated. Defaults to UTC. Example: Australia/Sydney.

startDate String

state String

Specifies whether the schedule is enabled or disabled. One of: ENABLED (default), DISABLED.

target ScheduleTarget

Configures the target of the schedule. Detailed below.

The following arguments are optional:

arn string

ARN of the schedule.

description string

Brief description of the schedule.

endDate string

flexibleTimeWindow ScheduleFlexibleTimeWindow

Configures a time window during which EventBridge Scheduler invokes the schedule. Detailed below.

groupName string

Name of the schedule group to associate with this schedule. When omitted, the default schedule group is used.

kmsKeyArn string

ARN for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

name string

Name of the schedule. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

namePrefix string

Creates a unique name beginning with the specified prefix. Conflicts with name.

scheduleExpression string

Defines when the schedule runs. Read more in Schedule types on EventBridge Scheduler.

scheduleExpressionTimezone string

Timezone in which the scheduling expression is evaluated. Defaults to UTC. Example: Australia/Sydney.

startDate string

state string

Specifies whether the schedule is enabled or disabled. One of: ENABLED (default), DISABLED.

target ScheduleTarget

Configures the target of the schedule. Detailed below.

The following arguments are optional:

arn str

ARN of the schedule.

description str

Brief description of the schedule.

end_date str

flexible_time_window ScheduleFlexibleTimeWindowArgs

Configures a time window during which EventBridge Scheduler invokes the schedule. Detailed below.

group_name str

Name of the schedule group to associate with this schedule. When omitted, the default schedule group is used.

kms_key_arn str

ARN for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

name str

Name of the schedule. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

name_prefix str

Creates a unique name beginning with the specified prefix. Conflicts with name.

schedule_expression str

Defines when the schedule runs. Read more in Schedule types on EventBridge Scheduler.

schedule_expression_timezone str

Timezone in which the scheduling expression is evaluated. Defaults to UTC. Example: Australia/Sydney.

start_date str

state str

Specifies whether the schedule is enabled or disabled. One of: ENABLED (default), DISABLED.

target ScheduleTargetArgs

Configures the target of the schedule. Detailed below.

The following arguments are optional:

arn String

ARN of the schedule.

description String

Brief description of the schedule.

endDate String

flexibleTimeWindow Property Map

Configures a time window during which EventBridge Scheduler invokes the schedule. Detailed below.

groupName String

Name of the schedule group to associate with this schedule. When omitted, the default schedule group is used.

kmsKeyArn String

ARN for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

name String

Name of the schedule. If omitted, the provider will assign a random, unique name. Conflicts with name_prefix.

namePrefix String

Creates a unique name beginning with the specified prefix. Conflicts with name.

scheduleExpression String

Defines when the schedule runs. Read more in Schedule types on EventBridge Scheduler.

scheduleExpressionTimezone String

Timezone in which the scheduling expression is evaluated. Defaults to UTC. Example: Australia/Sydney.

startDate String

state String

Specifies whether the schedule is enabled or disabled. One of: ENABLED (default), DISABLED.

target Property Map

Configures the target of the schedule. Detailed below.

The following arguments are optional:

Supporting Types

ScheduleFlexibleTimeWindow, ScheduleFlexibleTimeWindowArgs

Mode string: Determines whether the schedule is invoked within a flexible time window. One of: OFF, FLEXIBLE.
MaximumWindowInMinutes int: Maximum time window during which a schedule can be invoked. Ranges from 1 to 1440 minutes.

Mode string: Determines whether the schedule is invoked within a flexible time window. One of: OFF, FLEXIBLE.
MaximumWindowInMinutes int: Maximum time window during which a schedule can be invoked. Ranges from 1 to 1440 minutes.

mode String: Determines whether the schedule is invoked within a flexible time window. One of: OFF, FLEXIBLE.
maximumWindowInMinutes Integer: Maximum time window during which a schedule can be invoked. Ranges from 1 to 1440 minutes.

mode string: Determines whether the schedule is invoked within a flexible time window. One of: OFF, FLEXIBLE.
maximumWindowInMinutes number: Maximum time window during which a schedule can be invoked. Ranges from 1 to 1440 minutes.

mode str: Determines whether the schedule is invoked within a flexible time window. One of: OFF, FLEXIBLE.
maximum_window_in_minutes int: Maximum time window during which a schedule can be invoked. Ranges from 1 to 1440 minutes.

mode String: Determines whether the schedule is invoked within a flexible time window. One of: OFF, FLEXIBLE.
maximumWindowInMinutes Number: Maximum time window during which a schedule can be invoked. Ranges from 1 to 1440 minutes.

ScheduleTarget, ScheduleTargetArgs

Arn string

ARN of the target of this schedule, such as a SQS queue or ECS cluster. For universal targets, this is a Service ARN specific to the target service.

RoleArn string

ARN of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked. Read more in Set up the execution role.

The following arguments are optional:

DeadLetterConfig ScheduleTargetDeadLetterConfig

Information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue. Detailed below.

EcsParameters ScheduleTargetEcsParameters

Templated target type for the Amazon ECS RunTask API operation. Detailed below.

EventbridgeParameters ScheduleTargetEventbridgeParameters

Templated target type for the EventBridge PutEvents API operation. Detailed below.

Input string

Text, or well-formed JSON, passed to the target. Read more in Universal target.

KinesisParameters ScheduleTargetKinesisParameters

Templated target type for the Amazon Kinesis PutRecord API operation. Detailed below.

RetryPolicy ScheduleTargetRetryPolicy

Information about the retry policy settings. Detailed below.

SagemakerPipelineParameters ScheduleTargetSagemakerPipelineParameters

Templated target type for the Amazon SageMaker StartPipelineExecution API operation. Detailed below.

SqsParameters ScheduleTargetSqsParameters

The templated target type for the Amazon SQS SendMessage API operation. Detailed below.

Arn string

ARN of the target of this schedule, such as a SQS queue or ECS cluster. For universal targets, this is a Service ARN specific to the target service.

RoleArn string

ARN of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked. Read more in Set up the execution role.

The following arguments are optional:

DeadLetterConfig ScheduleTargetDeadLetterConfig

EcsParameters ScheduleTargetEcsParameters

Templated target type for the Amazon ECS RunTask API operation. Detailed below.

EventbridgeParameters ScheduleTargetEventbridgeParameters

Templated target type for the EventBridge PutEvents API operation. Detailed below.

Input string

Text, or well-formed JSON, passed to the target. Read more in Universal target.

KinesisParameters ScheduleTargetKinesisParameters

Templated target type for the Amazon Kinesis PutRecord API operation. Detailed below.

RetryPolicy ScheduleTargetRetryPolicy

Information about the retry policy settings. Detailed below.

SagemakerPipelineParameters ScheduleTargetSagemakerPipelineParameters

Templated target type for the Amazon SageMaker StartPipelineExecution API operation. Detailed below.

SqsParameters ScheduleTargetSqsParameters

The templated target type for the Amazon SQS SendMessage API operation. Detailed below.

arn String

ARN of the target of this schedule, such as a SQS queue or ECS cluster. For universal targets, this is a Service ARN specific to the target service.

roleArn String

ARN of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked. Read more in Set up the execution role.

The following arguments are optional:

deadLetterConfig ScheduleTargetDeadLetterConfig

ecsParameters ScheduleTargetEcsParameters

Templated target type for the Amazon ECS RunTask API operation. Detailed below.

eventbridgeParameters ScheduleTargetEventbridgeParameters

Templated target type for the EventBridge PutEvents API operation. Detailed below.

input String

Text, or well-formed JSON, passed to the target. Read more in Universal target.

kinesisParameters ScheduleTargetKinesisParameters

Templated target type for the Amazon Kinesis PutRecord API operation. Detailed below.

retryPolicy ScheduleTargetRetryPolicy

Information about the retry policy settings. Detailed below.

sagemakerPipelineParameters ScheduleTargetSagemakerPipelineParameters

Templated target type for the Amazon SageMaker StartPipelineExecution API operation. Detailed below.

sqsParameters ScheduleTargetSqsParameters

The templated target type for the Amazon SQS SendMessage API operation. Detailed below.

arn string

ARN of the target of this schedule, such as a SQS queue or ECS cluster. For universal targets, this is a Service ARN specific to the target service.

roleArn string

ARN of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked. Read more in Set up the execution role.

The following arguments are optional:

deadLetterConfig ScheduleTargetDeadLetterConfig

ecsParameters ScheduleTargetEcsParameters

Templated target type for the Amazon ECS RunTask API operation. Detailed below.

eventbridgeParameters ScheduleTargetEventbridgeParameters

Templated target type for the EventBridge PutEvents API operation. Detailed below.

input string

Text, or well-formed JSON, passed to the target. Read more in Universal target.

kinesisParameters ScheduleTargetKinesisParameters

Templated target type for the Amazon Kinesis PutRecord API operation. Detailed below.

retryPolicy ScheduleTargetRetryPolicy

Information about the retry policy settings. Detailed below.

sagemakerPipelineParameters ScheduleTargetSagemakerPipelineParameters

Templated target type for the Amazon SageMaker StartPipelineExecution API operation. Detailed below.

sqsParameters ScheduleTargetSqsParameters

The templated target type for the Amazon SQS SendMessage API operation. Detailed below.

arn str

ARN of the target of this schedule, such as a SQS queue or ECS cluster. For universal targets, this is a Service ARN specific to the target service.

role_arn str

ARN of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked. Read more in Set up the execution role.

The following arguments are optional:

dead_letter_config ScheduleTargetDeadLetterConfig

ecs_parameters ScheduleTargetEcsParameters

Templated target type for the Amazon ECS RunTask API operation. Detailed below.

eventbridge_parameters ScheduleTargetEventbridgeParameters

Templated target type for the EventBridge PutEvents API operation. Detailed below.

input str

Text, or well-formed JSON, passed to the target. Read more in Universal target.

kinesis_parameters ScheduleTargetKinesisParameters

Templated target type for the Amazon Kinesis PutRecord API operation. Detailed below.

retry_policy ScheduleTargetRetryPolicy

Information about the retry policy settings. Detailed below.

sagemaker_pipeline_parameters ScheduleTargetSagemakerPipelineParameters

Templated target type for the Amazon SageMaker StartPipelineExecution API operation. Detailed below.

sqs_parameters ScheduleTargetSqsParameters

The templated target type for the Amazon SQS SendMessage API operation. Detailed below.

arn String

ARN of the target of this schedule, such as a SQS queue or ECS cluster. For universal targets, this is a Service ARN specific to the target service.

roleArn String

ARN of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked. Read more in Set up the execution role.

The following arguments are optional:

deadLetterConfig Property Map

ecsParameters Property Map

Templated target type for the Amazon ECS RunTask API operation. Detailed below.

eventbridgeParameters Property Map

Templated target type for the EventBridge PutEvents API operation. Detailed below.

input String

Text, or well-formed JSON, passed to the target. Read more in Universal target.

kinesisParameters Property Map

Templated target type for the Amazon Kinesis PutRecord API operation. Detailed below.

retryPolicy Property Map

Information about the retry policy settings. Detailed below.

sagemakerPipelineParameters Property Map

Templated target type for the Amazon SageMaker StartPipelineExecution API operation. Detailed below.

sqsParameters Property Map

The templated target type for the Amazon SQS SendMessage API operation. Detailed below.

ScheduleTargetDeadLetterConfig, ScheduleTargetDeadLetterConfigArgs

Arn string: ARN of the SQS queue specified as the destination for the dead-letter queue.

Arn string: ARN of the SQS queue specified as the destination for the dead-letter queue.

arn String: ARN of the SQS queue specified as the destination for the dead-letter queue.

arn string: ARN of the SQS queue specified as the destination for the dead-letter queue.

arn str: ARN of the SQS queue specified as the destination for the dead-letter queue.

arn String: ARN of the SQS queue specified as the destination for the dead-letter queue.

ScheduleTargetEcsParameters, ScheduleTargetEcsParametersArgs

TaskDefinitionArn string

ARN of the task definition to use.

The following arguments are optional:

CapacityProviderStrategies List<ScheduleTargetEcsParametersCapacityProviderStrategy>

Up to 6 capacity provider strategies to use for the task. Detailed below.

EnableEcsManagedTags bool

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon ECS Developer Guide.

EnableExecuteCommand bool

Specifies whether to enable the execute command functionality for the containers in this task.

Group string

Specifies an ECS task group for the task. At most 255 characters.

LaunchType string

Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. One of: EC2, FARGATE, EXTERNAL.

NetworkConfiguration ScheduleTargetEcsParametersNetworkConfiguration

Configures the networking associated with the task. Detailed below.

PlacementConstraints List<ScheduleTargetEcsParametersPlacementConstraint>

A set of up to 10 placement constraints to use for the task. Detailed below.

PlacementStrategies List<ScheduleTargetEcsParametersPlacementStrategy>

A set of up to 5 placement strategies. Detailed below.

PlatformVersion string

Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.

PropagateTags string

Specifies whether to propagate the tags from the task definition to the task. One of: TASK_DEFINITION.

ReferenceId string

Reference ID to use for the task.

Tags Dictionary<string, string>

The metadata that you apply to the task. Each tag consists of a key and an optional value. For more information, see RunTask in the Amazon ECS API Reference.

TaskCount int

The number of tasks to create. Ranges from 1 (default) to 10.

TaskDefinitionArn string

ARN of the task definition to use.

The following arguments are optional:

CapacityProviderStrategies []ScheduleTargetEcsParametersCapacityProviderStrategy

Up to 6 capacity provider strategies to use for the task. Detailed below.

EnableEcsManagedTags bool

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon ECS Developer Guide.

EnableExecuteCommand bool

Specifies whether to enable the execute command functionality for the containers in this task.

Group string

Specifies an ECS task group for the task. At most 255 characters.

LaunchType string

NetworkConfiguration ScheduleTargetEcsParametersNetworkConfiguration

Configures the networking associated with the task. Detailed below.

PlacementConstraints []ScheduleTargetEcsParametersPlacementConstraint

A set of up to 10 placement constraints to use for the task. Detailed below.

PlacementStrategies []ScheduleTargetEcsParametersPlacementStrategy

A set of up to 5 placement strategies. Detailed below.

PlatformVersion string

Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.

PropagateTags string

Specifies whether to propagate the tags from the task definition to the task. One of: TASK_DEFINITION.

ReferenceId string

Reference ID to use for the task.

Tags map[string]string

The metadata that you apply to the task. Each tag consists of a key and an optional value. For more information, see RunTask in the Amazon ECS API Reference.

TaskCount int

The number of tasks to create. Ranges from 1 (default) to 10.

taskDefinitionArn String

ARN of the task definition to use.

The following arguments are optional:

capacityProviderStrategies List<ScheduleTargetEcsParametersCapacityProviderStrategy>

Up to 6 capacity provider strategies to use for the task. Detailed below.

enableEcsManagedTags Boolean

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon ECS Developer Guide.

enableExecuteCommand Boolean

Specifies whether to enable the execute command functionality for the containers in this task.

group String

Specifies an ECS task group for the task. At most 255 characters.

launchType String

networkConfiguration ScheduleTargetEcsParametersNetworkConfiguration

Configures the networking associated with the task. Detailed below.

placementConstraints List<ScheduleTargetEcsParametersPlacementConstraint>

A set of up to 10 placement constraints to use for the task. Detailed below.

placementStrategies List<ScheduleTargetEcsParametersPlacementStrategy>

A set of up to 5 placement strategies. Detailed below.

platformVersion String

Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.

propagateTags String

Specifies whether to propagate the tags from the task definition to the task. One of: TASK_DEFINITION.

referenceId String

Reference ID to use for the task.

tags Map<String,String>

The metadata that you apply to the task. Each tag consists of a key and an optional value. For more information, see RunTask in the Amazon ECS API Reference.

taskCount Integer

The number of tasks to create. Ranges from 1 (default) to 10.

taskDefinitionArn string

ARN of the task definition to use.

The following arguments are optional:

capacityProviderStrategies ScheduleTargetEcsParametersCapacityProviderStrategy[]

Up to 6 capacity provider strategies to use for the task. Detailed below.

enableEcsManagedTags boolean

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon ECS Developer Guide.

enableExecuteCommand boolean

Specifies whether to enable the execute command functionality for the containers in this task.

group string

Specifies an ECS task group for the task. At most 255 characters.

launchType string

networkConfiguration ScheduleTargetEcsParametersNetworkConfiguration

Configures the networking associated with the task. Detailed below.

placementConstraints ScheduleTargetEcsParametersPlacementConstraint[]

A set of up to 10 placement constraints to use for the task. Detailed below.

placementStrategies ScheduleTargetEcsParametersPlacementStrategy[]

A set of up to 5 placement strategies. Detailed below.

platformVersion string

Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.

propagateTags string

Specifies whether to propagate the tags from the task definition to the task. One of: TASK_DEFINITION.

referenceId string

Reference ID to use for the task.

tags {[key: string]: string}

The metadata that you apply to the task. Each tag consists of a key and an optional value. For more information, see RunTask in the Amazon ECS API Reference.

taskCount number

The number of tasks to create. Ranges from 1 (default) to 10.

task_definition_arn str

ARN of the task definition to use.

The following arguments are optional:

capacity_provider_strategies Sequence[ScheduleTargetEcsParametersCapacityProviderStrategy]

Up to 6 capacity provider strategies to use for the task. Detailed below.

enable_ecs_managed_tags bool

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon ECS Developer Guide.

enable_execute_command bool

Specifies whether to enable the execute command functionality for the containers in this task.

group str

Specifies an ECS task group for the task. At most 255 characters.

launch_type str

network_configuration ScheduleTargetEcsParametersNetworkConfiguration

Configures the networking associated with the task. Detailed below.

placement_constraints Sequence[ScheduleTargetEcsParametersPlacementConstraint]

A set of up to 10 placement constraints to use for the task. Detailed below.

placement_strategies Sequence[ScheduleTargetEcsParametersPlacementStrategy]

A set of up to 5 placement strategies. Detailed below.

platform_version str

Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.

propagate_tags str

Specifies whether to propagate the tags from the task definition to the task. One of: TASK_DEFINITION.

reference_id str

Reference ID to use for the task.

tags Mapping[str, str]

The metadata that you apply to the task. Each tag consists of a key and an optional value. For more information, see RunTask in the Amazon ECS API Reference.

task_count int

The number of tasks to create. Ranges from 1 (default) to 10.

taskDefinitionArn String

ARN of the task definition to use.

The following arguments are optional:

capacityProviderStrategies List<Property Map>

Up to 6 capacity provider strategies to use for the task. Detailed below.

enableEcsManagedTags Boolean

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon ECS Developer Guide.

enableExecuteCommand Boolean

Specifies whether to enable the execute command functionality for the containers in this task.

group String

Specifies an ECS task group for the task. At most 255 characters.

launchType String

networkConfiguration Property Map

Configures the networking associated with the task. Detailed below.

placementConstraints List<Property Map>

A set of up to 10 placement constraints to use for the task. Detailed below.

placementStrategies List<Property Map>

A set of up to 5 placement strategies. Detailed below.

platformVersion String

Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.

propagateTags String

Specifies whether to propagate the tags from the task definition to the task. One of: TASK_DEFINITION.

referenceId String

Reference ID to use for the task.

tags Map<String>

The metadata that you apply to the task. Each tag consists of a key and an optional value. For more information, see RunTask in the Amazon ECS API Reference.

taskCount Number

The number of tasks to create. Ranges from 1 (default) to 10.

ScheduleTargetEcsParametersCapacityProviderStrategy, ScheduleTargetEcsParametersCapacityProviderStrategyArgs

CapacityProvider string: Short name of the capacity provider.
Base int: How many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. Ranges from 0 (default) to 100000.
Weight int: Designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied. Ranges from from 0 to 1000.

CapacityProvider string: Short name of the capacity provider.
Base int: How many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. Ranges from 0 (default) to 100000.
Weight int: Designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied. Ranges from from 0 to 1000.

capacityProvider String: Short name of the capacity provider.
base Integer: How many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. Ranges from 0 (default) to 100000.
weight Integer: Designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied. Ranges from from 0 to 1000.

capacityProvider string: Short name of the capacity provider.
base number: How many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. Ranges from 0 (default) to 100000.
weight number: Designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied. Ranges from from 0 to 1000.

capacity_provider str: Short name of the capacity provider.
base int: How many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. Ranges from 0 (default) to 100000.
weight int: Designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied. Ranges from from 0 to 1000.

capacityProvider String: Short name of the capacity provider.
base Number: How many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. Ranges from 0 (default) to 100000.
weight Number: Designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied. Ranges from from 0 to 1000.

ScheduleTargetEcsParametersNetworkConfiguration, ScheduleTargetEcsParametersNetworkConfigurationArgs

Subnets List<string>: Set of 1 to 16 subnets to be associated with the task. These subnets must all be in the same VPC.
AssignPublicIp bool: Specifies whether the task's elastic network interface receives a public IP address. This attribute is a boolean type, where true maps to ENABLED and false to DISABLED. You can specify true only when the launch_type is set to FARGATE.
SecurityGroups List<string>: Set of 1 to 5 Security Group ID-s to be associated with the task. These security groups must all be in the same VPC.

Subnets []string: Set of 1 to 16 subnets to be associated with the task. These subnets must all be in the same VPC.
AssignPublicIp bool: Specifies whether the task's elastic network interface receives a public IP address. This attribute is a boolean type, where true maps to ENABLED and false to DISABLED. You can specify true only when the launch_type is set to FARGATE.
SecurityGroups []string: Set of 1 to 5 Security Group ID-s to be associated with the task. These security groups must all be in the same VPC.

subnets List<String>: Set of 1 to 16 subnets to be associated with the task. These subnets must all be in the same VPC.
assignPublicIp Boolean: Specifies whether the task's elastic network interface receives a public IP address. This attribute is a boolean type, where true maps to ENABLED and false to DISABLED. You can specify true only when the launch_type is set to FARGATE.
securityGroups List<String>: Set of 1 to 5 Security Group ID-s to be associated with the task. These security groups must all be in the same VPC.

subnets string[]: Set of 1 to 16 subnets to be associated with the task. These subnets must all be in the same VPC.
assignPublicIp boolean: Specifies whether the task's elastic network interface receives a public IP address. This attribute is a boolean type, where true maps to ENABLED and false to DISABLED. You can specify true only when the launch_type is set to FARGATE.
securityGroups string[]: Set of 1 to 5 Security Group ID-s to be associated with the task. These security groups must all be in the same VPC.

subnets Sequence[str]: Set of 1 to 16 subnets to be associated with the task. These subnets must all be in the same VPC.
assign_public_ip bool: Specifies whether the task's elastic network interface receives a public IP address. This attribute is a boolean type, where true maps to ENABLED and false to DISABLED. You can specify true only when the launch_type is set to FARGATE.
security_groups Sequence[str]: Set of 1 to 5 Security Group ID-s to be associated with the task. These security groups must all be in the same VPC.

subnets List<String>: Set of 1 to 16 subnets to be associated with the task. These subnets must all be in the same VPC.
assignPublicIp Boolean: Specifies whether the task's elastic network interface receives a public IP address. This attribute is a boolean type, where true maps to ENABLED and false to DISABLED. You can specify true only when the launch_type is set to FARGATE.
securityGroups List<String>: Set of 1 to 5 Security Group ID-s to be associated with the task. These security groups must all be in the same VPC.

ScheduleTargetEcsParametersPlacementConstraint, ScheduleTargetEcsParametersPlacementConstraintArgs

Type string: The type of constraint. One of: distinctInstance, memberOf.
Expression string: A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster query language in the Amazon ECS Developer Guide.

Type string: The type of constraint. One of: distinctInstance, memberOf.
Expression string: A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster query language in the Amazon ECS Developer Guide.

type String: The type of constraint. One of: distinctInstance, memberOf.
expression String: A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster query language in the Amazon ECS Developer Guide.

type string: The type of constraint. One of: distinctInstance, memberOf.
expression string: A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster query language in the Amazon ECS Developer Guide.

type str: The type of constraint. One of: distinctInstance, memberOf.
expression str: A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster query language in the Amazon ECS Developer Guide.

type String: The type of constraint. One of: distinctInstance, memberOf.
expression String: A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster query language in the Amazon ECS Developer Guide.

ScheduleTargetEcsParametersPlacementStrategy, ScheduleTargetEcsParametersPlacementStrategyArgs

Type string: The type of placement strategy. One of: random, spread, binpack.
Field string: The field to apply the placement strategy against.

Type string: The type of placement strategy. One of: random, spread, binpack.
Field string: The field to apply the placement strategy against.

type String: The type of placement strategy. One of: random, spread, binpack.
field String: The field to apply the placement strategy against.

type string: The type of placement strategy. One of: random, spread, binpack.
field string: The field to apply the placement strategy against.

type str: The type of placement strategy. One of: random, spread, binpack.
field str: The field to apply the placement strategy against.

type String: The type of placement strategy. One of: random, spread, binpack.
field String: The field to apply the placement strategy against.

ScheduleTargetEventbridgeParameters, ScheduleTargetEventbridgeParametersArgs

DetailType string: Free-form string used to decide what fields to expect in the event detail. Up to 128 characters.
Source string: Source of the event.

DetailType string: Free-form string used to decide what fields to expect in the event detail. Up to 128 characters.
Source string: Source of the event.

detailType String: Free-form string used to decide what fields to expect in the event detail. Up to 128 characters.
source String: Source of the event.

detailType string: Free-form string used to decide what fields to expect in the event detail. Up to 128 characters.
source string: Source of the event.

detail_type str: Free-form string used to decide what fields to expect in the event detail. Up to 128 characters.
source str: Source of the event.

detailType String: Free-form string used to decide what fields to expect in the event detail. Up to 128 characters.
source String: Source of the event.

ScheduleTargetKinesisParameters, ScheduleTargetKinesisParametersArgs

PartitionKey string: Specifies the shard to which EventBridge Scheduler sends the event. Up to 256 characters.

PartitionKey string: Specifies the shard to which EventBridge Scheduler sends the event. Up to 256 characters.

partitionKey String: Specifies the shard to which EventBridge Scheduler sends the event. Up to 256 characters.

partitionKey string: Specifies the shard to which EventBridge Scheduler sends the event. Up to 256 characters.

partition_key str: Specifies the shard to which EventBridge Scheduler sends the event. Up to 256 characters.

partitionKey String: Specifies the shard to which EventBridge Scheduler sends the event. Up to 256 characters.

ScheduleTargetRetryPolicy, ScheduleTargetRetryPolicyArgs

MaximumEventAgeInSeconds int: Maximum amount of time, in seconds, to continue to make retry attempts. Ranges from 60 to 86400 (default).
MaximumRetryAttempts int: Maximum number of retry attempts to make before the request fails. Ranges from 0 to 185 (default).

MaximumEventAgeInSeconds int: Maximum amount of time, in seconds, to continue to make retry attempts. Ranges from 60 to 86400 (default).
MaximumRetryAttempts int: Maximum number of retry attempts to make before the request fails. Ranges from 0 to 185 (default).

maximumEventAgeInSeconds Integer: Maximum amount of time, in seconds, to continue to make retry attempts. Ranges from 60 to 86400 (default).
maximumRetryAttempts Integer: Maximum number of retry attempts to make before the request fails. Ranges from 0 to 185 (default).

maximumEventAgeInSeconds number: Maximum amount of time, in seconds, to continue to make retry attempts. Ranges from 60 to 86400 (default).
maximumRetryAttempts number: Maximum number of retry attempts to make before the request fails. Ranges from 0 to 185 (default).

maximum_event_age_in_seconds int: Maximum amount of time, in seconds, to continue to make retry attempts. Ranges from 60 to 86400 (default).
maximum_retry_attempts int: Maximum number of retry attempts to make before the request fails. Ranges from 0 to 185 (default).

maximumEventAgeInSeconds Number: Maximum amount of time, in seconds, to continue to make retry attempts. Ranges from 60 to 86400 (default).
maximumRetryAttempts Number: Maximum number of retry attempts to make before the request fails. Ranges from 0 to 185 (default).

ScheduleTargetSagemakerPipelineParameters, ScheduleTargetSagemakerPipelineParametersArgs

PipelineParameters List<ScheduleTargetSagemakerPipelineParametersPipelineParameter>: Set of up to 200 parameter names and values to use when executing the SageMaker Model Building Pipeline. Detailed below.

PipelineParameters []ScheduleTargetSagemakerPipelineParametersPipelineParameter: Set of up to 200 parameter names and values to use when executing the SageMaker Model Building Pipeline. Detailed below.

pipelineParameters List<ScheduleTargetSagemakerPipelineParametersPipelineParameter>: Set of up to 200 parameter names and values to use when executing the SageMaker Model Building Pipeline. Detailed below.

pipelineParameters ScheduleTargetSagemakerPipelineParametersPipelineParameter[]: Set of up to 200 parameter names and values to use when executing the SageMaker Model Building Pipeline. Detailed below.

pipeline_parameters Sequence[ScheduleTargetSagemakerPipelineParametersPipelineParameter]: Set of up to 200 parameter names and values to use when executing the SageMaker Model Building Pipeline. Detailed below.

pipelineParameters List<Property Map>: Set of up to 200 parameter names and values to use when executing the SageMaker Model Building Pipeline. Detailed below.

ScheduleTargetSagemakerPipelineParametersPipelineParameter, ScheduleTargetSagemakerPipelineParametersPipelineParameterArgs

Name string: Name of parameter to start execution of a SageMaker Model Building Pipeline.
Value string: Value of parameter to start execution of a SageMaker Model Building Pipeline.

Name string: Name of parameter to start execution of a SageMaker Model Building Pipeline.
Value string: Value of parameter to start execution of a SageMaker Model Building Pipeline.

name String: Name of parameter to start execution of a SageMaker Model Building Pipeline.
value String: Value of parameter to start execution of a SageMaker Model Building Pipeline.

name string: Name of parameter to start execution of a SageMaker Model Building Pipeline.
value string: Value of parameter to start execution of a SageMaker Model Building Pipeline.

name str: Name of parameter to start execution of a SageMaker Model Building Pipeline.
value str: Value of parameter to start execution of a SageMaker Model Building Pipeline.

name String: Name of parameter to start execution of a SageMaker Model Building Pipeline.
value String: Value of parameter to start execution of a SageMaker Model Building Pipeline.

ScheduleTargetSqsParameters, ScheduleTargetSqsParametersArgs

MessageGroupId string: FIFO message group ID to use as the target.

MessageGroupId string: FIFO message group ID to use as the target.

messageGroupId String: FIFO message group ID to use as the target.

messageGroupId string: FIFO message group ID to use as the target.

message_group_id str: FIFO message group ID to use as the target.

messageGroupId String: FIFO message group ID to use as the target.

Import

Using pulumi import, import schedules using the combination group_name/name. For example:

$ pulumi import aws:scheduler/schedule:Schedule example my-schedule-group/my-schedule

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

pulumi/pulumi-aws

aws.scheduler.Schedule

On this page

On this page

Example Usage

Basic Usage

Universal Target

Create Schedule Resource

Constructor syntax

Parameters

Constructor example

Schedule Resource Properties

Inputs

Outputs

Look up Existing Schedule Resource

Supporting Types

ScheduleFlexibleTimeWindow, ScheduleFlexibleTimeWindowArgs

ScheduleTarget, ScheduleTargetArgs

ScheduleTargetDeadLetterConfig, ScheduleTargetDeadLetterConfigArgs

ScheduleTargetEcsParameters, ScheduleTargetEcsParametersArgs

ScheduleTargetEcsParametersCapacityProviderStrategy, ScheduleTargetEcsParametersCapacityProviderStrategyArgs

ScheduleTargetEcsParametersNetworkConfiguration, ScheduleTargetEcsParametersNetworkConfigurationArgs

ScheduleTargetEcsParametersPlacementConstraint, ScheduleTargetEcsParametersPlacementConstraintArgs

ScheduleTargetEcsParametersPlacementStrategy, ScheduleTargetEcsParametersPlacementStrategyArgs

ScheduleTargetEventbridgeParameters, ScheduleTargetEventbridgeParametersArgs

ScheduleTargetKinesisParameters, ScheduleTargetKinesisParametersArgs

ScheduleTargetRetryPolicy, ScheduleTargetRetryPolicyArgs

ScheduleTargetSagemakerPipelineParameters, ScheduleTargetSagemakerPipelineParametersArgs

ScheduleTargetSagemakerPipelineParametersPipelineParameter, ScheduleTargetSagemakerPipelineParametersPipelineParameterArgs

ScheduleTargetSqsParameters, ScheduleTargetSqsParametersArgs

Import

Package Details

On this page

On this page