Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. scheduler
  5. Schedule

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.scheduler.Schedule

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

Definition of AWS::Scheduler::Schedule Resource Type

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,
             schedule_expression_timezone: Optional[str] = None,
             start_date: Optional[str] = None,
             state: Optional[ScheduleState] = 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-native:scheduler:Schedule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ScheduleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. ScheduleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ScheduleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ScheduleArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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 This property is required. Pulumi.AwsNative.Scheduler.Inputs.ScheduleFlexibleTimeWindow
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
ScheduleExpression This property is required. string
The scheduling expression.
Target This property is required. Pulumi.AwsNative.Scheduler.Inputs.ScheduleTarget
The schedule's target details.
Description string
The 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 EndDate you specify.
GroupName string
The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
KmsKeyArn string
The ARN for a KMS Key that will be used to encrypt customer data.
Name string
The name of the schedule.
ScheduleExpressionTimezone string
The timezone in which the scheduling expression is evaluated.
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 StartDate you specify.
State Pulumi.AwsNative.Scheduler.ScheduleState

Specifies whether the schedule is enabled or disabled.

Allowed Values : ENABLED | DISABLED

FlexibleTimeWindow This property is required. ScheduleFlexibleTimeWindowArgs
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
ScheduleExpression This property is required. string
The scheduling expression.
Target This property is required. ScheduleTargetArgs
The schedule's target details.
Description string
The 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 EndDate you specify.
GroupName string
The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
KmsKeyArn string
The ARN for a KMS Key that will be used to encrypt customer data.
Name string
The name of the schedule.
ScheduleExpressionTimezone string
The timezone in which the scheduling expression is evaluated.
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 StartDate you specify.
State ScheduleStateEnum

Specifies whether the schedule is enabled or disabled.

Allowed Values : ENABLED | DISABLED

flexibleTimeWindow This property is required. ScheduleFlexibleTimeWindow
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
scheduleExpression This property is required. String
The scheduling expression.
target This property is required. ScheduleTarget
The schedule's target details.
description String
The 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 EndDate you specify.
groupName String
The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
kmsKeyArn String
The ARN for a KMS Key that will be used to encrypt customer data.
name String
The name of the schedule.
scheduleExpressionTimezone String
The timezone in which the scheduling expression is evaluated.
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 StartDate you specify.
state ScheduleState

Specifies whether the schedule is enabled or disabled.

Allowed Values : ENABLED | DISABLED

flexibleTimeWindow This property is required. ScheduleFlexibleTimeWindow
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
scheduleExpression This property is required. string
The scheduling expression.
target This property is required. ScheduleTarget
The schedule's target details.
description string
The 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 EndDate you specify.
groupName string
The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
kmsKeyArn string
The ARN for a KMS Key that will be used to encrypt customer data.
name string
The name of the schedule.
scheduleExpressionTimezone string
The timezone in which the scheduling expression is evaluated.
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 StartDate you specify.
state ScheduleState

Specifies whether the schedule is enabled or disabled.

Allowed Values : ENABLED | DISABLED

flexible_time_window This property is required. ScheduleFlexibleTimeWindowArgs
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
schedule_expression This property is required. str
The scheduling expression.
target This property is required. ScheduleTargetArgs
The schedule's target details.
description str
The description of the schedule.
end_date str
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 EndDate you specify.
group_name str
The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
kms_key_arn str
The ARN for a KMS Key that will be used to encrypt customer data.
name str
The name of the schedule.
schedule_expression_timezone str
The timezone in which the scheduling expression is evaluated.
start_date str
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 StartDate you specify.
state ScheduleState

Specifies whether the schedule is enabled or disabled.

Allowed Values : ENABLED | DISABLED

flexibleTimeWindow This property is required. Property Map
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
scheduleExpression This property is required. String
The scheduling expression.
target This property is required. Property Map
The schedule's target details.
description String
The 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 EndDate you specify.
groupName String
The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
kmsKeyArn String
The ARN for a KMS Key that will be used to encrypt customer data.
name String
The name of the schedule.
scheduleExpressionTimezone String
The timezone in which the scheduling expression is evaluated.
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 StartDate you specify.
state "ENABLED" | "DISABLED"

