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

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.scheduler.getSchedule

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::Scheduler::Schedule Resource Type

    Using getSchedule

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSchedule(args: GetScheduleArgs, opts?: InvokeOptions): Promise<GetScheduleResult>
function getScheduleOutput(args: GetScheduleOutputArgs, opts?: InvokeOptions): Output<GetScheduleResult>
    def get_schedule(name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetScheduleResult
def get_schedule_output(name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetScheduleResult]
    func LookupSchedule(ctx *Context, args *LookupScheduleArgs, opts ...InvokeOption) (*LookupScheduleResult, error)
func LookupScheduleOutput(ctx *Context, args *LookupScheduleOutputArgs, opts ...InvokeOption) LookupScheduleResultOutput

    > Note: This function is named LookupSchedule in the Go SDK.

    public static class GetSchedule 
{
    public static Task<GetScheduleResult> InvokeAsync(GetScheduleArgs args, InvokeOptions? opts = null)
    public static Output<GetScheduleResult> Invoke(GetScheduleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetScheduleResult> getSchedule(GetScheduleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:scheduler:getSchedule
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The name of the schedule.
    Name string
    The name of the schedule.
    name String
    The name of the schedule.
    name string
    The name of the schedule.
    name str
    The name of the schedule.
    name String
    The name of the schedule.

    getSchedule Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the schedule.
    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.
    FlexibleTimeWindow Pulumi.AwsNative.Scheduler.Outputs.ScheduleFlexibleTimeWindow
    Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
    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.
    ScheduleExpression string
    The scheduling expression.
    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

    Target Pulumi.AwsNative.Scheduler.Outputs.ScheduleTarget
    The schedule's target details.
    Arn string
    The Amazon Resource Name (ARN) of the schedule.
    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.
    FlexibleTimeWindow ScheduleFlexibleTimeWindow
    Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
    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.
    ScheduleExpression string
    The scheduling expression.
    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

    Target ScheduleTarget
    The schedule's target details.
    arn String
    The Amazon Resource Name (ARN) of the schedule.
    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.
    flexibleTimeWindow ScheduleFlexibleTimeWindow
    Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
    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.
    scheduleExpression String
    The scheduling expression.
    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

    target ScheduleTarget
    The schedule's target details.
    arn string
    The Amazon Resource Name (ARN) of the schedule.
    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.
    flexibleTimeWindow ScheduleFlexibleTimeWindow
    Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
    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.
    scheduleExpression string
    The scheduling expression.
    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

    target ScheduleTarget
    The schedule's target details.
    arn str
    The Amazon Resource Name (ARN) of the schedule.
    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.
    flexible_time_window ScheduleFlexibleTimeWindow
    Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
    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.
    schedule_expression str
    The scheduling expression.
    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

    target ScheduleTarget
    The schedule's target details.
    arn String
    The Amazon Resource Name (ARN) of the schedule.
    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.
    flexibleTimeWindow Property Map
    Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
    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.
    scheduleExpression String
    The scheduling expression.
    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

    target Property Map
    The schedule's target details.

    Supporting Types

    ScheduleAssignPublicIp

    ScheduleAwsVpcConfiguration

    Subnets 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 []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 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 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 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 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

    CapacityProvider 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 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 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 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 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 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

    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

    TaskDefinitionArn 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 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 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 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 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 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

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

    ScheduleFlexibleTimeWindow

    Mode 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 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 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 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 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 "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

    ScheduleKinesisParameters

    PartitionKey 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 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 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 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 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 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

    ScheduleNetworkConfiguration

    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

    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

    SchedulePlacementStrategy

    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

    SchedulePropagateTags

    ScheduleRetryPolicy

    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

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

    ScheduleSageMakerPipelineParameters

    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

    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

    ScheduleTarget

    Arn string
    The Amazon Resource Name (ARN) of the target.
    RoleArn 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 string
    The Amazon Resource Name (ARN) of the target.
    RoleArn 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 String
    The Amazon Resource Name (ARN) of the target.
    roleArn 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 string
    The Amazon Resource Name (ARN) of the target.
    roleArn 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 str
    The Amazon Resource Name (ARN) of the target.
    role_arn 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 String
    The Amazon Resource Name (ARN) of the target.
    roleArn 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
    aws-native logo

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

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native