Class CfnSchedulePropsMixin

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

Inheritance

object

Mixin

CfnSchedulePropsMixin

Implements

IMixin

Inherited Members

Mixin.IsMixin(object)

Namespace: Amazon.CDK.Mixins.Preview.AWS.Scheduler.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnSchedulePropsMixin : Mixin, IMixin

Syntax (vb)

Public Class CfnSchedulePropsMixin Inherits Mixin Implements IMixin

Remarks

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

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.Scheduler.Mixins;

             var tags;

             var cfnSchedulePropsMixin = new CfnSchedulePropsMixin(new CfnScheduleMixinProps {
                 Description = "description",
                 EndDate = "endDate",
                 FlexibleTimeWindow = new FlexibleTimeWindowProperty {
                     MaximumWindowInMinutes = 123,
                     Mode = "mode"
                 },
                 GroupName = "groupName",
                 KmsKeyArn = "kmsKeyArn",
                 Name = "name",
                 ScheduleExpression = "scheduleExpression",
                 ScheduleExpressionTimezone = "scheduleExpressionTimezone",
                 StartDate = "startDate",
                 State = "state",
                 Target = new TargetProperty {
                     Arn = "arn",
                     DeadLetterConfig = new DeadLetterConfigProperty {
                         Arn = "arn"
                     },
                     EcsParameters = new EcsParametersProperty {
                         CapacityProviderStrategy = new [] { new CapacityProviderStrategyItemProperty {
                             Base = 123,
                             CapacityProvider = "capacityProvider",
                             Weight = 123
                         } },
                         EnableEcsManagedTags = false,
                         EnableExecuteCommand = false,
                         Group = "group",
                         LaunchType = "launchType",
                         NetworkConfiguration = new NetworkConfigurationProperty {
                             AwsvpcConfiguration = new AwsVpcConfigurationProperty {
                                 AssignPublicIp = "assignPublicIp",
                                 SecurityGroups = new [] { "securityGroups" },
                                 Subnets = new [] { "subnets" }
                             }
                         },
                         PlacementConstraints = new [] { new PlacementConstraintProperty {
                             Expression = "expression",
                             Type = "type"
                         } },
                         PlacementStrategy = new [] { new PlacementStrategyProperty {
                             Field = "field",
                             Type = "type"
                         } },
                         PlatformVersion = "platformVersion",
                         PropagateTags = "propagateTags",
                         ReferenceId = "referenceId",
                         Tags = tags,
                         TaskCount = 123,
                         TaskDefinitionArn = "taskDefinitionArn"
                     },
                     EventBridgeParameters = new EventBridgeParametersProperty {
                         DetailType = "detailType",
                         Source = "source"
                     },
                     Input = "input",
                     KinesisParameters = new KinesisParametersProperty {
                         PartitionKey = "partitionKey"
                     },
                     RetryPolicy = new RetryPolicyProperty {
                         MaximumEventAgeInSeconds = 123,
                         MaximumRetryAttempts = 123
                     },
                     RoleArn = "roleArn",
                     SageMakerPipelineParameters = new SageMakerPipelineParametersProperty {
                         PipelineParameterList = new [] { new SageMakerPipelineParameterProperty {
                             Name = "name",
                             Value = "value"
                         } }
                     },
                     SqsParameters = new SqsParametersProperty {
                         MessageGroupId = "messageGroupId"
                     }
                 }
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Synopsis

Constructors

CfnSchedulePropsMixin(ICfnScheduleMixinProps, ICfnPropertyMixinOptions?)

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

Properties

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

Methods

ApplyTo(IConstruct)	Apply the mixin properties to the construct.
Supports(IConstruct)	Check if this mixin supports the given construct.

Constructors

CfnSchedulePropsMixin(ICfnScheduleMixinProps, ICfnPropertyMixinOptions?)

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

public CfnSchedulePropsMixin(ICfnScheduleMixinProps props, ICfnPropertyMixinOptions? options = null)

Parameters

props ICfnScheduleMixinProps

L1 properties to apply.

options ICfnPropertyMixinOptions

Mixin options.

Remarks

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

Properties

CFN_PROPERTY_KEYS

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

protected static string[] CFN_PROPERTY_KEYS { get; }

Property Value

string[]

Remarks

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

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.Scheduler.Mixins;

             var tags;

             var cfnSchedulePropsMixin = new CfnSchedulePropsMixin(new CfnScheduleMixinProps {
                 Description = "description",
                 EndDate = "endDate",
                 FlexibleTimeWindow = new FlexibleTimeWindowProperty {
                     MaximumWindowInMinutes = 123,
                     Mode = "mode"
                 },
                 GroupName = "groupName",
                 KmsKeyArn = "kmsKeyArn",
                 Name = "name",
                 ScheduleExpression = "scheduleExpression",
                 ScheduleExpressionTimezone = "scheduleExpressionTimezone",
                 StartDate = "startDate",
                 State = "state",
                 Target = new TargetProperty {
                     Arn = "arn",
                     DeadLetterConfig = new DeadLetterConfigProperty {
                         Arn = "arn"
                     },
                     EcsParameters = new EcsParametersProperty {
                         CapacityProviderStrategy = new [] { new CapacityProviderStrategyItemProperty {
                             Base = 123,
                             CapacityProvider = "capacityProvider",
                             Weight = 123
                         } },
                         EnableEcsManagedTags = false,
                         EnableExecuteCommand = false,
                         Group = "group",
                         LaunchType = "launchType",
                         NetworkConfiguration = new NetworkConfigurationProperty {
                             AwsvpcConfiguration = new AwsVpcConfigurationProperty {
                                 AssignPublicIp = "assignPublicIp",
                                 SecurityGroups = new [] { "securityGroups" },
                                 Subnets = new [] { "subnets" }
                             }
                         },
                         PlacementConstraints = new [] { new PlacementConstraintProperty {
                             Expression = "expression",
                             Type = "type"
                         } },
                         PlacementStrategy = new [] { new PlacementStrategyProperty {
                             Field = "field",
                             Type = "type"
                         } },
                         PlatformVersion = "platformVersion",
                         PropagateTags = "propagateTags",
                         ReferenceId = "referenceId",
                         Tags = tags,
                         TaskCount = 123,
                         TaskDefinitionArn = "taskDefinitionArn"
                     },
                     EventBridgeParameters = new EventBridgeParametersProperty {
                         DetailType = "detailType",
                         Source = "source"
                     },
                     Input = "input",
                     KinesisParameters = new KinesisParametersProperty {
                         PartitionKey = "partitionKey"
                     },
                     RetryPolicy = new RetryPolicyProperty {
                         MaximumEventAgeInSeconds = 123,
                         MaximumRetryAttempts = 123
                     },
                     RoleArn = "roleArn",
                     SageMakerPipelineParameters = new SageMakerPipelineParametersProperty {
                         PipelineParameterList = new [] { new SageMakerPipelineParameterProperty {
                             Name = "name",
                             Value = "value"
                         } }
                     },
                     SqsParameters = new SqsParametersProperty {
                         MessageGroupId = "messageGroupId"
                     }
                 }
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Props

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

protected virtual ICfnScheduleMixinProps Props { get; }

Property Value

ICfnScheduleMixinProps

Remarks

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

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.Scheduler.Mixins;

             var tags;

             var cfnSchedulePropsMixin = new CfnSchedulePropsMixin(new CfnScheduleMixinProps {
                 Description = "description",
                 EndDate = "endDate",
                 FlexibleTimeWindow = new FlexibleTimeWindowProperty {
                     MaximumWindowInMinutes = 123,
                     Mode = "mode"
                 },
                 GroupName = "groupName",
                 KmsKeyArn = "kmsKeyArn",
                 Name = "name",
                 ScheduleExpression = "scheduleExpression",
                 ScheduleExpressionTimezone = "scheduleExpressionTimezone",
                 StartDate = "startDate",
                 State = "state",
                 Target = new TargetProperty {
                     Arn = "arn",
                     DeadLetterConfig = new DeadLetterConfigProperty {
                         Arn = "arn"
                     },
                     EcsParameters = new EcsParametersProperty {
                         CapacityProviderStrategy = new [] { new CapacityProviderStrategyItemProperty {
                             Base = 123,
                             CapacityProvider = "capacityProvider",
                             Weight = 123
                         } },
                         EnableEcsManagedTags = false,
                         EnableExecuteCommand = false,
                         Group = "group",
                         LaunchType = "launchType",
                         NetworkConfiguration = new NetworkConfigurationProperty {
                             AwsvpcConfiguration = new AwsVpcConfigurationProperty {
                                 AssignPublicIp = "assignPublicIp",
                                 SecurityGroups = new [] { "securityGroups" },
                                 Subnets = new [] { "subnets" }
                             }
                         },
                         PlacementConstraints = new [] { new PlacementConstraintProperty {
                             Expression = "expression",
                             Type = "type"
                         } },
                         PlacementStrategy = new [] { new PlacementStrategyProperty {
                             Field = "field",
                             Type = "type"
                         } },
                         PlatformVersion = "platformVersion",
                         PropagateTags = "propagateTags",
                         ReferenceId = "referenceId",
                         Tags = tags,
                         TaskCount = 123,
                         TaskDefinitionArn = "taskDefinitionArn"
                     },
                     EventBridgeParameters = new EventBridgeParametersProperty {
                         DetailType = "detailType",
                         Source = "source"
                     },
                     Input = "input",
                     KinesisParameters = new KinesisParametersProperty {
                         PartitionKey = "partitionKey"
                     },
                     RetryPolicy = new RetryPolicyProperty {
                         MaximumEventAgeInSeconds = 123,
                         MaximumRetryAttempts = 123
                     },
                     RoleArn = "roleArn",
                     SageMakerPipelineParameters = new SageMakerPipelineParametersProperty {
                         PipelineParameterList = new [] { new SageMakerPipelineParameterProperty {
                             Name = "name",
                             Value = "value"
                         } }
                     },
                     SqsParameters = new SqsParametersProperty {
                         MessageGroupId = "messageGroupId"
                     }
                 }
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Strategy

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

protected virtual PropertyMergeStrategy Strategy { get; }

Property Value

PropertyMergeStrategy

Remarks

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

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.Scheduler.Mixins;

             var tags;

             var cfnSchedulePropsMixin = new CfnSchedulePropsMixin(new CfnScheduleMixinProps {
                 Description = "description",
                 EndDate = "endDate",
                 FlexibleTimeWindow = new FlexibleTimeWindowProperty {
                     MaximumWindowInMinutes = 123,
                     Mode = "mode"
                 },
                 GroupName = "groupName",
                 KmsKeyArn = "kmsKeyArn",
                 Name = "name",
                 ScheduleExpression = "scheduleExpression",
                 ScheduleExpressionTimezone = "scheduleExpressionTimezone",
                 StartDate = "startDate",
                 State = "state",
                 Target = new TargetProperty {
                     Arn = "arn",
                     DeadLetterConfig = new DeadLetterConfigProperty {
                         Arn = "arn"
                     },
                     EcsParameters = new EcsParametersProperty {
                         CapacityProviderStrategy = new [] { new CapacityProviderStrategyItemProperty {
                             Base = 123,
                             CapacityProvider = "capacityProvider",
                             Weight = 123
                         } },
                         EnableEcsManagedTags = false,
                         EnableExecuteCommand = false,
                         Group = "group",
                         LaunchType = "launchType",
                         NetworkConfiguration = new NetworkConfigurationProperty {
                             AwsvpcConfiguration = new AwsVpcConfigurationProperty {
                                 AssignPublicIp = "assignPublicIp",
                                 SecurityGroups = new [] { "securityGroups" },
                                 Subnets = new [] { "subnets" }
                             }
                         },
                         PlacementConstraints = new [] { new PlacementConstraintProperty {
                             Expression = "expression",
                             Type = "type"
                         } },
                         PlacementStrategy = new [] { new PlacementStrategyProperty {
                             Field = "field",
                             Type = "type"
                         } },
                         PlatformVersion = "platformVersion",
                         PropagateTags = "propagateTags",
                         ReferenceId = "referenceId",
                         Tags = tags,
                         TaskCount = 123,
                         TaskDefinitionArn = "taskDefinitionArn"
                     },
                     EventBridgeParameters = new EventBridgeParametersProperty {
                         DetailType = "detailType",
                         Source = "source"
                     },
                     Input = "input",
                     KinesisParameters = new KinesisParametersProperty {
                         PartitionKey = "partitionKey"
                     },
                     RetryPolicy = new RetryPolicyProperty {
                         MaximumEventAgeInSeconds = 123,
                         MaximumRetryAttempts = 123
                     },
                     RoleArn = "roleArn",
                     SageMakerPipelineParameters = new SageMakerPipelineParametersProperty {
                         PipelineParameterList = new [] { new SageMakerPipelineParameterProperty {
                             Name = "name",
                             Value = "value"
                         } }
                     },
                     SqsParameters = new SqsParametersProperty {
                         MessageGroupId = "messageGroupId"
                     }
                 }
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

public override void ApplyTo(IConstruct construct)

Parameters

construct IConstruct

Overrides

Mixin.ApplyTo(IConstruct)

Remarks

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

Supports(IConstruct)

Check if this mixin supports the given construct.

public override bool Supports(IConstruct construct)

Parameters

construct IConstruct

Returns

bool

Overrides

Mixin.Supports(IConstruct)

Remarks

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

Implements

Constructs.IMixin