Specifies whether the schedule is enabled or disabled.

Allowed Values : ENABLED | DISABLED

Outputs

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

Arn string
The Amazon Resource Name (ARN) of the schedule.
Id string
The provider-assigned unique ID for this managed resource.
Arn string
The Amazon Resource Name (ARN) of the schedule.
Id string
The provider-assigned unique ID for this managed resource.
arn String
The Amazon Resource Name (ARN) of the schedule.
id String
The provider-assigned unique ID for this managed resource.
arn string
The Amazon Resource Name (ARN) of the schedule.
id string
The provider-assigned unique ID for this managed resource.
arn str
The Amazon Resource Name (ARN) of the schedule.
id str
The provider-assigned unique ID for this managed resource.
arn String
The Amazon Resource Name (ARN) of the schedule.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

ScheduleAssignPublicIp
, ScheduleAssignPublicIpArgs

Enabled
ENABLED
Disabled
DISABLED
ScheduleAssignPublicIpEnabled
ENABLED
ScheduleAssignPublicIpDisabled
DISABLED
Enabled
ENABLED
Disabled
DISABLED
Enabled
ENABLED
Disabled
DISABLED
ENABLED
ENABLED
DISABLED
DISABLED
"ENABLED"
ENABLED
"DISABLED"
DISABLED

ScheduleAwsVpcConfiguration
, ScheduleAwsVpcConfigurationArgs

Subnets This property is required. List<string>
Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
AssignPublicIp Pulumi.AwsNative.Scheduler.ScheduleAssignPublicIp
Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE .
SecurityGroups List<string>
Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
Subnets This property is required. []string
Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
AssignPublicIp ScheduleAssignPublicIp
Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE .
SecurityGroups []string
Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
subnets This property is required. List<String>
Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
assignPublicIp ScheduleAssignPublicIp
Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE .
securityGroups List<String>
Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
subnets This property is required. string[]
Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
assignPublicIp ScheduleAssignPublicIp
Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE .
securityGroups string[]
Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
subnets This property is required. Sequence[str]
Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
assign_public_ip ScheduleAssignPublicIp
Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE .
security_groups Sequence[str]
Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.
subnets This property is required. List<String>
Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
assignPublicIp "ENABLED" | "DISABLED"
Specifies whether the task's elastic network interface receives a public IP address. You can specify ENABLED only when LaunchType in EcsParameters is set to FARGATE .
securityGroups List<String>
Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.

ScheduleCapacityProviderStrategyItem
, ScheduleCapacityProviderStrategyItemArgs

CapacityProvider This property is required. string
The short name of the capacity provider.
Base double
The base value designates 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. If no value is specified, the default value of 0 is used.
Weight double
The weight value 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.
CapacityProvider This property is required. string
The short name of the capacity provider.
Base float64
The base value designates 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. If no value is specified, the default value of 0 is used.
Weight float64
The weight value 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.
capacityProvider This property is required. String
The short name of the capacity provider.
base Double
The base value designates 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. If no value is specified, the default value of 0 is used.
weight Double
The weight value 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.
capacityProvider This property is required. string
The short name of the capacity provider.
base number
The base value designates 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. If no value is specified, the default value of 0 is used.
weight number
The weight value 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.
capacity_provider This property is required. str
The short name of the capacity provider.
base float
The base value designates 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. If no value is specified, the default value of 0 is used.
weight float
The weight value 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.
capacityProvider This property is required. String
The short name of the capacity provider.
base Number
The base value designates 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. If no value is specified, the default value of 0 is used.
weight Number
The weight value 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.

ScheduleDeadLetterConfig
, ScheduleDeadLetterConfigArgs

Arn string
The ARN of the SQS queue specified as the target for the dead-letter queue.
Arn string
The ARN of the SQS queue specified as the target for the dead-letter queue.
arn String
The ARN of the SQS queue specified as the target for the dead-letter queue.
arn string
The ARN of the SQS queue specified as the target for the dead-letter queue.
arn str
The ARN of the SQS queue specified as the target for the dead-letter queue.
arn String
The ARN of the SQS queue specified as the target for the dead-letter queue.

