latest--aws-scheduler-schedule
shared| Type | object |
|---|---|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-scheduler-schedule.json |
| Parent schema | serverless-framework-configuration |
Definition of AWS::Scheduler::Schedule Resource Type. Source:- No source definition found, add manually please
Properties
Flexible time window allows configuration of a window within which a schedule can be invoked
2 nested properties
Determines whether the schedule is executed within a flexible time window.
The maximum time window during which a schedule can be invoked.
The scheduling expression.
The schedule target.
10 nested properties
The Amazon Resource Name (ARN) of the target.
The Amazon Resource Name (ARN) of the IAM role to be used for this target when the schedule is triggered.
A DeadLetterConfig object that contains information about a dead-letter queue configuration.
1 nested properties
The ARN of the SQS queue specified as the target for the dead-letter queue.
A RetryPolicy object that includes information about the retry policy settings.
2 nested properties
The maximum amount of time, in seconds, to continue to make retry attempts.
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.
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.
The custom parameters to be used when the target is an Amazon ECS task.
14 nested properties
The ARN of the task definition to use if the event target is an Amazon ECS task.
The number of tasks to create based on TaskDefinition. The default is 1.
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 AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
This structure specifies the network configuration for an ECS task.
1 nested properties
This structure specifies the 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.
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.
Specifies an ECS task group for the task. The maximum length is 255 characters.
The capacity provider strategy to use for the task.
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.
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.
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).
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
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 TagResource API action.
The reference ID to use for the task.
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.
EventBridge PutEvent predefined target type.
2 nested properties
Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
The source of the event.
The custom parameter you can use to control the shard to which EventBridge Scheduler sends the event.
1 nested properties
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.
These are custom parameters to use when the target is a SageMaker Model Building Pipeline that starts based on AWS EventBridge Scheduler schedules.
1 nested properties
List of Parameter names and values for SageMaker Model Building Pipeline execution.
Contains the message group ID to use when the target is a FIFO queue. If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.
1 nested properties
The FIFO message group ID to use as the target.
The description of the schedule.
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.
The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
The ARN for a KMS Key that will be used to encrypt customer data.
The timezone in which the scheduling expression is evaluated.
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.
Specifies whether the schedule is enabled or disabled.
Definitions
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.
This structure specifies the 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.
Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
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.
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.
The details of a capacity provider strategy.
The short name of the capacity provider.
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.
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.
A DeadLetterConfig object that contains information about a dead-letter queue configuration.
The ARN of the SQS queue specified as the target for the dead-letter queue.
The custom parameters to be used when the target is an Amazon ECS task.
The ARN of the task definition to use if the event target is an Amazon ECS task.
The number of tasks to create based on TaskDefinition. The default is 1.
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 AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
This structure specifies the network configuration for an ECS task.
1 nested properties
This structure specifies the 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.
3 nested properties
Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
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.
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.
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.
Specifies an ECS task group for the task. The maximum length is 255 characters.
The capacity provider strategy to use for the task.
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.
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.
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).
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
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 TagResource API action.
The reference ID to use for the task.
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.
EventBridge PutEvent predefined target type.
Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
The source of the event.
Flexible time window allows configuration of a window within which a schedule can be invoked
Determines whether the schedule is executed within a flexible time window.
The maximum time window during which a schedule can be invoked.
Determines whether the schedule is executed within a flexible time window.
The custom parameter you can use to control the shard to which EventBridge Scheduler sends the event.
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.
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 AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
This structure specifies the network configuration for an ECS task.
This structure specifies the 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.
3 nested properties
Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
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.
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.
An object representing a constraint on task placement.
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.
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.
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.
The task placement strategy for a task or service.
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).
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.
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).
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 TagResource API action.
A RetryPolicy object that includes information about the retry policy settings.
The maximum amount of time, in seconds, to continue to make retry attempts.
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.
Name/Value pair of a parameter to start execution of a SageMaker Model Building Pipeline.
Name of parameter to start execution of a SageMaker Model Building Pipeline.
Value of parameter to start execution of a SageMaker Model Building Pipeline.
These are custom parameters to use when the target is a SageMaker Model Building Pipeline that starts based on AWS EventBridge Scheduler schedules.
List of Parameter names and values for SageMaker Model Building Pipeline execution.
Specifies whether the schedule is enabled or disabled.
Contains the message group ID to use when the target is a FIFO queue. If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.
The FIFO message group ID to use as the target.
The schedule target.
The Amazon Resource Name (ARN) of the target.
The Amazon Resource Name (ARN) of the IAM role to be used for this target when the schedule is triggered.
A DeadLetterConfig object that contains information about a dead-letter queue configuration.
1 nested properties
The ARN of the SQS queue specified as the target for the dead-letter queue.
A RetryPolicy object that includes information about the retry policy settings.
2 nested properties
The maximum amount of time, in seconds, to continue to make retry attempts.
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.
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.
The custom parameters to be used when the target is an Amazon ECS task.
14 nested properties
The ARN of the task definition to use if the event target is an Amazon ECS task.
The number of tasks to create based on TaskDefinition. The default is 1.
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 AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.
This structure specifies the network configuration for an ECS task.
1 nested properties
This structure specifies the 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.
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.
Specifies an ECS task group for the task. The maximum length is 255 characters.
The capacity provider strategy to use for the task.
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.
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.
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).
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
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 TagResource API action.
The reference ID to use for the task.
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.
EventBridge PutEvent predefined target type.
2 nested properties
Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
The source of the event.
The custom parameter you can use to control the shard to which EventBridge Scheduler sends the event.
1 nested properties
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.
These are custom parameters to use when the target is a SageMaker Model Building Pipeline that starts based on AWS EventBridge Scheduler schedules.
1 nested properties
List of Parameter names and values for SageMaker Model Building Pipeline execution.
Contains the message group ID to use when the target is a FIFO queue. If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.
1 nested properties
The FIFO message group ID to use as the target.