AWS Native v0.103.0, Apr 22 24

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.scheduler.Schedule

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

pulumi/pulumi-aws-native

Create Schedule Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Schedule(name: string, args: ScheduleArgs, opts?: CustomResourceOptions);

@overload
def Schedule(resource_name: str,
             args: ScheduleArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Schedule(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             flexible_time_window: Optional[ScheduleFlexibleTimeWindowArgs] = None,
             schedule_expression: Optional[str] = None,
             target: Optional[ScheduleTargetArgs] = None,
             description: Optional[str] = None,
             end_date: Optional[str] = None,
             group_name: Optional[str] = None,
             kms_key_arn: Optional[str] = None,
             name: Optional[str] = None,
             schedule_expression_timezone: Optional[str] = None,
             start_date: Optional[str] = None,
             state: Optional[ScheduleState] = None)

func NewSchedule(ctx *Context, name string, args ScheduleArgs, opts ...ResourceOption) (*Schedule, error)

public Schedule(string name, ScheduleArgs args, CustomResourceOptions? opts = null)

public Schedule(String name, ScheduleArgs args)
public Schedule(String name, ScheduleArgs args, CustomResourceOptions options)

type: aws-native:scheduler:Schedule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args ScheduleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ScheduleArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ScheduleArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ScheduleArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ScheduleArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Example

The following reference example uses placeholder values for all input properties.

Coming soon!

Coming soon!

Coming soon!

Coming soon!

const aws_nativeScheduleResource = new aws_native.scheduler.Schedule("aws-nativeScheduleResource", {
    flexibleTimeWindow: {
        mode: aws_native.scheduler.ScheduleFlexibleTimeWindowMode.Off,
        maximumWindowInMinutes: 0,
    },
    scheduleExpression: "string",
    target: {
        arn: "string",
        roleArn: "string",
        deadLetterConfig: {
            arn: "string",
        },
        ecsParameters: {
            taskDefinitionArn: "string",
            placementConstraints: [{
                expression: "string",
                type: aws_native.scheduler.SchedulePlacementConstraintType.DistinctInstance,
            }],
            enableExecuteCommand: false,
            group: "string",
            launchType: aws_native.scheduler.ScheduleLaunchType.Ec2,
            networkConfiguration: {
                awsvpcConfiguration: {
                    subnets: ["string"],
                    assignPublicIp: aws_native.scheduler.ScheduleAssignPublicIp.Enabled,
                    securityGroups: ["string"],
                },
            },
            capacityProviderStrategy: [{
                capacityProvider: "string",
                base: 0,
                weight: 0,
            }],
            placementStrategy: [{
                field: "string",
                type: aws_native.scheduler.SchedulePlacementStrategyType.Random,
            }],
            platformVersion: "string",
            propagateTags: aws_native.scheduler.SchedulePropagateTags.TaskDefinition,
            referenceId: "string",
            tags: [{
                string: "string",
            }],
            taskCount: 0,
            enableEcsManagedTags: false,
        },
        eventBridgeParameters: {
            detailType: "string",
            source: "string",
        },
        input: "string",
        kinesisParameters: {
            partitionKey: "string",
        },
        retryPolicy: {
            maximumEventAgeInSeconds: 0,
            maximumRetryAttempts: 0,
        },
        sageMakerPipelineParameters: {
            pipelineParameterList: [{
                name: "string",
                value: "string",
            }],
        },
        sqsParameters: {
            messageGroupId: "string",
        },
    },
    description: "string",
    endDate: "string",
    groupName: "string",
    kmsKeyArn: "string",
    name: "string",
    scheduleExpressionTimezone: "string",
    startDate: "string",
    state: aws_native.scheduler.ScheduleState.Enabled,
});

Coming soon!

Schedule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Schedule resource accepts the following input properties:

FlexibleTimeWindow Pulumi.AwsNative.Scheduler.Inputs.ScheduleFlexibleTimeWindow
ScheduleExpression string: The scheduling expression.
Target Pulumi.AwsNative.Scheduler.Inputs.ScheduleTarget
Description string: The description of the schedule.
EndDate string: The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify.
GroupName string: The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
KmsKeyArn string: The ARN for a KMS Key that will be used to encrypt customer data.
Name string
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

FlexibleTimeWindow ScheduleFlexibleTimeWindowArgs
ScheduleExpression string: The scheduling expression.
Target ScheduleTargetArgs
Description string: The description of the schedule.
EndDate string: The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify.
GroupName string: The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
KmsKeyArn string: The ARN for a KMS Key that will be used to encrypt customer data.
Name string
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

flexibleTimeWindow ScheduleFlexibleTimeWindow
scheduleExpression String: The scheduling expression.
target ScheduleTarget
description String: The description of the schedule.
endDate String: The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify.
groupName String: The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
kmsKeyArn String: The ARN for a KMS Key that will be used to encrypt customer data.
name String
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

flexibleTimeWindow ScheduleFlexibleTimeWindow
scheduleExpression string: The scheduling expression.
target ScheduleTarget
description string: The description of the schedule.
endDate string: The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify.
groupName string: The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
kmsKeyArn string: The ARN for a KMS Key that will be used to encrypt customer data.
name string
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

flexible_time_window ScheduleFlexibleTimeWindowArgs
schedule_expression str: The scheduling expression.
target ScheduleTargetArgs
description str: The description of the schedule.
end_date str: The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify.
group_name str: The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
kms_key_arn str: The ARN for a KMS Key that will be used to encrypt customer data.
name str
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

flexibleTimeWindow Property Map
scheduleExpression String: The scheduling expression.
target Property Map
description String: The description of the schedule.
endDate String: The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify.
groupName String: The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
kmsKeyArn String: The ARN for a KMS Key that will be used to encrypt customer data.
name String
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"

Outputs

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

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

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

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

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

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

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

Supporting Types

ScheduleAssignPublicIp, ScheduleAssignPublicIpArgs

Enabled: ENABLED
Disabled: DISABLED

ScheduleAssignPublicIpEnabled: ENABLED
ScheduleAssignPublicIpDisabled: DISABLED

Enabled: ENABLED
Disabled: DISABLED

Enabled: ENABLED
Disabled: DISABLED

ENABLED: ENABLED
DISABLED: DISABLED

"ENABLED": ENABLED
"DISABLED": DISABLED

ScheduleAwsVpcConfiguration, ScheduleAwsVpcConfigurationArgs

Subnets 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
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
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
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
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
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"
securityGroups List<String>: Specifies the security groups associated with the task. These security groups must all be in the same VPC. You can specify as many as five security groups. If you do not specify a security group, the default security group for the VPC is used.

ScheduleCapacityProviderStrategyItem, ScheduleCapacityProviderStrategyItemArgs

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

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

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

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

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

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

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

ScheduleEcsParameters, ScheduleEcsParametersArgs

TaskDefinitionArn 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
NetworkConfiguration Pulumi.AwsNative.Scheduler.Inputs.ScheduleNetworkConfiguration
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
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
NetworkConfiguration ScheduleNetworkConfiguration
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
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
networkConfiguration ScheduleNetworkConfiguration
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
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
networkConfiguration ScheduleNetworkConfiguration
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
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
network_configuration ScheduleNetworkConfiguration
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
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"
networkConfiguration Property Map
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"
referenceId String: The reference ID to use for the task.
tags List<Map<String>>: The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. To learn more, see RunTask in the Amazon ECS API Reference.
taskCount Number: The number of tasks to create based on TaskDefinition. The default is 1.

ScheduleEventBridgeParameters, ScheduleEventBridgeParametersArgs

DetailType 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, ScheduleFlexibleTimeWindowArgs

Mode Pulumi.AwsNative.Scheduler.ScheduleFlexibleTimeWindowMode
MaximumWindowInMinutes double: The maximum time window during which a schedule can be invoked.

Mode ScheduleFlexibleTimeWindowMode
MaximumWindowInMinutes float64: The maximum time window during which a schedule can be invoked.

mode ScheduleFlexibleTimeWindowMode
maximumWindowInMinutes Double: The maximum time window during which a schedule can be invoked.

mode ScheduleFlexibleTimeWindowMode
maximumWindowInMinutes number: The maximum time window during which a schedule can be invoked.

mode ScheduleFlexibleTimeWindowMode
maximum_window_in_minutes float: The maximum time window during which a schedule can be invoked.

mode "OFF" | "FLEXIBLE"
maximumWindowInMinutes Number: The maximum time window during which a schedule can be invoked.

ScheduleFlexibleTimeWindowMode, ScheduleFlexibleTimeWindowModeArgs

Off: OFF
Flexible: FLEXIBLE

ScheduleFlexibleTimeWindowModeOff: OFF
ScheduleFlexibleTimeWindowModeFlexible: FLEXIBLE

Off: OFF
Flexible: FLEXIBLE

Off: OFF
Flexible: FLEXIBLE

OFF: OFF
FLEXIBLE: FLEXIBLE

"OFF": OFF
"FLEXIBLE": FLEXIBLE

ScheduleKinesisParameters, ScheduleKinesisParametersArgs

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

Ec2: EC2
Fargate: FARGATE
External: EXTERNAL

ScheduleLaunchTypeEc2: EC2
ScheduleLaunchTypeFargate: FARGATE
ScheduleLaunchTypeExternal: EXTERNAL

Ec2: EC2
Fargate: FARGATE
External: EXTERNAL

Ec2: EC2
Fargate: FARGATE
External: EXTERNAL

EC2: EC2
FARGATE: FARGATE
EXTERNAL: EXTERNAL

"EC2": EC2
"FARGATE": FARGATE
"EXTERNAL": EXTERNAL

ScheduleNetworkConfiguration, ScheduleNetworkConfigurationArgs

AwsvpcConfiguration Pulumi.AwsNative.Scheduler.Inputs.ScheduleAwsVpcConfiguration

AwsvpcConfiguration ScheduleAwsVpcConfiguration

awsvpcConfiguration ScheduleAwsVpcConfiguration

awsvpcConfiguration ScheduleAwsVpcConfiguration

awsvpc_configuration ScheduleAwsVpcConfiguration

awsvpcConfiguration Property Map

SchedulePlacementConstraint, SchedulePlacementConstraintArgs

Expression string: A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance. To learn more, see Cluster Query Language in the Amazon Elastic Container Service Developer Guide.
Type Pulumi.AwsNative.Scheduler.SchedulePlacementConstraintType

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

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

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

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

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"

SchedulePlacementConstraintType, SchedulePlacementConstraintTypeArgs

DistinctInstance: distinctInstance
MemberOf: memberOf

SchedulePlacementConstraintTypeDistinctInstance: distinctInstance
SchedulePlacementConstraintTypeMemberOf: memberOf

DistinctInstance: distinctInstance
MemberOf: memberOf

DistinctInstance: distinctInstance
MemberOf: memberOf

DISTINCT_INSTANCE: distinctInstance
MEMBER_OF: memberOf

"distinctInstance": distinctInstance
"memberOf": memberOf

SchedulePlacementStrategy, SchedulePlacementStrategyArgs

Field string: The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this field is not used.
Type Pulumi.AwsNative.Scheduler.SchedulePlacementStrategyType

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

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

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

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

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"

SchedulePlacementStrategyType, SchedulePlacementStrategyTypeArgs

Random: random
Spread: spread
Binpack: binpack

SchedulePlacementStrategyTypeRandom: random
SchedulePlacementStrategyTypeSpread: spread
SchedulePlacementStrategyTypeBinpack: binpack

Random: random
Spread: spread
Binpack: binpack

Random: random
Spread: spread
Binpack: binpack

RANDOM: random
SPREAD: spread
BINPACK: binpack

"random": random
"spread": spread
"binpack": binpack

SchedulePropagateTags, SchedulePropagateTagsArgs

TaskDefinition: TASK_DEFINITION

SchedulePropagateTagsTaskDefinition: TASK_DEFINITION

TaskDefinition: TASK_DEFINITION

TaskDefinition: TASK_DEFINITION

TASK_DEFINITION: TASK_DEFINITION

"TASK_DEFINITION": TASK_DEFINITION

ScheduleRetryPolicy, ScheduleRetryPolicyArgs

MaximumEventAgeInSeconds double: The maximum amount of time, in seconds, to continue to make retry attempts.
MaximumRetryAttempts double: The maximum number of retry attempts to make before the request fails. Retry attempts with exponential backoff continue until either the maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is reached.

MaximumEventAgeInSeconds float64: The maximum amount of time, in seconds, to continue to make retry attempts.
MaximumRetryAttempts float64: The maximum number of retry attempts to make before the request fails. Retry attempts with exponential backoff continue until either the maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is reached.

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

maximumEventAgeInSeconds number: The maximum amount of time, in seconds, to continue to make retry attempts.
maximumRetryAttempts number: The maximum number of retry attempts to make before the request fails. Retry attempts with exponential backoff continue until either the maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is reached.

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

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

ScheduleSageMakerPipelineParameter, ScheduleSageMakerPipelineParameterArgs

Name 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, ScheduleSageMakerPipelineParametersArgs

PipelineParameterList List<Pulumi.AwsNative.Scheduler.Inputs.ScheduleSageMakerPipelineParameter>: List of Parameter names and values for SageMaker Model Building Pipeline execution.

PipelineParameterList []ScheduleSageMakerPipelineParameter: List of Parameter names and values for SageMaker Model Building Pipeline execution.

pipelineParameterList List<ScheduleSageMakerPipelineParameter>: List of Parameter names and values for SageMaker Model Building Pipeline execution.

pipelineParameterList ScheduleSageMakerPipelineParameter[]: List of Parameter names and values for SageMaker Model Building Pipeline execution.

pipeline_parameter_list Sequence[ScheduleSageMakerPipelineParameter]: List of Parameter names and values for SageMaker Model Building Pipeline execution.

pipelineParameterList List<Property Map>: List of Parameter names and values for SageMaker Model Building Pipeline execution.

ScheduleSqsParameters, ScheduleSqsParametersArgs

MessageGroupId string: The FIFO message group ID to use as the target.

MessageGroupId string: The FIFO message group ID to use as the target.

messageGroupId String: The FIFO message group ID to use as the target.

messageGroupId string: The FIFO message group ID to use as the target.

message_group_id str: The FIFO message group ID to use as the target.

messageGroupId String: The FIFO message group ID to use as the target.

ScheduleState, ScheduleStateArgs

Enabled: ENABLED
Disabled: DISABLED

ScheduleStateEnabled: ENABLED
ScheduleStateDisabled: DISABLED

Enabled: ENABLED
Disabled: DISABLED

Enabled: ENABLED
Disabled: DISABLED

ENABLED: ENABLED
DISABLED: DISABLED

"ENABLED": ENABLED
"DISABLED": DISABLED

ScheduleTarget, ScheduleTargetArgs

Arn 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
EcsParameters Pulumi.AwsNative.Scheduler.Inputs.ScheduleEcsParameters
EventBridgeParameters Pulumi.AwsNative.Scheduler.Inputs.ScheduleEventBridgeParameters
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
RetryPolicy Pulumi.AwsNative.Scheduler.Inputs.ScheduleRetryPolicy
SageMakerPipelineParameters Pulumi.AwsNative.Scheduler.Inputs.ScheduleSageMakerPipelineParameters
SqsParameters Pulumi.AwsNative.Scheduler.Inputs.ScheduleSqsParameters

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
EcsParameters ScheduleEcsParameters
EventBridgeParameters ScheduleEventBridgeParameters
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
RetryPolicy ScheduleRetryPolicy
SageMakerPipelineParameters ScheduleSageMakerPipelineParameters
SqsParameters ScheduleSqsParameters

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
ecsParameters ScheduleEcsParameters
eventBridgeParameters ScheduleEventBridgeParameters
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
retryPolicy ScheduleRetryPolicy
sageMakerPipelineParameters ScheduleSageMakerPipelineParameters
sqsParameters ScheduleSqsParameters

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
ecsParameters ScheduleEcsParameters
eventBridgeParameters ScheduleEventBridgeParameters
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
retryPolicy ScheduleRetryPolicy
sageMakerPipelineParameters ScheduleSageMakerPipelineParameters
sqsParameters ScheduleSqsParameters

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
ecs_parameters ScheduleEcsParameters
event_bridge_parameters ScheduleEventBridgeParameters
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
retry_policy ScheduleRetryPolicy
sage_maker_pipeline_parameters ScheduleSageMakerPipelineParameters
sqs_parameters ScheduleSqsParameters

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
ecsParameters Property Map
eventBridgeParameters Property Map
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
retryPolicy Property Map
sageMakerPipelineParameters Property Map
sqsParameters Property Map

Package Details

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

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.scheduler.Schedule

On this page

On this page

Create Schedule Resource

Constructor syntax

Parameters

Example

Schedule Resource Properties

Inputs

Outputs

Supporting Types

ScheduleAssignPublicIp, ScheduleAssignPublicIpArgs

ScheduleAwsVpcConfiguration, ScheduleAwsVpcConfigurationArgs

ScheduleCapacityProviderStrategyItem, ScheduleCapacityProviderStrategyItemArgs

ScheduleDeadLetterConfig, ScheduleDeadLetterConfigArgs

ScheduleEcsParameters, ScheduleEcsParametersArgs

ScheduleEventBridgeParameters, ScheduleEventBridgeParametersArgs

ScheduleFlexibleTimeWindow, ScheduleFlexibleTimeWindowArgs

ScheduleFlexibleTimeWindowMode, ScheduleFlexibleTimeWindowModeArgs

ScheduleKinesisParameters, ScheduleKinesisParametersArgs

ScheduleLaunchType, ScheduleLaunchTypeArgs

ScheduleNetworkConfiguration, ScheduleNetworkConfigurationArgs

SchedulePlacementConstraint, SchedulePlacementConstraintArgs

SchedulePlacementConstraintType, SchedulePlacementConstraintTypeArgs

SchedulePlacementStrategy, SchedulePlacementStrategyArgs

SchedulePlacementStrategyType, SchedulePlacementStrategyTypeArgs

SchedulePropagateTags, SchedulePropagateTagsArgs

ScheduleRetryPolicy, ScheduleRetryPolicyArgs

ScheduleSageMakerPipelineParameter, ScheduleSageMakerPipelineParameterArgs

ScheduleSageMakerPipelineParameters, ScheduleSageMakerPipelineParametersArgs

ScheduleSqsParameters, ScheduleSqsParametersArgs

ScheduleState, ScheduleStateArgs

ScheduleTarget, ScheduleTargetArgs

Package Details

On this page

On this page