ScheduleEcsParameters
, ScheduleEcsParametersArgs

TaskDefinitionArn This property is required. string
The ARN of the task definition to use if the event target is an Amazon ECS task.
CapacityProviderStrategy List<Pulumi.AwsNative.Scheduler.Inputs.ScheduleCapacityProviderStrategyItem>
The capacity provider strategy to use for the task.
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 Elastic Container Service Developer Guide.
EnableExecuteCommand bool
Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
Group string
Specifies an ECS task group for the task. The maximum length is 255 characters.
LaunchType Pulumi.AwsNative.Scheduler.ScheduleLaunchType
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. The FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon ECS Developer Guide .
NetworkConfiguration Pulumi.AwsNative.Scheduler.Inputs.ScheduleNetworkConfiguration
This structure specifies the network configuration for an ECS task.
PlacementConstraints List<Pulumi.AwsNative.Scheduler.Inputs.SchedulePlacementConstraint>
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
PlacementStrategy List<Pulumi.AwsNative.Scheduler.Inputs.SchedulePlacementStrategy>
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
PlatformVersion string
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.
PropagateTags Pulumi.AwsNative.Scheduler.SchedulePropagateTags
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the Amazon ECS TagResource API action.
ReferenceId string
The reference ID to use for the task.
Tags List<ImmutableDictionary<string, string>>
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.
TaskCount double
The number of tasks to create based on TaskDefinition. The default is 1.
TaskDefinitionArn This property is required. string
The ARN of the task definition to use if the event target is an Amazon ECS task.
CapacityProviderStrategy []ScheduleCapacityProviderStrategyItem
The capacity provider strategy to use for the task.
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 Elastic Container Service Developer Guide.
EnableExecuteCommand bool
Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
Group string
Specifies an ECS task group for the task. The maximum length is 255 characters.
LaunchType ScheduleLaunchType
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. The FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon ECS Developer Guide .
NetworkConfiguration ScheduleNetworkConfiguration
This structure specifies the network configuration for an ECS task.
PlacementConstraints []SchedulePlacementConstraint
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
PlacementStrategy []SchedulePlacementStrategy
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
PlatformVersion string
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.
PropagateTags SchedulePropagateTags
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the Amazon ECS TagResource API action.
ReferenceId string
The reference ID to use for the task.
Tags []map[string]string
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.
TaskCount float64
The number of tasks to create based on TaskDefinition. The default is 1.
taskDefinitionArn This property is required. String
The ARN of the task definition to use if the event target is an Amazon ECS task.
capacityProviderStrategy List<ScheduleCapacityProviderStrategyItem>
The capacity provider strategy to use for the task.
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 Elastic Container Service Developer Guide.
enableExecuteCommand Boolean
Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
group String
Specifies an ECS task group for the task. The maximum length is 255 characters.
launchType ScheduleLaunchType
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. The FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon ECS Developer Guide .
networkConfiguration ScheduleNetworkConfiguration
This structure specifies the network configuration for an ECS task.
placementConstraints List<SchedulePlacementConstraint>
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
placementStrategy List<SchedulePlacementStrategy>
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
platformVersion String
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.
propagateTags SchedulePropagateTags
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the Amazon ECS TagResource API action.
referenceId String
The reference ID to use for the task.
tags List<Map<String,String>>
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.
taskCount Double
The number of tasks to create based on TaskDefinition. The default is 1.
taskDefinitionArn This property is required. string
The ARN of the task definition to use if the event target is an Amazon ECS task.
capacityProviderStrategy ScheduleCapacityProviderStrategyItem[]
The capacity provider strategy to use for the task.
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 Elastic Container Service Developer Guide.
enableExecuteCommand boolean
Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
group string
Specifies an ECS task group for the task. The maximum length is 255 characters.
launchType ScheduleLaunchType
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. The FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon ECS Developer Guide .
networkConfiguration ScheduleNetworkConfiguration
This structure specifies the network configuration for an ECS task.
placementConstraints SchedulePlacementConstraint[]
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
placementStrategy SchedulePlacementStrategy[]
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
platformVersion string
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.
propagateTags SchedulePropagateTags
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the Amazon ECS TagResource API action.
referenceId string
The reference ID to use for the task.
tags {[key: string]: string}[]
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.
taskCount number
The number of tasks to create based on TaskDefinition. The default is 1.
task_definition_arn This property is required. str
The ARN of the task definition to use if the event target is an Amazon ECS task.
capacity_provider_strategy Sequence[ScheduleCapacityProviderStrategyItem]
The capacity provider strategy to use for the task.
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 Elastic Container Service Developer Guide.
enable_execute_command bool
Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
group str
Specifies an ECS task group for the task. The maximum length is 255 characters.
launch_type ScheduleLaunchType
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. The FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon ECS Developer Guide .
network_configuration ScheduleNetworkConfiguration
This structure specifies the network configuration for an ECS task.
placement_constraints Sequence[SchedulePlacementConstraint]
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
placement_strategy Sequence[SchedulePlacementStrategy]
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
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 SchedulePropagateTags
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the Amazon ECS TagResource API action.
reference_id str
The reference ID to use for the task.
tags Sequence[Mapping[str, str]]
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.
task_count float
The number of tasks to create based on TaskDefinition. The default is 1.
taskDefinitionArn This property is required. String
The ARN of the task definition to use if the event target is an Amazon ECS task.
capacityProviderStrategy List<Property Map>
The capacity provider strategy to use for the task.
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 Elastic Container Service Developer Guide.
enableExecuteCommand Boolean
Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
group String
Specifies an ECS task group for the task. The maximum length is 255 characters.
launchType "EC2" | "FARGATE" | "EXTERNAL"
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. The FARGATE value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon ECS Developer Guide .
networkConfiguration Property Map
This structure specifies the network configuration for an ECS task.
placementConstraints List<Property Map>
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
placementStrategy List<Property Map>
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
platformVersion String
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.
propagateTags "TASK_DEFINITION"
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the Amazon ECS TagResource API action.
referenceId String
The reference ID to use for the task.
tags List<Map<String>>
The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.
taskCount Number
The number of tasks to create based on TaskDefinition. The default is 1.

