Class CfnScheduleProps
Properties for defining a CfnSchedule
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Scheduler
Assembly: Amazon.CDK.AWS.Scheduler.dll
Syntax (csharp)
public class CfnScheduleProps : Object, ICfnScheduleProps
Syntax (vb)
Public Class CfnScheduleProps
Inherits Object
Implements ICfnScheduleProps
Remarks
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html
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.AWS.Scheduler;
var tags;
var cfnScheduleProps = new CfnScheduleProps {
FlexibleTimeWindow = new FlexibleTimeWindowProperty {
Mode = "mode",
// the properties below are optional
MaximumWindowInMinutes = 123
},
ScheduleExpression = "scheduleExpression",
Target = new TargetProperty {
Arn = "arn",
RoleArn = "roleArn",
// the properties below are optional
DeadLetterConfig = new DeadLetterConfigProperty {
Arn = "arn"
},
EcsParameters = new EcsParametersProperty {
TaskDefinitionArn = "taskDefinitionArn",
// the properties below are optional
CapacityProviderStrategy = new [] { new CapacityProviderStrategyItemProperty {
CapacityProvider = "capacityProvider",
// the properties below are optional
Base = 123,
Weight = 123
} },
EnableEcsManagedTags = false,
EnableExecuteCommand = false,
Group = "group",
LaunchType = "launchType",
NetworkConfiguration = new NetworkConfigurationProperty {
AwsvpcConfiguration = new AwsVpcConfigurationProperty {
Subnets = new [] { "subnets" },
// the properties below are optional
AssignPublicIp = "assignPublicIp",
SecurityGroups = new [] { "securityGroups" }
}
},
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
},
EventBridgeParameters = new EventBridgeParametersProperty {
DetailType = "detailType",
Source = "source"
},
Input = "input",
KinesisParameters = new KinesisParametersProperty {
PartitionKey = "partitionKey"
},
RetryPolicy = new RetryPolicyProperty {
MaximumEventAgeInSeconds = 123,
MaximumRetryAttempts = 123
},
SageMakerPipelineParameters = new SageMakerPipelineParametersProperty {
PipelineParameterList = new [] { new SageMakerPipelineParameterProperty {
Name = "name",
Value = "value"
} }
},
SqsParameters = new SqsParametersProperty {
MessageGroupId = "messageGroupId"
}
},
// the properties below are optional
Description = "description",
EndDate = "endDate",
GroupName = "groupName",
KmsKeyArn = "kmsKeyArn",
Name = "name",
ScheduleExpressionTimezone = "scheduleExpressionTimezone",
StartDate = "startDate",
State = "state"
};
Synopsis
Constructors
CfnScheduleProps() |
Properties
Description | The description you specify for the schedule. |
EndDate | The date, in UTC, before which the schedule can invoke its target. |
FlexibleTimeWindow | Allows you to configure a time window during which EventBridge Scheduler invokes the schedule. |
GroupName | The name of the schedule group associated with this schedule. |
KmsKeyArn | The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data. |
Name | The name of the schedule. |
ScheduleExpression | The expression that defines when the schedule runs. The following formats are supported. |
ScheduleExpressionTimezone | The timezone in which the scheduling expression is evaluated. |
StartDate | The date, in UTC, after which the schedule can begin invoking its target. |
State | Specifies whether the schedule is enabled or disabled. |
Target | The schedule's target details. |
Constructors
CfnScheduleProps()
public CfnScheduleProps()
Properties
Description
The description you specify for the schedule.
public string Description { get; set; }
Property Value
System.String
Remarks
EndDate
The date, in UTC, before which the schedule can invoke its target.
public string EndDate { get; set; }
Property Value
System.String
Remarks
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.
FlexibleTimeWindow
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
public object FlexibleTimeWindow { get; set; }
Property Value
System.Object
Remarks
GroupName
The name of the schedule group associated with this schedule.
public string GroupName { get; set; }
Property Value
System.String
Remarks
KmsKeyArn
The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
public string KmsKeyArn { get; set; }
Property Value
System.String
Remarks
Name
The name of the schedule.
public string Name { get; set; }
Property Value
System.String
Remarks
ScheduleExpression
The expression that defines when the schedule runs. The following formats are supported.
public string ScheduleExpression { get; set; }
Property Value
System.String
Remarks
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 .
ScheduleExpressionTimezone
The timezone in which the scheduling expression is evaluated.
public string ScheduleExpressionTimezone { get; set; }
Property Value
System.String
Remarks
StartDate
The date, in UTC, after which the schedule can begin invoking its target.
public string StartDate { get; set; }
Property Value
System.String
Remarks
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
Specifies whether the schedule is enabled or disabled.
public string State { get; set; }
Property Value
System.String
Remarks
Allowed Values : ENABLED
| DISABLED
Target
The schedule's target details.
public object Target { get; set; }
Property Value
System.Object