CfnSchedulePropsMixin

class aws_cdk.mixins_preview.aws_scheduler.mixins.CfnSchedulePropsMixin(props, *, strategy=None)

Bases: Mixin

A schedule is the main resource you create, configure, and manage using Amazon EventBridge Scheduler.

Every schedule has a schedule expression that determines when, and with what frequency, the schedule runs. EventBridge Scheduler supports three types of schedules: rate, cron, and one-time schedules. For more information about different schedule types, see Schedule types in the EventBridge Scheduler User Guide .

When you create a schedule, you configure a target for the schedule to invoke. A target is an API operation that EventBridge Scheduler calls on your behalf every time your schedule runs. EventBridge Scheduler supports two types of targets: templated targets invoke common API operations across a core groups of services, and customizeable universal targets that you can use to call more than 6,000 operations across over 270 services. For more information about configuring targets, see Managing targets in the EventBridge Scheduler User Guide .

For more information about managing schedules, changing the schedule state, setting up flexible time windows, and configuring a dead-letter queue for a schedule, see Managing a schedule in the EventBridge Scheduler User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html

CloudformationResource:

AWS::Scheduler::Schedule

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_scheduler import mixins as scheduler_mixins

# tags: Any

cfn_schedule_props_mixin = scheduler_mixins.CfnSchedulePropsMixin(scheduler_mixins.CfnScheduleMixinProps(
    description="description",
    end_date="endDate",
    flexible_time_window=scheduler_mixins.CfnSchedulePropsMixin.FlexibleTimeWindowProperty(
        maximum_window_in_minutes=123,
        mode="mode"
    ),
    group_name="groupName",
    kms_key_arn="kmsKeyArn",
    name="name",
    schedule_expression="scheduleExpression",
    schedule_expression_timezone="scheduleExpressionTimezone",
    start_date="startDate",
    state="state",
    target=scheduler_mixins.CfnSchedulePropsMixin.TargetProperty(
        arn="arn",
        dead_letter_config=scheduler_mixins.CfnSchedulePropsMixin.DeadLetterConfigProperty(
            arn="arn"
        ),
        ecs_parameters=scheduler_mixins.CfnSchedulePropsMixin.EcsParametersProperty(
            capacity_provider_strategy=[scheduler_mixins.CfnSchedulePropsMixin.CapacityProviderStrategyItemProperty(
                base=123,
                capacity_provider="capacityProvider",
                weight=123
            )],
            enable_ecs_managed_tags=False,
            enable_execute_command=False,
            group="group",
            launch_type="launchType",
            network_configuration=scheduler_mixins.CfnSchedulePropsMixin.NetworkConfigurationProperty(
                awsvpc_configuration=scheduler_mixins.CfnSchedulePropsMixin.AwsVpcConfigurationProperty(
                    assign_public_ip="assignPublicIp",
                    security_groups=["securityGroups"],
                    subnets=["subnets"]
                )
            ),
            placement_constraints=[scheduler_mixins.CfnSchedulePropsMixin.PlacementConstraintProperty(
                expression="expression",
                type="type"
            )],
            placement_strategy=[scheduler_mixins.CfnSchedulePropsMixin.PlacementStrategyProperty(
                field="field",
                type="type"
            )],
            platform_version="platformVersion",
            propagate_tags="propagateTags",
            reference_id="referenceId",
            tags=tags,
            task_count=123,
            task_definition_arn="taskDefinitionArn"
        ),
        event_bridge_parameters=scheduler_mixins.CfnSchedulePropsMixin.EventBridgeParametersProperty(
            detail_type="detailType",
            source="source"
        ),
        input="input",
        kinesis_parameters=scheduler_mixins.CfnSchedulePropsMixin.KinesisParametersProperty(
            partition_key="partitionKey"
        ),
        retry_policy=scheduler_mixins.CfnSchedulePropsMixin.RetryPolicyProperty(
            maximum_event_age_in_seconds=123,
            maximum_retry_attempts=123
        ),
        role_arn="roleArn",
        sage_maker_pipeline_parameters=scheduler_mixins.CfnSchedulePropsMixin.SageMakerPipelineParametersProperty(
            pipeline_parameter_list=[scheduler_mixins.CfnSchedulePropsMixin.SageMakerPipelineParameterProperty(
                name="name",
                value="value"
            )]
        ),
        sqs_parameters=scheduler_mixins.CfnSchedulePropsMixin.SqsParametersProperty(
            message_group_id="messageGroupId"
        )
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Scheduler::Schedule.

Parameters:

  • props (Union[CfnScheduleMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'endDate', 'flexibleTimeWindow', 'groupName', 'kmsKeyArn', 'name', 'scheduleExpression', 'scheduleExpressionTimezone', 'startDate', 'state', 'target']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental

AwsVpcConfigurationProperty

class CfnSchedulePropsMixin.AwsVpcConfigurationProperty(*, assign_public_ip=None, security_groups=None, subnets=None)

Bases: object

This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used.

This structure is relevant only for ECS tasks that use the awsvpc network mode.

Parameters:

  • assign_public_ip (Optional[str]) – 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 (Optional[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 (Optional[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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-awsvpcconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_scheduler import mixins as scheduler_mixins

aws_vpc_configuration_property = scheduler_mixins.CfnSchedulePropsMixin.AwsVpcConfigurationProperty(
    assign_public_ip="assignPublicIp",
    security_groups=["securityGroups"],
    subnets=["subnets"]
)

Attributes

assign_public_ip

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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-awsvpcconfiguration.html#cfn-scheduler-schedule-awsvpcconfiguration-assignpublicip

security_groups

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-awsvpcconfiguration.html#cfn-scheduler-schedule-awsvpcconfiguration-securitygroups

subnets

Specifies the subnets associated with the task.

These subnets must all be in the same VPC. You can specify as many as 16 subnets.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-awsvpcconfiguration.html#cfn-scheduler-schedule-awsvpcconfiguration-subnets

CapacityProviderStrategyItemProperty

class CfnSchedulePropsMixin.CapacityProviderStrategyItemProperty(*, base=None, capacity_provider=None, weight=None)

Bases: object

The details of a capacity provider strategy.

Parameters:

  • base (Union[int, float, None]) – 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. Default: - 0

  • capacity_provider (Optional[str]) – The short name of the capacity provider.

  • weight (Union[int, float, None]) – 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. Default: - 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-capacityproviderstrategyitem.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_scheduler import mixins as scheduler_mixins

capacity_provider_strategy_item_property = scheduler_mixins.CfnSchedulePropsMixin.CapacityProviderStrategyItemProperty(
    base=123,
    capacity_provider="capacityProvider",
    weight=123
)

Attributes

base

The base value designates how many tasks, at a minimum, to run on the specified capacity provider.

Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.

Default:

  • 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-capacityproviderstrategyitem.html#cfn-scheduler-schedule-capacityproviderstrategyitem-base

capacity_provider

The short name of the capacity provider.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-capacityproviderstrategyitem.html#cfn-scheduler-schedule-capacityproviderstrategyitem-capacityprovider

weight

The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.

The weight value is taken into consideration after the base value, if defined, is satisfied.

Default:

  • 0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-capacityproviderstrategyitem.html#cfn-scheduler-schedule-capacityproviderstrategyitem-weight

DeadLetterConfigProperty

class CfnSchedulePropsMixin.DeadLetterConfigProperty(*, arn=None)

Bases: object

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.

Parameters:

arn (Optional[str]) – The Amazon Resource Name (ARN) of the SQS queue specified as the destination for the dead-letter queue.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-deadletterconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_scheduler import mixins as scheduler_mixins

dead_letter_config_property = scheduler_mixins.CfnSchedulePropsMixin.DeadLetterConfigProperty(
    arn="arn"
)

Attributes

arn

The Amazon Resource Name (ARN) of the SQS queue specified as the destination for the dead-letter queue.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-deadletterconfig.html#cfn-scheduler-schedule-deadletterconfig-arn

EcsParametersProperty

class CfnSchedulePropsMixin.EcsParametersProperty(*, capacity_provider_strategy=None, enable_ecs_managed_tags=None, enable_execute_command=None, group=None, launch_type=None, network_configuration=None, placement_constraints=None, placement_strategy=None, platform_version=None, propagate_tags=None, reference_id=None, tags=None, task_count=None, task_definition_arn=None)

Bases: object

The templated target type for the Amazon ECS `RunTask <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html>`_ API operation.

Parameters:

  • capacity_provider_strategy (Union[IResolvable, Sequence[Union[IResolvable, CapacityProviderStrategyItemProperty, Dict[str, Any]]], None]) – The capacity provider strategy to use for the task.

  • enable_ecs_managed_tags (Union[bool, IResolvable, None]) – Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon ECS Developer Guide .

  • enable_execute_command (Union[bool, IResolvable, None]) – 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 (Optional[str]) – Specifies an Amazon ECS task group for the task. The maximum length is 255 characters.

  • launch_type (Optional[str]) – 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 (Union[IResolvable, NetworkConfigurationProperty, Dict[str, Any], None]) – This structure specifies the network configuration for an ECS task.

  • placement_constraints (Union[IResolvable, Sequence[Union[IResolvable, PlacementConstraintProperty, Dict[str, Any]]], None]) – 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 (Union[IResolvable, Sequence[Union[IResolvable, PlacementStrategyProperty, Dict[str, Any]]], None]) – The task placement strategy for a task or service.

  • platform_version (Optional[str]) – Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0 .

  • propagate_tags (Optional[str]) – 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 <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html>`_ API action.

  • reference_id (Optional[str]) – The reference ID to use for the task.

  • tags (Any) – The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. For more information, see `RunTask <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html>`_ in the Amazon ECS API Reference .

  • task_count (Union[int, float, None]) – The number of tasks to create based on TaskDefinition . The default is 1 .

  • task_definition_arn (Optional[str]) – The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_scheduler import mixins as scheduler_mixins

# tags: Any

ecs_parameters_property = scheduler_mixins.CfnSchedulePropsMixin.EcsParametersProperty(
    capacity_provider_strategy=[scheduler_mixins.CfnSchedulePropsMixin.CapacityProviderStrategyItemProperty(
        base=123,
        capacity_provider="capacityProvider",
        weight=123
    )],
    enable_ecs_managed_tags=False,
    enable_execute_command=False,
    group="group",
    launch_type="launchType",
    network_configuration=scheduler_mixins.CfnSchedulePropsMixin.NetworkConfigurationProperty(
        awsvpc_configuration=scheduler_mixins.CfnSchedulePropsMixin.AwsVpcConfigurationProperty(
            assign_public_ip="assignPublicIp",
            security_groups=["securityGroups"],
            subnets=["subnets"]
        )
    ),
    placement_constraints=[scheduler_mixins.CfnSchedulePropsMixin.PlacementConstraintProperty(
        expression="expression",
        type="type"
    )],
    placement_strategy=[scheduler_mixins.CfnSchedulePropsMixin.PlacementStrategyProperty(
        field="field",
        type="type"
    )],
    platform_version="platformVersion",
    propagate_tags="propagateTags",
    reference_id="referenceId",
    tags=tags,
    task_count=123,
    task_definition_arn="taskDefinitionArn"
)

Attributes

capacity_provider_strategy

The capacity provider strategy to use for the task.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-capacityproviderstrategy

enable_ecs_managed_tags

Specifies whether to enable Amazon ECS managed tags for the task.

For more information, see Tagging Your Amazon ECS Resources in the Amazon ECS Developer Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-enableecsmanagedtags

enable_execute_command

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-enableexecutecommand

group

Specifies an Amazon ECS task group for the task.

The maximum length is 255 characters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-group

launch_type

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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-launchtype

network_configuration

This structure specifies the network configuration for an ECS task.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-networkconfiguration

placement_constraints

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).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-placementconstraints

placement_strategy

The task placement strategy for a task or service.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-placementstrategy

platform_version

Specifies the platform version for the task.

Specify only the numeric portion of the platform version, such as 1.1.0 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-platformversion

propagate_tags

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 <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html>`_ API action.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-propagatetags

reference_id

The reference ID to use for the task.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-referenceid

tags

The metadata that you apply to the task to help you categorize and organize them.

Each tag consists of a key and an optional value, both of which you define. For more information, see `RunTask <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html>`_ in the Amazon ECS API Reference .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-tags

task_count

The number of tasks to create based on TaskDefinition .

The default is 1 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-taskcount

task_definition_arn

The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-ecsparameters.html#cfn-scheduler-schedule-ecsparameters-taskdefinitionarn

EventBridgeParametersProperty

class CfnSchedulePropsMixin.EventBridgeParametersProperty(*, detail_type=None, source=None)

Bases: object

The templated target type for the EventBridge `PutEvents <https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html>`_ API operation.

Parameters:

  • detail_type (Optional[str]) – A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.

  • source (Optional[str]) – The source of the event.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-eventbridgeparameters.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_scheduler import mixins as scheduler_mixins

event_bridge_parameters_property = scheduler_mixins.CfnSchedulePropsMixin.EventBridgeParametersProperty(
    detail_type="detailType",
    source="source"
)

Attributes

detail_type

A free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-eventbridgeparameters.html#cfn-scheduler-schedule-eventbridgeparameters-detailtype

source

The source of the event.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-eventbridgeparameters.html#cfn-scheduler-schedule-eventbridgeparameters-source

FlexibleTimeWindowProperty

class CfnSchedulePropsMixin.FlexibleTimeWindowProperty(*, maximum_window_in_minutes=None, mode=None)

Bases: object

Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

Parameters:

  • maximum_window_in_minutes (Union[int, float, None]) – The maximum time window during which a schedule can be invoked. Minimum : 1 Maximum : 1440

  • mode (Optional[str]) – 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"

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-flexibletimewindow.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_scheduler import mixins as scheduler_mixins

flexible_time_window_property = scheduler_mixins.CfnSchedulePropsMixin.FlexibleTimeWindowProperty(
    maximum_window_in_minutes=123,
    mode="mode"
)

Attributes

maximum_window_in_minutes

The maximum time window during which a schedule can be invoked.

Minimum : 1

Maximum : 1440

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-flexibletimewindow.html#cfn-scheduler-schedule-flexibletimewindow-maximumwindowinminutes

mode

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"

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-flexibletimewindow.html#cfn-scheduler-schedule-flexibletimewindow-mode

KinesisParametersProperty

class CfnSchedulePropsMixin.KinesisParametersProperty(*, partition_key=None)

Bases: object

The templated target type for the Amazon Kinesis `PutRecord <https://docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html>`_ API operation.

Parameters:

partition_key (Optional[str]) – Specifies the shard to which EventBridge Scheduler sends the event. For more information, see Amazon Kinesis Data Streams terminology and concepts in the Amazon Kinesis Streams Developer Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-kinesisparameters.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_scheduler import mixins as scheduler_mixins

kinesis_parameters_property = scheduler_mixins.CfnSchedulePropsMixin.KinesisParametersProperty(
    partition_key="partitionKey"
)

Attributes

partition_key

Specifies the shard to which EventBridge Scheduler sends the event.

For more information, see Amazon Kinesis Data Streams terminology and concepts in the Amazon Kinesis Streams Developer Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-kinesisparameters.html#cfn-scheduler-schedule-kinesisparameters-partitionkey

NetworkConfigurationProperty

class CfnSchedulePropsMixin.NetworkConfigurationProperty(*, awsvpc_configuration=None)

Bases: object

Specifies the network configuration for an ECS task.

Parameters:

awsvpc_configuration (Union[IResolvable, AwsVpcConfigurationProperty, Dict[str, Any], None]) – 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-networkconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_scheduler import mixins as scheduler_mixins

network_configuration_property = scheduler_mixins.CfnSchedulePropsMixin.NetworkConfigurationProperty(
    awsvpc_configuration=scheduler_mixins.CfnSchedulePropsMixin.AwsVpcConfigurationProperty(
        assign_public_ip="assignPublicIp",
        security_groups=["securityGroups"],
        subnets=["subnets"]
    )
)

Attributes

awsvpc_configuration

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-networkconfiguration.html#cfn-scheduler-schedule-networkconfiguration-awsvpcconfiguration

PlacementConstraintProperty

class CfnSchedulePropsMixin.PlacementConstraintProperty(*, expression=None, type=None)

Bases: object

An object representing a constraint on task placement.

Parameters:

  • expression (Optional[str]) – A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance . For more information, see Cluster query language in the Amazon ECS Developer Guide .

  • type (Optional[str]) – 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-placementconstraint.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_scheduler import mixins as scheduler_mixins

placement_constraint_property = scheduler_mixins.CfnSchedulePropsMixin.PlacementConstraintProperty(
    expression="expression",
    type="type"
)

Attributes

expression

A cluster query language expression to apply to the constraint.

You cannot specify an expression if the constraint type is distinctInstance . For more information, see Cluster query language in the Amazon ECS Developer Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-placementconstraint.html#cfn-scheduler-schedule-placementconstraint-expression

type

The type of constraint.

Use distinctInstance to ensure that each task in a particular group is running on a different container instance. Use memberOf to restrict the selection to a group of valid candidates.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-placementconstraint.html#cfn-scheduler-schedule-placementconstraint-type

PlacementStrategyProperty

class CfnSchedulePropsMixin.PlacementStrategyProperty(*, field=None, type=None)

Bases: object

The task placement strategy for a task or service.

Parameters:

  • field (Optional[str]) – The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or instanceId , which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone . For the binpack placement strategy, valid values are cpu and memory . For the random placement strategy, this field is not used.

  • type (Optional[str]) – 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).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-placementstrategy.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_scheduler import mixins as scheduler_mixins

placement_strategy_property = scheduler_mixins.CfnSchedulePropsMixin.PlacementStrategyProperty(
    field="field",
    type="type"
)

Attributes

field

The field to apply the placement strategy against.

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-placementstrategy.html#cfn-scheduler-schedule-placementstrategy-field

type

The type of placement strategy.

The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the field parameter. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified with the field parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory (but still enough to run the task).

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-placementstrategy.html#cfn-scheduler-schedule-placementstrategy-type

RetryPolicyProperty

class CfnSchedulePropsMixin.RetryPolicyProperty(*, maximum_event_age_in_seconds=None, maximum_retry_attempts=None)

Bases: object

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.

Parameters:

  • maximum_event_age_in_seconds (Union[int, float, None]) – The maximum amount of time, in seconds, to continue to make retry attempts.

  • maximum_retry_attempts (Union[int, float, None]) – 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-retrypolicy.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_scheduler import mixins as scheduler_mixins

retry_policy_property = scheduler_mixins.CfnSchedulePropsMixin.RetryPolicyProperty(
    maximum_event_age_in_seconds=123,
    maximum_retry_attempts=123
)

Attributes

maximum_event_age_in_seconds

The maximum amount of time, in seconds, to continue to make retry attempts.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-retrypolicy.html#cfn-scheduler-schedule-retrypolicy-maximumeventageinseconds

maximum_retry_attempts

The maximum number of retry attempts to make before the request fails.

Retry attempts with exponential backoff continue until either the maximum number of attempts is made or until the duration of the MaximumEventAgeInSeconds is reached.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-retrypolicy.html#cfn-scheduler-schedule-retrypolicy-maximumretryattempts

SageMakerPipelineParameterProperty

class CfnSchedulePropsMixin.SageMakerPipelineParameterProperty(*, name=None, value=None)

Bases: object

The name and value pair of a parameter to use to start execution of a SageMaker Model Building Pipeline.

Parameters:

  • name (Optional[str]) – Name of parameter to start execution of a SageMaker Model Building Pipeline.

  • value (Optional[str]) – Value of parameter to start execution of a SageMaker Model Building Pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sagemakerpipelineparameter.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_scheduler import mixins as scheduler_mixins

sage_maker_pipeline_parameter_property = scheduler_mixins.CfnSchedulePropsMixin.SageMakerPipelineParameterProperty(
    name="name",
    value="value"
)

Attributes

name

Name of parameter to start execution of a SageMaker Model Building Pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sagemakerpipelineparameter.html#cfn-scheduler-schedule-sagemakerpipelineparameter-name

value

Value of parameter to start execution of a SageMaker Model Building Pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sagemakerpipelineparameter.html#cfn-scheduler-schedule-sagemakerpipelineparameter-value

SageMakerPipelineParametersProperty

class CfnSchedulePropsMixin.SageMakerPipelineParametersProperty(*, pipeline_parameter_list=None)

Bases: object

The templated target type for the Amazon SageMaker `StartPipelineExecution <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html>`_ API operation.

Parameters:

pipeline_parameter_list (Union[IResolvable, Sequence[Union[IResolvable, SageMakerPipelineParameterProperty, Dict[str, Any]]], None]) – List of parameter names and values to use when executing the SageMaker Model Building Pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sagemakerpipelineparameters.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_scheduler import mixins as scheduler_mixins

sage_maker_pipeline_parameters_property = scheduler_mixins.CfnSchedulePropsMixin.SageMakerPipelineParametersProperty(
    pipeline_parameter_list=[scheduler_mixins.CfnSchedulePropsMixin.SageMakerPipelineParameterProperty(
        name="name",
        value="value"
    )]
)

Attributes

pipeline_parameter_list

List of parameter names and values to use when executing the SageMaker Model Building Pipeline.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sagemakerpipelineparameters.html#cfn-scheduler-schedule-sagemakerpipelineparameters-pipelineparameterlist

SqsParametersProperty

class CfnSchedulePropsMixin.SqsParametersProperty(*, message_group_id=None)

Bases: object

The templated target type for the Amazon SQS `SendMessage <https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html>`_ 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 .

Parameters:

message_group_id (Optional[str]) – The FIFO message group ID to use as the target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sqsparameters.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_scheduler import mixins as scheduler_mixins

sqs_parameters_property = scheduler_mixins.CfnSchedulePropsMixin.SqsParametersProperty(
    message_group_id="messageGroupId"
)

Attributes

message_group_id

The FIFO message group ID to use as the target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sqsparameters.html#cfn-scheduler-schedule-sqsparameters-messagegroupid

TargetProperty

class CfnSchedulePropsMixin.TargetProperty(*, arn=None, dead_letter_config=None, ecs_parameters=None, event_bridge_parameters=None, input=None, kinesis_parameters=None, retry_policy=None, role_arn=None, sage_maker_pipeline_parameters=None, sqs_parameters=None)

Bases: object

The schedule’s target.

EventBridge Scheduler supports templated target that invoke common API operations, as well as universal targets that you can customize to invoke over 6,000 API operations across more than 270 services. You can only specify one templated or universal target for a schedule.

Parameters:
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_scheduler import mixins as scheduler_mixins

# tags: Any

target_property = scheduler_mixins.CfnSchedulePropsMixin.TargetProperty(
    arn="arn",
    dead_letter_config=scheduler_mixins.CfnSchedulePropsMixin.DeadLetterConfigProperty(
        arn="arn"
    ),
    ecs_parameters=scheduler_mixins.CfnSchedulePropsMixin.EcsParametersProperty(
        capacity_provider_strategy=[scheduler_mixins.CfnSchedulePropsMixin.CapacityProviderStrategyItemProperty(
            base=123,
            capacity_provider="capacityProvider",
            weight=123
        )],
        enable_ecs_managed_tags=False,
        enable_execute_command=False,
        group="group",
        launch_type="launchType",
        network_configuration=scheduler_mixins.CfnSchedulePropsMixin.NetworkConfigurationProperty(
            awsvpc_configuration=scheduler_mixins.CfnSchedulePropsMixin.AwsVpcConfigurationProperty(
                assign_public_ip="assignPublicIp",
                security_groups=["securityGroups"],
                subnets=["subnets"]
            )
        ),
        placement_constraints=[scheduler_mixins.CfnSchedulePropsMixin.PlacementConstraintProperty(
            expression="expression",
            type="type"
        )],
        placement_strategy=[scheduler_mixins.CfnSchedulePropsMixin.PlacementStrategyProperty(
            field="field",
            type="type"
        )],
        platform_version="platformVersion",
        propagate_tags="propagateTags",
        reference_id="referenceId",
        tags=tags,
        task_count=123,
        task_definition_arn="taskDefinitionArn"
    ),
    event_bridge_parameters=scheduler_mixins.CfnSchedulePropsMixin.EventBridgeParametersProperty(
        detail_type="detailType",
        source="source"
    ),
    input="input",
    kinesis_parameters=scheduler_mixins.CfnSchedulePropsMixin.KinesisParametersProperty(
        partition_key="partitionKey"
    ),
    retry_policy=scheduler_mixins.CfnSchedulePropsMixin.RetryPolicyProperty(
        maximum_event_age_in_seconds=123,
        maximum_retry_attempts=123
    ),
    role_arn="roleArn",
    sage_maker_pipeline_parameters=scheduler_mixins.CfnSchedulePropsMixin.SageMakerPipelineParametersProperty(
        pipeline_parameter_list=[scheduler_mixins.CfnSchedulePropsMixin.SageMakerPipelineParameterProperty(
            name="name",
            value="value"
        )]
    ),
    sqs_parameters=scheduler_mixins.CfnSchedulePropsMixin.SqsParametersProperty(
        message_group_id="messageGroupId"
    )
)

Attributes

arn

The Amazon Resource Name (ARN) of the target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-arn

dead_letter_config

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-deadletterconfig

ecs_parameters

//docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html>`_ API operation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-ecsparameters

Type:

The templated target type for the Amazon ECS `RunTask <https

event_bridge_parameters

//docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html>`_ API operation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-eventbridgeparameters

Type:

The templated target type for the EventBridge `PutEvents <https

input

The text, or well-formed JSON, passed to the target.

If you are configuring a templated Lambda , AWS Step Functions , or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, Amazon EventBridge Scheduler delivers a default notification to the target.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-input

kinesis_parameters

//docs.aws.amazon.com/kinesis/latest/APIReference/API_PutRecord.html>`_ API operation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-kinesisparameters

Type:

The templated target type for the Amazon Kinesis `PutRecord <https

retry_policy

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-retrypolicy

role_arn

The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-rolearn

sage_maker_pipeline_parameters

//docs.aws.amazon.com/sagemaker/latest/APIReference/API_StartPipelineExecution.html>`_ API operation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-sagemakerpipelineparameters

Type:

The templated target type for the Amazon SageMaker `StartPipelineExecution <https

sqs_parameters

//docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessage.html>`_ 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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-target.html#cfn-scheduler-schedule-target-sqsparameters

Type:

The templated target type for the Amazon SQS `SendMessage <https