ScheduleEventBridgeParameters
, ScheduleEventBridgeParametersArgs

DetailType This property is required. string
Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
Source This property is required. string
The source of the event.
DetailType This property is required. string
Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
Source This property is required. string
The source of the event.
detailType This property is required. String
Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
source This property is required. String
The source of the event.
detailType This property is required. string
Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
source This property is required. string
The source of the event.
detail_type This property is required. str
Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
source This property is required. str
The source of the event.
detailType This property is required. String
Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
source This property is required. String
The source of the event.

ScheduleFlexibleTimeWindow
, ScheduleFlexibleTimeWindowArgs

Mode This property is required. Pulumi.AwsNative.Scheduler.ScheduleFlexibleTimeWindowMode

Determines whether the schedule is invoked within a flexible time window. You must use quotation marks when you specify this value in your JSON or YAML template.

Allowed Values : "OFF" | "FLEXIBLE"

MaximumWindowInMinutes double
The maximum time window during which a schedule can be invoked.
Mode This property is required. ScheduleFlexibleTimeWindowMode

Determines whether the schedule is invoked within a flexible time window. You must use quotation marks when you specify this value in your JSON or YAML template.

Allowed Values : "OFF" | "FLEXIBLE"

MaximumWindowInMinutes float64
The maximum time window during which a schedule can be invoked.
mode This property is required. ScheduleFlexibleTimeWindowMode

Determines whether the schedule is invoked within a flexible time window. You must use quotation marks when you specify this value in your JSON or YAML template.

Allowed Values : "OFF" | "FLEXIBLE"

maximumWindowInMinutes Double
The maximum time window during which a schedule can be invoked.
mode This property is required. ScheduleFlexibleTimeWindowMode

Determines whether the schedule is invoked within a flexible time window. You must use quotation marks when you specify this value in your JSON or YAML template.

Allowed Values : "OFF" | "FLEXIBLE"

maximumWindowInMinutes number
The maximum time window during which a schedule can be invoked.
mode This property is required. ScheduleFlexibleTimeWindowMode

Determines whether the schedule is invoked within a flexible time window. You must use quotation marks when you specify this value in your JSON or YAML template.

