Este producto no es compatible con el sitio Datadog seleccionado. ().
Esta página aún no está disponible en español. Estamos trabajando en su traducción.
Si tienes alguna pregunta o comentario sobre nuestro actual proyecto de traducción, no dudes en ponerte en contacto con nosotros.

aws_scheduler_schedule

account_id

Type: STRING

action_after_completion

Type: STRING
Provider name: ActionAfterCompletion
Description: Indicates the action that EventBridge Scheduler applies to the schedule after the schedule completes invoking the target.

arn

Type: STRING
Provider name: Arn
Description: The Amazon Resource Name (ARN) of the schedule.

creation_date

Type: TIMESTAMP
Provider name: CreationDate
Description: The time at which the schedule was created.

description

Type: STRING
Provider name: Description
Description: The description of the schedule.

end_date

Type: TIMESTAMP
Provider name: EndDate
Description: 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.

flexible_time_window

Type: STRUCT
Provider name: FlexibleTimeWindow
Description: Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

  • maximum_window_in_minutes
    Type: INT32
    Provider name: MaximumWindowInMinutes
    Description: The maximum time window during which a schedule can be invoked.
  • mode
    Type: STRING
    Provider name: Mode
    Description: Determines whether the schedule is invoked within a flexible time window.

group_name

Type: STRING
Provider name: GroupName
Description: The name of the schedule group associated with this schedule.

kms_key_arn

Type: STRING
Provider name: KmsKeyArn
Description: The ARN for a customer managed KMS Key that is be used to encrypt and decrypt your data.

last_modification_date

Type: TIMESTAMP
Provider name: LastModificationDate
Description: The time at which the schedule was last modified.

name

Type: STRING
Provider name: Name
Description: The name of the schedule.

schedule_expression

Type: STRING
Provider name: ScheduleExpression
Description: 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.

schedule_expression_timezone

Type: STRING
Provider name: ScheduleExpressionTimezone
Description: The timezone in which the scheduling expression is evaluated.

start_date

Type: TIMESTAMP
Provider name: StartDate
Description: 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.

state

Type: STRING
Provider name: State
Description: Specifies whether the schedule is enabled or disabled.

tags

Type: UNORDERED_LIST_STRING

target

Type: STRUCT
Provider name: Target
Description: The schedule target.

  • arn
    Type: STRING
    Provider name: Arn
    Description: The Amazon Resource Name (ARN) of the target.
  • dead_letter_config
    Type: STRUCT
    Provider name: DeadLetterConfig
    Description: 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.
    • arn
      Type: STRING
      Provider name: Arn
      Description: The Amazon Resource Name (ARN) of the SQS queue specified as the destination for the dead-letter queue.
  • ecs_parameters
    Type: STRUCT
    Provider name: EcsParameters
    Description: The templated target type for the Amazon ECS RunTask API operation.
    • capacity_provider_strategy
      Type: UNORDERED_LIST_STRUCT
      Provider name: CapacityProviderStrategy
      Description: The capacity provider strategy to use for the task.
      • base
        Type: INT32
        Provider name: base
        Description: 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.
      • capacity_provider
        Type: STRING
        Provider name: capacityProvider
        Description: The short name of the capacity provider.
      • weight
        Type: INT32
        Provider name: weight
        Description: 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.
    • enable_ecs_managed_tags
      Type: BOOLEAN
      Provider name: EnableECSManagedTags
      Description: Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon ECS Developer Guide.
    • enable_execute_command
      Type: BOOLEAN
      Provider name: EnableExecuteCommand
      Description: 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
      Type: STRING
      Provider name: Group
      Description: Specifies an ECS task group for the task. The maximum length is 255 characters.
    • launch_type
      Type: STRING
      Provider name: LaunchType
      Description: 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
      Type: STRUCT
      Provider name: NetworkConfiguration
      Description: This structure specifies the network configuration for an ECS task.
      • awsvpc_configuration
        Type: STRUCT
        Provider name: awsvpcConfiguration
        Description: 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.
        • assign_public_ip
          Type: STRING
          Provider name: AssignPublicIp
          Description: 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
          Type: UNORDERED_LIST_STRING
          Provider name: SecurityGroups
          Description: 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
          Type: UNORDERED_LIST_STRING
          Provider name: Subnets
          Description: Specifies the subnets associated with the task. These subnets must all be in the same VPC. You can specify as many as 16 subnets.
    • placement_constraints
      Type: UNORDERED_LIST_STRUCT
      Provider name: PlacementConstraints
      Description: 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).
      • expression
        Type: STRING
        Provider name: expression
        Description: A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. For more information, see Cluster query language in the Amazon ECS Developer Guide.
      • type
        Type: STRING
        Provider name: type
        Description: 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.
    • placement_strategy
      Type: UNORDERED_LIST_STRUCT
      Provider name: PlacementStrategy
      Description: The task placement strategy for a task or service.
      • field
        Type: STRING
        Provider name: field
        Description: 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.
      • type
        Type: STRING
        Provider name: type
        Description: 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).
    • platform_version
      Type: STRING
      Provider name: PlatformVersion
      Description: Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0.
    • propagate_tags
      Type: STRING
      Provider name: PropagateTags
      Description: 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.
    • reference_id
      Type: STRING
      Provider name: ReferenceId
      Description: The reference ID to use for the task.
    • task_count
      Type: INT32
      Provider name: TaskCount
      Description: The number of tasks to create based on TaskDefinition. The default is 1.
    • task_definition_arn
      Type: STRING
      Provider name: TaskDefinitionArn
      Description: The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.
  • event_bridge_parameters
    Type: STRUCT
    Provider name: EventBridgeParameters
    Description: The templated target type for the EventBridge PutEvents API operation.
    • detail_type
      Type: STRING
      Provider name: DetailType
      Description: A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.
    • source
      Type: STRING
      Provider name: Source
      Description: The source of the event.
  • input
    Type: STRING
    Provider name: Input
    Description: 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
    Type: STRUCT
    Provider name: KinesisParameters
    Description: The templated target type for the Amazon Kinesis PutRecord API operation.
  • retry_policy
    Type: STRUCT
    Provider name: RetryPolicy
    Description: 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.
    • maximum_event_age_in_seconds
      Type: INT32
      Provider name: MaximumEventAgeInSeconds
      Description: The maximum amount of time, in seconds, to continue to make retry attempts.
    • maximum_retry_attempts
      Type: INT32
      Provider name: MaximumRetryAttempts
      Description: 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.
  • role_arn
    Type: STRING
    Provider name: RoleArn
    Description: The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.
  • sage_maker_pipeline_parameters
    Type: STRUCT
    Provider name: SageMakerPipelineParameters
    Description: The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
    • pipeline_parameter_list
      Type: UNORDERED_LIST_STRUCT
      Provider name: PipelineParameterList
      Description: List of parameter names and values to use when executing the SageMaker Model Building Pipeline.
      • name
        Type: STRING
        Provider name: Name
        Description: Name of parameter to start execution of a SageMaker Model Building Pipeline.
      • value
        Type: STRING
        Provider name: Value
        Description: Value of parameter to start execution of a SageMaker Model Building Pipeline.
  • sqs_parameters
    Type: STRUCT
    Provider name: SqsParameters
    Description: 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.
    • message_group_id
      Type: STRING
      Provider name: MessageGroupId
      Description: The FIFO message group ID to use as the target.