CfnSchedule

class aws_cdk.aws_scheduler.CfnSchedule(scope, id, *, flexible_time_window, schedule_expression, target, description=None, end_date=None, group_name=None, kms_key_arn=None, name=None, schedule_expression_timezone=None, start_date=None, state=None)

Bases: CfnResource

A CloudFormation AWS::Scheduler::Schedule.

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 .

CloudformationResource:

AWS::Scheduler::Schedule

Link:

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

ExampleMetadata:

fixture=_generated

Example:

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

# tags: Any

cfn_schedule = scheduler.CfnSchedule(self, "MyCfnSchedule",
    flexible_time_window=scheduler.CfnSchedule.FlexibleTimeWindowProperty(
        mode="mode",

        # the properties below are optional
        maximum_window_in_minutes=123
    ),
    schedule_expression="scheduleExpression",
    target=scheduler.CfnSchedule.TargetProperty(
        arn="arn",
        role_arn="roleArn",

        # the properties below are optional
        dead_letter_config=scheduler.CfnSchedule.DeadLetterConfigProperty(
            arn="arn"
        ),
        ecs_parameters=scheduler.CfnSchedule.EcsParametersProperty(
            task_definition_arn="taskDefinitionArn",

            # the properties below are optional
            capacity_provider_strategy=[scheduler.CfnSchedule.CapacityProviderStrategyItemProperty(
                capacity_provider="capacityProvider",

                # the properties below are optional
                base=123,
                weight=123
            )],
            enable_ecs_managed_tags=False,
            enable_execute_command=False,
            group="group",
            launch_type="launchType",
            network_configuration=scheduler.CfnSchedule.NetworkConfigurationProperty(
                awsvpc_configuration=scheduler.CfnSchedule.AwsVpcConfigurationProperty(
                    subnets=["subnets"],

                    # the properties below are optional
                    assign_public_ip="assignPublicIp",
                    security_groups=["securityGroups"]
                )
            ),
            placement_constraints=[scheduler.CfnSchedule.PlacementConstraintProperty(
                expression="expression",
                type="type"
            )],
            placement_strategy=[scheduler.CfnSchedule.PlacementStrategyProperty(
                field="field",
                type="type"
            )],
            platform_version="platformVersion",
            propagate_tags="propagateTags",
            reference_id="referenceId",
            tags=tags,
            task_count=123
        ),
        event_bridge_parameters=scheduler.CfnSchedule.EventBridgeParametersProperty(
            detail_type="detailType",
            source="source"
        ),
        input="input",
        kinesis_parameters=scheduler.CfnSchedule.KinesisParametersProperty(
            partition_key="partitionKey"
        ),
        retry_policy=scheduler.CfnSchedule.RetryPolicyProperty(
            maximum_event_age_in_seconds=123,
            maximum_retry_attempts=123
        ),
        sage_maker_pipeline_parameters=scheduler.CfnSchedule.SageMakerPipelineParametersProperty(
            pipeline_parameter_list=[scheduler.CfnSchedule.SageMakerPipelineParameterProperty(
                name="name",
                value="value"
            )]
        ),
        sqs_parameters=scheduler.CfnSchedule.SqsParametersProperty(
            message_group_id="messageGroupId"
        )
    ),

    # the properties below are optional
    description="description",
    end_date="endDate",
    group_name="groupName",
    kms_key_arn="kmsKeyArn",
    name="name",
    schedule_expression_timezone="scheduleExpressionTimezone",
    start_date="startDate",
    state="state"
)

Create a new AWS::Scheduler::Schedule.