Allowed Values : "OFF" | "FLEXIBLE"

maximum_window_in_minutes float
The maximum time window during which a schedule can be invoked.
mode This property is required. "OFF" | "FLEXIBLE"

Determines whether the schedule is invoked within a flexible time window. You must use quotation marks when you specify this value in your JSON or YAML template.

Allowed Values : "OFF" | "FLEXIBLE"

maximumWindowInMinutes Number
The maximum time window during which a schedule can be invoked.

ScheduleFlexibleTimeWindowMode
, ScheduleFlexibleTimeWindowModeArgs

Off
OFF
Flexible
FLEXIBLE
ScheduleFlexibleTimeWindowModeOff
OFF
ScheduleFlexibleTimeWindowModeFlexible
FLEXIBLE
Off
OFF
Flexible
FLEXIBLE
Off
OFF
Flexible
FLEXIBLE
OFF
OFF
FLEXIBLE
FLEXIBLE
"OFF"
OFF
"FLEXIBLE"
FLEXIBLE

ScheduleKinesisParameters
, ScheduleKinesisParametersArgs

PartitionKey This property is required. string
The custom parameter used as the Kinesis partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.
PartitionKey This property is required. string
The custom parameter used as the Kinesis partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.
partitionKey This property is required. String
The custom parameter used as the Kinesis partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.
partitionKey This property is required. string
The custom parameter used as the Kinesis partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.
partition_key This property is required. str
The custom parameter used as the Kinesis partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.
partitionKey This property is required. String
The custom parameter used as the Kinesis partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.

ScheduleLaunchType
, ScheduleLaunchTypeArgs

Ec2
EC2
Fargate
FARGATE
External
EXTERNAL
ScheduleLaunchTypeEc2
EC2
ScheduleLaunchTypeFargate
FARGATE
ScheduleLaunchTypeExternal
EXTERNAL
Ec2
EC2
Fargate
FARGATE
External
EXTERNAL
Ec2
EC2
Fargate
FARGATE
External
EXTERNAL
EC2
EC2
FARGATE
FARGATE
EXTERNAL
EXTERNAL
"EC2"
EC2
"FARGATE"
FARGATE
"EXTERNAL"
EXTERNAL

ScheduleNetworkConfiguration
, ScheduleNetworkConfigurationArgs

AwsvpcConfiguration Pulumi.AwsNative.Scheduler.Inputs.ScheduleAwsVpcConfiguration
Specifies the Amazon VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.
AwsvpcConfiguration ScheduleAwsVpcConfiguration
Specifies the Amazon VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.
awsvpcConfiguration ScheduleAwsVpcConfiguration
Specifies the Amazon VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.
awsvpcConfiguration ScheduleAwsVpcConfiguration
Specifies the Amazon VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.
awsvpc_configuration ScheduleAwsVpcConfiguration
Specifies the Amazon VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.
awsvpcConfiguration Property Map
Specifies the Amazon VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.

SchedulePlacementConstraint
, SchedulePlacementConstraintArgs

Expression string
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
Type Pulumi.AwsNative.Scheduler.SchedulePlacementConstraintType
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.
Expression string
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
Type SchedulePlacementConstraintType
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.
expression String
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
type SchedulePlacementConstraintType
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.
expression string
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
type SchedulePlacementConstraintType
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.
expression str
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
type SchedulePlacementConstraintType
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.
expression String
A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
type "distinctInstance" | "memberOf"
The type of constraint. Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.

SchedulePlacementConstraintType
, SchedulePlacementConstraintTypeArgs

DistinctInstance
distinctInstance
MemberOf
memberOf
SchedulePlacementConstraintTypeDistinctInstance
distinctInstance
SchedulePlacementConstraintTypeMemberOf
memberOf
DistinctInstance
distinctInstance
MemberOf
memberOf
DistinctInstance
distinctInstance
MemberOf
memberOf
DISTINCT_INSTANCE
distinctInstance
MEMBER_OF
memberOf
"distinctInstance"
distinctInstance
"memberOf"
memberOf

SchedulePlacementStrategy
, SchedulePlacementStrategyArgs

