class CfnSchedule (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Scheduler.CfnSchedule |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsscheduler#CfnSchedule |
![]() | software.amazon.awscdk.services.scheduler.CfnSchedule |
![]() | aws_cdk.aws_scheduler.CfnSchedule |
![]() | aws-cdk-lib » aws_scheduler » CfnSchedule |
Implements
IConstruct
, IDependable
, IInspectable
A schedule is the main resource you create, configure, and manage using Amazon EventBridge Scheduler.
Every schedule has a schedule expression that determines when, and with what frequency, the schedule runs. EventBridge Scheduler supports three types of schedules: rate, cron, and one-time schedules. For more information about different schedule types, see Schedule types in the EventBridge Scheduler User Guide .
When you create a schedule, you configure a target for the schedule to invoke. A target is an API operation that EventBridge Scheduler calls on your behalf every time your schedule runs. EventBridge Scheduler supports two types of targets: templated targets invoke common API operations across a core groups of services, and customizeable universal targets that you can use to call more than 6,000 operations across over 270 services. For more information about configuring targets, see Managing targets in the EventBridge Scheduler User Guide .
For more information about managing schedules, changing the schedule state, setting up flexible time windows, and configuring a dead-letter queue for a schedule, see Managing a schedule in the EventBridge Scheduler User Guide .
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-scheduler-schedule.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_scheduler as scheduler } from 'aws-cdk-lib';
declare const tags: any;
const cfnSchedule = new scheduler.CfnSchedule(this, 'MyCfnSchedule', {
flexibleTimeWindow: {
mode: 'mode',
// the properties below are optional
maximumWindowInMinutes: 123,
},
scheduleExpression: 'scheduleExpression',
target: {
arn: 'arn',
roleArn: 'roleArn',
// the properties below are optional
deadLetterConfig: {
arn: 'arn',
},
ecsParameters: {
taskDefinitionArn: 'taskDefinitionArn',
// the properties below are optional
capacityProviderStrategy: [{
capacityProvider: 'capacityProvider',
// the properties below are optional
base: 123,
weight: 123,
}],
enableEcsManagedTags: false,
enableExecuteCommand: false,
group: 'group',
launchType: 'launchType',
networkConfiguration: {
awsvpcConfiguration: {
subnets: ['subnets'],
// the properties below are optional
assignPublicIp: 'assignPublicIp',
securityGroups: ['securityGroups'],
},
},
placementConstraints: [{
expression: 'expression',
type: 'type',
}],
placementStrategy: [{
field: 'field',
type: 'type',
}],
platformVersion: 'platformVersion',
propagateTags: 'propagateTags',
referenceId: 'referenceId',
tags: tags,
taskCount: 123,
},
eventBridgeParameters: {
detailType: 'detailType',
source: 'source',
},
input: 'input',
kinesisParameters: {
partitionKey: 'partitionKey',
},
retryPolicy: {
maximumEventAgeInSeconds: 123,
maximumRetryAttempts: 123,
},
sageMakerPipelineParameters: {
pipelineParameterList: [{
name: 'name',
value: 'value',
}],
},
sqsParameters: {
messageGroupId: 'messageGroupId',
},
},
// the properties below are optional
description: 'description',
endDate: 'endDate',
groupName: 'groupName',
kmsKeyArn: 'kmsKeyArn',
name: 'name',
scheduleExpressionTimezone: 'scheduleExpressionTimezone',
startDate: 'startDate',
state: 'state',
});
Initializer
new CfnSchedule(scope: Construct, id: string, props: CfnScheduleProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Schedule Props
Construct Props
Name | Type | Description |
---|---|---|
flexible | IResolvable | Flexible | Allows you to configure a time window during which EventBridge Scheduler invokes the schedule. |
schedule | string | The expression that defines when the schedule runs. The following formats are supported. |
target | IResolvable | Target | The schedule's target details. |
description? | string | The description you specify for the schedule. |
end | string | The date, in UTC, before which the schedule can invoke its target. |
group | string | The name of the schedule group associated with this schedule. |
kms | string | The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data. |
name? | string | The name of the schedule. |
schedule | string | The timezone in which the scheduling expression is evaluated. |
start | string | The date, in UTC, after which the schedule can begin invoking its target. |
state? | string | Specifies whether the schedule is enabled or disabled. |
flexibleTimeWindow
Type:
IResolvable
|
Flexible
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
scheduleExpression
Type:
string
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
Type:
IResolvable
|
Target
The schedule's target details.
description?
Type:
string
(optional)
The description you specify for the schedule.
endDate?
Type:
string
(optional)
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.
groupName?
Type:
string
(optional)
The name of the schedule group associated with this schedule.
kmsKeyArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
name?
Type:
string
(optional)
The name of the schedule.
scheduleExpressionTimezone?
Type:
string
(optional)
The timezone in which the scheduling expression is evaluated.
startDate?
Type:
string
(optional)
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?
Type:
string
(optional)
Specifies whether the schedule is enabled or disabled.
Allowed Values : ENABLED
| DISABLED
Properties
Name | Type | Description |
---|---|---|
attr | string | The Amazon Resource Name (ARN) for the Amazon EventBridge Scheduler schedule. |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
flexible | IResolvable | Flexible | Allows you to configure a time window during which EventBridge Scheduler invokes the schedule. |
logical | string | The logical ID for this CloudFormation stack element. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
schedule | string | The expression that defines when the schedule runs. |
stack | Stack | The stack in which this element is defined. |
target | IResolvable | Target | The schedule's target details. |
description? | string | The description you specify for the schedule. |
end | string | The date, in UTC, before which the schedule can invoke its target. |
group | string | The name of the schedule group associated with this schedule. |
kms | string | The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data. |
name? | string | The name of the schedule. |
schedule | string | The timezone in which the scheduling expression is evaluated. |
start | string | The date, in UTC, after which the schedule can begin invoking its target. |
state? | string | Specifies whether the schedule is enabled or disabled. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrArn
Type:
string
The Amazon Resource Name (ARN) for the Amazon EventBridge Scheduler schedule.
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
flexibleTimeWindow
Type:
IResolvable
|
Flexible
Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
logicalId
Type:
string
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)
.
node
Type:
Node
The tree node.
ref
Type:
string
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 })
.
scheduleExpression
Type:
string
The expression that defines when the schedule runs.
The following formats are supported.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
target
Type:
IResolvable
|
Target
The schedule's target details.
description?
Type:
string
(optional)
The description you specify for the schedule.
endDate?
Type:
string
(optional)
The date, in UTC, before which the schedule can invoke its target.
groupName?
Type:
string
(optional)
The name of the schedule group associated with this schedule.
kmsKeyArn?
Type:
string
(optional)
The Amazon Resource Name (ARN) for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
name?
Type:
string
(optional)
The name of the schedule.
scheduleExpressionTimezone?
Type:
string
(optional)
The timezone in which the scheduling expression is evaluated.
startDate?
Type:
string
(optional)
The date, in UTC, after which the schedule can begin invoking its target.
state?
Type:
string
(optional)
Specifies whether the schedule is enabled or disabled.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
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.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
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.](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.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The 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,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"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.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
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
). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT
). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
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.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
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.](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)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }