String assignPublicIp
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.
List<E> securityGroups
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.
List<E> subnets
Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
Integer base
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.
String capacityProvider
The short name of the capacity provider.
Integer weight
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.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.
String name
The name of the schedule group that you are creating.
List<E> tags
The list of tags to associate with the schedule group.
String scheduleGroupArn
The Amazon Resource Name (ARN) of the schedule group.
String actionAfterCompletion
Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.
String description
The description you specify for the schedule.
Date endDate
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. EventBridge Scheduler
ignores EndDate for one-time schedules.
FlexibleTimeWindow flexibleTimeWindow
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
String groupName
The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
String kmsKeyArn
The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
String name
The name of the schedule that you are creating.
String scheduleExpression
The expression that defines when the schedule runs. The following formats are supported.
at expression - at(yyyy-mm-ddThh:mm:ss)
rate expression - rate(value unit)
cron expression - cron(fields)
You can use at expressions to create one-time schedules that invoke a target once, at the time and
in the time zone, that you specify. You can use rate and cron expressions to create
recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such
as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target
periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.
A cron expression consists of six fields separated by white spaces:
(minutes hours day_of_month month day_of_week year).
A rate expression consists of a value as a positive integer, and a unit with the
following options: minute | minutes | hour | hours |
day | days
For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.
String scheduleExpressionTimezone
The timezone in which the scheduling expression is evaluated.
Date startDate
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. EventBridge Scheduler
ignores StartDate for one-time schedules.
String state
Specifies whether the schedule is enabled or disabled.
Target target
The schedule's target.
String scheduleArn
The Amazon Resource Name (ARN) of the schedule.
String arn
The Amazon Resource Name (ARN) of the SQS queue specified as the destination for the dead-letter queue.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.
String name
The name of the schedule group to delete.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.
String groupName
The name of the schedule group associated with this schedule. If you omit this, the default schedule group is used.
String name
The name of the schedule to delete.
List<E> capacityProviderStrategy
The capacity provider strategy to use for the task.
Boolean enableECSManagedTags
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.
Boolean enableExecuteCommand
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.
String group
Specifies an ECS task group for the task. The maximum length is 255 characters.
String launchType
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 networkConfiguration
This structure specifies the network configuration for an ECS task.
List<E> placementConstraints
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).
List<E> placementStrategy
The task placement strategy for a task or service.
String platformVersion
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as
1.1.0.
String propagateTags
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 Amazon ECS's TagResource
API action.
String referenceId
The reference ID to use for the task.
List<E> tags
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. For more information, see RunTask in
the Amazon ECS API Reference.
Integer taskCount
The number of tasks to create based on TaskDefinition. The default is 1.
String taskDefinitionArn
The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.
String name
The name of the schedule group to retrieve.
String arn
The Amazon Resource Name (ARN) of the schedule group.
Date creationDate
The time at which the schedule group was created.
Date lastModificationDate
The time at which the schedule group was last modified.
String name
The name of the schedule group.
String state
Specifies the state of the schedule group.
String actionAfterCompletion
Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
String arn
The Amazon Resource Name (ARN) of the schedule.
Date creationDate
The time at which the schedule was created.
String description
The description of the schedule.
Date endDate
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. EventBridge Scheduler
ignores EndDate for one-time schedules.
FlexibleTimeWindow flexibleTimeWindow
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
String groupName
The name of the schedule group associated with this schedule.
String kmsKeyArn
The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.
Date lastModificationDate
The time at which the schedule was last modified.
String name
The name of the schedule.
String scheduleExpression
The expression that defines when the schedule runs. The following formats are supported.
at expression - at(yyyy-mm-ddThh:mm:ss)
rate expression - rate(value unit)
cron expression - cron(fields)
You can use at expressions to create one-time schedules that invoke a target once, at the time and
in the time zone, that you specify. You can use rate and cron expressions to create
recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such
as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target
periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.
A cron expression consists of six fields separated by white spaces:
(minutes hours day_of_month month day_of_week year).
A rate expression consists of a value as a positive integer, and a unit with the
following options: minute | minutes | hour | hours |
day | days
For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.
String scheduleExpressionTimezone
The timezone in which the scheduling expression is evaluated.
Date startDate
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. EventBridge Scheduler
ignores StartDate for one-time schedules.
String state
Specifies whether the schedule is enabled or disabled.
Target target
The schedule target.
String partitionKey
Specifies the shard to which EventBridge Scheduler sends the event. For more information, see Amazon Kinesis Data Streams terminology and concepts in the Amazon Kinesis Streams Developer Guide.
Integer maxResults
If specified, limits the number of results returned by this operation. The operation also returns a
NextToken which you can use in a subsequent operation to retrieve the next set of results.
String namePrefix
The name prefix that you can use to return a filtered list of your schedule groups.
String nextToken
The token returned by a previous call to retrieve the next set of results.
String groupName
If specified, only lists the schedules whose associated schedule group matches the given filter.
Integer maxResults
If specified, limits the number of results returned by this operation. The operation also returns a
NextToken which you can use in a subsequent operation to retrieve the next set of results.
String namePrefix
Schedule name prefix to return the filtered list of resources.
String nextToken
The token returned by a previous call to retrieve the next set of results.
String state
If specified, only lists the schedules whose current state matches the given filter.
String resourceArn
The ARN of the EventBridge Scheduler resource for which you want to view tags.
AwsVpcConfiguration awsvpcConfiguration
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.
String expression
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.
String type
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.
String field
The field to apply the placement strategy against. For the spread placement strategy, valid values are
instanceId (or instanceId, 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.
String type
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).
Integer maximumEventAgeInSeconds
The maximum amount of time, in seconds, to continue to make retry attempts.
Integer maximumRetryAttempts
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.
String arn
The Amazon Resource Name (ARN) of the schedule group.
Date creationDate
The time at which the schedule group was created.
Date lastModificationDate
The time at which the schedule group was last modified.
String name
The name of the schedule group.
String state
Specifies the state of the schedule group.
String arn
The Amazon Resource Name (ARN) of the schedule.
Date creationDate
The time at which the schedule was created.
String groupName
The name of the schedule group associated with this schedule.
Date lastModificationDate
The time at which the schedule was last modified.
String name
The name of the schedule.
String state
Specifies whether the schedule is enabled or disabled.
TargetSummary target
The schedule's target details.
String messageGroupId
The FIFO message group ID to use as the target.
String arn
The Amazon Resource Name (ARN) of the target.
DeadLetterConfig deadLetterConfig
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 ecsParameters
The templated target type for the Amazon ECS RunTask API
operation.
EventBridgeParameters eventBridgeParameters
The templated target type for the EventBridge PutEvents
API operation.
String input
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 kinesisParameters
The templated target type for the Amazon Kinesis
PutRecord API operation.
RetryPolicy retryPolicy
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.
String roleArn
The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.
SageMakerPipelineParameters sageMakerPipelineParameters
The templated target type for the Amazon SageMaker
StartPipelineExecution API operation.
SqsParameters sqsParameters
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.
String arn
The Amazon Resource Name (ARN) of the target.
String actionAfterCompletion
Specifies the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.
String clientToken
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, EventBridge Scheduler uses a randomly generated token for the request to ensure idempotency.
String description
The description you specify for the schedule.
Date endDate
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. EventBridge Scheduler
ignores EndDate for one-time schedules.
FlexibleTimeWindow flexibleTimeWindow
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
String groupName
The name of the schedule group with which the schedule is associated. You must provide this value in order for EventBridge Scheduler to find the schedule you want to update. If you omit this value, EventBridge Scheduler assumes the group is associated to the default group.
String kmsKeyArn
The ARN for the customer managed KMS key that that you want EventBridge Scheduler to use to encrypt and decrypt your data.
String name
The name of the schedule that you are updating.
String scheduleExpression
The expression that defines when the schedule runs. The following formats are supported.
at expression - at(yyyy-mm-ddThh:mm:ss)
rate expression - rate(value unit)
cron expression - cron(fields)
You can use at expressions to create one-time schedules that invoke a target once, at the time and
in the time zone, that you specify. You can use rate and cron expressions to create
recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such
as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target
periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.
A cron expression consists of six fields separated by white spaces:
(minutes hours day_of_month month day_of_week year).
A rate expression consists of a value as a positive integer, and a unit with the
following options: minute | minutes | hour | hours |
day | days
For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide.
String scheduleExpressionTimezone
The timezone in which the scheduling expression is evaluated.
Date startDate
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. EventBridge Scheduler
ignores StartDate for one-time schedules.
String state
Specifies whether the schedule is enabled or disabled.
Target target
The schedule target. You can use this operation to change the target that your schedule invokes.
String scheduleArn
The Amazon Resource Name (ARN) of the schedule that you updated.
Copyright © 2024. All rights reserved.