Field string
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
Type Pulumi.AwsNative.Scheduler.SchedulePlacementStrategyType
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
Field string
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
Type SchedulePlacementStrategyType
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
field String
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
type SchedulePlacementStrategyType
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
field string
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
type SchedulePlacementStrategyType
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
field str
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
type SchedulePlacementStrategyType
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).
field String
The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
type "random" | "spread" | "binpack"
The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).

SchedulePlacementStrategyType
, SchedulePlacementStrategyTypeArgs

Random
random
Spread
spread
Binpack
binpack
SchedulePlacementStrategyTypeRandom
random
SchedulePlacementStrategyTypeSpread
spread
SchedulePlacementStrategyTypeBinpack
binpack
Random
random
Spread
spread
Binpack
binpack
Random
random
Spread
spread
Binpack
binpack
RANDOM
random
SPREAD
spread
BINPACK
binpack
"random"
random
"spread"
spread
"binpack"
binpack

SchedulePropagateTags
, SchedulePropagateTagsArgs

TaskDefinition
TASK_DEFINITION
SchedulePropagateTagsTaskDefinition
TASK_DEFINITION
TaskDefinition
TASK_DEFINITION
TaskDefinition
TASK_DEFINITION
TASK_DEFINITION
TASK_DEFINITION
"TASK_DEFINITION"
TASK_DEFINITION

ScheduleRetryPolicy
, ScheduleRetryPolicyArgs

MaximumEventAgeInSeconds double
The maximum amount of time, in seconds, to continue to make retry attempts.
MaximumRetryAttempts double
The maximum number of retry attempts to make before the request fails. Retry attempts with exponential backoff continue until either the maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is reached.
MaximumEventAgeInSeconds float64
The maximum amount of time, in seconds, to continue to make retry attempts.
MaximumRetryAttempts float64
The maximum number of retry attempts to make before the request fails. Retry attempts with exponential backoff continue until either the maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is reached.
maximumEventAgeInSeconds Double
The maximum amount of time, in seconds, to continue to make retry attempts.
maximumRetryAttempts Double
The maximum number of retry attempts to make before the request fails. Retry attempts with exponential backoff continue until either the maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is reached.
maximumEventAgeInSeconds number
The maximum amount of time, in seconds, to continue to make retry attempts.
maximumRetryAttempts number
The maximum number of retry attempts to make before the request fails. Retry attempts with exponential backoff continue until either the maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is reached.
maximum_event_age_in_seconds float
The maximum amount of time, in seconds, to continue to make retry attempts.
maximum_retry_attempts float
The maximum number of retry attempts to make before the request fails. Retry attempts with exponential backoff continue until either the maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is reached.
maximumEventAgeInSeconds Number
The maximum amount of time, in seconds, to continue to make retry attempts.
maximumRetryAttempts Number
The maximum number of retry attempts to make before the request fails. Retry attempts with exponential backoff continue until either the maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is reached.

ScheduleSageMakerPipelineParameter
, ScheduleSageMakerPipelineParameterArgs

Name This property is required. string
Name of parameter to start execution of a SageMaker Model Building Pipeline.
Value This property is required. string
Value of parameter to start execution of a SageMaker Model Building Pipeline.
Name This property is required. string
Name of parameter to start execution of a SageMaker Model Building Pipeline.
Value This property is required. string
Value of parameter to start execution of a SageMaker Model Building Pipeline.
name This property is required. String
Name of parameter to start execution of a SageMaker Model Building Pipeline.
value This property is required. String
Value of parameter to start execution of a SageMaker Model Building Pipeline.
name This property is required. string
Name of parameter to start execution of a SageMaker Model Building Pipeline.
value This property is required. string
Value of parameter to start execution of a SageMaker Model Building Pipeline.
name This property is required. str
Name of parameter to start execution of a SageMaker Model Building Pipeline.
value This property is required. str
Value of parameter to start execution of a SageMaker Model Building Pipeline.
name This property is required. String
Name of parameter to start execution of a SageMaker Model Building Pipeline.
value This property is required. String
Value of parameter to start execution of a SageMaker Model Building Pipeline.