Parameters:

  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • flexible_time_window (Union[FlexibleTimeWindowProperty, Dict[str, Any], IResolvable]) – Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

  • schedule_expression (str) – The expression that defines when the schedule runs. The following formats are supported. - at expression - at(yyyy-mm-ddThh:mm:ss) - rate expression - rate(value unit) - cron expression - cron(fields) You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month. A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year) . A rate expression consists of a value as a positive integer, and a unit with the following options: minute | minutes | hour | hours | day | days For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide .

  • target (Union[IResolvable, TargetProperty, Dict[str, Any]]) – The schedule’s target details.

  • description (Optional[str]) – The description you specify for the schedule.

  • end_date (Optional[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. EventBridge Scheduler ignores EndDate for one-time schedules.

  • group_name (Optional[str]) – The name of the schedule group associated with this schedule.

  • kms_key_arn (Optional[str]) – The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

  • name (Optional[str]) – The name of the schedule.

  • schedule_expression_timezone (Optional[str]) – The timezone in which the scheduling expression is evaluated.

  • start_date (Optional[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. EventBridge Scheduler ignores StartDate for one-time schedules.

  • state (Optional[str]) – Specifies whether the schedule is enabled or disabled. Allowed Values : ENABLED | DISABLED

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:

path (str) – The path of the value to delete.

Return type:

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (str) –

  • value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:

property_path (str) – The path to the property.

Return type:

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type:

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type:

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:

new_logical_id (str) – The new logical ID to use for this stack element.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Returns:

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Scheduler::Schedule'
attr_arn

The Amazon Resource Name (ARN) for the Amazon EventBridge Scheduler schedule.

CloudformationAttribute:

Arn

cfn_options

Options for this resource, such as condition, update policy etc.

cfn_resource_type

AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description

The description you specify for the schedule.

Link:

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

end_date

The date, in UTC, before which the schedule can invoke its target.

Depending on the schedule’s recurrence expression, invocations might stop on, or before, the EndDate you specify. EventBridge Scheduler ignores EndDate for one-time schedules.

Link:

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

flexible_time_window

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

Link:

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

group_name

The name of the schedule group associated with this schedule.

Link:

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

kms_key_arn

The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

Link:

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

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

The name of the schedule.

Link:

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

node

The construct tree node associated with this construct.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

schedule_expression

The expression that defines when the schedule runs. The following formats are supported.

  • at expression - at(yyyy-mm-ddThh:mm:ss)

  • rate expression - rate(value unit)

  • cron expression - cron(fields)

You can use at expressions to create one-time schedules that invoke a target once, at the time and in the time zone, that you specify. You can use rate and cron expressions to create recurring schedules. Rate-based schedules are useful when you want to invoke a target at regular intervals, such as every 15 minutes or every five days. Cron-based schedules are useful when you want to invoke a target periodically at a specific time, such as at 8:00 am (UTC+0) every 1st day of the month.

A cron expression consists of six fields separated by white spaces: (minutes hours day_of_month month day_of_week year) .

A rate expression consists of a value as a positive integer, and a unit with the following options: minute | minutes | hour | hours | day | days

For more information and examples, see Schedule types on EventBridge Scheduler in the EventBridge Scheduler User Guide .

Link:

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

schedule_expression_timezone

The timezone in which the scheduling expression is evaluated.

Link:

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

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

start_date

The date, in UTC, after which the schedule can begin invoking its target.

Depending on the schedule’s recurrence expression, invocations might occur on, or after, the StartDate you specify. EventBridge Scheduler ignores StartDate for one-time schedules.

Link:

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

state

Specifies whether the schedule is enabled or disabled.

Allowed Values : ENABLED | DISABLED

Link:

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

target

The schedule’s target details.

Link:

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

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters:

x (Any) –

Return type:

bool

AwsVpcConfigurationProperty

class CfnSchedule.AwsVpcConfigurationProperty(*, subnets, assign_public_ip=None, security_groups=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:

  • 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 (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.

Link:

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.
import aws_cdk.aws_scheduler as scheduler

aws_vpc_configuration_property = scheduler.CfnSchedule.AwsVpcConfigurationProperty(
    subnets=["subnets"],

    # the properties below are optional
    assign_public_ip="assignPublicIp",
    security_groups=["securityGroups"]
)

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 .

Link:

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.

Link:

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.

Link:

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

CapacityProviderStrategyItemProperty

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

Bases: object

The details of a capacity provider strategy.

Parameters:

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

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

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

Link:

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.
import aws_cdk.aws_scheduler as scheduler

capacity_provider_strategy_item_property = scheduler.CfnSchedule.CapacityProviderStrategyItemProperty(
    capacity_provider="capacityProvider",

    # the properties below are optional
    base=123,
    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.

Link:

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.

Link:

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.

Link:

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

DeadLetterConfigProperty

class CfnSchedule.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.

Link:

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.
import aws_cdk.aws_scheduler as scheduler

dead_letter_config_property = scheduler.CfnSchedule.DeadLetterConfigProperty(
    arn="arn"
)

Attributes

arn

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

Link:

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

EcsParametersProperty

class CfnSchedule.EcsParametersProperty(*, task_definition_arn, 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)

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:

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

  • 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 (Optional[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 .

Link:

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.
import aws_cdk.aws_scheduler as scheduler

# tags: Any

ecs_parameters_property = scheduler.CfnSchedule.EcsParametersProperty(
    task_definition_arn="taskDefinitionArn",

    # the properties below are optional
    capacity_provider_strategy=[scheduler.CfnSchedule.CapacityProviderStrategyItemProperty(
        capacity_provider="capacityProvider",

        # the properties below are optional
        base=123,
        weight=123
    )],
    enable_ecs_managed_tags=False,
    enable_execute_command=False,
    group="group",
    launch_type="launchType",
    network_configuration=scheduler.CfnSchedule.NetworkConfigurationProperty(
        awsvpc_configuration=scheduler.CfnSchedule.AwsVpcConfigurationProperty(
            subnets=["subnets"],

            # the properties below are optional
            assign_public_ip="assignPublicIp",
            security_groups=["securityGroups"]
        )
    ),
    placement_constraints=[scheduler.CfnSchedule.PlacementConstraintProperty(
        expression="expression",
        type="type"
    )],
    placement_strategy=[scheduler.CfnSchedule.PlacementStrategyProperty(
        field="field",
        type="type"
    )],
    platform_version="platformVersion",
    propagate_tags="propagateTags",
    reference_id="referenceId",
    tags=tags,
    task_count=123
)

Attributes

capacity_provider_strategy

The capacity provider strategy to use for the task.

Link:

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 .

Link:

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.

Link:

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.

Link:

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 .

Link:

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.

Link:

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

Link:

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.

Link:

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 .

Link:

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.

Link:

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.

Link:

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 .

Link:

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 .

Link:

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.

Link:

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

EventBridgeParametersProperty

class CfnSchedule.EventBridgeParametersProperty(*, detail_type, source)

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 (str) – A 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.

Link:

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.
import aws_cdk.aws_scheduler as scheduler

event_bridge_parameters_property = scheduler.CfnSchedule.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.

Link:

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.

Link:

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

FlexibleTimeWindowProperty

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

Bases: object

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

Parameters:

  • mode (str) – Determines whether the schedule is invoked within a flexible time window. Allowed Values : OFF | FLEXIBLE

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

Link:

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.
import aws_cdk.aws_scheduler as scheduler

flexible_time_window_property = scheduler.CfnSchedule.FlexibleTimeWindowProperty(
    mode="mode",

    # the properties below are optional
    maximum_window_in_minutes=123
)

Attributes

maximum_window_in_minutes

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

Minimum : 1

Maximum : 1440

Link:

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.

Allowed Values : OFF | FLEXIBLE

Link:

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

KinesisParametersProperty

class CfnSchedule.KinesisParametersProperty(*, partition_key)

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

Link:

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.
import aws_cdk.aws_scheduler as scheduler

kinesis_parameters_property = scheduler.CfnSchedule.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 .

Link:

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

NetworkConfigurationProperty

class CfnSchedule.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.

Link:

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.
import aws_cdk.aws_scheduler as scheduler

network_configuration_property = scheduler.CfnSchedule.NetworkConfigurationProperty(
    awsvpc_configuration=scheduler.CfnSchedule.AwsVpcConfigurationProperty(
        subnets=["subnets"],

        # the properties below are optional
        assign_public_ip="assignPublicIp",
        security_groups=["securityGroups"]
    )
)

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.

Link:

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

PlacementConstraintProperty

class CfnSchedule.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.

Link:

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.
import aws_cdk.aws_scheduler as scheduler

placement_constraint_property = scheduler.CfnSchedule.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 .

Link:

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.

Link:

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

PlacementStrategyProperty

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

Link:

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.
import aws_cdk.aws_scheduler as scheduler

placement_strategy_property = scheduler.CfnSchedule.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.

Link:

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

Link:

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

RetryPolicyProperty

class CfnSchedule.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.

Link:

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.
import aws_cdk.aws_scheduler as scheduler

retry_policy_property = scheduler.CfnSchedule.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.

Link:

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.

Link:

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

SageMakerPipelineParameterProperty

class CfnSchedule.SageMakerPipelineParameterProperty(*, name, value)

Bases: object

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

Parameters:

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

Link:

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.
import aws_cdk.aws_scheduler as scheduler

sage_maker_pipeline_parameter_property = scheduler.CfnSchedule.SageMakerPipelineParameterProperty(
    name="name",
    value="value"
)

Attributes

name

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

Link:

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.

Link:

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

SageMakerPipelineParametersProperty

class CfnSchedule.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.

Link:

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.
import aws_cdk.aws_scheduler as scheduler

sage_maker_pipeline_parameters_property = scheduler.CfnSchedule.SageMakerPipelineParametersProperty(
    pipeline_parameter_list=[scheduler.CfnSchedule.SageMakerPipelineParameterProperty(
        name="name",
        value="value"
    )]
)

Attributes

pipeline_parameter_list

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

Link:

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

SqsParametersProperty

class CfnSchedule.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.

Link:

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.
import aws_cdk.aws_scheduler as scheduler

sqs_parameters_property = scheduler.CfnSchedule.SqsParametersProperty(
    message_group_id="messageGroupId"
)

Attributes

message_group_id

The FIFO message group ID to use as the target.

Link:

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

TargetProperty

class CfnSchedule.TargetProperty(*, arn, role_arn, dead_letter_config=None, ecs_parameters=None, event_bridge_parameters=None, input=None, kinesis_parameters=None, retry_policy=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:
Link:

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.
import aws_cdk.aws_scheduler as scheduler

# tags: Any

target_property = scheduler.CfnSchedule.TargetProperty(
    arn="arn",
    role_arn="roleArn",

    # the properties below are optional
    dead_letter_config=scheduler.CfnSchedule.DeadLetterConfigProperty(
        arn="arn"
    ),
    ecs_parameters=scheduler.CfnSchedule.EcsParametersProperty(
        task_definition_arn="taskDefinitionArn",

        # the properties below are optional
        capacity_provider_strategy=[scheduler.CfnSchedule.CapacityProviderStrategyItemProperty(
            capacity_provider="capacityProvider",

            # the properties below are optional
            base=123,
            weight=123
        )],
        enable_ecs_managed_tags=False,
        enable_execute_command=False,
        group="group",
        launch_type="launchType",
        network_configuration=scheduler.CfnSchedule.NetworkConfigurationProperty(
            awsvpc_configuration=scheduler.CfnSchedule.AwsVpcConfigurationProperty(
                subnets=["subnets"],

                # the properties below are optional
                assign_public_ip="assignPublicIp",
                security_groups=["securityGroups"]
            )
        ),
        placement_constraints=[scheduler.CfnSchedule.PlacementConstraintProperty(
            expression="expression",
            type="type"
        )],
        placement_strategy=[scheduler.CfnSchedule.PlacementStrategyProperty(
            field="field",
            type="type"
        )],
        platform_version="platformVersion",
        propagate_tags="propagateTags",
        reference_id="referenceId",
        tags=tags,
        task_count=123
    ),
    event_bridge_parameters=scheduler.CfnSchedule.EventBridgeParametersProperty(
        detail_type="detailType",
        source="source"
    ),
    input="input",
    kinesis_parameters=scheduler.CfnSchedule.KinesisParametersProperty(
        partition_key="partitionKey"
    ),
    retry_policy=scheduler.CfnSchedule.RetryPolicyProperty(
        maximum_event_age_in_seconds=123,
        maximum_retry_attempts=123
    ),
    sage_maker_pipeline_parameters=scheduler.CfnSchedule.SageMakerPipelineParametersProperty(
        pipeline_parameter_list=[scheduler.CfnSchedule.SageMakerPipelineParameterProperty(
            name="name",
            value="value"
        )]
    ),
    sqs_parameters=scheduler.CfnSchedule.SqsParametersProperty(
        message_group_id="messageGroupId"
    )
)

Attributes

arn

The Amazon Resource Name (ARN) of the target.

Link:

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.

Link:

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.

Link:

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.

Link:

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.

Link:

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.

Link:

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.

Link:

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.

Link:

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.

Link:

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/SQSDeveloperGuide/using-messagededuplicationid-property.html>`_ in the Amazon SQS Developer Guide .

Link:

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

Type:

//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 <https