ScheduleSageMakerPipelineParameters
, ScheduleSageMakerPipelineParametersArgs

PipelineParameterList List<Pulumi.AwsNative.Scheduler.Inputs.ScheduleSageMakerPipelineParameter>
List of Parameter names and values for SageMaker Model Building Pipeline execution.
PipelineParameterList []ScheduleSageMakerPipelineParameter
List of Parameter names and values for SageMaker Model Building Pipeline execution.
pipelineParameterList List<ScheduleSageMakerPipelineParameter>
List of Parameter names and values for SageMaker Model Building Pipeline execution.
pipelineParameterList ScheduleSageMakerPipelineParameter[]
List of Parameter names and values for SageMaker Model Building Pipeline execution.
pipeline_parameter_list Sequence[ScheduleSageMakerPipelineParameter]
List of Parameter names and values for SageMaker Model Building Pipeline execution.
pipelineParameterList List<Property Map>
List of Parameter names and values for SageMaker Model Building Pipeline execution.

ScheduleSqsParameters
, ScheduleSqsParametersArgs

MessageGroupId string
The FIFO message group ID to use as the target.
MessageGroupId string
The FIFO message group ID to use as the target.
messageGroupId String
The FIFO message group ID to use as the target.
messageGroupId string
The FIFO message group ID to use as the target.
message_group_id str
The FIFO message group ID to use as the target.
messageGroupId String
The FIFO message group ID to use as the target.

ScheduleState
, ScheduleStateArgs

Enabled
ENABLED
Disabled
DISABLED
ScheduleStateEnabled
ENABLED
ScheduleStateDisabled
DISABLED
Enabled
ENABLED
Disabled
DISABLED
Enabled
ENABLED
Disabled
DISABLED
ENABLED
ENABLED
DISABLED
DISABLED
"ENABLED"
ENABLED
"DISABLED"
DISABLED

ScheduleTarget
, ScheduleTargetArgs

Arn This property is required. string
The Amazon Resource Name (ARN) of the target.
RoleArn This property is required. string
The Amazon Resource Name (ARN) of the IAM role to be used for this target when the schedule is triggered.
DeadLetterConfig Pulumi.AwsNative.Scheduler.Inputs.ScheduleDeadLetterConfig
An object that contains 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.
EcsParameters Pulumi.AwsNative.Scheduler.Inputs.ScheduleEcsParameters
The templated target type for the Amazon ECS RunTask API operation.
EventBridgeParameters Pulumi.AwsNative.Scheduler.Inputs.ScheduleEventBridgeParameters
The templated target type for the EventBridge PutEvents API operation.
Input string
The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, EventBridge Scheduler delivers a default notification to the target.
KinesisParameters Pulumi.AwsNative.Scheduler.Inputs.ScheduleKinesisParameters
The templated target type for the Amazon Kinesis PutRecord API operation.
RetryPolicy Pulumi.AwsNative.Scheduler.Inputs.ScheduleRetryPolicy
A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.
SageMakerPipelineParameters Pulumi.AwsNative.Scheduler.Inputs.ScheduleSageMakerPipelineParameters
The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
SqsParameters Pulumi.AwsNative.Scheduler.Inputs.ScheduleSqsParameters
The templated target type for the Amazon SQS SendMessage API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see Using the Amazon SQS message deduplication ID in the Amazon SQS Developer Guide .
Arn This property is required. string
The Amazon Resource Name (ARN) of the target.
RoleArn This property is required. string
The Amazon Resource Name (ARN) of the IAM role to be used for this target when the schedule is triggered.
DeadLetterConfig ScheduleDeadLetterConfig
An object that contains 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.
EcsParameters ScheduleEcsParameters
The templated target type for the Amazon ECS RunTask API operation.
EventBridgeParameters ScheduleEventBridgeParameters
The templated target type for the EventBridge PutEvents API operation.
Input string
The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, EventBridge Scheduler delivers a default notification to the target.
KinesisParameters ScheduleKinesisParameters
The templated target type for the Amazon Kinesis PutRecord API operation.
RetryPolicy ScheduleRetryPolicy
A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.
SageMakerPipelineParameters ScheduleSageMakerPipelineParameters
The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
SqsParameters ScheduleSqsParameters
The templated target type for the Amazon SQS SendMessage API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see Using the Amazon SQS message deduplication ID in the Amazon SQS Developer Guide .
arn This property is required. String
The Amazon Resource Name (ARN) of the target.
roleArn This property is required. String
The Amazon Resource Name (ARN) of the IAM role to be used for this target when the schedule is triggered.
deadLetterConfig ScheduleDeadLetterConfig
An object that contains 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.
ecsParameters ScheduleEcsParameters
The templated target type for the Amazon ECS RunTask API operation.
eventBridgeParameters ScheduleEventBridgeParameters
The templated target type for the EventBridge PutEvents API operation.
input String
The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, EventBridge Scheduler delivers a default notification to the target.
kinesisParameters ScheduleKinesisParameters
The templated target type for the Amazon Kinesis PutRecord API operation.
retryPolicy ScheduleRetryPolicy
A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.
sageMakerPipelineParameters ScheduleSageMakerPipelineParameters
The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
sqsParameters ScheduleSqsParameters
The templated target type for the Amazon SQS SendMessage API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see Using the Amazon SQS message deduplication ID in the Amazon SQS Developer Guide .
arn This property is required. string
The Amazon Resource Name (ARN) of the target.
roleArn This property is required. string
The Amazon Resource Name (ARN) of the IAM role to be used for this target when the schedule is triggered.
deadLetterConfig ScheduleDeadLetterConfig
An object that contains 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.
ecsParameters ScheduleEcsParameters
The templated target type for the Amazon ECS RunTask API operation.
eventBridgeParameters ScheduleEventBridgeParameters
The templated target type for the EventBridge PutEvents API operation.
input string
The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, EventBridge Scheduler delivers a default notification to the target.
kinesisParameters ScheduleKinesisParameters
The templated target type for the Amazon Kinesis PutRecord API operation.
retryPolicy ScheduleRetryPolicy
A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.
sageMakerPipelineParameters ScheduleSageMakerPipelineParameters
The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
sqsParameters ScheduleSqsParameters
The templated target type for the Amazon SQS SendMessage API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see Using the Amazon SQS message deduplication ID in the Amazon SQS Developer Guide .
arn This property is required. str
The Amazon Resource Name (ARN) of the target.
role_arn This property is required. str
The Amazon Resource Name (ARN) of the IAM role to be used for this target when the schedule is triggered.
dead_letter_config ScheduleDeadLetterConfig
An object that contains 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.
ecs_parameters ScheduleEcsParameters
The templated target type for the Amazon ECS RunTask API operation.
event_bridge_parameters ScheduleEventBridgeParameters
The templated target type for the EventBridge PutEvents API operation.
input str
The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, EventBridge Scheduler delivers a default notification to the target.
kinesis_parameters ScheduleKinesisParameters
The templated target type for the Amazon Kinesis PutRecord API operation.
retry_policy ScheduleRetryPolicy
A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.
sage_maker_pipeline_parameters ScheduleSageMakerPipelineParameters
The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
sqs_parameters ScheduleSqsParameters
The templated target type for the Amazon SQS SendMessage API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see Using the Amazon SQS message deduplication ID in the Amazon SQS Developer Guide .
arn This property is required. String
The Amazon Resource Name (ARN) of the target.
roleArn This property is required. String
The Amazon Resource Name (ARN) of the IAM role to be used for this target when the schedule is triggered.
deadLetterConfig Property Map
An object that contains 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.
ecsParameters Property Map
The templated target type for the Amazon ECS RunTask API operation.
eventBridgeParameters Property Map
The templated target type for the EventBridge PutEvents API operation.
input String
The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, EventBridge Scheduler delivers a default notification to the target.
kinesisParameters Property Map
The templated target type for the Amazon Kinesis PutRecord API operation.
retryPolicy Property Map
A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.
sageMakerPipelineParameters Property Map
The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
sqsParameters Property Map
The templated target type for the Amazon SQS SendMessage API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see Using the Amazon SQS message deduplication ID in the Amazon SQS Developer Guide .

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native